blob: c5b67838718a9b90e8fcc9835e7e2adf09563c51 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
drhe7375bf2020-03-10 19:24:38 +000045char sqlite3ExprAffinity(const Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
dan07f9e8f2020-04-25 15:01:53 +000048 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drha7d6db62019-06-11 21:02:15 +000049 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
drhdb36e252019-10-22 19:51:29 +000073 if( op==TK_VECTOR ){
74 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75 }
drh11949042019-08-05 18:01:42 +000076 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000077}
78
drh53db1452004-05-20 13:54:53 +000079/*
drh8b4c40d2007-02-01 23:02:45 +000080** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000081** sequence named by pToken. Return a pointer to a new Expr node that
82** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000083**
84** If a memory allocation error occurs, that fact is recorded in pParse->db
85** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000086*/
drh4ef7efa2014-03-20 15:14:08 +000087Expr *sqlite3ExprAddCollateToken(
88 Parse *pParse, /* Parsing context */
89 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000090 const Token *pCollName, /* Name of collating sequence */
91 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000092){
drh0a8a4062012-12-07 18:38:16 +000093 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000094 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000095 if( pNew ){
96 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000097 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000098 pExpr = pNew;
99 }
drhae80dde2012-12-06 21:16:43 +0000100 }
drh0a8a4062012-12-07 18:38:16 +0000101 return pExpr;
102}
103Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000104 Token s;
105 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000106 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000107 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000108}
109
110/*
drh0d950af2019-08-22 16:38:42 +0000111** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000112*/
113Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000114 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
dan07f9e8f2020-04-25 15:01:53 +0000115 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drh0d950af2019-08-22 16:38:42 +0000116 pExpr = pExpr->pLeft;
117 }
118 return pExpr;
119}
120
121/*
122** Skip over any TK_COLLATE operators and/or any unlikely()
123** or likelihood() or likely() functions at the root of an
124** expression.
125*/
126Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000127 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000128 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000129 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000131 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000132 pExpr = pExpr->x.pList->a[0].pExpr;
133 }else{
dan07f9e8f2020-04-25 15:01:53 +0000134 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drha4c3c872013-09-12 17:29:25 +0000135 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000136 }
drha4c3c872013-09-12 17:29:25 +0000137 }
drh0a8a4062012-12-07 18:38:16 +0000138 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000139}
140
141/*
drhae80dde2012-12-06 21:16:43 +0000142** Return the collation sequence for the expression pExpr. If
143** there is no defined collating sequence, return NULL.
144**
drh70efa842017-09-28 01:58:23 +0000145** See also: sqlite3ExprNNCollSeq()
146**
147** The sqlite3ExprNNCollSeq() works the same exact that it returns the
148** default collation if pExpr has no defined collation.
149**
drhae80dde2012-12-06 21:16:43 +0000150** The collating sequence might be determined by a COLLATE operator
151** or by the presence of a column with a defined collating sequence.
152** COLLATE operators take first precedence. Left operands take
153** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000154*/
drhe7375bf2020-03-10 19:24:38 +0000155CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000156 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000157 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000158 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000159 while( p ){
drhae80dde2012-12-06 21:16:43 +0000160 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_REGISTER ) op = p->op2;
162 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000163 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000164 ){
drheda079c2018-09-20 19:02:15 +0000165 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000166 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000167 int j = p->iColumn;
168 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000169 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000170 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000171 }
172 break;
danielk19770202b292004-06-09 09:55:16 +0000173 }
drhe081d732018-07-27 18:19:12 +0000174 if( op==TK_CAST || op==TK_UPLUS ){
175 p = p->pLeft;
176 continue;
177 }
drh269d3222019-10-23 18:09:39 +0000178 if( op==TK_VECTOR ){
179 p = p->x.pList->a[0].pExpr;
180 continue;
181 }
drhcb0e04f2018-12-12 21:34:17 +0000182 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000183 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
184 break;
185 }
drhae80dde2012-12-06 21:16:43 +0000186 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000187 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000188 p = p->pLeft;
189 }else{
drh2308ed32015-02-09 16:09:34 +0000190 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000191 /* The Expr.x union is never used at the same time as Expr.pRight */
192 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000193 if( p->x.pList!=0
194 && !db->mallocFailed
195 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
196 ){
drh2308ed32015-02-09 16:09:34 +0000197 int i;
drh95768022019-11-10 10:08:03 +0000198 for(i=0; i<p->x.pList->nExpr; i++){
drh2308ed32015-02-09 16:09:34 +0000199 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
200 pNext = p->x.pList->a[i].pExpr;
201 break;
202 }
203 }
204 }
205 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000206 }
207 }else{
drh7d10d5a2008-08-20 16:35:10 +0000208 break;
209 }
danielk19770202b292004-06-09 09:55:16 +0000210 }
danielk19777cedc8d2004-06-10 10:50:08 +0000211 if( sqlite3CheckCollSeq(pParse, pColl) ){
212 pColl = 0;
213 }
214 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000215}
216
217/*
drh70efa842017-09-28 01:58:23 +0000218** Return the collation sequence for the expression pExpr. If
219** there is no defined collating sequence, return a pointer to the
220** defautl collation sequence.
221**
222** See also: sqlite3ExprCollSeq()
223**
224** The sqlite3ExprCollSeq() routine works the same except that it
225** returns NULL if there is no defined collation.
226*/
drhe7375bf2020-03-10 19:24:38 +0000227CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000228 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
229 if( p==0 ) p = pParse->db->pDfltColl;
230 assert( p!=0 );
231 return p;
232}
233
234/*
235** Return TRUE if the two expressions have equivalent collating sequences.
236*/
drhe7375bf2020-03-10 19:24:38 +0000237int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000238 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
239 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
240 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
241}
242
243/*
drh626a8792005-01-17 22:08:19 +0000244** pExpr is an operand of a comparison operator. aff2 is the
245** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000246** type affinity that should be used for the comparison operator.
247*/
drhe7375bf2020-03-10 19:24:38 +0000248char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000249 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000250 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000251 /* Both sides of the comparison are columns. If one has numeric
252 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000253 */
drh8a512562005-11-14 22:29:05 +0000254 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000255 return SQLITE_AFF_NUMERIC;
256 }else{
drh05883a32015-06-02 15:32:08 +0000257 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000258 }
danielk1977e014a832004-05-17 10:48:57 +0000259 }else{
260 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000261 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
262 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
264}
265
drh53db1452004-05-20 13:54:53 +0000266/*
267** pExpr is a comparison operator. Return the type affinity that should
268** be applied to both operands prior to doing the comparison.
269*/
drhe7375bf2020-03-10 19:24:38 +0000270static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000271 char aff;
272 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000274 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000275 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000276 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000277 if( pExpr->pRight ){
278 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000279 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
280 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000281 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000282 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000283 }
284 return aff;
285}
286
287/*
288** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289** idx_affinity is the affinity of an indexed column. Return true
290** if the index with affinity idx_affinity may be used to implement
291** the comparison in pExpr.
292*/
drhe7375bf2020-03-10 19:24:38 +0000293int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000294 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000295 if( aff<SQLITE_AFF_TEXT ){
296 return 1;
drh8a512562005-11-14 22:29:05 +0000297 }
drh915e4342019-08-06 15:18:15 +0000298 if( aff==SQLITE_AFF_TEXT ){
299 return idx_affinity==SQLITE_AFF_TEXT;
300 }
301 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000302}
303
danielk1977a37cdde2004-05-16 11:15:36 +0000304/*
drh35573352008-01-08 23:54:25 +0000305** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000306** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000307*/
drhe7375bf2020-03-10 19:24:38 +0000308static u8 binaryCompareP5(
309 const Expr *pExpr1, /* Left operand */
310 const Expr *pExpr2, /* Right operand */
311 int jumpIfNull /* Extra flags added to P5 */
312){
drh35573352008-01-08 23:54:25 +0000313 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000314 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000315 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000316}
317
drha2e00042002-01-22 03:13:42 +0000318/*
danielk19770202b292004-06-09 09:55:16 +0000319** Return a pointer to the collation sequence that should be used by
320** a binary comparison operator comparing pLeft and pRight.
321**
322** If the left hand expression has a collating sequence type, then it is
323** used. Otherwise the collation sequence for the right hand expression
324** is used, or the default (BINARY) if neither expression has a collating
325** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000326**
327** Argument pRight (but not pLeft) may be a null pointer. In this case,
328** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000329*/
drh0a0e1312007-08-07 17:04:59 +0000330CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000331 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000332 const Expr *pLeft,
333 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000334){
drhec41dda2007-02-07 13:09:45 +0000335 CollSeq *pColl;
336 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000337 if( pLeft->flags & EP_Collate ){
338 pColl = sqlite3ExprCollSeq(pParse, pLeft);
339 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
340 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000341 }else{
342 pColl = sqlite3ExprCollSeq(pParse, pLeft);
343 if( !pColl ){
344 pColl = sqlite3ExprCollSeq(pParse, pRight);
345 }
danielk19770202b292004-06-09 09:55:16 +0000346 }
347 return pColl;
348}
349
drh898c5272019-10-22 00:03:41 +0000350/* Expresssion p is a comparison operator. Return a collation sequence
351** appropriate for the comparison operator.
352**
353** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
354** However, if the OP_Commuted flag is set, then the order of the operands
355** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
356** correct collating sequence is found.
357*/
drhe7375bf2020-03-10 19:24:38 +0000358CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000359 if( ExprHasProperty(p, EP_Commuted) ){
360 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
361 }else{
362 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
363 }
364}
365
danielk19770202b292004-06-09 09:55:16 +0000366/*
drhbe5c89a2004-07-26 00:31:09 +0000367** Generate code for a comparison operator.
368*/
369static int codeCompare(
370 Parse *pParse, /* The parsing (and code generating) context */
371 Expr *pLeft, /* The left operand */
372 Expr *pRight, /* The right operand */
373 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000374 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000375 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000376 int jumpIfNull, /* If true, jump if either operand is NULL */
377 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000378){
drh35573352008-01-08 23:54:25 +0000379 int p5;
380 int addr;
381 CollSeq *p4;
382
drh86541862019-12-19 20:37:32 +0000383 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000384 if( isCommuted ){
385 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
386 }else{
387 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
388 }
drh35573352008-01-08 23:54:25 +0000389 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
390 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
391 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000392 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000393 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000394}
395
dancfbb5e82016-07-13 19:48:13 +0000396/*
dan870a0702016-08-01 16:37:43 +0000397** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000398**
399** A vector is defined as any expression that results in two or more
400** columns of result. Every TK_VECTOR node is an vector because the
401** parser will not generate a TK_VECTOR with fewer than two entries.
402** But a TK_SELECT might be either a vector or a scalar. It is only
403** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000404*/
405int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000406 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000407}
408
409/*
dancfbb5e82016-07-13 19:48:13 +0000410** If the expression passed as the only argument is of type TK_VECTOR
411** return the number of expressions in the vector. Or, if the expression
412** is a sub-select, return the number of columns in the sub-select. For
413** any other type of expression, return 1.
414*/
dan71c57db2016-07-09 20:23:55 +0000415int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000416 u8 op = pExpr->op;
417 if( op==TK_REGISTER ) op = pExpr->op2;
418 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000419 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000420 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000421 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000422 }else{
423 return 1;
dan71c57db2016-07-09 20:23:55 +0000424 }
dan71c57db2016-07-09 20:23:55 +0000425}
426
danba00e302016-07-23 20:24:06 +0000427/*
drhfc7f27b2016-08-20 00:07:01 +0000428** Return a pointer to a subexpression of pVector that is the i-th
429** column of the vector (numbered starting with 0). The caller must
430** ensure that i is within range.
431**
drh76dbe7a2016-08-20 21:02:38 +0000432** If pVector is really a scalar (and "scalar" here includes subqueries
433** that return a single column!) then return pVector unmodified.
434**
drhfc7f27b2016-08-20 00:07:01 +0000435** pVector retains ownership of the returned subexpression.
436**
437** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000438** just the expression for the i-th term of the result set, and may
439** not be ready for evaluation because the table cursor has not yet
440** been positioned.
danba00e302016-07-23 20:24:06 +0000441*/
drhfc7f27b2016-08-20 00:07:01 +0000442Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000443 assert( i<sqlite3ExprVectorSize(pVector) );
444 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000445 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
446 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000447 return pVector->x.pSelect->pEList->a[i].pExpr;
448 }else{
449 return pVector->x.pList->a[i].pExpr;
450 }
dan71c57db2016-07-09 20:23:55 +0000451 }
dan870a0702016-08-01 16:37:43 +0000452 return pVector;
dan71c57db2016-07-09 20:23:55 +0000453}
drhfc7f27b2016-08-20 00:07:01 +0000454
drhfc7f27b2016-08-20 00:07:01 +0000455/*
456** Compute and return a new Expr object which when passed to
457** sqlite3ExprCode() will generate all necessary code to compute
458** the iField-th column of the vector expression pVector.
459**
drh8762ec12016-08-20 01:06:22 +0000460** It is ok for pVector to be a scalar (as long as iField==0).
461** In that case, this routine works like sqlite3ExprDup().
462**
drhfc7f27b2016-08-20 00:07:01 +0000463** The caller owns the returned Expr object and is responsible for
464** ensuring that the returned value eventually gets freed.
465**
drh8762ec12016-08-20 01:06:22 +0000466** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000467** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000468** valid for the life of the returned object. If pVector is a TK_VECTOR
469** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000470** returns.
drh8762ec12016-08-20 01:06:22 +0000471**
472** A trick to cause a TK_SELECT pVector to be deleted together with
473** the returned Expr object is to attach the pVector to the pRight field
474** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000475*/
476Expr *sqlite3ExprForVectorField(
477 Parse *pParse, /* Parsing context */
478 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000479 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000480){
481 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000482 if( pVector->op==TK_SELECT ){
483 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000484 /* The TK_SELECT_COLUMN Expr node:
485 **
drh966e2912017-01-03 02:58:01 +0000486 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000487 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000488 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000489 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000490 ** pLeft->iTable: First in an array of register holding result, or 0
491 ** if the result is not yet computed.
492 **
493 ** sqlite3ExprDelete() specifically skips the recursive delete of
494 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000495 ** can be attached to pRight to cause this node to take ownership of
496 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
497 ** with the same pLeft pointer to the pVector, but only one of them
498 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000499 */
drhabfd35e2016-12-06 22:47:23 +0000500 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000501 if( pRet ){
502 pRet->iColumn = iField;
503 pRet->pLeft = pVector;
504 }
drhfc7f27b2016-08-20 00:07:01 +0000505 assert( pRet==0 || pRet->iTable==0 );
506 }else{
drha1251bc2016-08-20 00:51:37 +0000507 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
508 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000509 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000510 }
511 return pRet;
512}
dan71c57db2016-07-09 20:23:55 +0000513
dan5c288b92016-07-30 21:02:33 +0000514/*
515** If expression pExpr is of type TK_SELECT, generate code to evaluate
516** it. Return the register in which the result is stored (or, if the
517** sub-select returns more than one column, the first in an array
518** of registers in which the result is stored).
519**
520** If pExpr is not a TK_SELECT expression, return 0.
521*/
522static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000523 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000524#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000525 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000526 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000527 }
danf9b2e052016-08-02 17:45:00 +0000528#endif
dan8da209b2016-07-26 18:06:08 +0000529 return reg;
530}
531
dan5c288b92016-07-30 21:02:33 +0000532/*
533** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000534** or TK_SELECT that returns more than one column. This function returns
535** the register number of a register that contains the value of
536** element iField of the vector.
537**
538** If pVector is a TK_SELECT expression, then code for it must have
539** already been generated using the exprCodeSubselect() routine. In this
540** case parameter regSelect should be the first in an array of registers
541** containing the results of the sub-select.
542**
543** If pVector is of type TK_VECTOR, then code for the requested field
544** is generated. In this case (*pRegFree) may be set to the number of
545** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000546**
547** Before returning, output parameter (*ppExpr) is set to point to the
548** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000549*/
550static int exprVectorRegister(
551 Parse *pParse, /* Parse context */
552 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000553 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000554 int regSelect, /* First in array of registers */
555 Expr **ppExpr, /* OUT: Expression element */
556 int *pRegFree /* OUT: Temp register to free */
557){
drh12abf402016-08-22 14:30:05 +0000558 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000559 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000560 if( op==TK_REGISTER ){
561 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
562 return pVector->iTable+iField;
563 }
564 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000565 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
566 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000567 }
dan870a0702016-08-01 16:37:43 +0000568 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000569 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
570}
571
572/*
573** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000574** the result of the comparison (1, 0, or NULL) and write that
575** result into register dest.
576**
577** The caller must satisfy the following preconditions:
578**
579** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
580** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
581** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000582*/
drh79752b62016-08-13 10:02:17 +0000583static void codeVectorCompare(
584 Parse *pParse, /* Code generator context */
585 Expr *pExpr, /* The comparison operation */
586 int dest, /* Write results into this register */
587 u8 op, /* Comparison operator */
588 u8 p5 /* SQLITE_NULLEQ or zero */
589){
dan71c57db2016-07-09 20:23:55 +0000590 Vdbe *v = pParse->pVdbe;
591 Expr *pLeft = pExpr->pLeft;
592 Expr *pRight = pExpr->pRight;
593 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000594 int i;
595 int regLeft = 0;
596 int regRight = 0;
597 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000598 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000599 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000600
drhe7375bf2020-03-10 19:24:38 +0000601 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh70d6b832019-12-30 23:50:19 +0000602 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000603 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
604 sqlite3ErrorMsg(pParse, "row value misused");
605 return;
606 }
drhb29e60c2016-09-05 12:02:34 +0000607 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
608 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
609 || pExpr->op==TK_LT || pExpr->op==TK_GT
610 || pExpr->op==TK_LE || pExpr->op==TK_GE
611 );
612 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
613 || (pExpr->op==TK_ISNOT && op==TK_NE) );
614 assert( p5==0 || pExpr->op!=op );
615 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000616
drhb29e60c2016-09-05 12:02:34 +0000617 p5 |= SQLITE_STOREP2;
618 if( opx==TK_LE ) opx = TK_LT;
619 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000620
drhb29e60c2016-09-05 12:02:34 +0000621 regLeft = exprCodeSubselect(pParse, pLeft);
622 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000623
drhb29e60c2016-09-05 12:02:34 +0000624 for(i=0; 1 /*Loop exits by "break"*/; i++){
625 int regFree1 = 0, regFree2 = 0;
626 Expr *pL, *pR;
627 int r1, r2;
628 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000629 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
630 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000631 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000632 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
633 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
634 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
635 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
636 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
637 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
638 sqlite3ReleaseTempReg(pParse, regFree1);
639 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000640 if( i==nLeft-1 ){
641 break;
dan71c57db2016-07-09 20:23:55 +0000642 }
drhb29e60c2016-09-05 12:02:34 +0000643 if( opx==TK_EQ ){
644 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
645 p5 |= SQLITE_KEEPNULL;
646 }else if( opx==TK_NE ){
647 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
648 p5 |= SQLITE_KEEPNULL;
649 }else{
650 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
651 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
652 VdbeCoverageIf(v, op==TK_LT);
653 VdbeCoverageIf(v, op==TK_GT);
654 VdbeCoverageIf(v, op==TK_LE);
655 VdbeCoverageIf(v, op==TK_GE);
656 if( i==nLeft-2 ) opx = op;
657 }
dan71c57db2016-07-09 20:23:55 +0000658 }
drhb29e60c2016-09-05 12:02:34 +0000659 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000660}
661
danielk19774b5255a2008-06-05 16:47:39 +0000662#if SQLITE_MAX_EXPR_DEPTH>0
663/*
664** Check that argument nHeight is less than or equal to the maximum
665** expression depth allowed. If it is not, leave an error message in
666** pParse.
667*/
drh7d10d5a2008-08-20 16:35:10 +0000668int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000669 int rc = SQLITE_OK;
670 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
671 if( nHeight>mxHeight ){
672 sqlite3ErrorMsg(pParse,
673 "Expression tree is too large (maximum depth %d)", mxHeight
674 );
675 rc = SQLITE_ERROR;
676 }
677 return rc;
678}
679
680/* The following three functions, heightOfExpr(), heightOfExprList()
681** and heightOfSelect(), are used to determine the maximum height
682** of any expression tree referenced by the structure passed as the
683** first argument.
684**
685** If this maximum height is greater than the current value pointed
686** to by pnHeight, the second parameter, then set *pnHeight to that
687** value.
688*/
689static void heightOfExpr(Expr *p, int *pnHeight){
690 if( p ){
691 if( p->nHeight>*pnHeight ){
692 *pnHeight = p->nHeight;
693 }
694 }
695}
696static void heightOfExprList(ExprList *p, int *pnHeight){
697 if( p ){
698 int i;
699 for(i=0; i<p->nExpr; i++){
700 heightOfExpr(p->a[i].pExpr, pnHeight);
701 }
702 }
703}
dan1a3a3082018-01-18 19:00:54 +0000704static void heightOfSelect(Select *pSelect, int *pnHeight){
705 Select *p;
706 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000707 heightOfExpr(p->pWhere, pnHeight);
708 heightOfExpr(p->pHaving, pnHeight);
709 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000710 heightOfExprList(p->pEList, pnHeight);
711 heightOfExprList(p->pGroupBy, pnHeight);
712 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000713 }
714}
715
716/*
717** Set the Expr.nHeight variable in the structure passed as an
718** argument. An expression with no children, Expr.pList or
719** Expr.pSelect member has a height of 1. Any other expression
720** has a height equal to the maximum height of any other
721** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000722**
723** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
724** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000725*/
726static void exprSetHeight(Expr *p){
727 int nHeight = 0;
728 heightOfExpr(p->pLeft, &nHeight);
729 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000730 if( ExprHasProperty(p, EP_xIsSelect) ){
731 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000732 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000733 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000734 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000735 }
danielk19774b5255a2008-06-05 16:47:39 +0000736 p->nHeight = nHeight + 1;
737}
738
739/*
740** Set the Expr.nHeight variable using the exprSetHeight() function. If
741** the height is greater than the maximum allowed expression depth,
742** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000743**
744** Also propagate all EP_Propagate flags from the Expr.x.pList into
745** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000746*/
drh2308ed32015-02-09 16:09:34 +0000747void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000748 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000749 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000750 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000751}
752
753/*
754** Return the maximum height of any expression tree referenced
755** by the select statement passed as an argument.
756*/
757int sqlite3SelectExprHeight(Select *p){
758 int nHeight = 0;
759 heightOfSelect(p, &nHeight);
760 return nHeight;
761}
drh2308ed32015-02-09 16:09:34 +0000762#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
763/*
764** Propagate all EP_Propagate flags from the Expr.x.pList into
765** Expr.flags.
766*/
767void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
768 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
769 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
770 }
771}
772#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000773#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
774
drhbe5c89a2004-07-26 00:31:09 +0000775/*
drhb7916a72009-05-27 10:31:29 +0000776** This routine is the core allocator for Expr nodes.
777**
drha76b5df2002-02-23 02:32:10 +0000778** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000779** for this node and for the pToken argument is a single allocation
780** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000781** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000782**
783** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000784** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000785** parameter is ignored if pToken is NULL or if the token does not
786** appear to be quoted. If the quotes were of the form "..." (double-quotes)
787** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000788**
789** Special case: If op==TK_INTEGER and pToken points to a string that
790** can be translated into a 32-bit integer, then the token is not
791** stored in u.zToken. Instead, the integer values is written
792** into u.iValue and the EP_IntValue flag is set. No extra storage
793** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000794*/
drhb7916a72009-05-27 10:31:29 +0000795Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000796 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000797 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000798 const Token *pToken, /* Token argument. Might be NULL */
799 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000800){
drha76b5df2002-02-23 02:32:10 +0000801 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000802 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000803 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000804
drh575fad62016-02-05 13:38:36 +0000805 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000806 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000807 if( op!=TK_INTEGER || pToken->z==0
808 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
809 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000810 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000811 }
drhb7916a72009-05-27 10:31:29 +0000812 }
drh575fad62016-02-05 13:38:36 +0000813 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000814 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000815 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000816 pNew->op = (u8)op;
817 pNew->iAgg = -1;
818 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000819 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000820 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000821 pNew->u.iValue = iValue;
822 }else{
drh33e619f2009-05-28 01:00:55 +0000823 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000824 assert( pToken->z!=0 || pToken->n==0 );
825 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000826 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000827 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000828 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000829 }
drhb7916a72009-05-27 10:31:29 +0000830 }
831 }
832#if SQLITE_MAX_EXPR_DEPTH>0
833 pNew->nHeight = 1;
834#endif
835 }
drha76b5df2002-02-23 02:32:10 +0000836 return pNew;
837}
838
839/*
drhb7916a72009-05-27 10:31:29 +0000840** Allocate a new expression node from a zero-terminated token that has
841** already been dequoted.
842*/
843Expr *sqlite3Expr(
844 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
845 int op, /* Expression opcode */
846 const char *zToken /* Token argument. Might be NULL */
847){
848 Token x;
849 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000850 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000851 return sqlite3ExprAlloc(db, op, &x, 0);
852}
853
854/*
855** Attach subtrees pLeft and pRight to the Expr node pRoot.
856**
857** If pRoot==NULL that means that a memory allocation error has occurred.
858** In that case, delete the subtrees pLeft and pRight.
859*/
860void sqlite3ExprAttachSubtrees(
861 sqlite3 *db,
862 Expr *pRoot,
863 Expr *pLeft,
864 Expr *pRight
865){
866 if( pRoot==0 ){
867 assert( db->mallocFailed );
868 sqlite3ExprDelete(db, pLeft);
869 sqlite3ExprDelete(db, pRight);
870 }else{
871 if( pRight ){
872 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000873 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000874 }
875 if( pLeft ){
876 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000877 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000878 }
879 exprSetHeight(pRoot);
880 }
881}
882
883/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000884** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000885**
drhbf664462009-06-19 18:32:54 +0000886** One or both of the subtrees can be NULL. Return a pointer to the new
887** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
888** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000889*/
drh17435752007-08-16 04:30:38 +0000890Expr *sqlite3PExpr(
891 Parse *pParse, /* Parsing context */
892 int op, /* Expression opcode */
893 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000894 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000895){
drh5fb52ca2012-03-31 02:34:35 +0000896 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000897 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
898 if( p ){
899 memset(p, 0, sizeof(Expr));
900 p->op = op & 0xff;
901 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000902 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000903 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000904 }else{
905 sqlite3ExprDelete(pParse->db, pLeft);
906 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000907 }
drh4e0cff62004-11-05 05:10:28 +0000908 return p;
909}
910
911/*
drh08de4f72016-04-11 01:06:47 +0000912** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
913** do a memory allocation failure) then delete the pSelect object.
914*/
915void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
916 if( pExpr ){
917 pExpr->x.pSelect = pSelect;
918 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
919 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
920 }else{
921 assert( pParse->db->mallocFailed );
922 sqlite3SelectDelete(pParse->db, pSelect);
923 }
924}
925
926
927/*
drh91bb0ee2004-09-01 03:06:34 +0000928** Join two expressions using an AND operator. If either expression is
929** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000930**
931** If one side or the other of the AND is known to be false, then instead
932** of returning an AND expression, just return a constant expression with
933** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000934*/
drhd5c851c2019-04-19 13:38:34 +0000935Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
936 sqlite3 *db = pParse->db;
937 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000938 return pRight;
939 }else if( pRight==0 ){
940 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000941 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
942 && !IN_RENAME_OBJECT
943 ){
944 sqlite3ExprDelete(db, pLeft);
945 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000946 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000947 }else{
drhd5c851c2019-04-19 13:38:34 +0000948 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000949 }
950}
951
952/*
953** Construct a new expression node for a function with multiple
954** arguments.
955*/
drh954733b2018-07-27 23:33:16 +0000956Expr *sqlite3ExprFunction(
957 Parse *pParse, /* Parsing context */
958 ExprList *pList, /* Argument list */
959 Token *pToken, /* Name of the function */
960 int eDistinct /* SF_Distinct or SF_ALL or 0 */
961){
drha76b5df2002-02-23 02:32:10 +0000962 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000963 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000964 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000965 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000966 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000967 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000968 return 0;
969 }
drh954733b2018-07-27 23:33:16 +0000970 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
971 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
972 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000973 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000974 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000975 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000976 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000977 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000978 return pNew;
979}
980
981/*
drh0dfa5252020-01-08 17:28:19 +0000982** Check to see if a function is usable according to current access
983** rules:
984**
985** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
986**
987** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
988** top-level SQL
989**
990** If the function is not usable, create an error.
991*/
992void sqlite3ExprFunctionUsable(
993 Parse *pParse, /* Parsing and code generating context */
994 Expr *pExpr, /* The function invocation */
995 FuncDef *pDef /* The function being invoked */
996){
997 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +0000998 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
999 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001000 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1001 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1002 ){
1003 /* Functions prohibited in triggers and views if:
1004 ** (1) tagged with SQLITE_DIRECTONLY
1005 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1006 ** is tagged with SQLITE_FUNC_UNSAFE) and
1007 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1008 ** that the schema is possibly tainted).
1009 */
1010 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1011 }
1012 }
1013}
1014
1015/*
drhfa6bc002004-09-07 16:19:52 +00001016** Assign a variable number to an expression that encodes a wildcard
1017** in the original SQL statement.
1018**
1019** Wildcards consisting of a single "?" are assigned the next sequential
1020** variable number.
1021**
1022** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001023** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001024** the SQL statement comes from an external source.
1025**
drh51f49f12009-05-21 20:41:32 +00001026** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001027** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001028** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001029** assigned.
1030*/
drhde25a882016-10-03 15:28:24 +00001031void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001032 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001033 const char *z;
drhf326d662016-12-23 13:30:53 +00001034 ynVar x;
drh17435752007-08-16 04:30:38 +00001035
drhfa6bc002004-09-07 16:19:52 +00001036 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001037 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001038 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001039 assert( z!=0 );
1040 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001041 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001042 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001043 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001044 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001045 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001046 }else{
drhf326d662016-12-23 13:30:53 +00001047 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001048 if( z[0]=='?' ){
1049 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1050 ** use it as the variable number */
1051 i64 i;
drh18814df2017-01-31 03:52:34 +00001052 int bOk;
1053 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1054 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1055 bOk = 1;
1056 }else{
1057 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1058 }
drh124c0b42011-06-01 18:15:55 +00001059 testcase( i==0 );
1060 testcase( i==1 );
1061 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1062 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1063 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1064 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1065 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001066 return;
drhfa6bc002004-09-07 16:19:52 +00001067 }
drh8e74e7b2017-01-31 12:41:48 +00001068 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001069 if( x>pParse->nVar ){
1070 pParse->nVar = (int)x;
1071 doAdd = 1;
1072 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1073 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001074 }
1075 }else{
1076 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1077 ** number as the prior appearance of the same name, or if the name
1078 ** has never appeared before, reuse the same variable number
1079 */
drh9bf755c2016-12-23 03:59:31 +00001080 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1081 if( x==0 ){
1082 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001083 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001084 }
drhfa6bc002004-09-07 16:19:52 +00001085 }
drhf326d662016-12-23 13:30:53 +00001086 if( doAdd ){
1087 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1088 }
1089 }
1090 pExpr->iColumn = x;
1091 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001092 sqlite3ErrorMsg(pParse, "too many SQL variables");
1093 }
drhfa6bc002004-09-07 16:19:52 +00001094}
1095
1096/*
danf6963f92009-11-23 14:39:14 +00001097** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001098*/
drh4f0010b2016-04-11 14:49:39 +00001099static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1100 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001101 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1102 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001103
1104 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1105 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001106 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001107#ifdef SQLITE_DEBUG
1108 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1109 assert( p->pLeft==0 );
1110 assert( p->pRight==0 );
1111 assert( p->x.pSelect==0 );
1112 }
1113#endif
1114 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001115 /* The Expr.x union is never used at the same time as Expr.pRight */
1116 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001117 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001118 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001119 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001120 sqlite3ExprDeleteNN(db, p->pRight);
1121 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001122 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001123 sqlite3SelectDelete(db, p->x.pSelect);
1124 }else{
1125 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001126#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001127 if( ExprHasProperty(p, EP_WinFunc) ){
1128 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001129 }
dan6ba7ab02019-07-02 11:56:47 +00001130#endif
dan8117f112019-07-10 20:16:53 +00001131 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001132 }
drh209bc522016-09-23 21:36:24 +00001133 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001134 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001135 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001136 }
drha2e00042002-01-22 03:13:42 +00001137}
drh4f0010b2016-04-11 14:49:39 +00001138void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1139 if( p ) sqlite3ExprDeleteNN(db, p);
1140}
drha2e00042002-01-22 03:13:42 +00001141
drh8e34e402019-06-11 10:43:56 +00001142/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1143** expression.
1144*/
1145void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1146 if( p ){
1147 if( IN_RENAME_OBJECT ){
1148 sqlite3RenameExprUnmap(pParse, p);
1149 }
1150 sqlite3ExprDeleteNN(pParse->db, p);
1151 }
1152}
1153
drhd2687b72005-08-12 22:56:09 +00001154/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001155** Return the number of bytes allocated for the expression structure
1156** passed as the first argument. This is always one of EXPR_FULLSIZE,
1157** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1158*/
1159static int exprStructSize(Expr *p){
1160 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001161 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1162 return EXPR_FULLSIZE;
1163}
1164
1165/*
drh33e619f2009-05-28 01:00:55 +00001166** The dupedExpr*Size() routines each return the number of bytes required
1167** to store a copy of an expression or expression tree. They differ in
1168** how much of the tree is measured.
1169**
1170** dupedExprStructSize() Size of only the Expr structure
1171** dupedExprNodeSize() Size of Expr + space for token
1172** dupedExprSize() Expr + token + subtree components
1173**
1174***************************************************************************
1175**
1176** The dupedExprStructSize() function returns two values OR-ed together:
1177** (1) the space required for a copy of the Expr structure only and
1178** (2) the EP_xxx flags that indicate what the structure size should be.
1179** The return values is always one of:
1180**
1181** EXPR_FULLSIZE
1182** EXPR_REDUCEDSIZE | EP_Reduced
1183** EXPR_TOKENONLYSIZE | EP_TokenOnly
1184**
1185** The size of the structure can be found by masking the return value
1186** of this routine with 0xfff. The flags can be found by masking the
1187** return value with EP_Reduced|EP_TokenOnly.
1188**
1189** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1190** (unreduced) Expr objects as they or originally constructed by the parser.
1191** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001192** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001193** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001194** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001195** to reduce a pristine expression tree from the parser. The implementation
1196** of dupedExprStructSize() contain multiple assert() statements that attempt
1197** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001198*/
1199static int dupedExprStructSize(Expr *p, int flags){
1200 int nSize;
drh33e619f2009-05-28 01:00:55 +00001201 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001202 assert( EXPR_FULLSIZE<=0xfff );
1203 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001204 if( 0==flags || p->op==TK_SELECT_COLUMN
1205#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001206 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001207#endif
1208 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001209 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001210 }else{
drhc5cd1242013-09-12 16:50:49 +00001211 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001212 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001213 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001214 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001215 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001216 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1217 }else{
drhaecd8022013-09-13 18:15:15 +00001218 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001219 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1220 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001221 }
1222 return nSize;
1223}
1224
1225/*
drh33e619f2009-05-28 01:00:55 +00001226** This function returns the space in bytes required to store the copy
1227** of the Expr structure and a copy of the Expr.u.zToken string (if that
1228** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001229*/
1230static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001231 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1232 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001233 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001234 }
danielk1977bc739712009-03-23 04:33:32 +00001235 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001236}
1237
1238/*
1239** Return the number of bytes required to create a duplicate of the
1240** expression passed as the first argument. The second argument is a
1241** mask containing EXPRDUP_XXX flags.
1242**
1243** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001244** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001245**
1246** If the EXPRDUP_REDUCE flag is set, then the return value includes
1247** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1248** and Expr.pRight variables (but not for any structures pointed to or
1249** descended from the Expr.x.pList or Expr.x.pSelect variables).
1250*/
1251static int dupedExprSize(Expr *p, int flags){
1252 int nByte = 0;
1253 if( p ){
1254 nByte = dupedExprNodeSize(p, flags);
1255 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001256 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001257 }
1258 }
1259 return nByte;
1260}
1261
1262/*
1263** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1264** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001265** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001266** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001267** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001268** portion of the buffer copied into by this function.
1269*/
drh3c194692016-04-11 16:43:43 +00001270static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1271 Expr *pNew; /* Value to return */
1272 u8 *zAlloc; /* Memory space from which to build Expr object */
1273 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1274
drh575fad62016-02-05 13:38:36 +00001275 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001276 assert( p );
1277 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1278 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001279
drh3c194692016-04-11 16:43:43 +00001280 /* Figure out where to write the new Expr structure. */
1281 if( pzBuffer ){
1282 zAlloc = *pzBuffer;
1283 staticFlag = EP_Static;
1284 }else{
1285 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1286 staticFlag = 0;
1287 }
1288 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001289
drh3c194692016-04-11 16:43:43 +00001290 if( pNew ){
1291 /* Set nNewSize to the size allocated for the structure pointed to
1292 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1293 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1294 ** by the copy of the p->u.zToken string (if any).
1295 */
1296 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1297 const int nNewSize = nStructSize & 0xfff;
1298 int nToken;
1299 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1300 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001301 }else{
drh3c194692016-04-11 16:43:43 +00001302 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001303 }
drh3c194692016-04-11 16:43:43 +00001304 if( dupFlags ){
1305 assert( ExprHasProperty(p, EP_Reduced)==0 );
1306 memcpy(zAlloc, p, nNewSize);
1307 }else{
1308 u32 nSize = (u32)exprStructSize(p);
1309 memcpy(zAlloc, p, nSize);
1310 if( nSize<EXPR_FULLSIZE ){
1311 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1312 }
1313 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001314
drh3c194692016-04-11 16:43:43 +00001315 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1316 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1317 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1318 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001319 ExprClearVVAProperties(pNew);
1320 if( dupFlags ){
1321 ExprSetVVAProperty(pNew, EP_Immutable);
1322 }
drh3c194692016-04-11 16:43:43 +00001323
1324 /* Copy the p->u.zToken string, if any. */
1325 if( nToken ){
1326 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1327 memcpy(zToken, p->u.zToken, nToken);
1328 }
1329
drh209bc522016-09-23 21:36:24 +00001330 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001331 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1332 if( ExprHasProperty(p, EP_xIsSelect) ){
1333 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001334 }else{
drh3c194692016-04-11 16:43:43 +00001335 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001336 }
drh3c194692016-04-11 16:43:43 +00001337 }
1338
1339 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001340 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001341 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001342 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001343 pNew->pLeft = p->pLeft ?
1344 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1345 pNew->pRight = p->pRight ?
1346 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001347 }
dan67a9b8e2018-06-22 20:51:35 +00001348#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001349 if( ExprHasProperty(p, EP_WinFunc) ){
1350 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1351 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001352 }
dan67a9b8e2018-06-22 20:51:35 +00001353#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001354 if( pzBuffer ){
1355 *pzBuffer = zAlloc;
1356 }
1357 }else{
drh209bc522016-09-23 21:36:24 +00001358 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001359 if( pNew->op==TK_SELECT_COLUMN ){
1360 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001361 assert( p->iColumn==0 || p->pRight==0 );
1362 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001363 }else{
1364 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1365 }
drh3c194692016-04-11 16:43:43 +00001366 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001367 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001368 }
1369 }
1370 return pNew;
1371}
1372
1373/*
danbfe31e72014-01-15 14:17:31 +00001374** Create and return a deep copy of the object passed as the second
1375** argument. If an OOM condition is encountered, NULL is returned
1376** and the db->mallocFailed flag set.
1377*/
daneede6a52014-01-15 19:42:23 +00001378#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001379static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001380 With *pRet = 0;
1381 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001382 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001383 pRet = sqlite3DbMallocZero(db, nByte);
1384 if( pRet ){
1385 int i;
1386 pRet->nCte = p->nCte;
1387 for(i=0; i<p->nCte; i++){
1388 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1389 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1390 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1391 }
1392 }
1393 }
1394 return pRet;
1395}
daneede6a52014-01-15 19:42:23 +00001396#else
1397# define withDup(x,y) 0
1398#endif
dan4e9119d2014-01-13 15:12:23 +00001399
drha8389972018-12-06 22:04:19 +00001400#ifndef SQLITE_OMIT_WINDOWFUNC
1401/*
1402** The gatherSelectWindows() procedure and its helper routine
1403** gatherSelectWindowsCallback() are used to scan all the expressions
1404** an a newly duplicated SELECT statement and gather all of the Window
1405** objects found there, assembling them onto the linked list at Select->pWin.
1406*/
1407static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001408 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001409 Select *pSelect = pWalker->u.pSelect;
1410 Window *pWin = pExpr->y.pWin;
1411 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001412 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001413 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001414 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001415 }
1416 return WRC_Continue;
1417}
drha37b6a52018-12-06 22:12:18 +00001418static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1419 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1420}
drha8389972018-12-06 22:04:19 +00001421static void gatherSelectWindows(Select *p){
1422 Walker w;
1423 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001424 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1425 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001426 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001427 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001428 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001429}
1430#endif
1431
1432
drha76b5df2002-02-23 02:32:10 +00001433/*
drhff78bd22002-02-27 01:47:11 +00001434** The following group of routines make deep copies of expressions,
1435** expression lists, ID lists, and select statements. The copies can
1436** be deleted (by being passed to their respective ...Delete() routines)
1437** without effecting the originals.
1438**
danielk19774adee202004-05-08 08:23:19 +00001439** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1440** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001441** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001442**
drhad3cab52002-05-24 02:04:32 +00001443** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001444**
drhb7916a72009-05-27 10:31:29 +00001445** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001446** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1447** truncated version of the usual Expr structure that will be stored as
1448** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001449*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001450Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001451 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001452 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001453}
danielk19776ab3a2e2009-02-19 14:39:25 +00001454ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001455 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001456 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001457 int i;
drhb1637482017-01-03 00:27:16 +00001458 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001459 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001460 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001461 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001462 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001463 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001464 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001465 pOldItem = p->a;
1466 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001467 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001468 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001469 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001470 if( pOldExpr
1471 && pOldExpr->op==TK_SELECT_COLUMN
1472 && (pNewExpr = pItem->pExpr)!=0
1473 ){
1474 assert( pNewExpr->iColumn==0 || i>0 );
1475 if( pNewExpr->iColumn==0 ){
1476 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001477 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1478 }else{
1479 assert( i>0 );
1480 assert( pItem[-1].pExpr!=0 );
1481 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1482 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1483 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001484 }
1485 }
drh41cee662019-12-12 20:22:34 +00001486 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001487 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001488 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001489 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001490 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001491 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001492 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001493 }
1494 return pNew;
1495}
danielk197793758c82005-01-21 08:13:14 +00001496
1497/*
1498** If cursors, triggers, views and subqueries are all omitted from
1499** the build, then none of the following routines, except for
1500** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1501** called with a NULL argument.
1502*/
danielk19776a67fe82005-02-04 04:07:16 +00001503#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1504 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001505SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001506 SrcList *pNew;
1507 int i;
drh113088e2003-03-20 01:16:58 +00001508 int nByte;
drh575fad62016-02-05 13:38:36 +00001509 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001510 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001511 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001512 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001513 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001514 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001515 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001516 struct SrcList_item *pNewItem = &pNew->a[i];
1517 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001518 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001519 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001520 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1521 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1522 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001523 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001524 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001525 pNewItem->addrFillSub = pOldItem->addrFillSub;
1526 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001527 if( pNewItem->fg.isIndexedBy ){
1528 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1529 }
1530 pNewItem->pIBIndex = pOldItem->pIBIndex;
1531 if( pNewItem->fg.isTabFunc ){
1532 pNewItem->u1.pFuncArg =
1533 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1534 }
drhed8a3bb2005-06-06 21:19:56 +00001535 pTab = pNewItem->pTab = pOldItem->pTab;
1536 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001537 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001538 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001539 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1540 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001541 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001542 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001543 }
1544 return pNew;
1545}
drh17435752007-08-16 04:30:38 +00001546IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001547 IdList *pNew;
1548 int i;
drh575fad62016-02-05 13:38:36 +00001549 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001550 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001551 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001552 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001553 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001554 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001555 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001556 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001557 return 0;
1558 }
drh6c535152012-02-02 03:38:30 +00001559 /* Note that because the size of the allocation for p->a[] is not
1560 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1561 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001562 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001563 struct IdList_item *pNewItem = &pNew->a[i];
1564 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001565 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001566 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001567 }
1568 return pNew;
1569}
dana7466202017-02-03 14:44:52 +00001570Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1571 Select *pRet = 0;
1572 Select *pNext = 0;
1573 Select **pp = &pRet;
1574 Select *p;
1575
drh575fad62016-02-05 13:38:36 +00001576 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001577 for(p=pDup; p; p=p->pPrior){
1578 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1579 if( pNew==0 ) break;
1580 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1581 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1582 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1583 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1584 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1585 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1586 pNew->op = p->op;
1587 pNew->pNext = pNext;
1588 pNew->pPrior = 0;
1589 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001590 pNew->iLimit = 0;
1591 pNew->iOffset = 0;
1592 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1593 pNew->addrOpenEphm[0] = -1;
1594 pNew->addrOpenEphm[1] = -1;
1595 pNew->nSelectRow = p->nSelectRow;
1596 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001597#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001598 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001599 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001600 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001601#endif
drhfef37762018-07-10 19:48:35 +00001602 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001603 *pp = pNew;
1604 pp = &pNew->pPrior;
1605 pNext = pNew;
1606 }
1607
1608 return pRet;
drhff78bd22002-02-27 01:47:11 +00001609}
danielk197793758c82005-01-21 08:13:14 +00001610#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001611Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001612 assert( p==0 );
1613 return 0;
1614}
1615#endif
drhff78bd22002-02-27 01:47:11 +00001616
1617
1618/*
drha76b5df2002-02-23 02:32:10 +00001619** Add a new element to the end of an expression list. If pList is
1620** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001621**
drha19543f2017-09-15 15:17:48 +00001622** The pList argument must be either NULL or a pointer to an ExprList
1623** obtained from a prior call to sqlite3ExprListAppend(). This routine
1624** may not be used with an ExprList obtained from sqlite3ExprListDup().
1625** Reason: This routine assumes that the number of slots in pList->a[]
1626** is a power of two. That is true for sqlite3ExprListAppend() returns
1627** but is not necessarily true from the return value of sqlite3ExprListDup().
1628**
drhb7916a72009-05-27 10:31:29 +00001629** If a memory allocation error occurs, the entire list is freed and
1630** NULL is returned. If non-NULL is returned, then it is guaranteed
1631** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001632*/
drh17435752007-08-16 04:30:38 +00001633ExprList *sqlite3ExprListAppend(
1634 Parse *pParse, /* Parsing context */
1635 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001636 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001637){
drh43606172017-04-05 11:32:13 +00001638 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001639 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001640 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001641 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001642 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001643 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001644 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001645 }
drhc263f7c2016-01-18 13:18:54 +00001646 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001647 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001648 ExprList *pNew;
1649 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001650 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001651 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001652 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001653 }
drh43606172017-04-05 11:32:13 +00001654 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001655 }
drh43606172017-04-05 11:32:13 +00001656 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001657 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001658 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001659 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001660 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001661 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001662
1663no_mem:
1664 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001665 sqlite3ExprDelete(db, pExpr);
1666 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001667 return 0;
drha76b5df2002-02-23 02:32:10 +00001668}
1669
1670/*
drh8762ec12016-08-20 01:06:22 +00001671** pColumns and pExpr form a vector assignment which is part of the SET
1672** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001673**
1674** (a,b,c) = (expr1,expr2,expr3)
1675** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1676**
1677** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001678** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001679** TK_SELECT_COLUMN expressions.
1680*/
1681ExprList *sqlite3ExprListAppendVector(
1682 Parse *pParse, /* Parsing context */
1683 ExprList *pList, /* List to which to append. Might be NULL */
1684 IdList *pColumns, /* List of names of LHS of the assignment */
1685 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1686){
1687 sqlite3 *db = pParse->db;
1688 int n;
1689 int i;
drh66860af2016-08-23 18:30:10 +00001690 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001691 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1692 ** exit prior to this routine being invoked */
1693 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001694 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001695
1696 /* If the RHS is a vector, then we can immediately check to see that
1697 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1698 ** wildcards ("*") in the result set of the SELECT must be expanded before
1699 ** we can do the size check, so defer the size check until code generation.
1700 */
1701 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001702 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1703 pColumns->nId, n);
1704 goto vector_append_error;
1705 }
drh966e2912017-01-03 02:58:01 +00001706
1707 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001708 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001709 assert( pSubExpr!=0 || db->mallocFailed );
1710 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1711 if( pSubExpr==0 ) continue;
1712 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001713 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1714 if( pList ){
drh66860af2016-08-23 18:30:10 +00001715 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001716 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001717 pColumns->a[i].zName = 0;
1718 }
1719 }
drh966e2912017-01-03 02:58:01 +00001720
drhffe28052017-05-06 18:09:36 +00001721 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001722 Expr *pFirst = pList->a[iFirst].pExpr;
1723 assert( pFirst!=0 );
1724 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001725
drhf4dd26c2017-04-05 11:49:06 +00001726 /* Store the SELECT statement in pRight so it will be deleted when
1727 ** sqlite3ExprListDelete() is called */
1728 pFirst->pRight = pExpr;
1729 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001730
drhf4dd26c2017-04-05 11:49:06 +00001731 /* Remember the size of the LHS in iTable so that we can check that
1732 ** the RHS and LHS sizes match during code generation. */
1733 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001734 }
1735
1736vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001737 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001738 sqlite3IdListDelete(db, pColumns);
1739 return pList;
1740}
1741
1742/*
drhbc622bc2015-08-24 15:39:42 +00001743** Set the sort order for the last element on the given ExprList.
1744*/
dan6e118922019-08-12 16:36:38 +00001745void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001746 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001747 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001748 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001749
1750 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1751 assert( iSortOrder==SQLITE_SO_UNDEFINED
1752 || iSortOrder==SQLITE_SO_ASC
1753 || iSortOrder==SQLITE_SO_DESC
1754 );
1755 assert( eNulls==SQLITE_SO_UNDEFINED
1756 || eNulls==SQLITE_SO_ASC
1757 || eNulls==SQLITE_SO_DESC
1758 );
1759
dan9105fd52019-08-19 17:26:32 +00001760 pItem = &p->a[p->nExpr-1];
1761 assert( pItem->bNulls==0 );
1762 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1763 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001764 }
dan9105fd52019-08-19 17:26:32 +00001765 pItem->sortFlags = (u8)iSortOrder;
1766
1767 if( eNulls!=SQLITE_SO_UNDEFINED ){
1768 pItem->bNulls = 1;
1769 if( iSortOrder!=eNulls ){
1770 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1771 }
drhbc622bc2015-08-24 15:39:42 +00001772 }
drhbc622bc2015-08-24 15:39:42 +00001773}
1774
1775/*
drh41cee662019-12-12 20:22:34 +00001776** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001777** on the expression list.
1778**
1779** pList might be NULL following an OOM error. But pName should never be
1780** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1781** is set.
1782*/
1783void sqlite3ExprListSetName(
1784 Parse *pParse, /* Parsing context */
1785 ExprList *pList, /* List to which to add the span. */
1786 Token *pName, /* Name to be added */
1787 int dequote /* True to cause the name to be dequoted */
1788){
1789 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001790 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001791 if( pList ){
1792 struct ExprList_item *pItem;
1793 assert( pList->nExpr>0 );
1794 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001795 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001796 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001797 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001798 if( dequote ){
1799 /* If dequote==0, then pName->z does not point to part of a DDL
1800 ** statement handled by the parser. And so no token need be added
1801 ** to the token-map. */
1802 sqlite3Dequote(pItem->zEName);
1803 if( IN_RENAME_OBJECT ){
1804 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1805 }
dan5be60c52018-08-15 20:28:39 +00001806 }
drhb7916a72009-05-27 10:31:29 +00001807 }
1808}
1809
1810/*
1811** Set the ExprList.a[].zSpan element of the most recently added item
1812** on the expression list.
1813**
1814** pList might be NULL following an OOM error. But pSpan should never be
1815** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1816** is set.
1817*/
1818void sqlite3ExprListSetSpan(
1819 Parse *pParse, /* Parsing context */
1820 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001821 const char *zStart, /* Start of the span */
1822 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001823){
1824 sqlite3 *db = pParse->db;
1825 assert( pList!=0 || db->mallocFailed!=0 );
1826 if( pList ){
1827 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1828 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001829 if( pItem->zEName==0 ){
1830 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1831 pItem->eEName = ENAME_SPAN;
1832 }
drhb7916a72009-05-27 10:31:29 +00001833 }
1834}
1835
1836/*
danielk19777a15a4b2007-05-08 17:54:43 +00001837** If the expression list pEList contains more than iLimit elements,
1838** leave an error message in pParse.
1839*/
1840void sqlite3ExprListCheckLength(
1841 Parse *pParse,
1842 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001843 const char *zObject
1844){
drhb1a6c3c2008-03-20 16:30:17 +00001845 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001846 testcase( pEList && pEList->nExpr==mx );
1847 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001848 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001849 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1850 }
1851}
1852
1853/*
drha76b5df2002-02-23 02:32:10 +00001854** Delete an entire expression list.
1855*/
drhaffa8552016-04-11 18:25:05 +00001856static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001857 int i = pList->nExpr;
1858 struct ExprList_item *pItem = pList->a;
1859 assert( pList->nExpr>0 );
1860 do{
drh633e6d52008-07-28 19:34:53 +00001861 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001862 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001863 pItem++;
1864 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001865 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001866}
drhaffa8552016-04-11 18:25:05 +00001867void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1868 if( pList ) exprListDeleteNN(db, pList);
1869}
drha76b5df2002-02-23 02:32:10 +00001870
1871/*
drh2308ed32015-02-09 16:09:34 +00001872** Return the bitwise-OR of all Expr.flags fields in the given
1873** ExprList.
drh885a5b02015-02-09 15:21:36 +00001874*/
drh2308ed32015-02-09 16:09:34 +00001875u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001876 int i;
drh2308ed32015-02-09 16:09:34 +00001877 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001878 assert( pList!=0 );
1879 for(i=0; i<pList->nExpr; i++){
1880 Expr *pExpr = pList->a[i].pExpr;
1881 assert( pExpr!=0 );
1882 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001883 }
drh2308ed32015-02-09 16:09:34 +00001884 return m;
drh885a5b02015-02-09 15:21:36 +00001885}
1886
1887/*
drh7e6f9802017-09-04 00:33:04 +00001888** This is a SELECT-node callback for the expression walker that
1889** always "fails". By "fail" in this case, we mean set
1890** pWalker->eCode to zero and abort.
1891**
1892** This callback is used by multiple expression walkers.
1893*/
1894int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1895 UNUSED_PARAMETER(NotUsed);
1896 pWalker->eCode = 0;
1897 return WRC_Abort;
1898}
1899
1900/*
drh0cbec592020-01-03 02:20:37 +00001901** Check the input string to see if it is "true" or "false" (in any case).
1902**
1903** If the string is.... Return
1904** "true" EP_IsTrue
1905** "false" EP_IsFalse
1906** anything else 0
1907*/
1908u32 sqlite3IsTrueOrFalse(const char *zIn){
1909 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1910 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1911 return 0;
1912}
1913
1914
1915/*
drh171d16b2018-02-26 20:15:54 +00001916** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001917** then convert it into an TK_TRUEFALSE term. Return non-zero if
1918** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001919*/
1920int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001921 u32 v;
drh171d16b2018-02-26 20:15:54 +00001922 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001923 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001924 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001925 ){
1926 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001927 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001928 return 1;
1929 }
1930 return 0;
1931}
1932
drh43c4ac82018-02-26 21:26:27 +00001933/*
drh96acafb2018-02-27 14:49:25 +00001934** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001935** and 0 if it is FALSE.
1936*/
drh96acafb2018-02-27 14:49:25 +00001937int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001938 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001939 assert( pExpr->op==TK_TRUEFALSE );
1940 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1941 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1942 return pExpr->u.zToken[4]==0;
1943}
1944
drh17180fc2019-04-19 17:26:19 +00001945/*
1946** If pExpr is an AND or OR expression, try to simplify it by eliminating
1947** terms that are always true or false. Return the simplified expression.
1948** Or return the original expression if no simplification is possible.
1949**
1950** Examples:
1951**
1952** (x<10) AND true => (x<10)
1953** (x<10) AND false => false
1954** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1955** (x<10) AND (y=22 OR true) => (x<10)
1956** (y=22) OR true => true
1957*/
1958Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1959 assert( pExpr!=0 );
1960 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1961 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1962 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1963 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1964 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1965 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1966 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1967 }
1968 }
1969 return pExpr;
1970}
1971
drh171d16b2018-02-26 20:15:54 +00001972
1973/*
drh059b2d52014-10-24 19:28:09 +00001974** These routines are Walker callbacks used to check expressions to
1975** see if they are "constant" for some definition of constant. The
1976** Walker.eCode value determines the type of "constant" we are looking
1977** for.
drh73b211a2005-01-18 04:00:42 +00001978**
drh7d10d5a2008-08-20 16:35:10 +00001979** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001980**
drh059b2d52014-10-24 19:28:09 +00001981** sqlite3ExprIsConstant() pWalker->eCode==1
1982** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001983** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001984** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001985**
drh059b2d52014-10-24 19:28:09 +00001986** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1987** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001988**
drh014fff22020-01-08 22:22:36 +00001989** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1990** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
1991** when parsing an existing schema out of the sqlite_master table and 4
1992** when processing a new CREATE TABLE statement. A bound parameter raises
1993** an error for new statements, but is silently converted
drhfeada2d2014-09-24 13:20:22 +00001994** to NULL for existing schemas. This allows sqlite_master tables that
1995** contain a bound parameter because they were generated by older versions
1996** of SQLite to be parsed by newer versions of SQLite without raising a
1997** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001998*/
drh7d10d5a2008-08-20 16:35:10 +00001999static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002000
drh059b2d52014-10-24 19:28:09 +00002001 /* If pWalker->eCode is 2 then any term of the expression that comes from
2002 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002003 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002004 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2005 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002006 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002007 }
2008
drh626a8792005-01-17 22:08:19 +00002009 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002010 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002011 ** and either pWalker->eCode==4 or 5 or the function has the
2012 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002013 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002014 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2015 && !ExprHasProperty(pExpr, EP_WinFunc)
2016 ){
drh014fff22020-01-08 22:22:36 +00002017 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002018 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002019 }else{
2020 pWalker->eCode = 0;
2021 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002022 }
drh626a8792005-01-17 22:08:19 +00002023 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002024 /* Convert "true" or "false" in a DEFAULT clause into the
2025 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002026 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002027 return WRC_Prune;
2028 }
2029 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00002030 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002031 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002032 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002033 testcase( pExpr->op==TK_ID );
2034 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002035 testcase( pExpr->op==TK_AGG_FUNCTION );
2036 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002037 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002038 return WRC_Continue;
2039 }
drh059b2d52014-10-24 19:28:09 +00002040 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2041 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002042 }
drhf43ce0b2017-05-25 00:08:48 +00002043 /* Fall through */
2044 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002045 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00002046 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002047 testcase( pExpr->op==TK_IF_NULL_ROW );
2048 pWalker->eCode = 0;
2049 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002050 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002051 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002052 /* Silently convert bound parameters that appear inside of CREATE
2053 ** statements into a NULL when parsing the CREATE statement text out
2054 ** of the sqlite_master table */
2055 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002056 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002057 /* A bound parameter in a CREATE statement that originates from
2058 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002059 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002060 return WRC_Abort;
2061 }
2062 /* Fall through */
drh626a8792005-01-17 22:08:19 +00002063 default:
drh6e341b92018-04-17 18:50:40 +00002064 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2065 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002066 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002067 }
2068}
drh059b2d52014-10-24 19:28:09 +00002069static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002070 Walker w;
drh059b2d52014-10-24 19:28:09 +00002071 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002072 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002073 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002074#ifdef SQLITE_DEBUG
2075 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2076#endif
drh059b2d52014-10-24 19:28:09 +00002077 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002078 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002079 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002080}
drh626a8792005-01-17 22:08:19 +00002081
2082/*
drh059b2d52014-10-24 19:28:09 +00002083** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002084** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002085**
2086** For the purposes of this function, a double-quoted string (ex: "abc")
2087** is considered a variable but a single-quoted string (ex: 'abc') is
2088** a constant.
drhfef52082000-06-06 01:50:43 +00002089*/
danielk19774adee202004-05-08 08:23:19 +00002090int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002091 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002092}
2093
2094/*
drh07aded62018-07-28 16:24:08 +00002095** Walk an expression tree. Return non-zero if
2096**
2097** (1) the expression is constant, and
2098** (2) the expression does originate in the ON or USING clause
2099** of a LEFT JOIN, and
2100** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2101** operands created by the constant propagation optimization.
2102**
2103** When this routine returns true, it indicates that the expression
2104** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002105** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002106*/
2107int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002108 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002109}
2110
2111/*
drhfcb9f4f2015-06-01 18:13:16 +00002112** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002113** for any single row of the table with cursor iCur. In other words, the
2114** expression must not refer to any non-deterministic function nor any
2115** table other than iCur.
2116*/
2117int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2118 return exprIsConst(p, 3, iCur);
2119}
2120
danab31a842017-04-29 20:53:09 +00002121
2122/*
2123** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2124*/
2125static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2126 ExprList *pGroupBy = pWalker->u.pGroupBy;
2127 int i;
2128
2129 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2130 ** it constant. */
2131 for(i=0; i<pGroupBy->nExpr; i++){
2132 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002133 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002134 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002135 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002136 return WRC_Prune;
2137 }
2138 }
2139 }
2140
2141 /* Check if pExpr is a sub-select. If so, consider it variable. */
2142 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2143 pWalker->eCode = 0;
2144 return WRC_Abort;
2145 }
2146
2147 return exprNodeIsConstant(pWalker, pExpr);
2148}
2149
2150/*
2151** Walk the expression tree passed as the first argument. Return non-zero
2152** if the expression consists entirely of constants or copies of terms
2153** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002154**
2155** This routine is used to determine if a term of the HAVING clause can
2156** be promoted into the WHERE clause. In order for such a promotion to work,
2157** the value of the HAVING clause term must be the same for all members of
2158** a "group". The requirement that the GROUP BY term must be BINARY
2159** assumes that no other collating sequence will have a finer-grained
2160** grouping than binary. In other words (A=B COLLATE binary) implies
2161** A=B in every other collating sequence. The requirement that the
2162** GROUP BY be BINARY is stricter than necessary. It would also work
2163** to promote HAVING clauses that use the same alternative collating
2164** sequence as the GROUP BY term, but that is much harder to check,
2165** alternative collating sequences are uncommon, and this is only an
2166** optimization, so we take the easy way out and simply require the
2167** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002168*/
2169int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2170 Walker w;
danab31a842017-04-29 20:53:09 +00002171 w.eCode = 1;
2172 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002173 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002174 w.u.pGroupBy = pGroupBy;
2175 w.pParse = pParse;
2176 sqlite3WalkExpr(&w, p);
2177 return w.eCode;
2178}
2179
drh059b2d52014-10-24 19:28:09 +00002180/*
drh014fff22020-01-08 22:22:36 +00002181** Walk an expression tree for the DEFAULT field of a column definition
2182** in a CREATE TABLE statement. Return non-zero if the expression is
2183** acceptable for use as a DEFAULT. That is to say, return non-zero if
2184** the expression is constant or a function call with constant arguments.
2185** Return and 0 if there are any variables.
2186**
2187** isInit is true when parsing from sqlite_master. isInit is false when
2188** processing a new CREATE TABLE statement. When isInit is true, parameters
2189** (such as ? or $abc) in the expression are converted into NULL. When
2190** isInit is false, parameters raise an error. Parameters should not be
2191** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
2192** allowed it, so we need to support it when reading sqlite_master for
2193** backwards compatibility.
2194**
2195** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002196**
2197** For the purposes of this function, a double-quoted string (ex: "abc")
2198** is considered a variable but a single-quoted string (ex: 'abc') is
2199** a constant.
2200*/
drhfeada2d2014-09-24 13:20:22 +00002201int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2202 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002203 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002204}
2205
drh5b88bc42013-12-07 23:35:21 +00002206#ifdef SQLITE_ENABLE_CURSOR_HINTS
2207/*
2208** Walk an expression tree. Return 1 if the expression contains a
2209** subquery of some kind. Return 0 if there are no subqueries.
2210*/
2211int sqlite3ExprContainsSubquery(Expr *p){
2212 Walker w;
drhbec24762015-08-13 20:07:13 +00002213 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002214 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002215 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002216#ifdef SQLITE_DEBUG
2217 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2218#endif
drh5b88bc42013-12-07 23:35:21 +00002219 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002220 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002221}
2222#endif
2223
drheb55bd22005-06-30 17:04:21 +00002224/*
drh73b211a2005-01-18 04:00:42 +00002225** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002226** to fit in a 32-bit integer, return 1 and put the value of the integer
2227** in *pValue. If the expression is not an integer or if it is too big
2228** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002229*/
danielk19774adee202004-05-08 08:23:19 +00002230int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002231 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002232 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002233
2234 /* If an expression is an integer literal that fits in a signed 32-bit
2235 ** integer, then the EP_IntValue flag will have already been set */
2236 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2237 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2238
drh92b01d52008-06-24 00:32:35 +00002239 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002240 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002241 return 1;
2242 }
drhe4de1fe2002-06-02 16:09:01 +00002243 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002244 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002245 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002246 break;
drh4b59ab52002-08-24 18:24:51 +00002247 }
drhe4de1fe2002-06-02 16:09:01 +00002248 case TK_UMINUS: {
2249 int v;
danielk19774adee202004-05-08 08:23:19 +00002250 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002251 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002252 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002253 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002254 }
2255 break;
2256 }
2257 default: break;
2258 }
drh92b01d52008-06-24 00:32:35 +00002259 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002260}
2261
2262/*
drh039fc322009-11-17 18:31:47 +00002263** Return FALSE if there is no chance that the expression can be NULL.
2264**
2265** If the expression might be NULL or if the expression is too complex
2266** to tell return TRUE.
2267**
2268** This routine is used as an optimization, to skip OP_IsNull opcodes
2269** when we know that a value cannot be NULL. Hence, a false positive
2270** (returning TRUE when in fact the expression can never be NULL) might
2271** be a small performance hit but is otherwise harmless. On the other
2272** hand, a false negative (returning FALSE when the result could be NULL)
2273** will likely result in an incorrect answer. So when in doubt, return
2274** TRUE.
2275*/
2276int sqlite3ExprCanBeNull(const Expr *p){
2277 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002278 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2279 p = p->pLeft;
2280 }
drh039fc322009-11-17 18:31:47 +00002281 op = p->op;
2282 if( op==TK_REGISTER ) op = p->op2;
2283 switch( op ){
2284 case TK_INTEGER:
2285 case TK_STRING:
2286 case TK_FLOAT:
2287 case TK_BLOB:
2288 return 0;
drh7248a8b2014-08-04 18:50:54 +00002289 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002290 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002291 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002292 (p->iColumn>=0
2293 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2294 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002295 default:
2296 return 1;
2297 }
2298}
2299
2300/*
2301** Return TRUE if the given expression is a constant which would be
2302** unchanged by OP_Affinity with the affinity given in the second
2303** argument.
2304**
2305** This routine is used to determine if the OP_Affinity operation
2306** can be omitted. When in doubt return FALSE. A false negative
2307** is harmless. A false positive, however, can result in the wrong
2308** answer.
2309*/
2310int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2311 u8 op;
drhaf866402019-08-22 11:11:28 +00002312 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002313 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002314 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2315 if( p->op==TK_UMINUS ) unaryMinus = 1;
2316 p = p->pLeft;
2317 }
drh039fc322009-11-17 18:31:47 +00002318 op = p->op;
2319 if( op==TK_REGISTER ) op = p->op2;
2320 switch( op ){
2321 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002322 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002323 }
2324 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002325 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002326 }
2327 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002328 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002329 }
2330 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002331 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002332 }
drh2f2855b2009-11-18 01:25:26 +00002333 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002334 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002335 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002336 }
drh039fc322009-11-17 18:31:47 +00002337 default: {
2338 return 0;
2339 }
2340 }
2341}
2342
2343/*
drhc4a3c772001-04-04 11:48:57 +00002344** Return TRUE if the given string is a row-id column name.
2345*/
danielk19774adee202004-05-08 08:23:19 +00002346int sqlite3IsRowid(const char *z){
2347 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2348 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2349 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002350 return 0;
2351}
2352
danielk19779a96b662007-11-29 17:05:18 +00002353/*
drh69c355b2016-03-09 15:34:51 +00002354** pX is the RHS of an IN operator. If pX is a SELECT statement
2355** that can be simplified to a direct table access, then return
2356** a pointer to the SELECT statement. If pX is not a SELECT statement,
2357** or if the SELECT statement needs to be manifested into a transient
2358** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002359*/
2360#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002361static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002362 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002363 SrcList *pSrc;
2364 ExprList *pEList;
2365 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002366 int i;
drh69c355b2016-03-09 15:34:51 +00002367 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2368 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2369 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002370 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002371 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002372 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2373 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2374 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002375 }
drh2e26a602020-01-06 18:59:46 +00002376 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002377 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002378 if( p->pWhere ) return 0; /* Has no WHERE clause */
2379 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002380 assert( pSrc!=0 );
2381 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002382 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002383 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002384 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002385 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002386 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2387 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002388 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002389 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002390 for(i=0; i<pEList->nExpr; i++){
2391 Expr *pRes = pEList->a[i].pExpr;
2392 if( pRes->op!=TK_COLUMN ) return 0;
2393 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002394 }
drh69c355b2016-03-09 15:34:51 +00002395 return p;
drhb287f4b2008-04-25 00:08:38 +00002396}
2397#endif /* SQLITE_OMIT_SUBQUERY */
2398
danf9b2e052016-08-02 17:45:00 +00002399#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002400/*
drh4c259e92014-08-01 21:12:35 +00002401** Generate code that checks the left-most column of index table iCur to see if
2402** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002403** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2404** to be set to NULL if iCur contains one or more NULL values.
2405*/
2406static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002407 int addr1;
drh6be515e2014-08-01 21:00:53 +00002408 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002409 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002410 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2411 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002412 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002413 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002414}
danf9b2e052016-08-02 17:45:00 +00002415#endif
drh6be515e2014-08-01 21:00:53 +00002416
drhbb53ecb2014-08-02 21:03:33 +00002417
2418#ifndef SQLITE_OMIT_SUBQUERY
2419/*
2420** The argument is an IN operator with a list (not a subquery) on the
2421** right-hand side. Return TRUE if that list is constant.
2422*/
2423static int sqlite3InRhsIsConstant(Expr *pIn){
2424 Expr *pLHS;
2425 int res;
2426 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2427 pLHS = pIn->pLeft;
2428 pIn->pLeft = 0;
2429 res = sqlite3ExprIsConstant(pIn);
2430 pIn->pLeft = pLHS;
2431 return res;
2432}
2433#endif
2434
drh6be515e2014-08-01 21:00:53 +00002435/*
danielk19779a96b662007-11-29 17:05:18 +00002436** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002437** The pX parameter is the expression on the RHS of the IN operator, which
2438** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002439**
drhd4305ca2012-09-18 17:08:33 +00002440** The job of this routine is to find or create a b-tree object that can
2441** be used either to test for membership in the RHS set or to iterate through
2442** all members of the RHS set, skipping duplicates.
2443**
drh3a856252014-08-01 14:46:57 +00002444** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002445** and pX->iTable is set to the index of that cursor.
2446**
drhb74b1012009-05-28 21:04:37 +00002447** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002448**
drh1ccce442013-03-12 20:38:51 +00002449** IN_INDEX_ROWID - The cursor was opened on a database table.
2450** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2451** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2452** IN_INDEX_EPH - The cursor was opened on a specially created and
2453** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002454** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2455** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002456**
drhd4305ca2012-09-18 17:08:33 +00002457** An existing b-tree might be used if the RHS expression pX is a simple
2458** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002459**
dan553168c2016-08-01 20:14:31 +00002460** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002461**
drhd4305ca2012-09-18 17:08:33 +00002462** If the RHS of the IN operator is a list or a more complex subquery, then
2463** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002464** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002465** existing table.
drhd4305ca2012-09-18 17:08:33 +00002466**
drh7fc0ba02017-11-17 15:02:00 +00002467** The inFlags parameter must contain, at a minimum, one of the bits
2468** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2469** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2470** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2471** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002472**
2473** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2474** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002475** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002476** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2477** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002478**
drh3a856252014-08-01 14:46:57 +00002479** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2480** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002481** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2482** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002483**
drhbb53ecb2014-08-02 21:03:33 +00002484** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2485** if the RHS of the IN operator is a list (not a subquery) then this
2486** routine might decide that creating an ephemeral b-tree for membership
2487** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2488** calling routine should implement the IN operator using a sequence
2489** of Eq or Ne comparison operations.
2490**
drhb74b1012009-05-28 21:04:37 +00002491** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002492** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002493** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002494** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002495** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002496** to *prRhsHasNull. If there is no chance that the (...) contains a
2497** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002498**
drhe21a6e12014-08-01 18:00:24 +00002499** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002500** the value in that register will be NULL if the b-tree contains one or more
2501** NULL values, and it will be some non-NULL value if the b-tree contains no
2502** NULL values.
dan553168c2016-08-01 20:14:31 +00002503**
2504** If the aiMap parameter is not NULL, it must point to an array containing
2505** one element for each column returned by the SELECT statement on the RHS
2506** of the IN(...) operator. The i'th entry of the array is populated with the
2507** offset of the index column that matches the i'th column returned by the
2508** SELECT. For example, if the expression and selected index are:
2509**
2510** (?,?,?) IN (SELECT a, b, c FROM t1)
2511** CREATE INDEX i1 ON t1(b, c, a);
2512**
2513** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002514*/
danielk1977284f4ac2007-12-10 05:03:46 +00002515#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002516int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002517 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002518 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002519 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2520 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002521 int *aiMap, /* Mapping from Index fields to RHS fields */
2522 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002523){
drhb74b1012009-05-28 21:04:37 +00002524 Select *p; /* SELECT to the right of IN operator */
2525 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2526 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002527 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002528 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002529
drh1450bc62009-10-30 13:25:56 +00002530 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002531 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002532
dan7b35a772016-07-28 19:47:15 +00002533 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2534 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002535 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002536 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002537 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002538 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2539 int i;
2540 ExprList *pEList = pX->x.pSelect->pEList;
2541 for(i=0; i<pEList->nExpr; i++){
2542 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2543 }
2544 if( i==pEList->nExpr ){
2545 prRhsHasNull = 0;
2546 }
2547 }
2548
drhb74b1012009-05-28 21:04:37 +00002549 /* Check to see if an existing table or index can be used to
2550 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002551 ** ephemeral table. */
2552 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002553 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002554 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002555 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002556 ExprList *pEList = p->pEList;
2557 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002558
drhb07028f2011-10-14 21:49:18 +00002559 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2560 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2561 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2562 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002563
drhb22f7c82014-02-06 23:56:27 +00002564 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002565 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2566 sqlite3CodeVerifySchema(pParse, iDb);
2567 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002568
drha84a2832016-08-26 21:15:35 +00002569 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002570 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002571 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002572 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002573 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002574
2575 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2576 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002577 ExplainQueryPlan((pParse, 0,
2578 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002579 sqlite3VdbeJumpHere(v, iAddr);
2580 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002581 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002582 int affinity_ok = 1;
2583 int i;
2584
2585 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002586 ** comparison is the same as the affinity of each column in table
2587 ** on the RHS of the IN operator. If it not, it is not possible to
2588 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002589 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002590 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002591 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002592 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002593 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002594 testcase( cmpaff==SQLITE_AFF_BLOB );
2595 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002596 switch( cmpaff ){
2597 case SQLITE_AFF_BLOB:
2598 break;
2599 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002600 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2601 ** other has no affinity and the other side is TEXT. Hence,
2602 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2603 ** and for the term on the LHS of the IN to have no affinity. */
2604 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002605 break;
2606 default:
2607 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2608 }
2609 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002610
drha84a2832016-08-26 21:15:35 +00002611 if( affinity_ok ){
2612 /* Search for an existing index that will work for this IN operator */
2613 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2614 Bitmask colUsed; /* Columns of the index used */
2615 Bitmask mCol; /* Mask for the current column */
2616 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002617 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002618 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2619 ** BITMASK(nExpr) without overflowing */
2620 testcase( pIdx->nColumn==BMS-2 );
2621 testcase( pIdx->nColumn==BMS-1 );
2622 if( pIdx->nColumn>=BMS-1 ) continue;
2623 if( mustBeUnique ){
2624 if( pIdx->nKeyCol>nExpr
2625 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2626 ){
2627 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002628 }
danielk19770cdc0222008-06-26 18:04:03 +00002629 }
drha84a2832016-08-26 21:15:35 +00002630
2631 colUsed = 0; /* Columns of index used so far */
2632 for(i=0; i<nExpr; i++){
2633 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2634 Expr *pRhs = pEList->a[i].pExpr;
2635 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2636 int j;
2637
2638 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2639 for(j=0; j<nExpr; j++){
2640 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2641 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002642 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2643 continue;
2644 }
drha84a2832016-08-26 21:15:35 +00002645 break;
2646 }
2647 if( j==nExpr ) break;
2648 mCol = MASKBIT(j);
2649 if( mCol & colUsed ) break; /* Each column used only once */
2650 colUsed |= mCol;
2651 if( aiMap ) aiMap[i] = j;
2652 }
2653
2654 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2655 if( colUsed==(MASKBIT(nExpr)-1) ){
2656 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002657 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002658 ExplainQueryPlan((pParse, 0,
2659 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002660 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2661 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2662 VdbeComment((v, "%s", pIdx->zName));
2663 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2664 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2665
2666 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002667#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002668 i64 mask = (1<<nExpr)-1;
2669 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2670 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002671#endif
2672 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002673 if( nExpr==1 ){
2674 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2675 }
2676 }
2677 sqlite3VdbeJumpHere(v, iAddr);
2678 }
2679 } /* End loop over indexes */
2680 } /* End if( affinity_ok ) */
2681 } /* End if not an rowid index */
2682 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002683
drhbb53ecb2014-08-02 21:03:33 +00002684 /* If no preexisting index is available for the IN clause
2685 ** and IN_INDEX_NOOP is an allowed reply
2686 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002687 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002688 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002689 ** the IN operator so return IN_INDEX_NOOP.
2690 */
2691 if( eType==0
2692 && (inFlags & IN_INDEX_NOOP_OK)
2693 && !ExprHasProperty(pX, EP_xIsSelect)
2694 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2695 ){
2696 eType = IN_INDEX_NOOP;
2697 }
drhbb53ecb2014-08-02 21:03:33 +00002698
danielk19779a96b662007-11-29 17:05:18 +00002699 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002700 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002701 ** We will have to generate an ephemeral table to do the job.
2702 */
drh8e23daf2013-06-11 13:30:04 +00002703 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002704 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002705 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002706 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002707 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002708 }else if( prRhsHasNull ){
2709 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002710 }
drh85bcdce2018-12-23 21:27:29 +00002711 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002712 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002713 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002714 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002715 }
drhcf4d38a2010-07-28 02:53:36 +00002716 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002717 }
danba00e302016-07-23 20:24:06 +00002718
2719 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2720 int i, n;
2721 n = sqlite3ExprVectorSize(pX->pLeft);
2722 for(i=0; i<n; i++) aiMap[i] = i;
2723 }
drh2c041312018-12-24 02:34:49 +00002724 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002725 return eType;
2726}
danielk1977284f4ac2007-12-10 05:03:46 +00002727#endif
drh626a8792005-01-17 22:08:19 +00002728
danf9b2e052016-08-02 17:45:00 +00002729#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002730/*
2731** Argument pExpr is an (?, ?...) IN(...) expression. This
2732** function allocates and returns a nul-terminated string containing
2733** the affinities to be used for each column of the comparison.
2734**
2735** It is the responsibility of the caller to ensure that the returned
2736** string is eventually freed using sqlite3DbFree().
2737*/
dan71c57db2016-07-09 20:23:55 +00002738static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2739 Expr *pLeft = pExpr->pLeft;
2740 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002741 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002742 char *zRet;
2743
dan553168c2016-08-01 20:14:31 +00002744 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002745 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002746 if( zRet ){
2747 int i;
2748 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002749 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002750 char a = sqlite3ExprAffinity(pA);
2751 if( pSelect ){
2752 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2753 }else{
2754 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002755 }
dan71c57db2016-07-09 20:23:55 +00002756 }
2757 zRet[nVal] = '\0';
2758 }
2759 return zRet;
2760}
danf9b2e052016-08-02 17:45:00 +00002761#endif
dan71c57db2016-07-09 20:23:55 +00002762
dan8da209b2016-07-26 18:06:08 +00002763#ifndef SQLITE_OMIT_SUBQUERY
2764/*
2765** Load the Parse object passed as the first argument with an error
2766** message of the form:
2767**
2768** "sub-select returns N columns - expected M"
2769*/
2770void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002771 if( pParse->nErr==0 ){
2772 const char *zFmt = "sub-select returns %d columns - expected %d";
2773 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2774 }
dan8da209b2016-07-26 18:06:08 +00002775}
2776#endif
2777
drh626a8792005-01-17 22:08:19 +00002778/*
dan44c56042016-12-07 15:38:37 +00002779** Expression pExpr is a vector that has been used in a context where
2780** it is not permitted. If pExpr is a sub-select vector, this routine
2781** loads the Parse object with a message of the form:
2782**
2783** "sub-select returns N columns - expected 1"
2784**
2785** Or, if it is a regular scalar vector:
2786**
2787** "row value misused"
2788*/
2789void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2790#ifndef SQLITE_OMIT_SUBQUERY
2791 if( pExpr->flags & EP_xIsSelect ){
2792 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2793 }else
2794#endif
2795 {
2796 sqlite3ErrorMsg(pParse, "row value misused");
2797 }
2798}
2799
drh85bcdce2018-12-23 21:27:29 +00002800#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002801/*
drh85bcdce2018-12-23 21:27:29 +00002802** Generate code that will construct an ephemeral table containing all terms
2803** in the RHS of an IN operator. The IN operator can be in either of two
2804** forms:
drh626a8792005-01-17 22:08:19 +00002805**
drh9cbe6352005-11-29 03:13:21 +00002806** x IN (4,5,11) -- IN operator with list on right-hand side
2807** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002808**
drh2c041312018-12-24 02:34:49 +00002809** The pExpr parameter is the IN operator. The cursor number for the
2810** constructed ephermeral table is returned. The first time the ephemeral
2811** table is computed, the cursor number is also stored in pExpr->iTable,
2812** however the cursor number returned might not be the same, as it might
2813** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002814**
drh85bcdce2018-12-23 21:27:29 +00002815** If the LHS expression ("x" in the examples) is a column value, or
2816** the SELECT statement returns a column value, then the affinity of that
2817** column is used to build the index keys. If both 'x' and the
2818** SELECT... statement are columns, then numeric affinity is used
2819** if either column has NUMERIC or INTEGER affinity. If neither
2820** 'x' nor the SELECT... statement are columns, then numeric affinity
2821** is used.
drhcce7d172000-05-31 15:34:51 +00002822*/
drh85bcdce2018-12-23 21:27:29 +00002823void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002824 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002825 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002826 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002827){
drh2c041312018-12-24 02:34:49 +00002828 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002829 int addr; /* Address of OP_OpenEphemeral instruction */
2830 Expr *pLeft; /* the LHS of the IN operator */
2831 KeyInfo *pKeyInfo = 0; /* Key information */
2832 int nVal; /* Size of vector pLeft */
2833 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002834
drh2c041312018-12-24 02:34:49 +00002835 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002836 assert( v!=0 );
2837
drh2c041312018-12-24 02:34:49 +00002838 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002839 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002840 **
2841 ** * The right-hand side is a correlated subquery
2842 ** * The right-hand side is an expression list containing variables
2843 ** * We are inside a trigger
2844 **
drh2c041312018-12-24 02:34:49 +00002845 ** If all of the above are false, then we can compute the RHS just once
2846 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002847 */
drhefb699f2018-12-24 11:55:44 +00002848 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002849 /* Reuse of the RHS is allowed */
2850 /* If this routine has already been coded, but the previous code
2851 ** might not have been invoked yet, so invoke it now as a subroutine.
2852 */
2853 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002854 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002855 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2856 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2857 pExpr->x.pSelect->selId));
2858 }
drh2c041312018-12-24 02:34:49 +00002859 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2860 pExpr->y.sub.iAddr);
2861 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002862 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002863 return;
2864 }
2865
2866 /* Begin coding the subroutine */
2867 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002868 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002869 pExpr->y.sub.regReturn = ++pParse->nMem;
2870 pExpr->y.sub.iAddr =
2871 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2872 VdbeComment((v, "return address"));
2873
2874 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002875 }
2876
drh85bcdce2018-12-23 21:27:29 +00002877 /* Check to see if this is a vector IN operator */
2878 pLeft = pExpr->pLeft;
2879 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002880
drh85bcdce2018-12-23 21:27:29 +00002881 /* Construct the ephemeral table that will contain the content of
2882 ** RHS of the IN operator.
2883 */
drh2c041312018-12-24 02:34:49 +00002884 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002885 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002886#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2887 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2888 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2889 }else{
2890 VdbeComment((v, "RHS of IN operator"));
2891 }
2892#endif
drh50ef6712019-02-22 23:29:56 +00002893 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002894
drh85bcdce2018-12-23 21:27:29 +00002895 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2896 /* Case 1: expr IN (SELECT ...)
2897 **
2898 ** Generate code to write the results of the select into the temporary
2899 ** table allocated and opened above.
2900 */
2901 Select *pSelect = pExpr->x.pSelect;
2902 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002903
drh2c041312018-12-24 02:34:49 +00002904 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2905 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002906 ));
drh85bcdce2018-12-23 21:27:29 +00002907 /* If the LHS and RHS of the IN operator do not match, that
2908 ** error will have been caught long before we reach this point. */
2909 if( ALWAYS(pEList->nExpr==nVal) ){
2910 SelectDest dest;
2911 int i;
drhbd462bc2018-12-24 20:21:06 +00002912 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002913 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2914 pSelect->iLimit = 0;
2915 testcase( pSelect->selFlags & SF_Distinct );
2916 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2917 if( sqlite3Select(pParse, pSelect, &dest) ){
2918 sqlite3DbFree(pParse->db, dest.zAffSdst);
2919 sqlite3KeyInfoUnref(pKeyInfo);
2920 return;
drhfef52082000-06-06 01:50:43 +00002921 }
drh85bcdce2018-12-23 21:27:29 +00002922 sqlite3DbFree(pParse->db, dest.zAffSdst);
2923 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2924 assert( pEList!=0 );
2925 assert( pEList->nExpr>0 );
2926 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2927 for(i=0; i<nVal; i++){
2928 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2929 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2930 pParse, p, pEList->a[i].pExpr
2931 );
danielk197741a05b72008-10-02 13:50:55 +00002932 }
drh85bcdce2018-12-23 21:27:29 +00002933 }
2934 }else if( ALWAYS(pExpr->x.pList!=0) ){
2935 /* Case 2: expr IN (exprlist)
2936 **
2937 ** For each expression, build an index key from the evaluation and
2938 ** store it in the temporary table. If <expr> is a column, then use
2939 ** that columns affinity when building index keys. If <expr> is not
2940 ** a column, use numeric affinity.
2941 */
2942 char affinity; /* Affinity of the LHS of the IN */
2943 int i;
2944 ExprList *pList = pExpr->x.pList;
2945 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002946 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002947 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002948 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002949 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00002950 }else if( affinity==SQLITE_AFF_REAL ){
2951 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00002952 }
2953 if( pKeyInfo ){
2954 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2955 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002956 }
2957
drh85bcdce2018-12-23 21:27:29 +00002958 /* Loop through each expression in <exprlist>. */
2959 r1 = sqlite3GetTempReg(pParse);
2960 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002961 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2962 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002963
2964 /* If the expression is not constant then we will need to
2965 ** disable the test that was generated above that makes sure
2966 ** this code only executes once. Because for a non-constant
2967 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002968 */
drh2c041312018-12-24 02:34:49 +00002969 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2970 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002971 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002972 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002973 }
drh1398ad32005-01-19 23:24:50 +00002974
drh85bcdce2018-12-23 21:27:29 +00002975 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002976 sqlite3ExprCode(pParse, pE2, r1);
2977 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2978 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002979 }
drh85bcdce2018-12-23 21:27:29 +00002980 sqlite3ReleaseTempReg(pParse, r1);
2981 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002982 }
drh85bcdce2018-12-23 21:27:29 +00002983 if( pKeyInfo ){
2984 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2985 }
drh2c041312018-12-24 02:34:49 +00002986 if( addrOnce ){
2987 sqlite3VdbeJumpHere(v, addrOnce);
2988 /* Subroutine return */
2989 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2990 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002991 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002992 }
2993}
2994#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002995
drh85bcdce2018-12-23 21:27:29 +00002996/*
2997** Generate code for scalar subqueries used as a subquery expression
2998** or EXISTS operator:
2999**
3000** (SELECT a FROM b) -- subquery
3001** EXISTS (SELECT a FROM b) -- EXISTS subquery
3002**
3003** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3004**
drhd86fe442019-08-26 13:45:49 +00003005** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003006** the result is stored in a contiguous array of registers and the
3007** return value is the register of the left-most result column.
3008** Return 0 if an error occurs.
3009*/
3010#ifndef SQLITE_OMIT_SUBQUERY
3011int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003012 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003013 int rReg = 0; /* Register storing resulting */
3014 Select *pSel; /* SELECT statement to encode */
3015 SelectDest dest; /* How to deal with SELECT result */
3016 int nReg; /* Registers to allocate */
3017 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003018
3019 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003020 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003021 testcase( pExpr->op==TK_EXISTS );
3022 testcase( pExpr->op==TK_SELECT );
3023 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3024 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3025 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003026
drh5198ff52018-12-24 12:09:47 +00003027 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003028 ** is encountered if any of the following is true:
3029 **
3030 ** * The right-hand side is a correlated subquery
3031 ** * The right-hand side is an expression list containing variables
3032 ** * We are inside a trigger
3033 **
3034 ** If all of the above are false, then we can run this code just once
3035 ** save the results, and reuse the same result on subsequent invocations.
3036 */
3037 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003038 /* If this routine has already been coded, then invoke it as a
3039 ** subroutine. */
3040 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003041 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003042 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3043 pExpr->y.sub.iAddr);
3044 return pExpr->iTable;
3045 }
3046
3047 /* Begin coding the subroutine */
3048 ExprSetProperty(pExpr, EP_Subrtn);
3049 pExpr->y.sub.regReturn = ++pParse->nMem;
3050 pExpr->y.sub.iAddr =
3051 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3052 VdbeComment((v, "return address"));
3053
drh2c041312018-12-24 02:34:49 +00003054 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003055 }
drh85bcdce2018-12-23 21:27:29 +00003056
3057 /* For a SELECT, generate code to put the values for all columns of
3058 ** the first row into an array of registers and return the index of
3059 ** the first register.
3060 **
3061 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3062 ** into a register and return that register number.
3063 **
3064 ** In both cases, the query is augmented with "LIMIT 1". Any
3065 ** preexisting limit is discarded in place of the new LIMIT 1.
3066 */
drhbd462bc2018-12-24 20:21:06 +00003067 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3068 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003069 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3070 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3071 pParse->nMem += nReg;
3072 if( pExpr->op==TK_SELECT ){
3073 dest.eDest = SRT_Mem;
3074 dest.iSdst = dest.iSDParm;
3075 dest.nSdst = nReg;
3076 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3077 VdbeComment((v, "Init subquery result"));
3078 }else{
3079 dest.eDest = SRT_Exists;
3080 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3081 VdbeComment((v, "Init EXISTS result"));
3082 }
drh85bcdce2018-12-23 21:27:29 +00003083 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003084 /* The subquery already has a limit. If the pre-existing limit is X
3085 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3086 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003087 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003088 if( pLimit ){
3089 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3090 pLimit = sqlite3PExpr(pParse, TK_NE,
3091 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3092 }
3093 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003094 pSel->pLimit->pLeft = pLimit;
3095 }else{
drh7ca13472019-09-23 11:55:22 +00003096 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003097 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003098 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3099 }
3100 pSel->iLimit = 0;
3101 if( sqlite3Select(pParse, pSel, &dest) ){
3102 return 0;
3103 }
drh2c041312018-12-24 02:34:49 +00003104 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003105 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003106 if( addrOnce ){
3107 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003108
drh5198ff52018-12-24 12:09:47 +00003109 /* Subroutine return */
3110 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3111 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003112 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003113 }
drh2c041312018-12-24 02:34:49 +00003114
drh1450bc62009-10-30 13:25:56 +00003115 return rReg;
drhcce7d172000-05-31 15:34:51 +00003116}
drh51522cd2005-01-20 13:36:19 +00003117#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003118
drhe3365e62009-11-12 17:52:24 +00003119#ifndef SQLITE_OMIT_SUBQUERY
3120/*
dan7b35a772016-07-28 19:47:15 +00003121** Expr pIn is an IN(...) expression. This function checks that the
3122** sub-select on the RHS of the IN() operator has the same number of
3123** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3124** a sub-query, that the LHS is a vector of size 1.
3125*/
3126int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3127 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3128 if( (pIn->flags & EP_xIsSelect) ){
3129 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3130 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3131 return 1;
3132 }
3133 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003134 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003135 return 1;
3136 }
3137 return 0;
3138}
3139#endif
3140
3141#ifndef SQLITE_OMIT_SUBQUERY
3142/*
drhe3365e62009-11-12 17:52:24 +00003143** Generate code for an IN expression.
3144**
3145** x IN (SELECT ...)
3146** x IN (value, value, ...)
3147**
drhecb87ac2016-08-25 15:46:25 +00003148** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003149** right-hand side (RHS) is an array of zero or more scalar values, or a
3150** subquery. If the RHS is a subquery, the number of result columns must
3151** match the number of columns in the vector on the LHS. If the RHS is
3152** a list of values, the LHS must be a scalar.
3153**
3154** The IN operator is true if the LHS value is contained within the RHS.
3155** The result is false if the LHS is definitely not in the RHS. The
3156** result is NULL if the presence of the LHS in the RHS cannot be
3157** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003158**
drh6be515e2014-08-01 21:00:53 +00003159** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003160** contained within the RHS. If due to NULLs we cannot determine if the LHS
3161** is contained in the RHS then jump to destIfNull. If the LHS is contained
3162** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003163**
3164** See the separate in-operator.md documentation file in the canonical
3165** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003166*/
3167static void sqlite3ExprCodeIN(
3168 Parse *pParse, /* Parsing and code generating context */
3169 Expr *pExpr, /* The IN expression */
3170 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3171 int destIfNull /* Jump here if the results are unknown due to NULLs */
3172){
3173 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003174 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003175 int rLhs; /* Register(s) holding the LHS values */
3176 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003177 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003178 int *aiMap = 0; /* Map from vector field to index column */
3179 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003180 int nVector; /* Size of vectors for this IN operator */
3181 int iDummy; /* Dummy parameter to exprCodeVector() */
3182 Expr *pLeft; /* The LHS of the IN operator */
3183 int i; /* loop counter */
3184 int destStep2; /* Where to jump when NULLs seen in step 2 */
3185 int destStep6 = 0; /* Start of code for Step 6 */
3186 int addrTruthOp; /* Address of opcode that determines the IN is true */
3187 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3188 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003189 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003190 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003191
drhe7375bf2020-03-10 19:24:38 +00003192 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003193 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003194 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003195 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003196 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3197 aiMap = (int*)sqlite3DbMallocZero(
3198 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3199 );
drhe347d3e2016-08-25 21:14:34 +00003200 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003201
danba00e302016-07-23 20:24:06 +00003202 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003203 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003204 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3205 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003206 v = pParse->pVdbe;
3207 assert( v!=0 ); /* OOM detected prior to this routine */
3208 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003209 eType = sqlite3FindInIndex(pParse, pExpr,
3210 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003211 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3212 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003213
danba00e302016-07-23 20:24:06 +00003214 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3215 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3216 );
drhecb87ac2016-08-25 15:46:25 +00003217#ifdef SQLITE_DEBUG
3218 /* Confirm that aiMap[] contains nVector integer values between 0 and
3219 ** nVector-1. */
3220 for(i=0; i<nVector; i++){
3221 int j, cnt;
3222 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3223 assert( cnt==1 );
3224 }
3225#endif
drhe3365e62009-11-12 17:52:24 +00003226
danba00e302016-07-23 20:24:06 +00003227 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3228 ** vector, then it is stored in an array of nVector registers starting
3229 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003230 **
3231 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3232 ** so that the fields are in the same order as an existing index. The
3233 ** aiMap[] array contains a mapping from the original LHS field order to
3234 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003235 **
3236 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3237 ** even if it is constant, as OP_Affinity may be used on the register
3238 ** by code generated below. */
3239 assert( pParse->okConstFactor==okConstFactor );
3240 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003241 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003242 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003243 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003244 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003245 /* LHS fields are not reordered */
3246 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003247 }else{
3248 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003249 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003250 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003251 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003252 }
danba00e302016-07-23 20:24:06 +00003253 }
drhe3365e62009-11-12 17:52:24 +00003254
drhbb53ecb2014-08-02 21:03:33 +00003255 /* If sqlite3FindInIndex() did not find or create an index that is
3256 ** suitable for evaluating the IN operator, then evaluate using a
3257 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003258 **
3259 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003260 */
drhbb53ecb2014-08-02 21:03:33 +00003261 if( eType==IN_INDEX_NOOP ){
3262 ExprList *pList = pExpr->x.pList;
3263 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003264 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003265 int r2, regToFree;
3266 int regCkNull = 0;
3267 int ii;
3268 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003269 if( destIfNull!=destIfFalse ){
3270 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003271 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003272 }
3273 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003274 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003275 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003276 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3277 }
drhf6ea97e2020-01-04 15:21:47 +00003278 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003279 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003280 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3281 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003282 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003283 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3284 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3285 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3286 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003287 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003288 }else{
drh47994882019-12-22 23:48:36 +00003289 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003290 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003291 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3292 (void*)pColl, P4_COLLSEQ);
3293 VdbeCoverageIf(v, op==OP_Ne);
3294 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003295 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003296 }
drhbb53ecb2014-08-02 21:03:33 +00003297 }
3298 if( regCkNull ){
3299 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003300 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003301 }
3302 sqlite3VdbeResolveLabel(v, labelOk);
3303 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003304 goto sqlite3ExprCodeIN_finished;
3305 }
3306
3307 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3308 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3309 ** We will then skip the binary search of the RHS.
3310 */
3311 if( destIfNull==destIfFalse ){
3312 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003313 }else{
drhec4ccdb2018-12-29 02:26:59 +00003314 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003315 }
drh4eac5f02019-12-24 15:01:17 +00003316 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003317 for(i=0; i<nVector; i++){
3318 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3319 if( sqlite3ExprCanBeNull(p) ){
3320 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003321 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003322 }
drhe3365e62009-11-12 17:52:24 +00003323 }
drhe347d3e2016-08-25 21:14:34 +00003324
3325 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3326 ** of the RHS using the LHS as a probe. If found, the result is
3327 ** true.
3328 */
3329 if( eType==IN_INDEX_ROWID ){
3330 /* In this case, the RHS is the ROWID of table b-tree and so we also
3331 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3332 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003333 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003334 VdbeCoverage(v);
3335 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3336 }else{
3337 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3338 if( destIfFalse==destIfNull ){
3339 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003340 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003341 rLhs, nVector); VdbeCoverage(v);
3342 goto sqlite3ExprCodeIN_finished;
3343 }
3344 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003345 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003346 rLhs, nVector); VdbeCoverage(v);
3347 }
3348
3349 /* Step 4. If the RHS is known to be non-NULL and we did not find
3350 ** an match on the search above, then the result must be FALSE.
3351 */
3352 if( rRhsHasNull && nVector==1 ){
3353 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3354 VdbeCoverage(v);
3355 }
3356
3357 /* Step 5. If we do not care about the difference between NULL and
3358 ** FALSE, then just return false.
3359 */
3360 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3361
3362 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3363 ** If any comparison is NULL, then the result is NULL. If all
3364 ** comparisons are FALSE then the final result is FALSE.
3365 **
3366 ** For a scalar LHS, it is sufficient to check just the first row
3367 ** of the RHS.
3368 */
3369 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003370 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003371 VdbeCoverage(v);
3372 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003373 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003374 }else{
3375 /* For nVector==1, combine steps 6 and 7 by immediately returning
3376 ** FALSE if the first comparison is not NULL */
3377 destNotNull = destIfFalse;
3378 }
3379 for(i=0; i<nVector; i++){
3380 Expr *p;
3381 CollSeq *pColl;
3382 int r3 = sqlite3GetTempReg(pParse);
3383 p = sqlite3VectorFieldSubexpr(pLeft, i);
3384 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003385 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003386 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3387 (void*)pColl, P4_COLLSEQ);
3388 VdbeCoverage(v);
3389 sqlite3ReleaseTempReg(pParse, r3);
3390 }
3391 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3392 if( nVector>1 ){
3393 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003394 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003395 VdbeCoverage(v);
3396
3397 /* Step 7: If we reach this point, we know that the result must
3398 ** be false. */
3399 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3400 }
3401
3402 /* Jumps here in order to return true. */
3403 sqlite3VdbeJumpHere(v, addrTruthOp);
3404
3405sqlite3ExprCodeIN_finished:
3406 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003407 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003408sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003409 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003410 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003411}
3412#endif /* SQLITE_OMIT_SUBQUERY */
3413
drh13573c72010-01-12 17:04:07 +00003414#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003415/*
3416** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003417** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003418**
3419** The z[] string will probably not be zero-terminated. But the
3420** z[n] character is guaranteed to be something that does not look
3421** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003422*/
drhb7916a72009-05-27 10:31:29 +00003423static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003424 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003425 double value;
drh9339da12010-09-30 00:50:49 +00003426 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003427 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3428 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003429 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003430 }
3431}
drh13573c72010-01-12 17:04:07 +00003432#endif
drh598f1342007-10-23 15:39:45 +00003433
3434
3435/*
drhfec19aa2004-05-19 20:41:03 +00003436** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003437** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003438**
shaneh5f1d6b62010-09-30 16:51:25 +00003439** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003440*/
drh13573c72010-01-12 17:04:07 +00003441static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3442 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003443 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003444 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003445 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003446 if( negFlag ) i = -i;
3447 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003448 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003449 int c;
3450 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003451 const char *z = pExpr->u.zToken;
3452 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003453 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003454 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003455#ifdef SQLITE_OMIT_FLOATING_POINT
3456 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3457#else
drh1b7ddc52014-07-23 14:52:05 +00003458#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003459 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003460 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003461 }else
3462#endif
3463 {
drh9296c182014-07-23 13:40:49 +00003464 codeReal(v, z, negFlag, iMem);
3465 }
drh13573c72010-01-12 17:04:07 +00003466#endif
drh77320ea2016-11-30 14:47:37 +00003467 }else{
drh84d4f1a2017-09-20 10:47:10 +00003468 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003469 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003470 }
drhfec19aa2004-05-19 20:41:03 +00003471 }
3472}
3473
drh5cd79232009-05-25 11:46:29 +00003474
drh1f9ca2c2015-08-25 16:57:52 +00003475/* Generate code that will load into register regOut a value that is
3476** appropriate for the iIdxCol-th column of index pIdx.
3477*/
3478void sqlite3ExprCodeLoadIndexColumn(
3479 Parse *pParse, /* The parsing context */
3480 Index *pIdx, /* The index whose column is to be loaded */
3481 int iTabCur, /* Cursor pointing to a table row */
3482 int iIdxCol, /* The column of the index to be loaded */
3483 int regOut /* Store the index column value in this register */
3484){
3485 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003486 if( iTabCol==XN_EXPR ){
3487 assert( pIdx->aColExpr );
3488 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003489 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003490 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003491 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003492 }else{
drh6df9c4b2019-10-18 12:52:08 +00003493 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003494 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003495 }
drh1f9ca2c2015-08-25 16:57:52 +00003496}
3497
drhe70fa7f2019-10-22 21:01:34 +00003498#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3499/*
3500** Generate code that will compute the value of generated column pCol
3501** and store the result in register regOut
3502*/
3503void sqlite3ExprCodeGeneratedColumn(
3504 Parse *pParse,
3505 Column *pCol,
3506 int regOut
3507){
drh4dad7ed2019-12-16 16:52:22 +00003508 int iAddr;
3509 Vdbe *v = pParse->pVdbe;
3510 assert( v!=0 );
3511 assert( pParse->iSelfTab!=0 );
3512 if( pParse->iSelfTab>0 ){
3513 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3514 }else{
3515 iAddr = 0;
3516 }
drh24e39902020-03-10 13:35:04 +00003517 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003518 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003519 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003520 }
drh4dad7ed2019-12-16 16:52:22 +00003521 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003522}
3523#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3524
drh5cd79232009-05-25 11:46:29 +00003525/*
drh5c092e82010-05-14 19:24:02 +00003526** Generate code to extract the value of the iCol-th column of a table.
3527*/
3528void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003529 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003530 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003531 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003532 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003533 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003534){
drhab45fc02019-10-16 22:01:56 +00003535 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003536 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003537 if( pTab==0 ){
3538 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3539 return;
3540 }
drh5c092e82010-05-14 19:24:02 +00003541 if( iCol<0 || iCol==pTab->iPKey ){
3542 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3543 }else{
drh81f7b372019-10-16 12:18:59 +00003544 int op;
3545 int x;
3546 if( IsVirtual(pTab) ){
3547 op = OP_VColumn;
3548 x = iCol;
3549#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003550 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003551 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003552 if( pCol->colFlags & COLFLAG_BUSY ){
3553 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3554 }else{
3555 int savedSelfTab = pParse->iSelfTab;
3556 pCol->colFlags |= COLFLAG_BUSY;
3557 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003558 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003559 pParse->iSelfTab = savedSelfTab;
3560 pCol->colFlags &= ~COLFLAG_BUSY;
3561 }
drh81f7b372019-10-16 12:18:59 +00003562 return;
3563#endif
3564 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003565 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003566 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003567 op = OP_Column;
3568 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003569 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003570 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003571 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003572 }
3573 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003574 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3575 }
3576}
3577
3578/*
drh945498f2007-02-24 11:52:52 +00003579** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003580** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003581**
3582** There must be an open cursor to pTab in iTable when this routine
3583** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003584*/
drhe55cbd72008-03-31 23:48:03 +00003585int sqlite3ExprCodeGetColumn(
3586 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003587 Table *pTab, /* Description of the table we are reading from */
3588 int iColumn, /* Index of the table column */
3589 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003590 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003591 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003592){
drh81f7b372019-10-16 12:18:59 +00003593 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003594 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003595 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003596 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3597 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003598 }
drhe55cbd72008-03-31 23:48:03 +00003599 return iReg;
3600}
drhe55cbd72008-03-31 23:48:03 +00003601
3602/*
drhb21e7c72008-06-22 12:37:57 +00003603** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003604** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003605*/
drhb21e7c72008-06-22 12:37:57 +00003606void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003607 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003608}
3609
drh652fbf52008-04-01 01:42:41 +00003610/*
drh12abf402016-08-22 14:30:05 +00003611** Convert a scalar expression node to a TK_REGISTER referencing
3612** register iReg. The caller must ensure that iReg already contains
3613** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003614*/
dan069d1b12019-06-16 08:58:14 +00003615static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003616 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003617 p->op2 = p->op;
3618 p->op = TK_REGISTER;
3619 p->iTable = iReg;
3620 ExprClearProperty(p, EP_Skip);
3621}
3622
drh12abf402016-08-22 14:30:05 +00003623/*
3624** Evaluate an expression (either a vector or a scalar expression) and store
3625** the result in continguous temporary registers. Return the index of
3626** the first register used to store the result.
3627**
3628** If the returned result register is a temporary scalar, then also write
3629** that register number into *piFreeable. If the returned result register
3630** is not a temporary or if the expression is a vector set *piFreeable
3631** to 0.
3632*/
3633static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3634 int iResult;
3635 int nResult = sqlite3ExprVectorSize(p);
3636 if( nResult==1 ){
3637 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3638 }else{
3639 *piFreeable = 0;
3640 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003641#if SQLITE_OMIT_SUBQUERY
3642 iResult = 0;
3643#else
drh85bcdce2018-12-23 21:27:29 +00003644 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003645#endif
drh12abf402016-08-22 14:30:05 +00003646 }else{
3647 int i;
3648 iResult = pParse->nMem+1;
3649 pParse->nMem += nResult;
3650 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003651 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003652 }
3653 }
3654 }
3655 return iResult;
3656}
3657
drh25c42962020-01-01 13:55:08 +00003658/*
drh92a27f72020-02-04 01:41:44 +00003659** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3660** so that a subsequent copy will not be merged into this one.
3661*/
3662static void setDoNotMergeFlagOnCopy(Vdbe *v){
3663 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3664 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3665 }
3666}
3667
3668/*
drh25c42962020-01-01 13:55:08 +00003669** Generate code to implement special SQL functions that are implemented
3670** in-line rather than by using the usual callbacks.
3671*/
3672static int exprCodeInlineFunction(
3673 Parse *pParse, /* Parsing context */
3674 ExprList *pFarg, /* List of function arguments */
3675 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3676 int target /* Store function result in this register */
3677){
3678 int nFarg;
3679 Vdbe *v = pParse->pVdbe;
3680 assert( v!=0 );
3681 assert( pFarg!=0 );
3682 nFarg = pFarg->nExpr;
3683 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3684 switch( iFuncId ){
3685 case INLINEFUNC_coalesce: {
3686 /* Attempt a direct implementation of the built-in COALESCE() and
3687 ** IFNULL() functions. This avoids unnecessary evaluation of
3688 ** arguments past the first non-NULL argument.
3689 */
3690 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3691 int i;
3692 assert( nFarg>=2 );
3693 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3694 for(i=1; i<nFarg; i++){
3695 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3696 VdbeCoverage(v);
3697 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3698 }
drh92a27f72020-02-04 01:41:44 +00003699 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003700 sqlite3VdbeResolveLabel(v, endCoalesce);
3701 break;
3702 }
drh3c0e6062020-05-13 18:03:34 +00003703 case INLINEFUNC_iif: {
3704 Expr caseExpr;
3705 memset(&caseExpr, 0, sizeof(caseExpr));
3706 caseExpr.op = TK_CASE;
3707 caseExpr.x.pList = pFarg;
3708 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3709 }
drh25c42962020-01-01 13:55:08 +00003710
drh171c50e2020-01-01 15:43:30 +00003711 default: {
drh25c42962020-01-01 13:55:08 +00003712 /* The UNLIKELY() function is a no-op. The result is the value
3713 ** of the first argument.
3714 */
drh171c50e2020-01-01 15:43:30 +00003715 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003716 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3717 break;
3718 }
3719
drh171c50e2020-01-01 15:43:30 +00003720 /***********************************************************************
3721 ** Test-only SQL functions that are only usable if enabled
3722 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3723 */
3724 case INLINEFUNC_expr_compare: {
3725 /* Compare two expressions using sqlite3ExprCompare() */
3726 assert( nFarg==2 );
3727 sqlite3VdbeAddOp2(v, OP_Integer,
3728 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3729 target);
3730 break;
3731 }
3732
3733 case INLINEFUNC_expr_implies_expr: {
3734 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3735 assert( nFarg==2 );
3736 sqlite3VdbeAddOp2(v, OP_Integer,
3737 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3738 target);
3739 break;
3740 }
3741
3742 case INLINEFUNC_implies_nonnull_row: {
3743 /* REsult of sqlite3ExprImpliesNonNullRow() */
3744 Expr *pA1;
3745 assert( nFarg==2 );
3746 pA1 = pFarg->a[1].pExpr;
3747 if( pA1->op==TK_COLUMN ){
3748 sqlite3VdbeAddOp2(v, OP_Integer,
3749 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3750 target);
3751 }else{
3752 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3753 }
3754 break;
3755 }
3756
drh25c42962020-01-01 13:55:08 +00003757#ifdef SQLITE_DEBUG
3758 case INLINEFUNC_affinity: {
3759 /* The AFFINITY() function evaluates to a string that describes
3760 ** the type affinity of the argument. This is used for testing of
3761 ** the SQLite type logic.
3762 */
3763 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3764 char aff;
3765 assert( nFarg==1 );
3766 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3767 sqlite3VdbeLoadString(v, target,
3768 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3769 break;
3770 }
3771#endif
3772 }
3773 return target;
3774}
3775
dan71c57db2016-07-09 20:23:55 +00003776
drha4c3c872013-09-12 17:29:25 +00003777/*
drhcce7d172000-05-31 15:34:51 +00003778** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003779** expression. Attempt to store the results in register "target".
3780** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003781**
drh8b213892008-08-29 02:14:02 +00003782** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003783** be stored in target. The result might be stored in some other
3784** register if it is convenient to do so. The calling function
3785** must check the return code and move the results to the desired
3786** register.
drhcce7d172000-05-31 15:34:51 +00003787*/
drh678ccce2008-03-31 18:19:54 +00003788int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003789 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3790 int op; /* The opcode being coded */
3791 int inReg = target; /* Results stored in register inReg */
3792 int regFree1 = 0; /* If non-zero free this temporary register */
3793 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003794 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003795 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003796 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003797
drh9cbf3422008-01-17 16:22:13 +00003798 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003799 if( v==0 ){
3800 assert( pParse->db->mallocFailed );
3801 return 0;
3802 }
drh389a1ad2008-01-03 23:44:53 +00003803
drh1efa8022018-04-28 04:16:43 +00003804expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003805 if( pExpr==0 ){
3806 op = TK_NULL;
3807 }else{
drhe7375bf2020-03-10 19:24:38 +00003808 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003809 op = pExpr->op;
3810 }
drhf2bc0132004-10-04 13:19:23 +00003811 switch( op ){
drh13449892005-09-07 21:22:45 +00003812 case TK_AGG_COLUMN: {
3813 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003814 struct AggInfo_col *pCol;
3815 assert( pAggInfo!=0 );
3816 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3817 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003818 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003819 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003820 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003821 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003822 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003823 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003824 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003825 if( pCol->iColumn<0 ){
3826 VdbeComment((v,"%s.rowid",pTab->zName));
3827 }else{
3828 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3829 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3830 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3831 }
drh0c76e892020-03-10 11:50:43 +00003832 }
drhc332cc32016-09-19 10:24:19 +00003833 return target;
drh13449892005-09-07 21:22:45 +00003834 }
3835 /* Otherwise, fall thru into the TK_COLUMN case */
3836 }
drh967e8b72000-06-21 13:59:10 +00003837 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003838 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003839 int iReg;
drhefad2e22018-07-27 16:57:11 +00003840 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003841 /* This COLUMN expression is really a constant due to WHERE clause
3842 ** constraints, and that constant is coded by the pExpr->pLeft
3843 ** expresssion. However, make sure the constant has the correct
3844 ** datatype by applying the Affinity of the table column to the
3845 ** constant.
3846 */
drh57f7ece2019-11-21 18:28:44 +00003847 int aff;
drh67b9ba12019-12-20 20:45:02 +00003848 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003849 if( pExpr->y.pTab ){
3850 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3851 }else{
3852 aff = pExpr->affExpr;
3853 }
drh96fb16e2019-08-06 14:37:24 +00003854 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003855 static const char zAff[] = "B\000C\000D\000E";
3856 assert( SQLITE_AFF_BLOB=='A' );
3857 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003858 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3859 &zAff[(aff-'B')*2], P4_STATIC);
3860 }
3861 return iReg;
drhefad2e22018-07-27 16:57:11 +00003862 }
drhb2b9d3d2013-08-01 01:14:43 +00003863 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003864 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003865 /* Other columns in the same row for CHECK constraints or
3866 ** generated columns or for inserting into partial index.
3867 ** The row is unpacked into registers beginning at
3868 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3869 ** immediately prior to the first column.
3870 */
3871 Column *pCol;
3872 Table *pTab = pExpr->y.pTab;
3873 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003874 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003875 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003876 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003877 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003878 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003879 return -1-pParse->iSelfTab;
3880 }
drhc5f808d2019-10-19 15:01:52 +00003881 pCol = pTab->aCol + iCol;
3882 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3883 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003884#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3885 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003886 if( pCol->colFlags & COLFLAG_BUSY ){
3887 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3888 pCol->zName);
3889 return 0;
3890 }
3891 pCol->colFlags |= COLFLAG_BUSY;
3892 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3893 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3894 }
3895 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003896 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003897 }else
3898#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3899 if( pCol->affinity==SQLITE_AFF_REAL ){
3900 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003901 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3902 return target;
3903 }else{
drh9942ef02019-10-18 02:19:18 +00003904 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003905 }
drhb2b9d3d2013-08-01 01:14:43 +00003906 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003907 /* Coding an expression that is part of an index where column names
3908 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003909 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003910 }
drh22827922000-06-06 17:27:05 +00003911 }
drh67b9ba12019-12-20 20:45:02 +00003912 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003913 pExpr->iColumn, iTab, target,
3914 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003915 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3916 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3917 }
3918 return iReg;
drhcce7d172000-05-31 15:34:51 +00003919 }
3920 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003921 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003922 return target;
drhfec19aa2004-05-19 20:41:03 +00003923 }
drh8abed7b2018-02-26 18:49:05 +00003924 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003925 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003926 return target;
3927 }
drh13573c72010-01-12 17:04:07 +00003928#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003929 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003930 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3931 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003932 return target;
drh598f1342007-10-23 15:39:45 +00003933 }
drh13573c72010-01-12 17:04:07 +00003934#endif
drhfec19aa2004-05-19 20:41:03 +00003935 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003936 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003937 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003938 return target;
drhcce7d172000-05-31 15:34:51 +00003939 }
drhaac30f92019-12-14 15:01:55 +00003940 default: {
drhc29af652019-12-18 21:22:40 +00003941 /* Make NULL the default case so that if a bug causes an illegal
3942 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003943 ** sanely and not crash. But keep the assert() to bring the problem
3944 ** to the attention of the developers. */
3945 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003946 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003947 return target;
drhf0863fe2005-06-12 21:35:51 +00003948 }
danielk19775338a5f2005-01-20 13:03:10 +00003949#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003950 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003951 int n;
3952 const char *z;
drhca48c902008-01-18 14:08:24 +00003953 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003954 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3955 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3956 assert( pExpr->u.zToken[1]=='\'' );
3957 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003958 n = sqlite3Strlen30(z) - 1;
3959 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003960 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3961 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003962 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003963 }
danielk19775338a5f2005-01-20 13:03:10 +00003964#endif
drh50457892003-09-06 01:10:47 +00003965 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003966 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3967 assert( pExpr->u.zToken!=0 );
3968 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003969 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3970 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003971 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003972 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003973 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003974 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003975 }
drhc332cc32016-09-19 10:24:19 +00003976 return target;
drh50457892003-09-06 01:10:47 +00003977 }
drh4e0cff62004-11-05 05:10:28 +00003978 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003979 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003980 }
drh487e2622005-06-25 18:42:14 +00003981#ifndef SQLITE_OMIT_CAST
3982 case TK_CAST: {
3983 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003984 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003985 if( inReg!=target ){
3986 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3987 inReg = target;
3988 }
drh4169e432014-08-25 20:11:52 +00003989 sqlite3VdbeAddOp2(v, OP_Cast, target,
3990 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003991 return inReg;
drh487e2622005-06-25 18:42:14 +00003992 }
3993#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003994 case TK_IS:
3995 case TK_ISNOT:
3996 op = (op==TK_IS) ? TK_EQ : TK_NE;
3997 p5 = SQLITE_NULLEQ;
3998 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003999 case TK_LT:
4000 case TK_LE:
4001 case TK_GT:
4002 case TK_GE:
4003 case TK_NE:
4004 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004005 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004006 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004007 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004008 }else{
4009 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4010 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4011 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004012 r1, r2, inReg, SQLITE_STOREP2 | p5,
4013 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004014 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4015 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4016 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4017 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4018 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4019 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4020 testcase( regFree1==0 );
4021 testcase( regFree2==0 );
4022 }
drh6a2fe092009-09-23 02:29:36 +00004023 break;
4024 }
drhcce7d172000-05-31 15:34:51 +00004025 case TK_AND:
4026 case TK_OR:
4027 case TK_PLUS:
4028 case TK_STAR:
4029 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004030 case TK_REM:
4031 case TK_BITAND:
4032 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004033 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004034 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004035 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004036 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004037 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4038 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4039 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4040 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4041 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4042 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4043 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4044 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4045 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4046 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4047 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004048 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4049 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004050 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004051 testcase( regFree1==0 );
4052 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004053 break;
4054 }
drhcce7d172000-05-31 15:34:51 +00004055 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004056 Expr *pLeft = pExpr->pLeft;
4057 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004058 if( pLeft->op==TK_INTEGER ){
4059 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004060 return target;
drh13573c72010-01-12 17:04:07 +00004061#ifndef SQLITE_OMIT_FLOATING_POINT
4062 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004063 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4064 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004065 return target;
drh13573c72010-01-12 17:04:07 +00004066#endif
drh3c84ddf2008-01-09 02:15:38 +00004067 }else{
drh10d1edf2013-11-15 15:52:39 +00004068 tempX.op = TK_INTEGER;
4069 tempX.flags = EP_IntValue|EP_TokenOnly;
4070 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004071 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004072 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004073 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004074 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004075 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004076 }
drh3c84ddf2008-01-09 02:15:38 +00004077 break;
drh6e142f52000-06-08 13:36:40 +00004078 }
drhbf4133c2001-10-13 02:59:08 +00004079 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004080 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004081 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4082 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004083 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4084 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004085 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004086 break;
4087 }
drh8abed7b2018-02-26 18:49:05 +00004088 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004089 int isTrue; /* IS TRUE or IS NOT TRUE */
4090 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004091 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4092 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004093 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4094 bNormal = pExpr->op2==TK_IS;
4095 testcase( isTrue && bNormal);
4096 testcase( !isTrue && bNormal);
4097 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004098 break;
4099 }
drhcce7d172000-05-31 15:34:51 +00004100 case TK_ISNULL:
4101 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004102 int addr;
drh7d176102014-02-18 03:07:12 +00004103 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4104 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004105 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004106 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004107 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004108 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004109 VdbeCoverageIf(v, op==TK_ISNULL);
4110 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004111 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004112 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004113 break;
drhcce7d172000-05-31 15:34:51 +00004114 }
drh22827922000-06-06 17:27:05 +00004115 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004116 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004117 if( pInfo==0
4118 || NEVER(pExpr->iAgg<0)
4119 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4120 ){
drh33e619f2009-05-28 01:00:55 +00004121 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4122 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004123 }else{
drhc332cc32016-09-19 10:24:19 +00004124 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004125 }
drh22827922000-06-06 17:27:05 +00004126 break;
4127 }
drhcce7d172000-05-31 15:34:51 +00004128 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004129 ExprList *pFarg; /* List of function arguments */
4130 int nFarg; /* Number of function arguments */
4131 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004132 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004133 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004134 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004135 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004136 u8 enc = ENC(db); /* The text encoding used by this database */
4137 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004138
dan67a9b8e2018-06-22 20:51:35 +00004139#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004140 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4141 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004142 }
dan67a9b8e2018-06-22 20:51:35 +00004143#endif
dan86fb6e12018-05-16 20:58:07 +00004144
drh1e9b53f2017-01-04 01:07:24 +00004145 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004146 /* SQL functions can be expensive. So try to avoid running them
4147 ** multiple times if we know they always give the same result */
4148 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004149 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004150 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004151 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4152 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004153 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004154 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4155 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004156 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004157#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4158 if( pDef==0 && pParse->explain ){
4159 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4160 }
4161#endif
danb6e9f7a2018-05-19 14:15:29 +00004162 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004163 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004164 break;
4165 }
drh25c42962020-01-01 13:55:08 +00004166 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004167 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4168 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004169 return exprCodeInlineFunction(pParse, pFarg,
4170 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004171 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4172 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004173 }
4174
drhd1a01ed2013-11-21 16:08:52 +00004175 for(i=0; i<nFarg; i++){
4176 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004177 testcase( i==31 );
4178 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004179 }
4180 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4181 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4182 }
4183 }
drh12ffee82009-04-08 13:51:51 +00004184 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004185 if( constMask ){
4186 r1 = pParse->nMem+1;
4187 pParse->nMem += nFarg;
4188 }else{
4189 r1 = sqlite3GetTempRange(pParse, nFarg);
4190 }
drha748fdc2012-03-28 01:34:47 +00004191
4192 /* For length() and typeof() functions with a column argument,
4193 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4194 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4195 ** loading.
4196 */
drhd36e1042013-09-06 13:10:12 +00004197 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004198 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004199 assert( nFarg==1 );
4200 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004201 exprOp = pFarg->a[0].pExpr->op;
4202 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004203 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4204 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004205 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4206 pFarg->a[0].pExpr->op2 =
4207 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004208 }
4209 }
4210
drh5579d592015-08-26 14:01:41 +00004211 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004212 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004213 }else{
drh12ffee82009-04-08 13:51:51 +00004214 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004215 }
drhb7f6f682006-07-08 17:06:43 +00004216#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004217 /* Possibly overload the function if the first argument is
4218 ** a virtual table column.
4219 **
4220 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4221 ** second argument, not the first, as the argument to test to
4222 ** see if it is a column in a virtual table. This is done because
4223 ** the left operand of infix functions (the operand we want to
4224 ** control overloading) ends up as the second argument to the
4225 ** function. The expression "A glob B" is equivalent to
4226 ** "glob(B,A). We want to use the A in "A glob B" to test
4227 ** for function overloading. But we use the B term in "glob(B,A)".
4228 */
drh59155062018-05-26 18:03:48 +00004229 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004230 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4231 }else if( nFarg>0 ){
4232 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004233 }
4234#endif
drhd36e1042013-09-06 13:10:12 +00004235 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004236 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004237 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004238 }
drh092457b2017-12-29 15:04:49 +00004239#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4240 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004241 Expr *pArg = pFarg->a[0].pExpr;
4242 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004243 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004244 }else{
4245 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4246 }
drh092457b2017-12-29 15:04:49 +00004247 }else
4248#endif
4249 {
drh920cf592019-10-30 16:29:02 +00004250 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004251 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004252 }
drh13d79502019-12-23 02:18:49 +00004253 if( nFarg ){
4254 if( constMask==0 ){
4255 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4256 }else{
drh3aef2fb2020-01-02 17:46:02 +00004257 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004258 }
drh2dcef112008-01-12 19:03:48 +00004259 }
drhc332cc32016-09-19 10:24:19 +00004260 return target;
drhcce7d172000-05-31 15:34:51 +00004261 }
drhfe2093d2005-01-20 22:48:47 +00004262#ifndef SQLITE_OMIT_SUBQUERY
4263 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004264 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004265 int nCol;
drhc5499be2008-04-01 15:06:33 +00004266 testcase( op==TK_EXISTS );
4267 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004268 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4269 sqlite3SubselectError(pParse, nCol, 1);
4270 }else{
drh85bcdce2018-12-23 21:27:29 +00004271 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004272 }
drh19a775c2000-06-05 18:54:46 +00004273 break;
4274 }
drhfc7f27b2016-08-20 00:07:01 +00004275 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004276 int n;
drhfc7f27b2016-08-20 00:07:01 +00004277 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004278 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004279 }
drh966e2912017-01-03 02:58:01 +00004280 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004281 if( pExpr->iTable!=0
4282 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004283 ){
4284 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4285 pExpr->iTable, n);
4286 }
drhc332cc32016-09-19 10:24:19 +00004287 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004288 }
drhfef52082000-06-06 01:50:43 +00004289 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004290 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4291 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004292 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4293 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4294 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4295 sqlite3VdbeResolveLabel(v, destIfFalse);
4296 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4297 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004298 return target;
drhfef52082000-06-06 01:50:43 +00004299 }
drhe3365e62009-11-12 17:52:24 +00004300#endif /* SQLITE_OMIT_SUBQUERY */
4301
4302
drh2dcef112008-01-12 19:03:48 +00004303 /*
4304 ** x BETWEEN y AND z
4305 **
4306 ** This is equivalent to
4307 **
4308 ** x>=y AND x<=z
4309 **
4310 ** X is stored in pExpr->pLeft.
4311 ** Y is stored in pExpr->pList->a[0].pExpr.
4312 ** Z is stored in pExpr->pList->a[1].pExpr.
4313 */
drhfef52082000-06-06 01:50:43 +00004314 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004315 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004316 return target;
drhfef52082000-06-06 01:50:43 +00004317 }
drh94fa9c42016-02-27 21:16:04 +00004318 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004319 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004320 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004321 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004322 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004323 }
drh2dcef112008-01-12 19:03:48 +00004324
dan165921a2009-08-28 18:53:45 +00004325 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004326 /* If the opcode is TK_TRIGGER, then the expression is a reference
4327 ** to a column in the new.* or old.* pseudo-tables available to
4328 ** trigger programs. In this case Expr.iTable is set to 1 for the
4329 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4330 ** is set to the column of the pseudo-table to read, or to -1 to
4331 ** read the rowid field.
4332 **
4333 ** The expression is implemented using an OP_Param opcode. The p1
4334 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4335 ** to reference another column of the old.* pseudo-table, where
4336 ** i is the index of the column. For a new.rowid reference, p1 is
4337 ** set to (n+1), where n is the number of columns in each pseudo-table.
4338 ** For a reference to any other column in the new.* pseudo-table, p1
4339 ** is set to (n+2+i), where n and i are as defined previously. For
4340 ** example, if the table on which triggers are being fired is
4341 ** declared as:
4342 **
4343 ** CREATE TABLE t1(a, b);
4344 **
4345 ** Then p1 is interpreted as follows:
4346 **
4347 ** p1==0 -> old.rowid p1==3 -> new.rowid
4348 ** p1==1 -> old.a p1==4 -> new.a
4349 ** p1==2 -> old.b p1==5 -> new.b
4350 */
drheda079c2018-09-20 19:02:15 +00004351 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004352 int iCol = pExpr->iColumn;
4353 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004354 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004355
4356 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004357 assert( iCol>=-1 && iCol<pTab->nCol );
4358 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004359 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4360
4361 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004362 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004363 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004364 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004365 ));
dan65a7cd12009-09-01 12:16:01 +00004366
drh44dbca82010-01-13 04:22:20 +00004367#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004368 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004369 ** integer. Use OP_RealAffinity to make sure it is really real.
4370 **
4371 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4372 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004373 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004374 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4375 }
drh44dbca82010-01-13 04:22:20 +00004376#endif
dan165921a2009-08-28 18:53:45 +00004377 break;
4378 }
4379
dan71c57db2016-07-09 20:23:55 +00004380 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004381 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004382 break;
4383 }
4384
drh9e9a67a2019-08-17 17:07:15 +00004385 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4386 ** that derive from the right-hand table of a LEFT JOIN. The
4387 ** Expr.iTable value is the table number for the right-hand table.
4388 ** The expression is only evaluated if that table is not currently
4389 ** on a LEFT JOIN NULL row.
4390 */
drh31d6fd52017-04-14 19:03:10 +00004391 case TK_IF_NULL_ROW: {
4392 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004393 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004394 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004395 /* Temporarily disable factoring of constant expressions, since
4396 ** even though expressions may appear to be constant, they are not
4397 ** really constant because they originate from the right-hand side
4398 ** of a LEFT JOIN. */
4399 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004400 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004401 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004402 sqlite3VdbeJumpHere(v, addrINR);
4403 sqlite3VdbeChangeP3(v, addrINR, inReg);
4404 break;
4405 }
4406
drh2dcef112008-01-12 19:03:48 +00004407 /*
4408 ** Form A:
4409 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4410 **
4411 ** Form B:
4412 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4413 **
4414 ** Form A is can be transformed into the equivalent form B as follows:
4415 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4416 ** WHEN x=eN THEN rN ELSE y END
4417 **
4418 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004419 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4420 ** odd. The Y is also optional. If the number of elements in x.pList
4421 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004422 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4423 **
4424 ** The result of the expression is the Ri for the first matching Ei,
4425 ** or if there is no matching Ei, the ELSE term Y, or if there is
4426 ** no ELSE term, NULL.
4427 */
drhaac30f92019-12-14 15:01:55 +00004428 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004429 int endLabel; /* GOTO label for end of CASE stmt */
4430 int nextCase; /* GOTO label for next WHEN clause */
4431 int nExpr; /* 2x number of WHEN terms */
4432 int i; /* Loop counter */
4433 ExprList *pEList; /* List of WHEN terms */
4434 struct ExprList_item *aListelem; /* Array of WHEN terms */
4435 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004436 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004437 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004438 Expr *pDel = 0;
4439 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004440
danielk19776ab3a2e2009-02-19 14:39:25 +00004441 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004442 assert(pExpr->x.pList->nExpr > 0);
4443 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004444 aListelem = pEList->a;
4445 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004446 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004447 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004448 pDel = sqlite3ExprDup(db, pX, 0);
4449 if( db->mallocFailed ){
4450 sqlite3ExprDelete(db, pDel);
4451 break;
4452 }
drh33cd4902009-05-30 20:49:20 +00004453 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004454 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004455 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004456 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004457 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004458 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004459 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004460 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4461 ** The value in regFree1 might get SCopy-ed into the file result.
4462 ** So make sure that the regFree1 register is not reused for other
4463 ** purposes and possibly overwritten. */
4464 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004465 }
drhc5cd1242013-09-12 16:50:49 +00004466 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004467 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004468 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004469 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004470 }else{
drh2dcef112008-01-12 19:03:48 +00004471 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004472 }
drhec4ccdb2018-12-29 02:26:59 +00004473 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004474 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004475 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004476 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004477 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004478 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004479 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004480 }
drhc5cd1242013-09-12 16:50:49 +00004481 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004482 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004483 }else{
drh9de221d2008-01-05 06:51:30 +00004484 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004485 }
dan8b65e592019-07-17 14:34:17 +00004486 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004487 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004488 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004489 break;
4490 }
danielk19775338a5f2005-01-20 13:03:10 +00004491#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004492 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004493 assert( pExpr->affExpr==OE_Rollback
4494 || pExpr->affExpr==OE_Abort
4495 || pExpr->affExpr==OE_Fail
4496 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004497 );
drh9e5fdc42020-05-08 19:02:21 +00004498 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004499 sqlite3ErrorMsg(pParse,
4500 "RAISE() may only be used within a trigger-program");
4501 return 0;
4502 }
drh11949042019-08-05 18:01:42 +00004503 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004504 sqlite3MayAbort(pParse);
4505 }
dan165921a2009-08-28 18:53:45 +00004506 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004507 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004508 sqlite3VdbeAddOp4(
4509 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004510 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004511 }else{
drh9e5fdc42020-05-08 19:02:21 +00004512 sqlite3HaltConstraint(pParse,
4513 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4514 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004515 }
4516
drhffe07b22005-11-03 00:41:17 +00004517 break;
drh17a7f8d2002-03-24 13:13:27 +00004518 }
danielk19775338a5f2005-01-20 13:03:10 +00004519#endif
drhffe07b22005-11-03 00:41:17 +00004520 }
drh2dcef112008-01-12 19:03:48 +00004521 sqlite3ReleaseTempReg(pParse, regFree1);
4522 sqlite3ReleaseTempReg(pParse, regFree2);
4523 return inReg;
4524}
4525
4526/*
drh9b258c52020-03-11 19:41:49 +00004527** Generate code that will evaluate expression pExpr just one time
4528** per prepared statement execution.
4529**
4530** If the expression uses functions (that might throw an exception) then
4531** guard them with an OP_Once opcode to ensure that the code is only executed
4532** once. If no functions are involved, then factor the code out and put it at
4533** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004534**
drhad879ff2017-01-04 04:10:02 +00004535** If regDest>=0 then the result is always stored in that register and the
4536** result is not reusable. If regDest<0 then this routine is free to
4537** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004538** is stored is returned. When regDest<0, two identical expressions might
4539** code to the same register, if they do not contain function calls and hence
4540** are factored out into the initialization section at the end of the
4541** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004542*/
drh9b258c52020-03-11 19:41:49 +00004543int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004544 Parse *pParse, /* Parsing context */
4545 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004546 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004547){
drhd1a01ed2013-11-21 16:08:52 +00004548 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004549 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004550 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004551 if( regDest<0 && p ){
4552 struct ExprList_item *pItem;
4553 int i;
4554 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004555 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004556 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004557 }
4558 }
drh1e9b53f2017-01-04 01:07:24 +00004559 }
drhd1a01ed2013-11-21 16:08:52 +00004560 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004561 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4562 Vdbe *v = pParse->pVdbe;
4563 int addr;
4564 assert( v );
4565 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4566 pParse->okConstFactor = 0;
4567 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004568 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004569 sqlite3ExprCode(pParse, pExpr, regDest);
4570 }
4571 pParse->okConstFactor = 1;
4572 sqlite3ExprDelete(pParse->db, pExpr);
4573 sqlite3VdbeJumpHere(v, addr);
4574 }else{
4575 p = sqlite3ExprListAppend(pParse, p, pExpr);
4576 if( p ){
4577 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4578 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004579 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004580 pItem->u.iConstExprReg = regDest;
4581 }
4582 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004583 }
drh1e9b53f2017-01-04 01:07:24 +00004584 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004585}
4586
4587/*
drh2dcef112008-01-12 19:03:48 +00004588** Generate code to evaluate an expression and store the results
4589** into a register. Return the register number where the results
4590** are stored.
4591**
4592** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004593** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004594** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004595**
4596** If pExpr is a constant, then this routine might generate this
4597** code to fill the register in the initialization section of the
4598** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004599*/
4600int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004601 int r2;
drh0d950af2019-08-22 16:38:42 +00004602 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004603 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004604 && pExpr->op!=TK_REGISTER
4605 && sqlite3ExprIsConstantNotJoin(pExpr)
4606 ){
drhf30a9692013-11-15 01:10:18 +00004607 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004608 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004609 }else{
drhf30a9692013-11-15 01:10:18 +00004610 int r1 = sqlite3GetTempReg(pParse);
4611 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4612 if( r2==r1 ){
4613 *pReg = r1;
4614 }else{
4615 sqlite3ReleaseTempReg(pParse, r1);
4616 *pReg = 0;
4617 }
drh2dcef112008-01-12 19:03:48 +00004618 }
4619 return r2;
4620}
4621
4622/*
4623** Generate code that will evaluate expression pExpr and store the
4624** results in register target. The results are guaranteed to appear
4625** in register target.
4626*/
drh05a86c52014-02-16 01:55:49 +00004627void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004628 int inReg;
4629
drhe7375bf2020-03-10 19:24:38 +00004630 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004631 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004632 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4633 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4634 if( inReg!=target && pParse->pVdbe ){
drh629b88c2020-01-02 02:50:45 +00004635 u8 op;
4636 if( ExprHasProperty(pExpr,EP_Subquery) ){
4637 op = OP_Copy;
4638 }else{
4639 op = OP_SCopy;
4640 }
4641 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004642 }
drhcce7d172000-05-31 15:34:51 +00004643}
4644
4645/*
drh1c75c9d2015-12-21 15:22:13 +00004646** Make a transient copy of expression pExpr and then code it using
4647** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4648** except that the input expression is guaranteed to be unchanged.
4649*/
4650void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4651 sqlite3 *db = pParse->db;
4652 pExpr = sqlite3ExprDup(db, pExpr, 0);
4653 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4654 sqlite3ExprDelete(db, pExpr);
4655}
4656
4657/*
drh05a86c52014-02-16 01:55:49 +00004658** Generate code that will evaluate expression pExpr and store the
4659** results in register target. The results are guaranteed to appear
4660** in register target. If the expression is constant, then this routine
4661** might choose to code the expression at initialization time.
4662*/
4663void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004664 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004665 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004666 }else{
drh088489e2020-03-10 02:57:37 +00004667 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004668 }
drhcce7d172000-05-31 15:34:51 +00004669}
4670
4671/*
drh268380c2004-02-25 13:47:31 +00004672** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004673** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004674**
drh3df6c3b2017-09-15 15:38:01 +00004675** Return the number of elements evaluated. The number returned will
4676** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4677** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004678**
4679** The SQLITE_ECEL_DUP flag prevents the arguments from being
4680** filled using OP_SCopy. OP_Copy must be used instead.
4681**
4682** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4683** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004684**
4685** The SQLITE_ECEL_REF flag means that expressions in the list with
4686** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4687** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004688** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4689** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004690*/
danielk19774adee202004-05-08 08:23:19 +00004691int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004692 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004693 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004694 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004695 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004696 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004697){
4698 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004699 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004700 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004701 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004702 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004703 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004704 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004705 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004706 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004707 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004708 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004709#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4710 if( pItem->bSorterRef ){
4711 i--;
4712 n--;
4713 }else
4714#endif
dan257c13f2016-11-10 20:14:06 +00004715 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4716 if( flags & SQLITE_ECEL_OMITREF ){
4717 i--;
4718 n--;
4719 }else{
4720 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4721 }
drhb8b06692018-08-04 15:16:20 +00004722 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4723 && sqlite3ExprIsConstantNotJoin(pExpr)
4724 ){
drh9b258c52020-03-11 19:41:49 +00004725 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004726 }else{
4727 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4728 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004729 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004730 if( copyOp==OP_Copy
4731 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4732 && pOp->p1+pOp->p3+1==inReg
4733 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004734 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004735 ){
4736 pOp->p3++;
4737 }else{
4738 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4739 }
drhd1a01ed2013-11-21 16:08:52 +00004740 }
drhd1766112008-09-17 00:13:12 +00004741 }
drh268380c2004-02-25 13:47:31 +00004742 }
drhf9b596e2004-05-26 16:54:42 +00004743 return n;
drh268380c2004-02-25 13:47:31 +00004744}
4745
4746/*
drh36c563a2009-11-12 13:32:22 +00004747** Generate code for a BETWEEN operator.
4748**
4749** x BETWEEN y AND z
4750**
4751** The above is equivalent to
4752**
4753** x>=y AND x<=z
4754**
4755** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004756** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004757**
4758** The xJumpIf parameter determines details:
4759**
4760** NULL: Store the boolean result in reg[dest]
4761** sqlite3ExprIfTrue: Jump to dest if true
4762** sqlite3ExprIfFalse: Jump to dest if false
4763**
4764** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004765*/
4766static void exprCodeBetween(
4767 Parse *pParse, /* Parsing and code generating context */
4768 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004769 int dest, /* Jump destination or storage location */
4770 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004771 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4772){
dan8b65e592019-07-17 14:34:17 +00004773 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004774 Expr compLeft; /* The x>=y term */
4775 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004776 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004777 Expr *pDel = 0;
4778 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004779
dan71c57db2016-07-09 20:23:55 +00004780 memset(&compLeft, 0, sizeof(Expr));
4781 memset(&compRight, 0, sizeof(Expr));
4782 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004783
4784 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004785 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4786 if( db->mallocFailed==0 ){
4787 exprAnd.op = TK_AND;
4788 exprAnd.pLeft = &compLeft;
4789 exprAnd.pRight = &compRight;
4790 compLeft.op = TK_GE;
4791 compLeft.pLeft = pDel;
4792 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4793 compRight.op = TK_LE;
4794 compRight.pLeft = pDel;
4795 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4796 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4797 if( xJump ){
4798 xJump(pParse, &exprAnd, dest, jumpIfNull);
4799 }else{
4800 /* Mark the expression is being from the ON or USING clause of a join
4801 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4802 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4803 ** for clarity, but we are out of bits in the Expr.flags field so we
4804 ** have to reuse the EP_FromJoin bit. Bummer. */
4805 pDel->flags |= EP_FromJoin;
4806 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4807 }
4808 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004809 }
dan8b65e592019-07-17 14:34:17 +00004810 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004811
4812 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004813 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4814 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4815 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4816 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4817 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4818 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4819 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4820 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004821 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004822}
4823
4824/*
drhcce7d172000-05-31 15:34:51 +00004825** Generate code for a boolean expression such that a jump is made
4826** to the label "dest" if the expression is true but execution
4827** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004828**
4829** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004830** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004831**
4832** This code depends on the fact that certain token values (ex: TK_EQ)
4833** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4834** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4835** the make process cause these values to align. Assert()s in the code
4836** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004837*/
danielk19774adee202004-05-08 08:23:19 +00004838void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004839 Vdbe *v = pParse->pVdbe;
4840 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004841 int regFree1 = 0;
4842 int regFree2 = 0;
4843 int r1, r2;
4844
drh35573352008-01-08 23:54:25 +00004845 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004846 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004847 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004848 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004849 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004850 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004851 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004852 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004853 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4854 if( pAlt!=pExpr ){
4855 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4856 }else if( op==TK_AND ){
4857 int d2 = sqlite3VdbeMakeLabel(pParse);
4858 testcase( jumpIfNull==0 );
4859 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4860 jumpIfNull^SQLITE_JUMPIFNULL);
4861 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4862 sqlite3VdbeResolveLabel(v, d2);
4863 }else{
4864 testcase( jumpIfNull==0 );
4865 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4866 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4867 }
drhcce7d172000-05-31 15:34:51 +00004868 break;
4869 }
4870 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004871 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004872 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004873 break;
4874 }
drh8abed7b2018-02-26 18:49:05 +00004875 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004876 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4877 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004878 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004879 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004880 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004881 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004882 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004883 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004884 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4885 isNot ? SQLITE_JUMPIFNULL : 0);
4886 }else{
4887 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4888 isNot ? SQLITE_JUMPIFNULL : 0);
4889 }
drh007c8432018-02-26 03:20:18 +00004890 break;
4891 }
drhde845c22016-03-17 19:07:52 +00004892 case TK_IS:
4893 case TK_ISNOT:
4894 testcase( op==TK_IS );
4895 testcase( op==TK_ISNOT );
4896 op = (op==TK_IS) ? TK_EQ : TK_NE;
4897 jumpIfNull = SQLITE_NULLEQ;
4898 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004899 case TK_LT:
4900 case TK_LE:
4901 case TK_GT:
4902 case TK_GE:
4903 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004904 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004905 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004906 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004907 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4908 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004909 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004910 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004911 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4912 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4913 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4914 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004915 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4916 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4917 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4918 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4919 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4920 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004921 testcase( regFree1==0 );
4922 testcase( regFree2==0 );
4923 break;
4924 }
drhcce7d172000-05-31 15:34:51 +00004925 case TK_ISNULL:
4926 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004927 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4928 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004929 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4930 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004931 VdbeCoverageIf(v, op==TK_ISNULL);
4932 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004933 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004934 break;
4935 }
drhfef52082000-06-06 01:50:43 +00004936 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004937 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004938 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004939 break;
4940 }
drh84e30ca2011-02-10 17:46:14 +00004941#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004942 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004943 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004944 int destIfNull = jumpIfNull ? dest : destIfFalse;
4945 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004946 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004947 sqlite3VdbeResolveLabel(v, destIfFalse);
4948 break;
4949 }
shanehbb201342011-02-09 19:55:20 +00004950#endif
drhcce7d172000-05-31 15:34:51 +00004951 default: {
dan7b35a772016-07-28 19:47:15 +00004952 default_expr:
drhad317272019-04-19 16:21:51 +00004953 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004954 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004955 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004956 /* No-op */
4957 }else{
4958 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4959 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004960 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004961 testcase( regFree1==0 );
4962 testcase( jumpIfNull==0 );
4963 }
drhcce7d172000-05-31 15:34:51 +00004964 break;
4965 }
4966 }
drh2dcef112008-01-12 19:03:48 +00004967 sqlite3ReleaseTempReg(pParse, regFree1);
4968 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004969}
4970
4971/*
drh66b89c82000-11-28 20:47:17 +00004972** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004973** to the label "dest" if the expression is false but execution
4974** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004975**
4976** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004977** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4978** is 0.
drhcce7d172000-05-31 15:34:51 +00004979*/
danielk19774adee202004-05-08 08:23:19 +00004980void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004981 Vdbe *v = pParse->pVdbe;
4982 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004983 int regFree1 = 0;
4984 int regFree2 = 0;
4985 int r1, r2;
4986
drh35573352008-01-08 23:54:25 +00004987 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004988 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004989 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00004990 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004991
4992 /* The value of pExpr->op and op are related as follows:
4993 **
4994 ** pExpr->op op
4995 ** --------- ----------
4996 ** TK_ISNULL OP_NotNull
4997 ** TK_NOTNULL OP_IsNull
4998 ** TK_NE OP_Eq
4999 ** TK_EQ OP_Ne
5000 ** TK_GT OP_Le
5001 ** TK_LE OP_Gt
5002 ** TK_GE OP_Lt
5003 ** TK_LT OP_Ge
5004 **
5005 ** For other values of pExpr->op, op is undefined and unused.
5006 ** The value of TK_ and OP_ constants are arranged such that we
5007 ** can compute the mapping above using the following expression.
5008 ** Assert()s verify that the computation is correct.
5009 */
5010 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5011
5012 /* Verify correct alignment of TK_ and OP_ constants
5013 */
5014 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5015 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5016 assert( pExpr->op!=TK_NE || op==OP_Eq );
5017 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5018 assert( pExpr->op!=TK_LT || op==OP_Ge );
5019 assert( pExpr->op!=TK_LE || op==OP_Gt );
5020 assert( pExpr->op!=TK_GT || op==OP_Le );
5021 assert( pExpr->op!=TK_GE || op==OP_Lt );
5022
danba00e302016-07-23 20:24:06 +00005023 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005024 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005025 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005026 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5027 if( pAlt!=pExpr ){
5028 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5029 }else if( pExpr->op==TK_AND ){
5030 testcase( jumpIfNull==0 );
5031 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5032 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5033 }else{
5034 int d2 = sqlite3VdbeMakeLabel(pParse);
5035 testcase( jumpIfNull==0 );
5036 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5037 jumpIfNull^SQLITE_JUMPIFNULL);
5038 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5039 sqlite3VdbeResolveLabel(v, d2);
5040 }
drhcce7d172000-05-31 15:34:51 +00005041 break;
5042 }
5043 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005044 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005045 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005046 break;
5047 }
drh8abed7b2018-02-26 18:49:05 +00005048 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005049 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5050 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005051 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005052 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005053 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005054 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005055 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005056 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005057 /* IS TRUE and IS NOT FALSE */
5058 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5059 isNot ? 0 : SQLITE_JUMPIFNULL);
5060
5061 }else{
5062 /* IS FALSE and IS NOT TRUE */
5063 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005064 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005065 }
drh007c8432018-02-26 03:20:18 +00005066 break;
5067 }
drhde845c22016-03-17 19:07:52 +00005068 case TK_IS:
5069 case TK_ISNOT:
5070 testcase( pExpr->op==TK_IS );
5071 testcase( pExpr->op==TK_ISNOT );
5072 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5073 jumpIfNull = SQLITE_NULLEQ;
5074 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00005075 case TK_LT:
5076 case TK_LE:
5077 case TK_GT:
5078 case TK_GE:
5079 case TK_NE:
5080 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005081 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005082 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005083 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5084 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005085 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005086 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005087 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5088 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5089 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5090 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005091 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5092 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5093 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5094 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5095 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5096 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005097 testcase( regFree1==0 );
5098 testcase( regFree2==0 );
5099 break;
5100 }
drhcce7d172000-05-31 15:34:51 +00005101 case TK_ISNULL:
5102 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005103 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5104 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005105 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5106 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005107 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005108 break;
5109 }
drhfef52082000-06-06 01:50:43 +00005110 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005111 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005112 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005113 break;
5114 }
drh84e30ca2011-02-10 17:46:14 +00005115#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005116 case TK_IN: {
5117 if( jumpIfNull ){
5118 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5119 }else{
drhec4ccdb2018-12-29 02:26:59 +00005120 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005121 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5122 sqlite3VdbeResolveLabel(v, destIfNull);
5123 }
5124 break;
5125 }
shanehbb201342011-02-09 19:55:20 +00005126#endif
drhcce7d172000-05-31 15:34:51 +00005127 default: {
danba00e302016-07-23 20:24:06 +00005128 default_expr:
drhad317272019-04-19 16:21:51 +00005129 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005130 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005131 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005132 /* no-op */
5133 }else{
5134 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5135 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005136 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005137 testcase( regFree1==0 );
5138 testcase( jumpIfNull==0 );
5139 }
drhcce7d172000-05-31 15:34:51 +00005140 break;
5141 }
5142 }
drh2dcef112008-01-12 19:03:48 +00005143 sqlite3ReleaseTempReg(pParse, regFree1);
5144 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005145}
drh22827922000-06-06 17:27:05 +00005146
5147/*
drh72bc8202015-06-11 13:58:35 +00005148** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5149** code generation, and that copy is deleted after code generation. This
5150** ensures that the original pExpr is unchanged.
5151*/
5152void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5153 sqlite3 *db = pParse->db;
5154 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5155 if( db->mallocFailed==0 ){
5156 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5157 }
5158 sqlite3ExprDelete(db, pCopy);
5159}
5160
dan5aa550c2017-06-24 18:10:29 +00005161/*
5162** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5163** type of expression.
5164**
5165** If pExpr is a simple SQL value - an integer, real, string, blob
5166** or NULL value - then the VDBE currently being prepared is configured
5167** to re-prepare each time a new value is bound to variable pVar.
5168**
5169** Additionally, if pExpr is a simple SQL value and the value is the
5170** same as that currently bound to variable pVar, non-zero is returned.
5171** Otherwise, if the values are not the same or if pExpr is not a simple
5172** SQL value, zero is returned.
5173*/
5174static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5175 int res = 0;
drhc0804222017-06-28 21:47:16 +00005176 int iVar;
5177 sqlite3_value *pL, *pR = 0;
5178
5179 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5180 if( pR ){
5181 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005182 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005183 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005184 if( pL ){
5185 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5186 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5187 }
5188 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005189 }
drhc0804222017-06-28 21:47:16 +00005190 sqlite3ValueFree(pR);
5191 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005192 }
5193
5194 return res;
5195}
drh72bc8202015-06-11 13:58:35 +00005196
5197/*
drh1d9da702010-01-07 15:17:02 +00005198** Do a deep comparison of two expression trees. Return 0 if the two
5199** expressions are completely identical. Return 1 if they differ only
5200** by a COLLATE operator at the top level. Return 2 if there are differences
5201** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005202**
drh619a1302013-08-01 13:04:46 +00005203** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5204** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5205**
drh66518ca2013-08-01 15:09:57 +00005206** The pA side might be using TK_REGISTER. If that is the case and pB is
5207** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5208**
drh1d9da702010-01-07 15:17:02 +00005209** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005210** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005211** identical, we return 2 just to be safe. So if this routine
5212** returns 2, then you do not really know for certain if the two
5213** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005214** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005215** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005216** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005217** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005218**
drhc0804222017-06-28 21:47:16 +00005219** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5220** pParse->pReprepare can be matched against literals in pB. The
5221** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5222** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5223** Argument pParse should normally be NULL. If it is not NULL and pA or
5224** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005225*/
dan5aa550c2017-06-24 18:10:29 +00005226int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005227 u32 combinedFlags;
5228 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005229 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005230 }
dan5aa550c2017-06-24 18:10:29 +00005231 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5232 return 0;
5233 }
drh10d1edf2013-11-15 15:52:39 +00005234 combinedFlags = pA->flags | pB->flags;
5235 if( combinedFlags & EP_IntValue ){
5236 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5237 return 0;
5238 }
drh1d9da702010-01-07 15:17:02 +00005239 return 2;
drh22827922000-06-06 17:27:05 +00005240 }
dan16dd3982018-12-20 15:04:38 +00005241 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005242 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005243 return 1;
5244 }
dan5aa550c2017-06-24 18:10:29 +00005245 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005246 return 1;
5247 }
5248 return 2;
5249 }
drh2edc5fd2015-11-24 02:10:52 +00005250 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005251 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005252 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005253#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005254 assert( pA->op==pB->op );
5255 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5256 return 2;
5257 }
drheda079c2018-09-20 19:02:15 +00005258 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005259 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5260 return 2;
5261 }
drheda079c2018-09-20 19:02:15 +00005262 }
5263#endif
drhf20bbc52019-01-17 01:06:00 +00005264 }else if( pA->op==TK_NULL ){
5265 return 0;
drhd5af5422018-04-13 14:27:01 +00005266 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005267 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005268 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005269 return 2;
drh2646da72005-12-09 20:02:05 +00005270 }
drh22827922000-06-06 17:27:05 +00005271 }
drh898c5272019-10-22 00:03:41 +00005272 if( (pA->flags & (EP_Distinct|EP_Commuted))
5273 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005274 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005275 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005276 if( (combinedFlags & EP_FixedCol)==0
5277 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005278 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005279 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005280 if( pA->op!=TK_STRING
5281 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005282 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005283 ){
drh10d1edf2013-11-15 15:52:39 +00005284 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005285 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005286 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5287 return 2;
5288 }
drh10d1edf2013-11-15 15:52:39 +00005289 }
5290 }
drh1d9da702010-01-07 15:17:02 +00005291 return 0;
drh22827922000-06-06 17:27:05 +00005292}
5293
drh8c6f6662010-04-26 19:17:26 +00005294/*
danfbb6e9f2020-01-09 20:11:29 +00005295** Compare two ExprList objects. Return 0 if they are identical, 1
5296** if they are certainly different, or 2 if it is not possible to
5297** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005298**
drh619a1302013-08-01 13:04:46 +00005299** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5300** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5301**
drh8c6f6662010-04-26 19:17:26 +00005302** This routine might return non-zero for equivalent ExprLists. The
5303** only consequence will be disabled optimizations. But this routine
5304** must never return 0 if the two ExprList objects are different, or
5305** a malfunction will result.
5306**
5307** Two NULL pointers are considered to be the same. But a NULL pointer
5308** always differs from a non-NULL pointer.
5309*/
drh619a1302013-08-01 13:04:46 +00005310int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005311 int i;
5312 if( pA==0 && pB==0 ) return 0;
5313 if( pA==0 || pB==0 ) return 1;
5314 if( pA->nExpr!=pB->nExpr ) return 1;
5315 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005316 int res;
drh8c6f6662010-04-26 19:17:26 +00005317 Expr *pExprA = pA->a[i].pExpr;
5318 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005319 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005320 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005321 }
5322 return 0;
5323}
drh13449892005-09-07 21:22:45 +00005324
drh22827922000-06-06 17:27:05 +00005325/*
drhf9463df2017-02-11 14:59:58 +00005326** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5327** are ignored.
5328*/
5329int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005330 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005331 sqlite3ExprSkipCollateAndLikely(pA),
5332 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005333 iTab);
5334}
5335
5336/*
drhc51cf862019-05-11 19:36:03 +00005337** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005338**
5339** Or if seenNot is true, return non-zero if Expr p can only be
5340** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005341*/
5342static int exprImpliesNotNull(
5343 Parse *pParse, /* Parsing context */
5344 Expr *p, /* The expression to be checked */
5345 Expr *pNN, /* The expression that is NOT NULL */
5346 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005347 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005348){
5349 assert( p );
5350 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005351 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5352 return pNN->op!=TK_NULL;
5353 }
drhc51cf862019-05-11 19:36:03 +00005354 switch( p->op ){
5355 case TK_IN: {
5356 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5357 assert( ExprHasProperty(p,EP_xIsSelect)
5358 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005359 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005360 }
5361 case TK_BETWEEN: {
5362 ExprList *pList = p->x.pList;
5363 assert( pList!=0 );
5364 assert( pList->nExpr==2 );
5365 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005366 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5367 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005368 ){
5369 return 1;
5370 }
drh7a231b42019-08-30 15:11:08 +00005371 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005372 }
5373 case TK_EQ:
5374 case TK_NE:
5375 case TK_LT:
5376 case TK_LE:
5377 case TK_GT:
5378 case TK_GE:
5379 case TK_PLUS:
5380 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005381 case TK_BITOR:
5382 case TK_LSHIFT:
5383 case TK_RSHIFT:
5384 case TK_CONCAT:
5385 seenNot = 1;
5386 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005387 case TK_STAR:
5388 case TK_REM:
5389 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005390 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005391 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5392 /* Fall thru into the next case */
5393 }
5394 case TK_SPAN:
5395 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005396 case TK_UPLUS:
5397 case TK_UMINUS: {
5398 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5399 }
5400 case TK_TRUTH: {
5401 if( seenNot ) return 0;
5402 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005403 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005404 }
dan1cd382e2019-08-29 15:06:35 +00005405 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005406 case TK_NOT: {
5407 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5408 }
5409 }
5410 return 0;
5411}
5412
5413/*
drh4bd5f732013-07-31 23:22:39 +00005414** Return true if we can prove the pE2 will always be true if pE1 is
5415** true. Return false if we cannot complete the proof or if pE2 might
5416** be false. Examples:
5417**
drh619a1302013-08-01 13:04:46 +00005418** pE1: x==5 pE2: x==5 Result: true
5419** pE1: x>0 pE2: x==5 Result: false
5420** pE1: x=21 pE2: x=21 OR y=43 Result: true
5421** pE1: x!=123 pE2: x IS NOT NULL Result: true
5422** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5423** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5424** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005425**
5426** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5427** Expr.iTable<0 then assume a table number given by iTab.
5428**
drhc0804222017-06-28 21:47:16 +00005429** If pParse is not NULL, then the values of bound variables in pE1 are
5430** compared against literal values in pE2 and pParse->pVdbe->expmask is
5431** modified to record which bound variables are referenced. If pParse
5432** is NULL, then false will be returned if pE1 contains any bound variables.
5433**
drh4bd5f732013-07-31 23:22:39 +00005434** When in doubt, return false. Returning true might give a performance
5435** improvement. Returning false might cause a performance reduction, but
5436** it will always give the correct answer and is hence always safe.
5437*/
dan5aa550c2017-06-24 18:10:29 +00005438int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5439 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005440 return 1;
5441 }
5442 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005443 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5444 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005445 ){
5446 return 1;
5447 }
drh664d6d12019-05-04 17:32:07 +00005448 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005449 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005450 ){
drhc51cf862019-05-11 19:36:03 +00005451 return 1;
drh619a1302013-08-01 13:04:46 +00005452 }
5453 return 0;
drh4bd5f732013-07-31 23:22:39 +00005454}
5455
5456/*
drh6c68d752019-11-04 02:05:52 +00005457** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005458** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005459** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5460**
5461** This routine controls an optimization. False positives (setting
5462** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5463** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005464*/
5465static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005466 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005467 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005468 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5469 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005470 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005471 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005472 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005473 case TK_IS:
5474 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005475 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005476 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005477 case TK_IN:
drh25897872018-03-20 21:16:15 +00005478 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005479 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005480 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005481 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005482 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005483 testcase( pExpr->op==TK_IS );
5484 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005485 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005486 testcase( pExpr->op==TK_CASE );
5487 testcase( pExpr->op==TK_IN );
5488 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005489 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005490 return WRC_Prune;
5491 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005492 if( pWalker->u.iCur==pExpr->iTable ){
5493 pWalker->eCode = 1;
5494 return WRC_Abort;
5495 }
5496 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005497
dan9d23ea72019-08-29 19:34:29 +00005498 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005499 if( pWalker->eCode==0 ){
5500 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5501 if( pWalker->eCode ){
5502 pWalker->eCode = 0;
5503 sqlite3WalkExpr(pWalker, pExpr->pRight);
5504 }
dan9d23ea72019-08-29 19:34:29 +00005505 }
5506 return WRC_Prune;
5507
5508 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005509 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5510 assert( pWalker->eCode );
5511 return WRC_Abort;
5512 }
dan9d23ea72019-08-29 19:34:29 +00005513 return WRC_Prune;
5514
drh98811552018-04-03 14:04:48 +00005515 /* Virtual tables are allowed to use constraints like x=NULL. So
5516 ** a term of the form x=y does not prove that y is not null if x
5517 ** is the column of a virtual table */
5518 case TK_EQ:
5519 case TK_NE:
5520 case TK_LT:
5521 case TK_LE:
5522 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005523 case TK_GE: {
5524 Expr *pLeft = pExpr->pLeft;
5525 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005526 testcase( pExpr->op==TK_EQ );
5527 testcase( pExpr->op==TK_NE );
5528 testcase( pExpr->op==TK_LT );
5529 testcase( pExpr->op==TK_LE );
5530 testcase( pExpr->op==TK_GT );
5531 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005532 /* The y.pTab=0 assignment in wherecode.c always happens after the
5533 ** impliesNotNullRow() test */
5534 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5535 && IsVirtual(pLeft->y.pTab))
5536 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5537 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005538 ){
drh78d1d222020-02-17 19:25:07 +00005539 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005540 }
drh78d1d222020-02-17 19:25:07 +00005541 }
drh25897872018-03-20 21:16:15 +00005542 default:
5543 return WRC_Continue;
5544 }
5545}
5546
5547/*
5548** Return true (non-zero) if expression p can only be true if at least
5549** one column of table iTab is non-null. In other words, return true
5550** if expression p will always be NULL or false if every column of iTab
5551** is NULL.
5552**
drh821b6102018-03-24 18:01:51 +00005553** False negatives are acceptable. In other words, it is ok to return
5554** zero even if expression p will never be true of every column of iTab
5555** is NULL. A false negative is merely a missed optimization opportunity.
5556**
5557** False positives are not allowed, however. A false positive may result
5558** in an incorrect answer.
5559**
drh25897872018-03-20 21:16:15 +00005560** Terms of p that are marked with EP_FromJoin (and hence that come from
5561** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5562**
5563** This routine is used to check if a LEFT JOIN can be converted into
5564** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5565** clause requires that some column of the right table of the LEFT JOIN
5566** be non-NULL, then the LEFT JOIN can be safely converted into an
5567** ordinary join.
5568*/
5569int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5570 Walker w;
drh0d950af2019-08-22 16:38:42 +00005571 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005572 if( p==0 ) return 0;
5573 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005574 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005575 }else{
5576 while( p->op==TK_AND ){
5577 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5578 p = p->pRight;
5579 }
drhd6db6592019-04-01 19:42:42 +00005580 }
drh25897872018-03-20 21:16:15 +00005581 w.xExprCallback = impliesNotNullRow;
5582 w.xSelectCallback = 0;
5583 w.xSelectCallback2 = 0;
5584 w.eCode = 0;
5585 w.u.iCur = iTab;
5586 sqlite3WalkExpr(&w, p);
5587 return w.eCode;
5588}
5589
5590/*
drh030796d2012-08-23 16:18:10 +00005591** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005592** to determine if an expression can be evaluated by reference to the
5593** index only, without having to do a search for the corresponding
5594** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5595** is the cursor for the table.
5596*/
5597struct IdxCover {
5598 Index *pIdx; /* The index to be tested for coverage */
5599 int iCur; /* Cursor number for the table corresponding to the index */
5600};
5601
5602/*
5603** Check to see if there are references to columns in table
5604** pWalker->u.pIdxCover->iCur can be satisfied using the index
5605** pWalker->u.pIdxCover->pIdx.
5606*/
5607static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5608 if( pExpr->op==TK_COLUMN
5609 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005610 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005611 ){
5612 pWalker->eCode = 1;
5613 return WRC_Abort;
5614 }
5615 return WRC_Continue;
5616}
5617
5618/*
drhe604ec02016-07-27 19:20:58 +00005619** Determine if an index pIdx on table with cursor iCur contains will
5620** the expression pExpr. Return true if the index does cover the
5621** expression and false if the pExpr expression references table columns
5622** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005623**
5624** An index covering an expression means that the expression can be
5625** evaluated using only the index and without having to lookup the
5626** corresponding table entry.
5627*/
5628int sqlite3ExprCoveredByIndex(
5629 Expr *pExpr, /* The index to be tested */
5630 int iCur, /* The cursor number for the corresponding table */
5631 Index *pIdx /* The index that might be used for coverage */
5632){
5633 Walker w;
5634 struct IdxCover xcov;
5635 memset(&w, 0, sizeof(w));
5636 xcov.iCur = iCur;
5637 xcov.pIdx = pIdx;
5638 w.xExprCallback = exprIdxCover;
5639 w.u.pIdxCover = &xcov;
5640 sqlite3WalkExpr(&w, pExpr);
5641 return !w.eCode;
5642}
5643
5644
5645/*
5646** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005647** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005648** aggregate function, in order to implement the
5649** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005650*/
drh030796d2012-08-23 16:18:10 +00005651struct SrcCount {
5652 SrcList *pSrc; /* One particular FROM clause in a nested query */
5653 int nThis; /* Number of references to columns in pSrcList */
5654 int nOther; /* Number of references to columns in other FROM clauses */
5655};
5656
5657/*
5658** Count the number of references to columns.
5659*/
5660static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005661 /* There was once a NEVER() on the second term on the grounds that
5662 ** sqlite3FunctionUsesThisSrc() was always called before
5663 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5664 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5665 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5666 ** FunctionUsesThisSrc() when creating a new sub-select. */
5667 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005668 int i;
drh030796d2012-08-23 16:18:10 +00005669 struct SrcCount *p = pWalker->u.pSrcCount;
5670 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005671 int nSrc = pSrc ? pSrc->nSrc : 0;
5672 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005673 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005674 }
drh655814d2015-01-09 01:27:29 +00005675 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005676 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005677 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5678 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005679 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005680 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005681 p->nOther++;
5682 }
drh374fdce2012-04-17 16:38:53 +00005683 }
drh030796d2012-08-23 16:18:10 +00005684 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005685}
5686
5687/*
drh030796d2012-08-23 16:18:10 +00005688** Determine if any of the arguments to the pExpr Function reference
5689** pSrcList. Return true if they do. Also return true if the function
5690** has no arguments or has only constant arguments. Return false if pExpr
5691** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005692*/
drh030796d2012-08-23 16:18:10 +00005693int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005694 Walker w;
drh030796d2012-08-23 16:18:10 +00005695 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005696 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005697 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005698 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005699 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005700 w.u.pSrcCount = &cnt;
5701 cnt.pSrc = pSrcList;
5702 cnt.nThis = 0;
5703 cnt.nOther = 0;
5704 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005705#ifndef SQLITE_OMIT_WINDOWFUNC
5706 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5707 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5708 }
5709#endif
drh030796d2012-08-23 16:18:10 +00005710 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005711}
5712
5713/*
drh13449892005-09-07 21:22:45 +00005714** Add a new element to the pAggInfo->aCol[] array. Return the index of
5715** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005716*/
drh17435752007-08-16 04:30:38 +00005717static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005718 int i;
drhcf643722007-03-27 13:36:37 +00005719 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005720 db,
drhcf643722007-03-27 13:36:37 +00005721 pInfo->aCol,
5722 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005723 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005724 &i
5725 );
drh13449892005-09-07 21:22:45 +00005726 return i;
5727}
5728
5729/*
5730** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5731** the new element. Return a negative number if malloc fails.
5732*/
drh17435752007-08-16 04:30:38 +00005733static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005734 int i;
drhcf643722007-03-27 13:36:37 +00005735 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005736 db,
drhcf643722007-03-27 13:36:37 +00005737 pInfo->aFunc,
5738 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005739 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005740 &i
5741 );
drh13449892005-09-07 21:22:45 +00005742 return i;
5743}
drh22827922000-06-06 17:27:05 +00005744
5745/*
drh7d10d5a2008-08-20 16:35:10 +00005746** This is the xExprCallback for a tree walker. It is used to
5747** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005748** for additional information.
drh22827922000-06-06 17:27:05 +00005749*/
drh7d10d5a2008-08-20 16:35:10 +00005750static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005751 int i;
drh7d10d5a2008-08-20 16:35:10 +00005752 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005753 Parse *pParse = pNC->pParse;
5754 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005755 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005756
drh25c3b8c2018-04-16 10:34:13 +00005757 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005758 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005759 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005760 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005761 testcase( pExpr->op==TK_AGG_COLUMN );
5762 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005763 /* Check to see if the column is in one of the tables in the FROM
5764 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005765 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005766 struct SrcList_item *pItem = pSrcList->a;
5767 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5768 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005769 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005770 if( pExpr->iTable==pItem->iCursor ){
5771 /* If we reach this point, it means that pExpr refers to a table
5772 ** that is in the FROM clause of the aggregate query.
5773 **
5774 ** Make an entry for the column in pAggInfo->aCol[] if there
5775 ** is not an entry there already.
5776 */
drh7f906d62007-03-12 23:48:52 +00005777 int k;
drh13449892005-09-07 21:22:45 +00005778 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005779 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005780 if( pCol->iTable==pExpr->iTable &&
5781 pCol->iColumn==pExpr->iColumn ){
5782 break;
5783 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005784 }
danielk19771e536952007-08-16 10:09:01 +00005785 if( (k>=pAggInfo->nColumn)
5786 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5787 ){
drh7f906d62007-03-12 23:48:52 +00005788 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005789 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005790 pCol->iTable = pExpr->iTable;
5791 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005792 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005793 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005794 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005795 if( pAggInfo->pGroupBy ){
5796 int j, n;
5797 ExprList *pGB = pAggInfo->pGroupBy;
5798 struct ExprList_item *pTerm = pGB->a;
5799 n = pGB->nExpr;
5800 for(j=0; j<n; j++, pTerm++){
5801 Expr *pE = pTerm->pExpr;
5802 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5803 pE->iColumn==pExpr->iColumn ){
5804 pCol->iSorterColumn = j;
5805 break;
5806 }
5807 }
5808 }
5809 if( pCol->iSorterColumn<0 ){
5810 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5811 }
5812 }
5813 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5814 ** because it was there before or because we just created it).
5815 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5816 ** pAggInfo->aCol[] entry.
5817 */
drhebb6a652013-09-12 23:42:22 +00005818 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005819 pExpr->pAggInfo = pAggInfo;
5820 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005821 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005822 break;
5823 } /* endif pExpr->iTable==pItem->iCursor */
5824 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005825 }
drh7d10d5a2008-08-20 16:35:10 +00005826 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005827 }
5828 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005829 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005830 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005831 ){
drh13449892005-09-07 21:22:45 +00005832 /* Check to see if pExpr is a duplicate of another aggregate
5833 ** function that is already in the pAggInfo structure
5834 */
5835 struct AggInfo_func *pItem = pAggInfo->aFunc;
5836 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005837 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005838 break;
5839 }
drh22827922000-06-06 17:27:05 +00005840 }
drh13449892005-09-07 21:22:45 +00005841 if( i>=pAggInfo->nFunc ){
5842 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5843 */
danielk197714db2662006-01-09 16:12:04 +00005844 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005845 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005846 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005847 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005848 pItem = &pAggInfo->aFunc[i];
5849 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005850 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005851 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005852 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005853 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005854 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005855 if( pExpr->flags & EP_Distinct ){
5856 pItem->iDistinct = pParse->nTab++;
5857 }else{
5858 pItem->iDistinct = -1;
5859 }
drh13449892005-09-07 21:22:45 +00005860 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005861 }
drh13449892005-09-07 21:22:45 +00005862 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5863 */
drhc5cd1242013-09-12 16:50:49 +00005864 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005865 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005866 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005867 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005868 return WRC_Prune;
5869 }else{
5870 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005871 }
drh22827922000-06-06 17:27:05 +00005872 }
5873 }
drh7d10d5a2008-08-20 16:35:10 +00005874 return WRC_Continue;
5875}
drh626a8792005-01-17 22:08:19 +00005876
5877/*
drhe8abb4c2012-11-02 18:24:57 +00005878** Analyze the pExpr expression looking for aggregate functions and
5879** for variables that need to be added to AggInfo object that pNC->pAggInfo
5880** points to. Additional entries are made on the AggInfo object as
5881** necessary.
drh626a8792005-01-17 22:08:19 +00005882**
5883** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005884** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005885*/
drhd2b3e232008-01-23 14:51:49 +00005886void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005887 Walker w;
5888 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00005889 w.xSelectCallback = sqlite3WalkerDepthIncrease;
5890 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00005891 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005892 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005893 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005894 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005895 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005896}
drh5d9a4af2005-08-30 00:54:01 +00005897
5898/*
5899** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5900** expression list. Return the number of errors.
5901**
5902** If an error is found, the analysis is cut short.
5903*/
drhd2b3e232008-01-23 14:51:49 +00005904void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005905 struct ExprList_item *pItem;
5906 int i;
drh5d9a4af2005-08-30 00:54:01 +00005907 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005908 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5909 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005910 }
5911 }
drh5d9a4af2005-08-30 00:54:01 +00005912}
drh892d3172008-01-10 03:46:36 +00005913
5914/*
drhceea3322009-04-23 13:22:42 +00005915** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005916*/
5917int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005918 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005919 return ++pParse->nMem;
5920 }
danielk19772f425f62008-07-04 09:41:39 +00005921 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005922}
drhceea3322009-04-23 13:22:42 +00005923
5924/*
5925** Deallocate a register, making available for reuse for some other
5926** purpose.
drhceea3322009-04-23 13:22:42 +00005927*/
drh892d3172008-01-10 03:46:36 +00005928void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00005929 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00005930 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00005931 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5932 pParse->aTempReg[pParse->nTempReg++] = iReg;
5933 }
drh892d3172008-01-10 03:46:36 +00005934 }
5935}
5936
5937/*
drhed24da42016-09-06 14:37:05 +00005938** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005939*/
5940int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005941 int i, n;
drhed24da42016-09-06 14:37:05 +00005942 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005943 i = pParse->iRangeReg;
5944 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005945 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005946 pParse->iRangeReg += nReg;
5947 pParse->nRangeReg -= nReg;
5948 }else{
5949 i = pParse->nMem+1;
5950 pParse->nMem += nReg;
5951 }
5952 return i;
5953}
5954void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005955 if( nReg==1 ){
5956 sqlite3ReleaseTempReg(pParse, iReg);
5957 return;
5958 }
drh3aef2fb2020-01-02 17:46:02 +00005959 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00005960 if( nReg>pParse->nRangeReg ){
5961 pParse->nRangeReg = nReg;
5962 pParse->iRangeReg = iReg;
5963 }
5964}
drhcdc69552011-12-06 13:24:59 +00005965
5966/*
5967** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005968**
5969** Always invoke this procedure after coding a subroutine or co-routine
5970** that might be invoked from other parts of the code, to ensure that
5971** the sub/co-routine does not use registers in common with the code that
5972** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005973*/
5974void sqlite3ClearTempRegCache(Parse *pParse){
5975 pParse->nTempReg = 0;
5976 pParse->nRangeReg = 0;
5977}
drhbb9b5f22016-03-19 00:35:02 +00005978
5979/*
5980** Validate that no temporary register falls within the range of
5981** iFirst..iLast, inclusive. This routine is only call from within assert()
5982** statements.
5983*/
5984#ifdef SQLITE_DEBUG
5985int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5986 int i;
5987 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005988 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5989 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005990 ){
5991 return 0;
5992 }
5993 for(i=0; i<pParse->nTempReg; i++){
5994 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5995 return 0;
5996 }
5997 }
5998 return 1;
5999}
6000#endif /* SQLITE_DEBUG */