blob: 8c0768bb7efaa293f52dffa61ad3a7750522d828 [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) ){
48 assert( pExpr->op==TK_COLLATE );
49 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
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) ){
115 assert( pExpr->op==TK_COLLATE );
116 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{
drh0b8d2552015-09-05 22:36:07 +0000134 assert( pExpr->op==TK_COLLATE );
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 );
1790 if( pList ){
1791 struct ExprList_item *pItem;
1792 assert( pList->nExpr>0 );
1793 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001794 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001795 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001796 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1797 if( dequote ) sqlite3Dequote(pItem->zEName);
danc9461ec2018-08-29 21:00:16 +00001798 if( IN_RENAME_OBJECT ){
drh41cee662019-12-12 20:22:34 +00001799 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
dan5be60c52018-08-15 20:28:39 +00001800 }
drhb7916a72009-05-27 10:31:29 +00001801 }
1802}
1803
1804/*
1805** Set the ExprList.a[].zSpan element of the most recently added item
1806** on the expression list.
1807**
1808** pList might be NULL following an OOM error. But pSpan should never be
1809** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1810** is set.
1811*/
1812void sqlite3ExprListSetSpan(
1813 Parse *pParse, /* Parsing context */
1814 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001815 const char *zStart, /* Start of the span */
1816 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001817){
1818 sqlite3 *db = pParse->db;
1819 assert( pList!=0 || db->mallocFailed!=0 );
1820 if( pList ){
1821 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1822 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001823 if( pItem->zEName==0 ){
1824 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1825 pItem->eEName = ENAME_SPAN;
1826 }
drhb7916a72009-05-27 10:31:29 +00001827 }
1828}
1829
1830/*
danielk19777a15a4b2007-05-08 17:54:43 +00001831** If the expression list pEList contains more than iLimit elements,
1832** leave an error message in pParse.
1833*/
1834void sqlite3ExprListCheckLength(
1835 Parse *pParse,
1836 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001837 const char *zObject
1838){
drhb1a6c3c2008-03-20 16:30:17 +00001839 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001840 testcase( pEList && pEList->nExpr==mx );
1841 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001842 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001843 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1844 }
1845}
1846
1847/*
drha76b5df2002-02-23 02:32:10 +00001848** Delete an entire expression list.
1849*/
drhaffa8552016-04-11 18:25:05 +00001850static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001851 int i = pList->nExpr;
1852 struct ExprList_item *pItem = pList->a;
1853 assert( pList->nExpr>0 );
1854 do{
drh633e6d52008-07-28 19:34:53 +00001855 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001856 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001857 pItem++;
1858 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001859 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001860}
drhaffa8552016-04-11 18:25:05 +00001861void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1862 if( pList ) exprListDeleteNN(db, pList);
1863}
drha76b5df2002-02-23 02:32:10 +00001864
1865/*
drh2308ed32015-02-09 16:09:34 +00001866** Return the bitwise-OR of all Expr.flags fields in the given
1867** ExprList.
drh885a5b02015-02-09 15:21:36 +00001868*/
drh2308ed32015-02-09 16:09:34 +00001869u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001870 int i;
drh2308ed32015-02-09 16:09:34 +00001871 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001872 assert( pList!=0 );
1873 for(i=0; i<pList->nExpr; i++){
1874 Expr *pExpr = pList->a[i].pExpr;
1875 assert( pExpr!=0 );
1876 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001877 }
drh2308ed32015-02-09 16:09:34 +00001878 return m;
drh885a5b02015-02-09 15:21:36 +00001879}
1880
1881/*
drh7e6f9802017-09-04 00:33:04 +00001882** This is a SELECT-node callback for the expression walker that
1883** always "fails". By "fail" in this case, we mean set
1884** pWalker->eCode to zero and abort.
1885**
1886** This callback is used by multiple expression walkers.
1887*/
1888int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1889 UNUSED_PARAMETER(NotUsed);
1890 pWalker->eCode = 0;
1891 return WRC_Abort;
1892}
1893
1894/*
drh0cbec592020-01-03 02:20:37 +00001895** Check the input string to see if it is "true" or "false" (in any case).
1896**
1897** If the string is.... Return
1898** "true" EP_IsTrue
1899** "false" EP_IsFalse
1900** anything else 0
1901*/
1902u32 sqlite3IsTrueOrFalse(const char *zIn){
1903 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1904 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1905 return 0;
1906}
1907
1908
1909/*
drh171d16b2018-02-26 20:15:54 +00001910** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001911** then convert it into an TK_TRUEFALSE term. Return non-zero if
1912** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001913*/
1914int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001915 u32 v;
drh171d16b2018-02-26 20:15:54 +00001916 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001917 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001918 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001919 ){
1920 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001921 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001922 return 1;
1923 }
1924 return 0;
1925}
1926
drh43c4ac82018-02-26 21:26:27 +00001927/*
drh96acafb2018-02-27 14:49:25 +00001928** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001929** and 0 if it is FALSE.
1930*/
drh96acafb2018-02-27 14:49:25 +00001931int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001932 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001933 assert( pExpr->op==TK_TRUEFALSE );
1934 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1935 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1936 return pExpr->u.zToken[4]==0;
1937}
1938
drh17180fc2019-04-19 17:26:19 +00001939/*
1940** If pExpr is an AND or OR expression, try to simplify it by eliminating
1941** terms that are always true or false. Return the simplified expression.
1942** Or return the original expression if no simplification is possible.
1943**
1944** Examples:
1945**
1946** (x<10) AND true => (x<10)
1947** (x<10) AND false => false
1948** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1949** (x<10) AND (y=22 OR true) => (x<10)
1950** (y=22) OR true => true
1951*/
1952Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1953 assert( pExpr!=0 );
1954 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1955 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1956 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1957 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1958 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1959 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1960 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1961 }
1962 }
1963 return pExpr;
1964}
1965
drh171d16b2018-02-26 20:15:54 +00001966
1967/*
drh059b2d52014-10-24 19:28:09 +00001968** These routines are Walker callbacks used to check expressions to
1969** see if they are "constant" for some definition of constant. The
1970** Walker.eCode value determines the type of "constant" we are looking
1971** for.
drh73b211a2005-01-18 04:00:42 +00001972**
drh7d10d5a2008-08-20 16:35:10 +00001973** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001974**
drh059b2d52014-10-24 19:28:09 +00001975** sqlite3ExprIsConstant() pWalker->eCode==1
1976** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001977** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001978** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001979**
drh059b2d52014-10-24 19:28:09 +00001980** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1981** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001982**
drh014fff22020-01-08 22:22:36 +00001983** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1984** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
1985** when parsing an existing schema out of the sqlite_master table and 4
1986** when processing a new CREATE TABLE statement. A bound parameter raises
1987** an error for new statements, but is silently converted
drhfeada2d2014-09-24 13:20:22 +00001988** to NULL for existing schemas. This allows sqlite_master tables that
1989** contain a bound parameter because they were generated by older versions
1990** of SQLite to be parsed by newer versions of SQLite without raising a
1991** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001992*/
drh7d10d5a2008-08-20 16:35:10 +00001993static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001994
drh059b2d52014-10-24 19:28:09 +00001995 /* If pWalker->eCode is 2 then any term of the expression that comes from
1996 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001997 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001998 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1999 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002000 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002001 }
2002
drh626a8792005-01-17 22:08:19 +00002003 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002004 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002005 ** and either pWalker->eCode==4 or 5 or the function has the
2006 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002007 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002008 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2009 && !ExprHasProperty(pExpr, EP_WinFunc)
2010 ){
drh014fff22020-01-08 22:22:36 +00002011 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002012 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002013 }else{
2014 pWalker->eCode = 0;
2015 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002016 }
drh626a8792005-01-17 22:08:19 +00002017 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002018 /* Convert "true" or "false" in a DEFAULT clause into the
2019 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002020 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002021 return WRC_Prune;
2022 }
2023 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00002024 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002025 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002026 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002027 testcase( pExpr->op==TK_ID );
2028 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002029 testcase( pExpr->op==TK_AGG_FUNCTION );
2030 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002031 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002032 return WRC_Continue;
2033 }
drh059b2d52014-10-24 19:28:09 +00002034 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2035 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002036 }
drhf43ce0b2017-05-25 00:08:48 +00002037 /* Fall through */
2038 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002039 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00002040 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002041 testcase( pExpr->op==TK_IF_NULL_ROW );
2042 pWalker->eCode = 0;
2043 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002044 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002045 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002046 /* Silently convert bound parameters that appear inside of CREATE
2047 ** statements into a NULL when parsing the CREATE statement text out
2048 ** of the sqlite_master table */
2049 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002050 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002051 /* A bound parameter in a CREATE statement that originates from
2052 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002053 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002054 return WRC_Abort;
2055 }
2056 /* Fall through */
drh626a8792005-01-17 22:08:19 +00002057 default:
drh6e341b92018-04-17 18:50:40 +00002058 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2059 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002060 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002061 }
2062}
drh059b2d52014-10-24 19:28:09 +00002063static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002064 Walker w;
drh059b2d52014-10-24 19:28:09 +00002065 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002066 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002067 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002068#ifdef SQLITE_DEBUG
2069 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2070#endif
drh059b2d52014-10-24 19:28:09 +00002071 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002072 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002073 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002074}
drh626a8792005-01-17 22:08:19 +00002075
2076/*
drh059b2d52014-10-24 19:28:09 +00002077** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002078** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002079**
2080** For the purposes of this function, a double-quoted string (ex: "abc")
2081** is considered a variable but a single-quoted string (ex: 'abc') is
2082** a constant.
drhfef52082000-06-06 01:50:43 +00002083*/
danielk19774adee202004-05-08 08:23:19 +00002084int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002085 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002086}
2087
2088/*
drh07aded62018-07-28 16:24:08 +00002089** Walk an expression tree. Return non-zero if
2090**
2091** (1) the expression is constant, and
2092** (2) the expression does originate in the ON or USING clause
2093** of a LEFT JOIN, and
2094** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2095** operands created by the constant propagation optimization.
2096**
2097** When this routine returns true, it indicates that the expression
2098** can be added to the pParse->pConstExpr list and evaluated once when
2099** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002100*/
2101int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002102 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002103}
2104
2105/*
drhfcb9f4f2015-06-01 18:13:16 +00002106** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002107** for any single row of the table with cursor iCur. In other words, the
2108** expression must not refer to any non-deterministic function nor any
2109** table other than iCur.
2110*/
2111int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2112 return exprIsConst(p, 3, iCur);
2113}
2114
danab31a842017-04-29 20:53:09 +00002115
2116/*
2117** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2118*/
2119static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2120 ExprList *pGroupBy = pWalker->u.pGroupBy;
2121 int i;
2122
2123 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2124 ** it constant. */
2125 for(i=0; i<pGroupBy->nExpr; i++){
2126 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002127 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002128 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002129 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002130 return WRC_Prune;
2131 }
2132 }
2133 }
2134
2135 /* Check if pExpr is a sub-select. If so, consider it variable. */
2136 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2137 pWalker->eCode = 0;
2138 return WRC_Abort;
2139 }
2140
2141 return exprNodeIsConstant(pWalker, pExpr);
2142}
2143
2144/*
2145** Walk the expression tree passed as the first argument. Return non-zero
2146** if the expression consists entirely of constants or copies of terms
2147** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002148**
2149** This routine is used to determine if a term of the HAVING clause can
2150** be promoted into the WHERE clause. In order for such a promotion to work,
2151** the value of the HAVING clause term must be the same for all members of
2152** a "group". The requirement that the GROUP BY term must be BINARY
2153** assumes that no other collating sequence will have a finer-grained
2154** grouping than binary. In other words (A=B COLLATE binary) implies
2155** A=B in every other collating sequence. The requirement that the
2156** GROUP BY be BINARY is stricter than necessary. It would also work
2157** to promote HAVING clauses that use the same alternative collating
2158** sequence as the GROUP BY term, but that is much harder to check,
2159** alternative collating sequences are uncommon, and this is only an
2160** optimization, so we take the easy way out and simply require the
2161** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002162*/
2163int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2164 Walker w;
danab31a842017-04-29 20:53:09 +00002165 w.eCode = 1;
2166 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002167 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002168 w.u.pGroupBy = pGroupBy;
2169 w.pParse = pParse;
2170 sqlite3WalkExpr(&w, p);
2171 return w.eCode;
2172}
2173
drh059b2d52014-10-24 19:28:09 +00002174/*
drh014fff22020-01-08 22:22:36 +00002175** Walk an expression tree for the DEFAULT field of a column definition
2176** in a CREATE TABLE statement. Return non-zero if the expression is
2177** acceptable for use as a DEFAULT. That is to say, return non-zero if
2178** the expression is constant or a function call with constant arguments.
2179** Return and 0 if there are any variables.
2180**
2181** isInit is true when parsing from sqlite_master. isInit is false when
2182** processing a new CREATE TABLE statement. When isInit is true, parameters
2183** (such as ? or $abc) in the expression are converted into NULL. When
2184** isInit is false, parameters raise an error. Parameters should not be
2185** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
2186** allowed it, so we need to support it when reading sqlite_master for
2187** backwards compatibility.
2188**
2189** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002190**
2191** For the purposes of this function, a double-quoted string (ex: "abc")
2192** is considered a variable but a single-quoted string (ex: 'abc') is
2193** a constant.
2194*/
drhfeada2d2014-09-24 13:20:22 +00002195int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2196 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002197 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002198}
2199
drh5b88bc42013-12-07 23:35:21 +00002200#ifdef SQLITE_ENABLE_CURSOR_HINTS
2201/*
2202** Walk an expression tree. Return 1 if the expression contains a
2203** subquery of some kind. Return 0 if there are no subqueries.
2204*/
2205int sqlite3ExprContainsSubquery(Expr *p){
2206 Walker w;
drhbec24762015-08-13 20:07:13 +00002207 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002208 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002209 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002210#ifdef SQLITE_DEBUG
2211 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2212#endif
drh5b88bc42013-12-07 23:35:21 +00002213 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002214 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002215}
2216#endif
2217
drheb55bd22005-06-30 17:04:21 +00002218/*
drh73b211a2005-01-18 04:00:42 +00002219** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002220** to fit in a 32-bit integer, return 1 and put the value of the integer
2221** in *pValue. If the expression is not an integer or if it is too big
2222** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002223*/
danielk19774adee202004-05-08 08:23:19 +00002224int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002225 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002226 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002227
2228 /* If an expression is an integer literal that fits in a signed 32-bit
2229 ** integer, then the EP_IntValue flag will have already been set */
2230 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2231 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2232
drh92b01d52008-06-24 00:32:35 +00002233 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002234 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002235 return 1;
2236 }
drhe4de1fe2002-06-02 16:09:01 +00002237 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002238 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002239 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002240 break;
drh4b59ab52002-08-24 18:24:51 +00002241 }
drhe4de1fe2002-06-02 16:09:01 +00002242 case TK_UMINUS: {
2243 int v;
danielk19774adee202004-05-08 08:23:19 +00002244 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002245 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002246 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002247 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002248 }
2249 break;
2250 }
2251 default: break;
2252 }
drh92b01d52008-06-24 00:32:35 +00002253 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002254}
2255
2256/*
drh039fc322009-11-17 18:31:47 +00002257** Return FALSE if there is no chance that the expression can be NULL.
2258**
2259** If the expression might be NULL or if the expression is too complex
2260** to tell return TRUE.
2261**
2262** This routine is used as an optimization, to skip OP_IsNull opcodes
2263** when we know that a value cannot be NULL. Hence, a false positive
2264** (returning TRUE when in fact the expression can never be NULL) might
2265** be a small performance hit but is otherwise harmless. On the other
2266** hand, a false negative (returning FALSE when the result could be NULL)
2267** will likely result in an incorrect answer. So when in doubt, return
2268** TRUE.
2269*/
2270int sqlite3ExprCanBeNull(const Expr *p){
2271 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002272 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2273 p = p->pLeft;
2274 }
drh039fc322009-11-17 18:31:47 +00002275 op = p->op;
2276 if( op==TK_REGISTER ) op = p->op2;
2277 switch( op ){
2278 case TK_INTEGER:
2279 case TK_STRING:
2280 case TK_FLOAT:
2281 case TK_BLOB:
2282 return 0;
drh7248a8b2014-08-04 18:50:54 +00002283 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002284 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002285 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002286 (p->iColumn>=0
2287 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2288 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002289 default:
2290 return 1;
2291 }
2292}
2293
2294/*
2295** Return TRUE if the given expression is a constant which would be
2296** unchanged by OP_Affinity with the affinity given in the second
2297** argument.
2298**
2299** This routine is used to determine if the OP_Affinity operation
2300** can be omitted. When in doubt return FALSE. A false negative
2301** is harmless. A false positive, however, can result in the wrong
2302** answer.
2303*/
2304int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2305 u8 op;
drhaf866402019-08-22 11:11:28 +00002306 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002307 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002308 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2309 if( p->op==TK_UMINUS ) unaryMinus = 1;
2310 p = p->pLeft;
2311 }
drh039fc322009-11-17 18:31:47 +00002312 op = p->op;
2313 if( op==TK_REGISTER ) op = p->op2;
2314 switch( op ){
2315 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002316 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002317 }
2318 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002319 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002320 }
2321 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002322 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002323 }
2324 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002325 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002326 }
drh2f2855b2009-11-18 01:25:26 +00002327 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002328 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002329 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002330 }
drh039fc322009-11-17 18:31:47 +00002331 default: {
2332 return 0;
2333 }
2334 }
2335}
2336
2337/*
drhc4a3c772001-04-04 11:48:57 +00002338** Return TRUE if the given string is a row-id column name.
2339*/
danielk19774adee202004-05-08 08:23:19 +00002340int sqlite3IsRowid(const char *z){
2341 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2342 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2343 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002344 return 0;
2345}
2346
danielk19779a96b662007-11-29 17:05:18 +00002347/*
drh69c355b2016-03-09 15:34:51 +00002348** pX is the RHS of an IN operator. If pX is a SELECT statement
2349** that can be simplified to a direct table access, then return
2350** a pointer to the SELECT statement. If pX is not a SELECT statement,
2351** or if the SELECT statement needs to be manifested into a transient
2352** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002353*/
2354#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002355static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002356 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002357 SrcList *pSrc;
2358 ExprList *pEList;
2359 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002360 int i;
drh69c355b2016-03-09 15:34:51 +00002361 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2362 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2363 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002364 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002365 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002366 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2367 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2368 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002369 }
drh2e26a602020-01-06 18:59:46 +00002370 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002371 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002372 if( p->pWhere ) return 0; /* Has no WHERE clause */
2373 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002374 assert( pSrc!=0 );
2375 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002376 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002377 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002378 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002379 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002380 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2381 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002382 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002383 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002384 for(i=0; i<pEList->nExpr; i++){
2385 Expr *pRes = pEList->a[i].pExpr;
2386 if( pRes->op!=TK_COLUMN ) return 0;
2387 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002388 }
drh69c355b2016-03-09 15:34:51 +00002389 return p;
drhb287f4b2008-04-25 00:08:38 +00002390}
2391#endif /* SQLITE_OMIT_SUBQUERY */
2392
danf9b2e052016-08-02 17:45:00 +00002393#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002394/*
drh4c259e92014-08-01 21:12:35 +00002395** Generate code that checks the left-most column of index table iCur to see if
2396** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002397** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2398** to be set to NULL if iCur contains one or more NULL values.
2399*/
2400static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002401 int addr1;
drh6be515e2014-08-01 21:00:53 +00002402 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002403 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002404 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2405 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002406 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002407 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002408}
danf9b2e052016-08-02 17:45:00 +00002409#endif
drh6be515e2014-08-01 21:00:53 +00002410
drhbb53ecb2014-08-02 21:03:33 +00002411
2412#ifndef SQLITE_OMIT_SUBQUERY
2413/*
2414** The argument is an IN operator with a list (not a subquery) on the
2415** right-hand side. Return TRUE if that list is constant.
2416*/
2417static int sqlite3InRhsIsConstant(Expr *pIn){
2418 Expr *pLHS;
2419 int res;
2420 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2421 pLHS = pIn->pLeft;
2422 pIn->pLeft = 0;
2423 res = sqlite3ExprIsConstant(pIn);
2424 pIn->pLeft = pLHS;
2425 return res;
2426}
2427#endif
2428
drh6be515e2014-08-01 21:00:53 +00002429/*
danielk19779a96b662007-11-29 17:05:18 +00002430** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002431** The pX parameter is the expression on the RHS of the IN operator, which
2432** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002433**
drhd4305ca2012-09-18 17:08:33 +00002434** The job of this routine is to find or create a b-tree object that can
2435** be used either to test for membership in the RHS set or to iterate through
2436** all members of the RHS set, skipping duplicates.
2437**
drh3a856252014-08-01 14:46:57 +00002438** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002439** and pX->iTable is set to the index of that cursor.
2440**
drhb74b1012009-05-28 21:04:37 +00002441** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002442**
drh1ccce442013-03-12 20:38:51 +00002443** IN_INDEX_ROWID - The cursor was opened on a database table.
2444** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2445** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2446** IN_INDEX_EPH - The cursor was opened on a specially created and
2447** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002448** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2449** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002450**
drhd4305ca2012-09-18 17:08:33 +00002451** An existing b-tree might be used if the RHS expression pX is a simple
2452** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002453**
dan553168c2016-08-01 20:14:31 +00002454** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002455**
drhd4305ca2012-09-18 17:08:33 +00002456** If the RHS of the IN operator is a list or a more complex subquery, then
2457** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002458** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002459** existing table.
drhd4305ca2012-09-18 17:08:33 +00002460**
drh7fc0ba02017-11-17 15:02:00 +00002461** The inFlags parameter must contain, at a minimum, one of the bits
2462** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2463** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2464** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2465** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002466**
2467** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2468** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002469** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002470** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2471** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002472**
drh3a856252014-08-01 14:46:57 +00002473** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2474** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002475** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2476** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002477**
drhbb53ecb2014-08-02 21:03:33 +00002478** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2479** if the RHS of the IN operator is a list (not a subquery) then this
2480** routine might decide that creating an ephemeral b-tree for membership
2481** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2482** calling routine should implement the IN operator using a sequence
2483** of Eq or Ne comparison operations.
2484**
drhb74b1012009-05-28 21:04:37 +00002485** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002486** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002487** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002488** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002489** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002490** to *prRhsHasNull. If there is no chance that the (...) contains a
2491** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002492**
drhe21a6e12014-08-01 18:00:24 +00002493** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002494** the value in that register will be NULL if the b-tree contains one or more
2495** NULL values, and it will be some non-NULL value if the b-tree contains no
2496** NULL values.
dan553168c2016-08-01 20:14:31 +00002497**
2498** If the aiMap parameter is not NULL, it must point to an array containing
2499** one element for each column returned by the SELECT statement on the RHS
2500** of the IN(...) operator. The i'th entry of the array is populated with the
2501** offset of the index column that matches the i'th column returned by the
2502** SELECT. For example, if the expression and selected index are:
2503**
2504** (?,?,?) IN (SELECT a, b, c FROM t1)
2505** CREATE INDEX i1 ON t1(b, c, a);
2506**
2507** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002508*/
danielk1977284f4ac2007-12-10 05:03:46 +00002509#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002510int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002511 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002512 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002513 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2514 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002515 int *aiMap, /* Mapping from Index fields to RHS fields */
2516 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002517){
drhb74b1012009-05-28 21:04:37 +00002518 Select *p; /* SELECT to the right of IN operator */
2519 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2520 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002521 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002522 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002523
drh1450bc62009-10-30 13:25:56 +00002524 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002525 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002526
dan7b35a772016-07-28 19:47:15 +00002527 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2528 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002529 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002530 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002531 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002532 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2533 int i;
2534 ExprList *pEList = pX->x.pSelect->pEList;
2535 for(i=0; i<pEList->nExpr; i++){
2536 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2537 }
2538 if( i==pEList->nExpr ){
2539 prRhsHasNull = 0;
2540 }
2541 }
2542
drhb74b1012009-05-28 21:04:37 +00002543 /* Check to see if an existing table or index can be used to
2544 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002545 ** ephemeral table. */
2546 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002547 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002548 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002549 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002550 ExprList *pEList = p->pEList;
2551 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002552
drhb07028f2011-10-14 21:49:18 +00002553 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2554 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2555 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2556 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002557
drhb22f7c82014-02-06 23:56:27 +00002558 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002559 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2560 sqlite3CodeVerifySchema(pParse, iDb);
2561 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002562
drha84a2832016-08-26 21:15:35 +00002563 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002564 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002565 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002566 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002567 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002568
2569 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2570 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002571 ExplainQueryPlan((pParse, 0,
2572 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002573 sqlite3VdbeJumpHere(v, iAddr);
2574 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002575 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002576 int affinity_ok = 1;
2577 int i;
2578
2579 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002580 ** comparison is the same as the affinity of each column in table
2581 ** on the RHS of the IN operator. If it not, it is not possible to
2582 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002583 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002584 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002585 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002586 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002587 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002588 testcase( cmpaff==SQLITE_AFF_BLOB );
2589 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002590 switch( cmpaff ){
2591 case SQLITE_AFF_BLOB:
2592 break;
2593 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002594 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2595 ** other has no affinity and the other side is TEXT. Hence,
2596 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2597 ** and for the term on the LHS of the IN to have no affinity. */
2598 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002599 break;
2600 default:
2601 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2602 }
2603 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002604
drha84a2832016-08-26 21:15:35 +00002605 if( affinity_ok ){
2606 /* Search for an existing index that will work for this IN operator */
2607 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2608 Bitmask colUsed; /* Columns of the index used */
2609 Bitmask mCol; /* Mask for the current column */
2610 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002611 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002612 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2613 ** BITMASK(nExpr) without overflowing */
2614 testcase( pIdx->nColumn==BMS-2 );
2615 testcase( pIdx->nColumn==BMS-1 );
2616 if( pIdx->nColumn>=BMS-1 ) continue;
2617 if( mustBeUnique ){
2618 if( pIdx->nKeyCol>nExpr
2619 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2620 ){
2621 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002622 }
danielk19770cdc0222008-06-26 18:04:03 +00002623 }
drha84a2832016-08-26 21:15:35 +00002624
2625 colUsed = 0; /* Columns of index used so far */
2626 for(i=0; i<nExpr; i++){
2627 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2628 Expr *pRhs = pEList->a[i].pExpr;
2629 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2630 int j;
2631
2632 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2633 for(j=0; j<nExpr; j++){
2634 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2635 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002636 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2637 continue;
2638 }
drha84a2832016-08-26 21:15:35 +00002639 break;
2640 }
2641 if( j==nExpr ) break;
2642 mCol = MASKBIT(j);
2643 if( mCol & colUsed ) break; /* Each column used only once */
2644 colUsed |= mCol;
2645 if( aiMap ) aiMap[i] = j;
2646 }
2647
2648 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2649 if( colUsed==(MASKBIT(nExpr)-1) ){
2650 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002651 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002652 ExplainQueryPlan((pParse, 0,
2653 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002654 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2655 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2656 VdbeComment((v, "%s", pIdx->zName));
2657 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2658 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2659
2660 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002661#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002662 i64 mask = (1<<nExpr)-1;
2663 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2664 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002665#endif
2666 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002667 if( nExpr==1 ){
2668 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2669 }
2670 }
2671 sqlite3VdbeJumpHere(v, iAddr);
2672 }
2673 } /* End loop over indexes */
2674 } /* End if( affinity_ok ) */
2675 } /* End if not an rowid index */
2676 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002677
drhbb53ecb2014-08-02 21:03:33 +00002678 /* If no preexisting index is available for the IN clause
2679 ** and IN_INDEX_NOOP is an allowed reply
2680 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002681 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002682 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002683 ** the IN operator so return IN_INDEX_NOOP.
2684 */
2685 if( eType==0
2686 && (inFlags & IN_INDEX_NOOP_OK)
2687 && !ExprHasProperty(pX, EP_xIsSelect)
2688 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2689 ){
2690 eType = IN_INDEX_NOOP;
2691 }
drhbb53ecb2014-08-02 21:03:33 +00002692
danielk19779a96b662007-11-29 17:05:18 +00002693 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002694 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002695 ** We will have to generate an ephemeral table to do the job.
2696 */
drh8e23daf2013-06-11 13:30:04 +00002697 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002698 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002699 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002700 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002701 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002702 }else if( prRhsHasNull ){
2703 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002704 }
drh85bcdce2018-12-23 21:27:29 +00002705 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002706 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002707 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002708 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002709 }
drhcf4d38a2010-07-28 02:53:36 +00002710 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002711 }
danba00e302016-07-23 20:24:06 +00002712
2713 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2714 int i, n;
2715 n = sqlite3ExprVectorSize(pX->pLeft);
2716 for(i=0; i<n; i++) aiMap[i] = i;
2717 }
drh2c041312018-12-24 02:34:49 +00002718 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002719 return eType;
2720}
danielk1977284f4ac2007-12-10 05:03:46 +00002721#endif
drh626a8792005-01-17 22:08:19 +00002722
danf9b2e052016-08-02 17:45:00 +00002723#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002724/*
2725** Argument pExpr is an (?, ?...) IN(...) expression. This
2726** function allocates and returns a nul-terminated string containing
2727** the affinities to be used for each column of the comparison.
2728**
2729** It is the responsibility of the caller to ensure that the returned
2730** string is eventually freed using sqlite3DbFree().
2731*/
dan71c57db2016-07-09 20:23:55 +00002732static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2733 Expr *pLeft = pExpr->pLeft;
2734 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002735 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002736 char *zRet;
2737
dan553168c2016-08-01 20:14:31 +00002738 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002739 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002740 if( zRet ){
2741 int i;
2742 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002743 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002744 char a = sqlite3ExprAffinity(pA);
2745 if( pSelect ){
2746 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2747 }else{
2748 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002749 }
dan71c57db2016-07-09 20:23:55 +00002750 }
2751 zRet[nVal] = '\0';
2752 }
2753 return zRet;
2754}
danf9b2e052016-08-02 17:45:00 +00002755#endif
dan71c57db2016-07-09 20:23:55 +00002756
dan8da209b2016-07-26 18:06:08 +00002757#ifndef SQLITE_OMIT_SUBQUERY
2758/*
2759** Load the Parse object passed as the first argument with an error
2760** message of the form:
2761**
2762** "sub-select returns N columns - expected M"
2763*/
2764void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002765 if( pParse->nErr==0 ){
2766 const char *zFmt = "sub-select returns %d columns - expected %d";
2767 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2768 }
dan8da209b2016-07-26 18:06:08 +00002769}
2770#endif
2771
drh626a8792005-01-17 22:08:19 +00002772/*
dan44c56042016-12-07 15:38:37 +00002773** Expression pExpr is a vector that has been used in a context where
2774** it is not permitted. If pExpr is a sub-select vector, this routine
2775** loads the Parse object with a message of the form:
2776**
2777** "sub-select returns N columns - expected 1"
2778**
2779** Or, if it is a regular scalar vector:
2780**
2781** "row value misused"
2782*/
2783void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2784#ifndef SQLITE_OMIT_SUBQUERY
2785 if( pExpr->flags & EP_xIsSelect ){
2786 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2787 }else
2788#endif
2789 {
2790 sqlite3ErrorMsg(pParse, "row value misused");
2791 }
2792}
2793
drh85bcdce2018-12-23 21:27:29 +00002794#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002795/*
drh85bcdce2018-12-23 21:27:29 +00002796** Generate code that will construct an ephemeral table containing all terms
2797** in the RHS of an IN operator. The IN operator can be in either of two
2798** forms:
drh626a8792005-01-17 22:08:19 +00002799**
drh9cbe6352005-11-29 03:13:21 +00002800** x IN (4,5,11) -- IN operator with list on right-hand side
2801** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002802**
drh2c041312018-12-24 02:34:49 +00002803** The pExpr parameter is the IN operator. The cursor number for the
2804** constructed ephermeral table is returned. The first time the ephemeral
2805** table is computed, the cursor number is also stored in pExpr->iTable,
2806** however the cursor number returned might not be the same, as it might
2807** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002808**
drh85bcdce2018-12-23 21:27:29 +00002809** If the LHS expression ("x" in the examples) is a column value, or
2810** the SELECT statement returns a column value, then the affinity of that
2811** column is used to build the index keys. If both 'x' and the
2812** SELECT... statement are columns, then numeric affinity is used
2813** if either column has NUMERIC or INTEGER affinity. If neither
2814** 'x' nor the SELECT... statement are columns, then numeric affinity
2815** is used.
drhcce7d172000-05-31 15:34:51 +00002816*/
drh85bcdce2018-12-23 21:27:29 +00002817void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002818 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002819 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002820 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002821){
drh2c041312018-12-24 02:34:49 +00002822 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002823 int addr; /* Address of OP_OpenEphemeral instruction */
2824 Expr *pLeft; /* the LHS of the IN operator */
2825 KeyInfo *pKeyInfo = 0; /* Key information */
2826 int nVal; /* Size of vector pLeft */
2827 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002828
drh2c041312018-12-24 02:34:49 +00002829 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002830 assert( v!=0 );
2831
drh2c041312018-12-24 02:34:49 +00002832 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002833 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002834 **
2835 ** * The right-hand side is a correlated subquery
2836 ** * The right-hand side is an expression list containing variables
2837 ** * We are inside a trigger
2838 **
drh2c041312018-12-24 02:34:49 +00002839 ** If all of the above are false, then we can compute the RHS just once
2840 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002841 */
drhefb699f2018-12-24 11:55:44 +00002842 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002843 /* Reuse of the RHS is allowed */
2844 /* If this routine has already been coded, but the previous code
2845 ** might not have been invoked yet, so invoke it now as a subroutine.
2846 */
2847 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002848 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002849 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2850 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2851 pExpr->x.pSelect->selId));
2852 }
drh2c041312018-12-24 02:34:49 +00002853 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2854 pExpr->y.sub.iAddr);
2855 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002856 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002857 return;
2858 }
2859
2860 /* Begin coding the subroutine */
2861 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002862 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002863 pExpr->y.sub.regReturn = ++pParse->nMem;
2864 pExpr->y.sub.iAddr =
2865 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2866 VdbeComment((v, "return address"));
2867
2868 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002869 }
2870
drh85bcdce2018-12-23 21:27:29 +00002871 /* Check to see if this is a vector IN operator */
2872 pLeft = pExpr->pLeft;
2873 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002874
drh85bcdce2018-12-23 21:27:29 +00002875 /* Construct the ephemeral table that will contain the content of
2876 ** RHS of the IN operator.
2877 */
drh2c041312018-12-24 02:34:49 +00002878 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002879 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002880#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2881 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2882 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2883 }else{
2884 VdbeComment((v, "RHS of IN operator"));
2885 }
2886#endif
drh50ef6712019-02-22 23:29:56 +00002887 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002888
drh85bcdce2018-12-23 21:27:29 +00002889 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2890 /* Case 1: expr IN (SELECT ...)
2891 **
2892 ** Generate code to write the results of the select into the temporary
2893 ** table allocated and opened above.
2894 */
2895 Select *pSelect = pExpr->x.pSelect;
2896 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002897
drh2c041312018-12-24 02:34:49 +00002898 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2899 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002900 ));
drh85bcdce2018-12-23 21:27:29 +00002901 /* If the LHS and RHS of the IN operator do not match, that
2902 ** error will have been caught long before we reach this point. */
2903 if( ALWAYS(pEList->nExpr==nVal) ){
2904 SelectDest dest;
2905 int i;
drhbd462bc2018-12-24 20:21:06 +00002906 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002907 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2908 pSelect->iLimit = 0;
2909 testcase( pSelect->selFlags & SF_Distinct );
2910 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2911 if( sqlite3Select(pParse, pSelect, &dest) ){
2912 sqlite3DbFree(pParse->db, dest.zAffSdst);
2913 sqlite3KeyInfoUnref(pKeyInfo);
2914 return;
drhfef52082000-06-06 01:50:43 +00002915 }
drh85bcdce2018-12-23 21:27:29 +00002916 sqlite3DbFree(pParse->db, dest.zAffSdst);
2917 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2918 assert( pEList!=0 );
2919 assert( pEList->nExpr>0 );
2920 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2921 for(i=0; i<nVal; i++){
2922 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2923 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2924 pParse, p, pEList->a[i].pExpr
2925 );
danielk197741a05b72008-10-02 13:50:55 +00002926 }
drh85bcdce2018-12-23 21:27:29 +00002927 }
2928 }else if( ALWAYS(pExpr->x.pList!=0) ){
2929 /* Case 2: expr IN (exprlist)
2930 **
2931 ** For each expression, build an index key from the evaluation and
2932 ** store it in the temporary table. If <expr> is a column, then use
2933 ** that columns affinity when building index keys. If <expr> is not
2934 ** a column, use numeric affinity.
2935 */
2936 char affinity; /* Affinity of the LHS of the IN */
2937 int i;
2938 ExprList *pList = pExpr->x.pList;
2939 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002940 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002941 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002942 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002943 affinity = SQLITE_AFF_BLOB;
2944 }
2945 if( pKeyInfo ){
2946 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2947 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002948 }
2949
drh85bcdce2018-12-23 21:27:29 +00002950 /* Loop through each expression in <exprlist>. */
2951 r1 = sqlite3GetTempReg(pParse);
2952 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002953 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2954 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002955
2956 /* If the expression is not constant then we will need to
2957 ** disable the test that was generated above that makes sure
2958 ** this code only executes once. Because for a non-constant
2959 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002960 */
drh2c041312018-12-24 02:34:49 +00002961 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2962 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002963 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002964 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002965 }
drh1398ad32005-01-19 23:24:50 +00002966
drh85bcdce2018-12-23 21:27:29 +00002967 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002968 sqlite3ExprCode(pParse, pE2, r1);
2969 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2970 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002971 }
drh85bcdce2018-12-23 21:27:29 +00002972 sqlite3ReleaseTempReg(pParse, r1);
2973 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002974 }
drh85bcdce2018-12-23 21:27:29 +00002975 if( pKeyInfo ){
2976 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2977 }
drh2c041312018-12-24 02:34:49 +00002978 if( addrOnce ){
2979 sqlite3VdbeJumpHere(v, addrOnce);
2980 /* Subroutine return */
2981 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2982 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002983 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002984 }
2985}
2986#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002987
drh85bcdce2018-12-23 21:27:29 +00002988/*
2989** Generate code for scalar subqueries used as a subquery expression
2990** or EXISTS operator:
2991**
2992** (SELECT a FROM b) -- subquery
2993** EXISTS (SELECT a FROM b) -- EXISTS subquery
2994**
2995** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2996**
drhd86fe442019-08-26 13:45:49 +00002997** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002998** the result is stored in a contiguous array of registers and the
2999** return value is the register of the left-most result column.
3000** Return 0 if an error occurs.
3001*/
3002#ifndef SQLITE_OMIT_SUBQUERY
3003int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003004 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003005 int rReg = 0; /* Register storing resulting */
3006 Select *pSel; /* SELECT statement to encode */
3007 SelectDest dest; /* How to deal with SELECT result */
3008 int nReg; /* Registers to allocate */
3009 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003010
3011 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003012 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003013 testcase( pExpr->op==TK_EXISTS );
3014 testcase( pExpr->op==TK_SELECT );
3015 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3016 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3017 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003018
drh5198ff52018-12-24 12:09:47 +00003019 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003020 ** is encountered if any of the following is true:
3021 **
3022 ** * The right-hand side is a correlated subquery
3023 ** * The right-hand side is an expression list containing variables
3024 ** * We are inside a trigger
3025 **
3026 ** If all of the above are false, then we can run this code just once
3027 ** save the results, and reuse the same result on subsequent invocations.
3028 */
3029 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003030 /* If this routine has already been coded, then invoke it as a
3031 ** subroutine. */
3032 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003033 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003034 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3035 pExpr->y.sub.iAddr);
3036 return pExpr->iTable;
3037 }
3038
3039 /* Begin coding the subroutine */
3040 ExprSetProperty(pExpr, EP_Subrtn);
3041 pExpr->y.sub.regReturn = ++pParse->nMem;
3042 pExpr->y.sub.iAddr =
3043 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3044 VdbeComment((v, "return address"));
3045
drh2c041312018-12-24 02:34:49 +00003046 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003047 }
drh85bcdce2018-12-23 21:27:29 +00003048
3049 /* For a SELECT, generate code to put the values for all columns of
3050 ** the first row into an array of registers and return the index of
3051 ** the first register.
3052 **
3053 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3054 ** into a register and return that register number.
3055 **
3056 ** In both cases, the query is augmented with "LIMIT 1". Any
3057 ** preexisting limit is discarded in place of the new LIMIT 1.
3058 */
drhbd462bc2018-12-24 20:21:06 +00003059 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3060 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003061 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3062 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3063 pParse->nMem += nReg;
3064 if( pExpr->op==TK_SELECT ){
3065 dest.eDest = SRT_Mem;
3066 dest.iSdst = dest.iSDParm;
3067 dest.nSdst = nReg;
3068 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3069 VdbeComment((v, "Init subquery result"));
3070 }else{
3071 dest.eDest = SRT_Exists;
3072 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3073 VdbeComment((v, "Init EXISTS result"));
3074 }
drh85bcdce2018-12-23 21:27:29 +00003075 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003076 /* The subquery already has a limit. If the pre-existing limit is X
3077 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3078 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003079 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003080 if( pLimit ){
3081 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3082 pLimit = sqlite3PExpr(pParse, TK_NE,
3083 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3084 }
3085 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003086 pSel->pLimit->pLeft = pLimit;
3087 }else{
drh7ca13472019-09-23 11:55:22 +00003088 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003089 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003090 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3091 }
3092 pSel->iLimit = 0;
3093 if( sqlite3Select(pParse, pSel, &dest) ){
3094 return 0;
3095 }
drh2c041312018-12-24 02:34:49 +00003096 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003097 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003098 if( addrOnce ){
3099 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003100
drh5198ff52018-12-24 12:09:47 +00003101 /* Subroutine return */
3102 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3103 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003104 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003105 }
drh2c041312018-12-24 02:34:49 +00003106
drh1450bc62009-10-30 13:25:56 +00003107 return rReg;
drhcce7d172000-05-31 15:34:51 +00003108}
drh51522cd2005-01-20 13:36:19 +00003109#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003110
drhe3365e62009-11-12 17:52:24 +00003111#ifndef SQLITE_OMIT_SUBQUERY
3112/*
dan7b35a772016-07-28 19:47:15 +00003113** Expr pIn is an IN(...) expression. This function checks that the
3114** sub-select on the RHS of the IN() operator has the same number of
3115** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3116** a sub-query, that the LHS is a vector of size 1.
3117*/
3118int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3119 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3120 if( (pIn->flags & EP_xIsSelect) ){
3121 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3122 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3123 return 1;
3124 }
3125 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003126 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003127 return 1;
3128 }
3129 return 0;
3130}
3131#endif
3132
3133#ifndef SQLITE_OMIT_SUBQUERY
3134/*
drhe3365e62009-11-12 17:52:24 +00003135** Generate code for an IN expression.
3136**
3137** x IN (SELECT ...)
3138** x IN (value, value, ...)
3139**
drhecb87ac2016-08-25 15:46:25 +00003140** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003141** right-hand side (RHS) is an array of zero or more scalar values, or a
3142** subquery. If the RHS is a subquery, the number of result columns must
3143** match the number of columns in the vector on the LHS. If the RHS is
3144** a list of values, the LHS must be a scalar.
3145**
3146** The IN operator is true if the LHS value is contained within the RHS.
3147** The result is false if the LHS is definitely not in the RHS. The
3148** result is NULL if the presence of the LHS in the RHS cannot be
3149** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003150**
drh6be515e2014-08-01 21:00:53 +00003151** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003152** contained within the RHS. If due to NULLs we cannot determine if the LHS
3153** is contained in the RHS then jump to destIfNull. If the LHS is contained
3154** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003155**
3156** See the separate in-operator.md documentation file in the canonical
3157** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003158*/
3159static void sqlite3ExprCodeIN(
3160 Parse *pParse, /* Parsing and code generating context */
3161 Expr *pExpr, /* The IN expression */
3162 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3163 int destIfNull /* Jump here if the results are unknown due to NULLs */
3164){
3165 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003166 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003167 int rLhs; /* Register(s) holding the LHS values */
3168 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003169 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003170 int *aiMap = 0; /* Map from vector field to index column */
3171 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003172 int nVector; /* Size of vectors for this IN operator */
3173 int iDummy; /* Dummy parameter to exprCodeVector() */
3174 Expr *pLeft; /* The LHS of the IN operator */
3175 int i; /* loop counter */
3176 int destStep2; /* Where to jump when NULLs seen in step 2 */
3177 int destStep6 = 0; /* Start of code for Step 6 */
3178 int addrTruthOp; /* Address of opcode that determines the IN is true */
3179 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3180 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003181 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003182
drhe7375bf2020-03-10 19:24:38 +00003183 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003184 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003185 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003186 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003187 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3188 aiMap = (int*)sqlite3DbMallocZero(
3189 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3190 );
drhe347d3e2016-08-25 21:14:34 +00003191 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003192
danba00e302016-07-23 20:24:06 +00003193 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003194 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003195 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3196 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003197 v = pParse->pVdbe;
3198 assert( v!=0 ); /* OOM detected prior to this routine */
3199 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003200 eType = sqlite3FindInIndex(pParse, pExpr,
3201 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003202 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3203 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003204
danba00e302016-07-23 20:24:06 +00003205 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3206 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3207 );
drhecb87ac2016-08-25 15:46:25 +00003208#ifdef SQLITE_DEBUG
3209 /* Confirm that aiMap[] contains nVector integer values between 0 and
3210 ** nVector-1. */
3211 for(i=0; i<nVector; i++){
3212 int j, cnt;
3213 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3214 assert( cnt==1 );
3215 }
3216#endif
drhe3365e62009-11-12 17:52:24 +00003217
danba00e302016-07-23 20:24:06 +00003218 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3219 ** vector, then it is stored in an array of nVector registers starting
3220 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003221 **
3222 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3223 ** so that the fields are in the same order as an existing index. The
3224 ** aiMap[] array contains a mapping from the original LHS field order to
3225 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003226 */
drhe347d3e2016-08-25 21:14:34 +00003227 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3228 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003229 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003230 /* LHS fields are not reordered */
3231 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003232 }else{
3233 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003234 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003235 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003236 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003237 }
danba00e302016-07-23 20:24:06 +00003238 }
drhe3365e62009-11-12 17:52:24 +00003239
drhbb53ecb2014-08-02 21:03:33 +00003240 /* If sqlite3FindInIndex() did not find or create an index that is
3241 ** suitable for evaluating the IN operator, then evaluate using a
3242 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003243 **
3244 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003245 */
drhbb53ecb2014-08-02 21:03:33 +00003246 if( eType==IN_INDEX_NOOP ){
3247 ExprList *pList = pExpr->x.pList;
3248 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003249 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003250 int r2, regToFree;
3251 int regCkNull = 0;
3252 int ii;
drhdd668c22019-09-02 02:21:58 +00003253 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003254 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003255 if( destIfNull!=destIfFalse ){
3256 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003257 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003258 }
drhdd668c22019-09-02 02:21:58 +00003259 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003260 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003261 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003262 r2 = regToFree = sqlite3GetTempReg(pParse);
3263 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003264 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003265 }else{
3266 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003267 }
drha9769792014-08-04 16:39:39 +00003268 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003269 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3270 }
drhf6ea97e2020-01-04 15:21:47 +00003271 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003272 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003273 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3274 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003275 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003276 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3277 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3278 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3279 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003280 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003281 }else{
drh47994882019-12-22 23:48:36 +00003282 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003283 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003284 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3285 (void*)pColl, P4_COLLSEQ);
3286 VdbeCoverageIf(v, op==OP_Ne);
3287 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003288 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003289 }
drhbb53ecb2014-08-02 21:03:33 +00003290 }
3291 if( regCkNull ){
3292 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003293 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003294 }
3295 sqlite3VdbeResolveLabel(v, labelOk);
3296 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003297 goto sqlite3ExprCodeIN_finished;
3298 }
3299
3300 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3301 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3302 ** We will then skip the binary search of the RHS.
3303 */
3304 if( destIfNull==destIfFalse ){
3305 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003306 }else{
drhec4ccdb2018-12-29 02:26:59 +00003307 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003308 }
drh4eac5f02019-12-24 15:01:17 +00003309 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003310 for(i=0; i<nVector; i++){
3311 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3312 if( sqlite3ExprCanBeNull(p) ){
3313 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003314 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003315 }
drhe3365e62009-11-12 17:52:24 +00003316 }
drhe347d3e2016-08-25 21:14:34 +00003317
3318 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3319 ** of the RHS using the LHS as a probe. If found, the result is
3320 ** true.
3321 */
3322 if( eType==IN_INDEX_ROWID ){
3323 /* In this case, the RHS is the ROWID of table b-tree and so we also
3324 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3325 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003326 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003327 VdbeCoverage(v);
3328 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3329 }else{
3330 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3331 if( destIfFalse==destIfNull ){
3332 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003333 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003334 rLhs, nVector); VdbeCoverage(v);
3335 goto sqlite3ExprCodeIN_finished;
3336 }
3337 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003338 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003339 rLhs, nVector); VdbeCoverage(v);
3340 }
3341
3342 /* Step 4. If the RHS is known to be non-NULL and we did not find
3343 ** an match on the search above, then the result must be FALSE.
3344 */
3345 if( rRhsHasNull && nVector==1 ){
3346 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3347 VdbeCoverage(v);
3348 }
3349
3350 /* Step 5. If we do not care about the difference between NULL and
3351 ** FALSE, then just return false.
3352 */
3353 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3354
3355 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3356 ** If any comparison is NULL, then the result is NULL. If all
3357 ** comparisons are FALSE then the final result is FALSE.
3358 **
3359 ** For a scalar LHS, it is sufficient to check just the first row
3360 ** of the RHS.
3361 */
3362 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003363 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003364 VdbeCoverage(v);
3365 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003366 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003367 }else{
3368 /* For nVector==1, combine steps 6 and 7 by immediately returning
3369 ** FALSE if the first comparison is not NULL */
3370 destNotNull = destIfFalse;
3371 }
3372 for(i=0; i<nVector; i++){
3373 Expr *p;
3374 CollSeq *pColl;
3375 int r3 = sqlite3GetTempReg(pParse);
3376 p = sqlite3VectorFieldSubexpr(pLeft, i);
3377 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003378 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003379 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3380 (void*)pColl, P4_COLLSEQ);
3381 VdbeCoverage(v);
3382 sqlite3ReleaseTempReg(pParse, r3);
3383 }
3384 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3385 if( nVector>1 ){
3386 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003387 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003388 VdbeCoverage(v);
3389
3390 /* Step 7: If we reach this point, we know that the result must
3391 ** be false. */
3392 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3393 }
3394
3395 /* Jumps here in order to return true. */
3396 sqlite3VdbeJumpHere(v, addrTruthOp);
3397
3398sqlite3ExprCodeIN_finished:
3399 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003400 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003401sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003402 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003403 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003404}
3405#endif /* SQLITE_OMIT_SUBQUERY */
3406
drh13573c72010-01-12 17:04:07 +00003407#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003408/*
3409** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003410** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003411**
3412** The z[] string will probably not be zero-terminated. But the
3413** z[n] character is guaranteed to be something that does not look
3414** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003415*/
drhb7916a72009-05-27 10:31:29 +00003416static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003417 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003418 double value;
drh9339da12010-09-30 00:50:49 +00003419 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003420 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3421 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003422 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003423 }
3424}
drh13573c72010-01-12 17:04:07 +00003425#endif
drh598f1342007-10-23 15:39:45 +00003426
3427
3428/*
drhfec19aa2004-05-19 20:41:03 +00003429** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003430** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003431**
shaneh5f1d6b62010-09-30 16:51:25 +00003432** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003433*/
drh13573c72010-01-12 17:04:07 +00003434static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3435 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003436 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003437 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003438 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003439 if( negFlag ) i = -i;
3440 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003441 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003442 int c;
3443 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003444 const char *z = pExpr->u.zToken;
3445 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003446 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003447 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003448#ifdef SQLITE_OMIT_FLOATING_POINT
3449 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3450#else
drh1b7ddc52014-07-23 14:52:05 +00003451#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003452 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003453 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003454 }else
3455#endif
3456 {
drh9296c182014-07-23 13:40:49 +00003457 codeReal(v, z, negFlag, iMem);
3458 }
drh13573c72010-01-12 17:04:07 +00003459#endif
drh77320ea2016-11-30 14:47:37 +00003460 }else{
drh84d4f1a2017-09-20 10:47:10 +00003461 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003462 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003463 }
drhfec19aa2004-05-19 20:41:03 +00003464 }
3465}
3466
drh5cd79232009-05-25 11:46:29 +00003467
drh1f9ca2c2015-08-25 16:57:52 +00003468/* Generate code that will load into register regOut a value that is
3469** appropriate for the iIdxCol-th column of index pIdx.
3470*/
3471void sqlite3ExprCodeLoadIndexColumn(
3472 Parse *pParse, /* The parsing context */
3473 Index *pIdx, /* The index whose column is to be loaded */
3474 int iTabCur, /* Cursor pointing to a table row */
3475 int iIdxCol, /* The column of the index to be loaded */
3476 int regOut /* Store the index column value in this register */
3477){
3478 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003479 if( iTabCol==XN_EXPR ){
3480 assert( pIdx->aColExpr );
3481 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003482 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003483 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003484 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003485 }else{
drh6df9c4b2019-10-18 12:52:08 +00003486 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003487 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003488 }
drh1f9ca2c2015-08-25 16:57:52 +00003489}
3490
drhe70fa7f2019-10-22 21:01:34 +00003491#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3492/*
3493** Generate code that will compute the value of generated column pCol
3494** and store the result in register regOut
3495*/
3496void sqlite3ExprCodeGeneratedColumn(
3497 Parse *pParse,
3498 Column *pCol,
3499 int regOut
3500){
drh4dad7ed2019-12-16 16:52:22 +00003501 int iAddr;
3502 Vdbe *v = pParse->pVdbe;
3503 assert( v!=0 );
3504 assert( pParse->iSelfTab!=0 );
3505 if( pParse->iSelfTab>0 ){
3506 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3507 }else{
3508 iAddr = 0;
3509 }
drh24e39902020-03-10 13:35:04 +00003510 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003511 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003512 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003513 }
drh4dad7ed2019-12-16 16:52:22 +00003514 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003515}
3516#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3517
drh5cd79232009-05-25 11:46:29 +00003518/*
drh5c092e82010-05-14 19:24:02 +00003519** Generate code to extract the value of the iCol-th column of a table.
3520*/
3521void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003522 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003523 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003524 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003525 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003526 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003527){
drhab45fc02019-10-16 22:01:56 +00003528 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003529 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003530 if( pTab==0 ){
3531 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3532 return;
3533 }
drh5c092e82010-05-14 19:24:02 +00003534 if( iCol<0 || iCol==pTab->iPKey ){
3535 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3536 }else{
drh81f7b372019-10-16 12:18:59 +00003537 int op;
3538 int x;
3539 if( IsVirtual(pTab) ){
3540 op = OP_VColumn;
3541 x = iCol;
3542#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003543 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003544 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003545 if( pCol->colFlags & COLFLAG_BUSY ){
3546 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3547 }else{
3548 int savedSelfTab = pParse->iSelfTab;
3549 pCol->colFlags |= COLFLAG_BUSY;
3550 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003551 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003552 pParse->iSelfTab = savedSelfTab;
3553 pCol->colFlags &= ~COLFLAG_BUSY;
3554 }
drh81f7b372019-10-16 12:18:59 +00003555 return;
3556#endif
3557 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003558 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003559 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003560 op = OP_Column;
3561 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003562 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003563 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003564 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003565 }
3566 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003567 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3568 }
3569}
3570
3571/*
drh945498f2007-02-24 11:52:52 +00003572** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003573** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003574**
3575** There must be an open cursor to pTab in iTable when this routine
3576** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003577*/
drhe55cbd72008-03-31 23:48:03 +00003578int sqlite3ExprCodeGetColumn(
3579 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003580 Table *pTab, /* Description of the table we are reading from */
3581 int iColumn, /* Index of the table column */
3582 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003583 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003584 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003585){
drh81f7b372019-10-16 12:18:59 +00003586 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003587 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003588 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003589 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3590 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003591 }
drhe55cbd72008-03-31 23:48:03 +00003592 return iReg;
3593}
drhe55cbd72008-03-31 23:48:03 +00003594
3595/*
drhb21e7c72008-06-22 12:37:57 +00003596** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003597** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003598*/
drhb21e7c72008-06-22 12:37:57 +00003599void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003600 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003601}
3602
drh652fbf52008-04-01 01:42:41 +00003603/*
drh12abf402016-08-22 14:30:05 +00003604** Convert a scalar expression node to a TK_REGISTER referencing
3605** register iReg. The caller must ensure that iReg already contains
3606** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003607*/
dan069d1b12019-06-16 08:58:14 +00003608static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003609 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003610 p->op2 = p->op;
3611 p->op = TK_REGISTER;
3612 p->iTable = iReg;
3613 ExprClearProperty(p, EP_Skip);
3614}
3615
drh12abf402016-08-22 14:30:05 +00003616/*
3617** Evaluate an expression (either a vector or a scalar expression) and store
3618** the result in continguous temporary registers. Return the index of
3619** the first register used to store the result.
3620**
3621** If the returned result register is a temporary scalar, then also write
3622** that register number into *piFreeable. If the returned result register
3623** is not a temporary or if the expression is a vector set *piFreeable
3624** to 0.
3625*/
3626static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3627 int iResult;
3628 int nResult = sqlite3ExprVectorSize(p);
3629 if( nResult==1 ){
3630 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3631 }else{
3632 *piFreeable = 0;
3633 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003634#if SQLITE_OMIT_SUBQUERY
3635 iResult = 0;
3636#else
drh85bcdce2018-12-23 21:27:29 +00003637 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003638#endif
drh12abf402016-08-22 14:30:05 +00003639 }else{
3640 int i;
3641 iResult = pParse->nMem+1;
3642 pParse->nMem += nResult;
3643 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003644 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003645 }
3646 }
3647 }
3648 return iResult;
3649}
3650
drh25c42962020-01-01 13:55:08 +00003651/*
drh92a27f72020-02-04 01:41:44 +00003652** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3653** so that a subsequent copy will not be merged into this one.
3654*/
3655static void setDoNotMergeFlagOnCopy(Vdbe *v){
3656 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3657 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3658 }
3659}
3660
3661/*
drh25c42962020-01-01 13:55:08 +00003662** Generate code to implement special SQL functions that are implemented
3663** in-line rather than by using the usual callbacks.
3664*/
3665static int exprCodeInlineFunction(
3666 Parse *pParse, /* Parsing context */
3667 ExprList *pFarg, /* List of function arguments */
3668 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3669 int target /* Store function result in this register */
3670){
3671 int nFarg;
3672 Vdbe *v = pParse->pVdbe;
3673 assert( v!=0 );
3674 assert( pFarg!=0 );
3675 nFarg = pFarg->nExpr;
3676 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3677 switch( iFuncId ){
3678 case INLINEFUNC_coalesce: {
3679 /* Attempt a direct implementation of the built-in COALESCE() and
3680 ** IFNULL() functions. This avoids unnecessary evaluation of
3681 ** arguments past the first non-NULL argument.
3682 */
3683 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3684 int i;
3685 assert( nFarg>=2 );
3686 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3687 for(i=1; i<nFarg; i++){
3688 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3689 VdbeCoverage(v);
3690 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3691 }
drh92a27f72020-02-04 01:41:44 +00003692 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003693 sqlite3VdbeResolveLabel(v, endCoalesce);
3694 break;
3695 }
3696
drh171c50e2020-01-01 15:43:30 +00003697 default: {
drh25c42962020-01-01 13:55:08 +00003698 /* The UNLIKELY() function is a no-op. The result is the value
3699 ** of the first argument.
3700 */
drh171c50e2020-01-01 15:43:30 +00003701 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003702 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3703 break;
3704 }
3705
drh171c50e2020-01-01 15:43:30 +00003706 /***********************************************************************
3707 ** Test-only SQL functions that are only usable if enabled
3708 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3709 */
3710 case INLINEFUNC_expr_compare: {
3711 /* Compare two expressions using sqlite3ExprCompare() */
3712 assert( nFarg==2 );
3713 sqlite3VdbeAddOp2(v, OP_Integer,
3714 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3715 target);
3716 break;
3717 }
3718
3719 case INLINEFUNC_expr_implies_expr: {
3720 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3721 assert( nFarg==2 );
3722 sqlite3VdbeAddOp2(v, OP_Integer,
3723 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3724 target);
3725 break;
3726 }
3727
3728 case INLINEFUNC_implies_nonnull_row: {
3729 /* REsult of sqlite3ExprImpliesNonNullRow() */
3730 Expr *pA1;
3731 assert( nFarg==2 );
3732 pA1 = pFarg->a[1].pExpr;
3733 if( pA1->op==TK_COLUMN ){
3734 sqlite3VdbeAddOp2(v, OP_Integer,
3735 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3736 target);
3737 }else{
3738 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3739 }
3740 break;
3741 }
3742
drh25c42962020-01-01 13:55:08 +00003743#ifdef SQLITE_DEBUG
3744 case INLINEFUNC_affinity: {
3745 /* The AFFINITY() function evaluates to a string that describes
3746 ** the type affinity of the argument. This is used for testing of
3747 ** the SQLite type logic.
3748 */
3749 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3750 char aff;
3751 assert( nFarg==1 );
3752 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3753 sqlite3VdbeLoadString(v, target,
3754 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3755 break;
3756 }
3757#endif
3758 }
3759 return target;
3760}
3761
dan71c57db2016-07-09 20:23:55 +00003762
drha4c3c872013-09-12 17:29:25 +00003763/*
drhcce7d172000-05-31 15:34:51 +00003764** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003765** expression. Attempt to store the results in register "target".
3766** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003767**
drh8b213892008-08-29 02:14:02 +00003768** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003769** be stored in target. The result might be stored in some other
3770** register if it is convenient to do so. The calling function
3771** must check the return code and move the results to the desired
3772** register.
drhcce7d172000-05-31 15:34:51 +00003773*/
drh678ccce2008-03-31 18:19:54 +00003774int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003775 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3776 int op; /* The opcode being coded */
3777 int inReg = target; /* Results stored in register inReg */
3778 int regFree1 = 0; /* If non-zero free this temporary register */
3779 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003780 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003781 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003782 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003783
drh9cbf3422008-01-17 16:22:13 +00003784 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003785 if( v==0 ){
3786 assert( pParse->db->mallocFailed );
3787 return 0;
3788 }
drh389a1ad2008-01-03 23:44:53 +00003789
drh1efa8022018-04-28 04:16:43 +00003790expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003791 if( pExpr==0 ){
3792 op = TK_NULL;
3793 }else{
drhe7375bf2020-03-10 19:24:38 +00003794 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003795 op = pExpr->op;
3796 }
drhf2bc0132004-10-04 13:19:23 +00003797 switch( op ){
drh13449892005-09-07 21:22:45 +00003798 case TK_AGG_COLUMN: {
3799 AggInfo *pAggInfo = pExpr->pAggInfo;
3800 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3801 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003802 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003803 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003804 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003805 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003806 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003807 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003808 if( pCol->iColumn<0 ){
3809 VdbeComment((v,"%s.rowid",pTab->zName));
3810 }else{
3811 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3812 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3813 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3814 }
drh0c76e892020-03-10 11:50:43 +00003815 }
drhc332cc32016-09-19 10:24:19 +00003816 return target;
drh13449892005-09-07 21:22:45 +00003817 }
3818 /* Otherwise, fall thru into the TK_COLUMN case */
3819 }
drh967e8b72000-06-21 13:59:10 +00003820 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003821 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003822 int iReg;
drhefad2e22018-07-27 16:57:11 +00003823 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003824 /* This COLUMN expression is really a constant due to WHERE clause
3825 ** constraints, and that constant is coded by the pExpr->pLeft
3826 ** expresssion. However, make sure the constant has the correct
3827 ** datatype by applying the Affinity of the table column to the
3828 ** constant.
3829 */
drh57f7ece2019-11-21 18:28:44 +00003830 int aff;
drh67b9ba12019-12-20 20:45:02 +00003831 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003832 if( pExpr->y.pTab ){
3833 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3834 }else{
3835 aff = pExpr->affExpr;
3836 }
drh96fb16e2019-08-06 14:37:24 +00003837 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003838 static const char zAff[] = "B\000C\000D\000E";
3839 assert( SQLITE_AFF_BLOB=='A' );
3840 assert( SQLITE_AFF_TEXT=='B' );
3841 if( iReg!=target ){
3842 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3843 iReg = target;
3844 }
3845 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3846 &zAff[(aff-'B')*2], P4_STATIC);
3847 }
3848 return iReg;
drhefad2e22018-07-27 16:57:11 +00003849 }
drhb2b9d3d2013-08-01 01:14:43 +00003850 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003851 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003852 /* Other columns in the same row for CHECK constraints or
3853 ** generated columns or for inserting into partial index.
3854 ** The row is unpacked into registers beginning at
3855 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3856 ** immediately prior to the first column.
3857 */
3858 Column *pCol;
3859 Table *pTab = pExpr->y.pTab;
3860 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003861 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003862 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003863 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003864 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003865 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003866 return -1-pParse->iSelfTab;
3867 }
drhc5f808d2019-10-19 15:01:52 +00003868 pCol = pTab->aCol + iCol;
3869 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3870 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003871#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3872 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003873 if( pCol->colFlags & COLFLAG_BUSY ){
3874 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3875 pCol->zName);
3876 return 0;
3877 }
3878 pCol->colFlags |= COLFLAG_BUSY;
3879 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3880 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3881 }
3882 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003883 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003884 }else
3885#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3886 if( pCol->affinity==SQLITE_AFF_REAL ){
3887 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003888 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3889 return target;
3890 }else{
drh9942ef02019-10-18 02:19:18 +00003891 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003892 }
drhb2b9d3d2013-08-01 01:14:43 +00003893 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003894 /* Coding an expression that is part of an index where column names
3895 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003896 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003897 }
drh22827922000-06-06 17:27:05 +00003898 }
drh67b9ba12019-12-20 20:45:02 +00003899 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003900 pExpr->iColumn, iTab, target,
3901 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003902 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3903 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3904 }
3905 return iReg;
drhcce7d172000-05-31 15:34:51 +00003906 }
3907 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003908 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003909 return target;
drhfec19aa2004-05-19 20:41:03 +00003910 }
drh8abed7b2018-02-26 18:49:05 +00003911 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003912 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003913 return target;
3914 }
drh13573c72010-01-12 17:04:07 +00003915#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003916 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003917 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3918 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003919 return target;
drh598f1342007-10-23 15:39:45 +00003920 }
drh13573c72010-01-12 17:04:07 +00003921#endif
drhfec19aa2004-05-19 20:41:03 +00003922 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003923 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003924 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003925 return target;
drhcce7d172000-05-31 15:34:51 +00003926 }
drhaac30f92019-12-14 15:01:55 +00003927 default: {
drhc29af652019-12-18 21:22:40 +00003928 /* Make NULL the default case so that if a bug causes an illegal
3929 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003930 ** sanely and not crash. But keep the assert() to bring the problem
3931 ** to the attention of the developers. */
3932 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003933 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003934 return target;
drhf0863fe2005-06-12 21:35:51 +00003935 }
danielk19775338a5f2005-01-20 13:03:10 +00003936#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003937 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003938 int n;
3939 const char *z;
drhca48c902008-01-18 14:08:24 +00003940 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003941 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3942 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3943 assert( pExpr->u.zToken[1]=='\'' );
3944 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003945 n = sqlite3Strlen30(z) - 1;
3946 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003947 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3948 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003949 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003950 }
danielk19775338a5f2005-01-20 13:03:10 +00003951#endif
drh50457892003-09-06 01:10:47 +00003952 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003953 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3954 assert( pExpr->u.zToken!=0 );
3955 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003956 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3957 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003958 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003959 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003960 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003961 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003962 }
drhc332cc32016-09-19 10:24:19 +00003963 return target;
drh50457892003-09-06 01:10:47 +00003964 }
drh4e0cff62004-11-05 05:10:28 +00003965 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003966 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003967 }
drh487e2622005-06-25 18:42:14 +00003968#ifndef SQLITE_OMIT_CAST
3969 case TK_CAST: {
3970 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003971 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003972 if( inReg!=target ){
3973 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3974 inReg = target;
3975 }
drh4169e432014-08-25 20:11:52 +00003976 sqlite3VdbeAddOp2(v, OP_Cast, target,
3977 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003978 return inReg;
drh487e2622005-06-25 18:42:14 +00003979 }
3980#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003981 case TK_IS:
3982 case TK_ISNOT:
3983 op = (op==TK_IS) ? TK_EQ : TK_NE;
3984 p5 = SQLITE_NULLEQ;
3985 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003986 case TK_LT:
3987 case TK_LE:
3988 case TK_GT:
3989 case TK_GE:
3990 case TK_NE:
3991 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003992 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003993 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003994 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003995 }else{
3996 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3997 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3998 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00003999 r1, r2, inReg, SQLITE_STOREP2 | p5,
4000 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004001 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4002 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4003 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4004 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4005 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4006 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4007 testcase( regFree1==0 );
4008 testcase( regFree2==0 );
4009 }
drh6a2fe092009-09-23 02:29:36 +00004010 break;
4011 }
drhcce7d172000-05-31 15:34:51 +00004012 case TK_AND:
4013 case TK_OR:
4014 case TK_PLUS:
4015 case TK_STAR:
4016 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004017 case TK_REM:
4018 case TK_BITAND:
4019 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004020 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004021 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004022 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004023 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004024 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4025 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4026 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4027 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4028 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4029 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4030 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4031 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4032 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4033 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4034 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004035 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4036 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004037 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004038 testcase( regFree1==0 );
4039 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004040 break;
4041 }
drhcce7d172000-05-31 15:34:51 +00004042 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004043 Expr *pLeft = pExpr->pLeft;
4044 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004045 if( pLeft->op==TK_INTEGER ){
4046 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004047 return target;
drh13573c72010-01-12 17:04:07 +00004048#ifndef SQLITE_OMIT_FLOATING_POINT
4049 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004050 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4051 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004052 return target;
drh13573c72010-01-12 17:04:07 +00004053#endif
drh3c84ddf2008-01-09 02:15:38 +00004054 }else{
drh10d1edf2013-11-15 15:52:39 +00004055 tempX.op = TK_INTEGER;
4056 tempX.flags = EP_IntValue|EP_TokenOnly;
4057 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004058 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004059 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004060 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004061 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004062 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004063 }
drh3c84ddf2008-01-09 02:15:38 +00004064 break;
drh6e142f52000-06-08 13:36:40 +00004065 }
drhbf4133c2001-10-13 02:59:08 +00004066 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004067 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004068 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4069 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004070 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4071 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004072 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004073 break;
4074 }
drh8abed7b2018-02-26 18:49:05 +00004075 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004076 int isTrue; /* IS TRUE or IS NOT TRUE */
4077 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004078 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4079 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004080 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4081 bNormal = pExpr->op2==TK_IS;
4082 testcase( isTrue && bNormal);
4083 testcase( !isTrue && bNormal);
4084 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004085 break;
4086 }
drhcce7d172000-05-31 15:34:51 +00004087 case TK_ISNULL:
4088 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004089 int addr;
drh7d176102014-02-18 03:07:12 +00004090 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4091 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004092 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004093 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004094 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004095 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004096 VdbeCoverageIf(v, op==TK_ISNULL);
4097 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004098 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004099 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004100 break;
drhcce7d172000-05-31 15:34:51 +00004101 }
drh22827922000-06-06 17:27:05 +00004102 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004103 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00004104 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00004105 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4106 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004107 }else{
drhc332cc32016-09-19 10:24:19 +00004108 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004109 }
drh22827922000-06-06 17:27:05 +00004110 break;
4111 }
drhcce7d172000-05-31 15:34:51 +00004112 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004113 ExprList *pFarg; /* List of function arguments */
4114 int nFarg; /* Number of function arguments */
4115 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004116 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004117 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004118 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004119 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004120 u8 enc = ENC(db); /* The text encoding used by this database */
4121 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004122
dan67a9b8e2018-06-22 20:51:35 +00004123#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004124 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4125 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004126 }
dan67a9b8e2018-06-22 20:51:35 +00004127#endif
dan86fb6e12018-05-16 20:58:07 +00004128
drh1e9b53f2017-01-04 01:07:24 +00004129 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00004130 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00004131 ** out of the inner loop, even if that means an extra OP_Copy. */
4132 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004133 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004134 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004135 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4136 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004137 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004138 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4139 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004140 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004141#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4142 if( pDef==0 && pParse->explain ){
4143 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4144 }
4145#endif
danb6e9f7a2018-05-19 14:15:29 +00004146 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004147 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004148 break;
4149 }
drh25c42962020-01-01 13:55:08 +00004150 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004151 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4152 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004153 return exprCodeInlineFunction(pParse, pFarg,
4154 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004155 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4156 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004157 }
4158
drhd1a01ed2013-11-21 16:08:52 +00004159 for(i=0; i<nFarg; i++){
4160 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004161 testcase( i==31 );
4162 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004163 }
4164 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4165 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4166 }
4167 }
drh12ffee82009-04-08 13:51:51 +00004168 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004169 if( constMask ){
4170 r1 = pParse->nMem+1;
4171 pParse->nMem += nFarg;
4172 }else{
4173 r1 = sqlite3GetTempRange(pParse, nFarg);
4174 }
drha748fdc2012-03-28 01:34:47 +00004175
4176 /* For length() and typeof() functions with a column argument,
4177 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4178 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4179 ** loading.
4180 */
drhd36e1042013-09-06 13:10:12 +00004181 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004182 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004183 assert( nFarg==1 );
4184 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004185 exprOp = pFarg->a[0].pExpr->op;
4186 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004187 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4188 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004189 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4190 pFarg->a[0].pExpr->op2 =
4191 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004192 }
4193 }
4194
drh5579d592015-08-26 14:01:41 +00004195 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004196 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004197 }else{
drh12ffee82009-04-08 13:51:51 +00004198 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004199 }
drhb7f6f682006-07-08 17:06:43 +00004200#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004201 /* Possibly overload the function if the first argument is
4202 ** a virtual table column.
4203 **
4204 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4205 ** second argument, not the first, as the argument to test to
4206 ** see if it is a column in a virtual table. This is done because
4207 ** the left operand of infix functions (the operand we want to
4208 ** control overloading) ends up as the second argument to the
4209 ** function. The expression "A glob B" is equivalent to
4210 ** "glob(B,A). We want to use the A in "A glob B" to test
4211 ** for function overloading. But we use the B term in "glob(B,A)".
4212 */
drh59155062018-05-26 18:03:48 +00004213 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004214 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4215 }else if( nFarg>0 ){
4216 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004217 }
4218#endif
drhd36e1042013-09-06 13:10:12 +00004219 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004220 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004221 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004222 }
drh092457b2017-12-29 15:04:49 +00004223#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4224 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004225 Expr *pArg = pFarg->a[0].pExpr;
4226 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004227 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004228 }else{
4229 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4230 }
drh092457b2017-12-29 15:04:49 +00004231 }else
4232#endif
4233 {
drh920cf592019-10-30 16:29:02 +00004234 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004235 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004236 }
drh13d79502019-12-23 02:18:49 +00004237 if( nFarg ){
4238 if( constMask==0 ){
4239 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4240 }else{
drh3aef2fb2020-01-02 17:46:02 +00004241 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004242 }
drh2dcef112008-01-12 19:03:48 +00004243 }
drhc332cc32016-09-19 10:24:19 +00004244 return target;
drhcce7d172000-05-31 15:34:51 +00004245 }
drhfe2093d2005-01-20 22:48:47 +00004246#ifndef SQLITE_OMIT_SUBQUERY
4247 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004248 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004249 int nCol;
drhc5499be2008-04-01 15:06:33 +00004250 testcase( op==TK_EXISTS );
4251 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004252 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4253 sqlite3SubselectError(pParse, nCol, 1);
4254 }else{
drh85bcdce2018-12-23 21:27:29 +00004255 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004256 }
drh19a775c2000-06-05 18:54:46 +00004257 break;
4258 }
drhfc7f27b2016-08-20 00:07:01 +00004259 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004260 int n;
drhfc7f27b2016-08-20 00:07:01 +00004261 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004262 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004263 }
drh966e2912017-01-03 02:58:01 +00004264 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004265 if( pExpr->iTable!=0
4266 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004267 ){
4268 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4269 pExpr->iTable, n);
4270 }
drhc332cc32016-09-19 10:24:19 +00004271 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004272 }
drhfef52082000-06-06 01:50:43 +00004273 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004274 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4275 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004276 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4277 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4278 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4279 sqlite3VdbeResolveLabel(v, destIfFalse);
4280 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4281 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004282 return target;
drhfef52082000-06-06 01:50:43 +00004283 }
drhe3365e62009-11-12 17:52:24 +00004284#endif /* SQLITE_OMIT_SUBQUERY */
4285
4286
drh2dcef112008-01-12 19:03:48 +00004287 /*
4288 ** x BETWEEN y AND z
4289 **
4290 ** This is equivalent to
4291 **
4292 ** x>=y AND x<=z
4293 **
4294 ** X is stored in pExpr->pLeft.
4295 ** Y is stored in pExpr->pList->a[0].pExpr.
4296 ** Z is stored in pExpr->pList->a[1].pExpr.
4297 */
drhfef52082000-06-06 01:50:43 +00004298 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004299 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004300 return target;
drhfef52082000-06-06 01:50:43 +00004301 }
drh94fa9c42016-02-27 21:16:04 +00004302 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004303 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004304 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004305 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004306 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004307 }
drh2dcef112008-01-12 19:03:48 +00004308
dan165921a2009-08-28 18:53:45 +00004309 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004310 /* If the opcode is TK_TRIGGER, then the expression is a reference
4311 ** to a column in the new.* or old.* pseudo-tables available to
4312 ** trigger programs. In this case Expr.iTable is set to 1 for the
4313 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4314 ** is set to the column of the pseudo-table to read, or to -1 to
4315 ** read the rowid field.
4316 **
4317 ** The expression is implemented using an OP_Param opcode. The p1
4318 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4319 ** to reference another column of the old.* pseudo-table, where
4320 ** i is the index of the column. For a new.rowid reference, p1 is
4321 ** set to (n+1), where n is the number of columns in each pseudo-table.
4322 ** For a reference to any other column in the new.* pseudo-table, p1
4323 ** is set to (n+2+i), where n and i are as defined previously. For
4324 ** example, if the table on which triggers are being fired is
4325 ** declared as:
4326 **
4327 ** CREATE TABLE t1(a, b);
4328 **
4329 ** Then p1 is interpreted as follows:
4330 **
4331 ** p1==0 -> old.rowid p1==3 -> new.rowid
4332 ** p1==1 -> old.a p1==4 -> new.a
4333 ** p1==2 -> old.b p1==5 -> new.b
4334 */
drheda079c2018-09-20 19:02:15 +00004335 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004336 int iCol = pExpr->iColumn;
4337 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004338 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004339
4340 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004341 assert( iCol>=-1 && iCol<pTab->nCol );
4342 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004343 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4344
4345 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004346 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004347 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004348 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004349 ));
dan65a7cd12009-09-01 12:16:01 +00004350
drh44dbca82010-01-13 04:22:20 +00004351#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004352 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004353 ** integer. Use OP_RealAffinity to make sure it is really real.
4354 **
4355 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4356 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004357 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004358 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4359 }
drh44dbca82010-01-13 04:22:20 +00004360#endif
dan165921a2009-08-28 18:53:45 +00004361 break;
4362 }
4363
dan71c57db2016-07-09 20:23:55 +00004364 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004365 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004366 break;
4367 }
4368
drh9e9a67a2019-08-17 17:07:15 +00004369 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4370 ** that derive from the right-hand table of a LEFT JOIN. The
4371 ** Expr.iTable value is the table number for the right-hand table.
4372 ** The expression is only evaluated if that table is not currently
4373 ** on a LEFT JOIN NULL row.
4374 */
drh31d6fd52017-04-14 19:03:10 +00004375 case TK_IF_NULL_ROW: {
4376 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004377 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004378 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004379 /* Temporarily disable factoring of constant expressions, since
4380 ** even though expressions may appear to be constant, they are not
4381 ** really constant because they originate from the right-hand side
4382 ** of a LEFT JOIN. */
4383 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004384 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004385 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004386 sqlite3VdbeJumpHere(v, addrINR);
4387 sqlite3VdbeChangeP3(v, addrINR, inReg);
4388 break;
4389 }
4390
drh2dcef112008-01-12 19:03:48 +00004391 /*
4392 ** Form A:
4393 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4394 **
4395 ** Form B:
4396 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4397 **
4398 ** Form A is can be transformed into the equivalent form B as follows:
4399 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4400 ** WHEN x=eN THEN rN ELSE y END
4401 **
4402 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004403 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4404 ** odd. The Y is also optional. If the number of elements in x.pList
4405 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004406 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4407 **
4408 ** The result of the expression is the Ri for the first matching Ei,
4409 ** or if there is no matching Ei, the ELSE term Y, or if there is
4410 ** no ELSE term, NULL.
4411 */
drhaac30f92019-12-14 15:01:55 +00004412 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004413 int endLabel; /* GOTO label for end of CASE stmt */
4414 int nextCase; /* GOTO label for next WHEN clause */
4415 int nExpr; /* 2x number of WHEN terms */
4416 int i; /* Loop counter */
4417 ExprList *pEList; /* List of WHEN terms */
4418 struct ExprList_item *aListelem; /* Array of WHEN terms */
4419 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004420 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004421 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004422 Expr *pDel = 0;
4423 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004424
danielk19776ab3a2e2009-02-19 14:39:25 +00004425 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004426 assert(pExpr->x.pList->nExpr > 0);
4427 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004428 aListelem = pEList->a;
4429 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004430 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004431 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004432 pDel = sqlite3ExprDup(db, pX, 0);
4433 if( db->mallocFailed ){
4434 sqlite3ExprDelete(db, pDel);
4435 break;
4436 }
drh33cd4902009-05-30 20:49:20 +00004437 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004438 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004439 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004440 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004441 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004442 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004443 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004444 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4445 ** The value in regFree1 might get SCopy-ed into the file result.
4446 ** So make sure that the regFree1 register is not reused for other
4447 ** purposes and possibly overwritten. */
4448 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004449 }
drhc5cd1242013-09-12 16:50:49 +00004450 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004451 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004452 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004453 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004454 }else{
drh2dcef112008-01-12 19:03:48 +00004455 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004456 }
drhec4ccdb2018-12-29 02:26:59 +00004457 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004458 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004459 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004460 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004461 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004462 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004463 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004464 }
drhc5cd1242013-09-12 16:50:49 +00004465 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004466 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004467 }else{
drh9de221d2008-01-05 06:51:30 +00004468 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004469 }
dan8b65e592019-07-17 14:34:17 +00004470 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004471 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004472 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004473 break;
4474 }
danielk19775338a5f2005-01-20 13:03:10 +00004475#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004476 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004477 assert( pExpr->affExpr==OE_Rollback
4478 || pExpr->affExpr==OE_Abort
4479 || pExpr->affExpr==OE_Fail
4480 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004481 );
dane0af83a2009-09-08 19:15:01 +00004482 if( !pParse->pTriggerTab ){
4483 sqlite3ErrorMsg(pParse,
4484 "RAISE() may only be used within a trigger-program");
4485 return 0;
4486 }
drh11949042019-08-05 18:01:42 +00004487 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004488 sqlite3MayAbort(pParse);
4489 }
dan165921a2009-08-28 18:53:45 +00004490 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004491 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004492 sqlite3VdbeAddOp4(
4493 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004494 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004495 }else{
drh433dccf2013-02-09 15:37:11 +00004496 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004497 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004498 }
4499
drhffe07b22005-11-03 00:41:17 +00004500 break;
drh17a7f8d2002-03-24 13:13:27 +00004501 }
danielk19775338a5f2005-01-20 13:03:10 +00004502#endif
drhffe07b22005-11-03 00:41:17 +00004503 }
drh2dcef112008-01-12 19:03:48 +00004504 sqlite3ReleaseTempReg(pParse, regFree1);
4505 sqlite3ReleaseTempReg(pParse, regFree2);
4506 return inReg;
4507}
4508
4509/*
drhd1a01ed2013-11-21 16:08:52 +00004510** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004511**
drhad879ff2017-01-04 04:10:02 +00004512** If regDest>=0 then the result is always stored in that register and the
4513** result is not reusable. If regDest<0 then this routine is free to
4514** store the value whereever it wants. The register where the expression
4515** is stored is returned. When regDest<0, two identical expressions will
4516** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004517*/
drh1e9b53f2017-01-04 01:07:24 +00004518int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004519 Parse *pParse, /* Parsing context */
4520 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004521 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004522){
drhd1a01ed2013-11-21 16:08:52 +00004523 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004524 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004525 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004526 if( regDest<0 && p ){
4527 struct ExprList_item *pItem;
4528 int i;
4529 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004530 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004531 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004532 }
4533 }
drh1e9b53f2017-01-04 01:07:24 +00004534 }
drh38dfbda2020-03-11 17:58:27 +00004535 if( regDest<0 ) regDest = ++pParse->nMem;
drhd1a01ed2013-11-21 16:08:52 +00004536 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004537 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4538 Vdbe *v = pParse->pVdbe;
4539 int addr;
4540 assert( v );
4541 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4542 pParse->okConstFactor = 0;
4543 if( !pParse->db->mallocFailed ){
4544 sqlite3ExprCode(pParse, pExpr, regDest);
4545 }
4546 pParse->okConstFactor = 1;
4547 sqlite3ExprDelete(pParse->db, pExpr);
4548 sqlite3VdbeJumpHere(v, addr);
4549 }else{
4550 p = sqlite3ExprListAppend(pParse, p, pExpr);
4551 if( p ){
4552 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4553 pItem->reusable = regDest<0;
4554 pItem->u.iConstExprReg = regDest;
4555 }
4556 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004557 }
drh1e9b53f2017-01-04 01:07:24 +00004558 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004559}
4560
4561/*
drh2dcef112008-01-12 19:03:48 +00004562** Generate code to evaluate an expression and store the results
4563** into a register. Return the register number where the results
4564** are stored.
4565**
4566** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004567** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004568** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004569**
4570** If pExpr is a constant, then this routine might generate this
4571** code to fill the register in the initialization section of the
4572** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004573*/
4574int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004575 int r2;
drh0d950af2019-08-22 16:38:42 +00004576 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004577 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004578 && pExpr->op!=TK_REGISTER
4579 && sqlite3ExprIsConstantNotJoin(pExpr)
4580 ){
drhf30a9692013-11-15 01:10:18 +00004581 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004582 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004583 }else{
drhf30a9692013-11-15 01:10:18 +00004584 int r1 = sqlite3GetTempReg(pParse);
4585 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4586 if( r2==r1 ){
4587 *pReg = r1;
4588 }else{
4589 sqlite3ReleaseTempReg(pParse, r1);
4590 *pReg = 0;
4591 }
drh2dcef112008-01-12 19:03:48 +00004592 }
4593 return r2;
4594}
4595
4596/*
4597** Generate code that will evaluate expression pExpr and store the
4598** results in register target. The results are guaranteed to appear
4599** in register target.
4600*/
drh05a86c52014-02-16 01:55:49 +00004601void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004602 int inReg;
4603
drhe7375bf2020-03-10 19:24:38 +00004604 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004605 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004606 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4607 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4608 if( inReg!=target && pParse->pVdbe ){
drh629b88c2020-01-02 02:50:45 +00004609 u8 op;
4610 if( ExprHasProperty(pExpr,EP_Subquery) ){
4611 op = OP_Copy;
4612 }else{
4613 op = OP_SCopy;
4614 }
4615 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004616 }
drhcce7d172000-05-31 15:34:51 +00004617}
4618
4619/*
drh1c75c9d2015-12-21 15:22:13 +00004620** Make a transient copy of expression pExpr and then code it using
4621** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4622** except that the input expression is guaranteed to be unchanged.
4623*/
4624void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4625 sqlite3 *db = pParse->db;
4626 pExpr = sqlite3ExprDup(db, pExpr, 0);
4627 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4628 sqlite3ExprDelete(db, pExpr);
4629}
4630
4631/*
drh05a86c52014-02-16 01:55:49 +00004632** Generate code that will evaluate expression pExpr and store the
4633** results in register target. The results are guaranteed to appear
4634** in register target. If the expression is constant, then this routine
4635** might choose to code the expression at initialization time.
4636*/
4637void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004638 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004639 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004640 }else{
drh088489e2020-03-10 02:57:37 +00004641 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004642 }
drhcce7d172000-05-31 15:34:51 +00004643}
4644
4645/*
drh268380c2004-02-25 13:47:31 +00004646** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004647** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004648**
drh3df6c3b2017-09-15 15:38:01 +00004649** Return the number of elements evaluated. The number returned will
4650** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4651** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004652**
4653** The SQLITE_ECEL_DUP flag prevents the arguments from being
4654** filled using OP_SCopy. OP_Copy must be used instead.
4655**
4656** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4657** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004658**
4659** The SQLITE_ECEL_REF flag means that expressions in the list with
4660** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4661** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004662** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4663** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004664*/
danielk19774adee202004-05-08 08:23:19 +00004665int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004666 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004667 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004668 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004669 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004670 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004671){
4672 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004673 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004674 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004675 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004676 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004677 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004678 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004679 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004680 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004681 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004682 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004683#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4684 if( pItem->bSorterRef ){
4685 i--;
4686 n--;
4687 }else
4688#endif
dan257c13f2016-11-10 20:14:06 +00004689 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4690 if( flags & SQLITE_ECEL_OMITREF ){
4691 i--;
4692 n--;
4693 }else{
4694 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4695 }
drhb8b06692018-08-04 15:16:20 +00004696 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4697 && sqlite3ExprIsConstantNotJoin(pExpr)
4698 ){
drhad879ff2017-01-04 04:10:02 +00004699 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004700 }else{
4701 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4702 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004703 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004704 if( copyOp==OP_Copy
4705 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4706 && pOp->p1+pOp->p3+1==inReg
4707 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004708 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004709 ){
4710 pOp->p3++;
4711 }else{
4712 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4713 }
drhd1a01ed2013-11-21 16:08:52 +00004714 }
drhd1766112008-09-17 00:13:12 +00004715 }
drh268380c2004-02-25 13:47:31 +00004716 }
drhf9b596e2004-05-26 16:54:42 +00004717 return n;
drh268380c2004-02-25 13:47:31 +00004718}
4719
4720/*
drh36c563a2009-11-12 13:32:22 +00004721** Generate code for a BETWEEN operator.
4722**
4723** x BETWEEN y AND z
4724**
4725** The above is equivalent to
4726**
4727** x>=y AND x<=z
4728**
4729** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004730** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004731**
4732** The xJumpIf parameter determines details:
4733**
4734** NULL: Store the boolean result in reg[dest]
4735** sqlite3ExprIfTrue: Jump to dest if true
4736** sqlite3ExprIfFalse: Jump to dest if false
4737**
4738** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004739*/
4740static void exprCodeBetween(
4741 Parse *pParse, /* Parsing and code generating context */
4742 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004743 int dest, /* Jump destination or storage location */
4744 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004745 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4746){
dan8b65e592019-07-17 14:34:17 +00004747 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004748 Expr compLeft; /* The x>=y term */
4749 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004750 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004751 Expr *pDel = 0;
4752 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004753
dan71c57db2016-07-09 20:23:55 +00004754 memset(&compLeft, 0, sizeof(Expr));
4755 memset(&compRight, 0, sizeof(Expr));
4756 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004757
4758 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004759 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4760 if( db->mallocFailed==0 ){
4761 exprAnd.op = TK_AND;
4762 exprAnd.pLeft = &compLeft;
4763 exprAnd.pRight = &compRight;
4764 compLeft.op = TK_GE;
4765 compLeft.pLeft = pDel;
4766 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4767 compRight.op = TK_LE;
4768 compRight.pLeft = pDel;
4769 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4770 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4771 if( xJump ){
4772 xJump(pParse, &exprAnd, dest, jumpIfNull);
4773 }else{
4774 /* Mark the expression is being from the ON or USING clause of a join
4775 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4776 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4777 ** for clarity, but we are out of bits in the Expr.flags field so we
4778 ** have to reuse the EP_FromJoin bit. Bummer. */
4779 pDel->flags |= EP_FromJoin;
4780 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4781 }
4782 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004783 }
dan8b65e592019-07-17 14:34:17 +00004784 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004785
4786 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004787 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4788 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4789 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4790 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4791 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4792 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4793 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4794 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004795 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004796}
4797
4798/*
drhcce7d172000-05-31 15:34:51 +00004799** Generate code for a boolean expression such that a jump is made
4800** to the label "dest" if the expression is true but execution
4801** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004802**
4803** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004804** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004805**
4806** This code depends on the fact that certain token values (ex: TK_EQ)
4807** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4808** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4809** the make process cause these values to align. Assert()s in the code
4810** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004811*/
danielk19774adee202004-05-08 08:23:19 +00004812void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004813 Vdbe *v = pParse->pVdbe;
4814 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004815 int regFree1 = 0;
4816 int regFree2 = 0;
4817 int r1, r2;
4818
drh35573352008-01-08 23:54:25 +00004819 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004820 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004821 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004822 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004823 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004824 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004825 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004826 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004827 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4828 if( pAlt!=pExpr ){
4829 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4830 }else if( op==TK_AND ){
4831 int d2 = sqlite3VdbeMakeLabel(pParse);
4832 testcase( jumpIfNull==0 );
4833 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4834 jumpIfNull^SQLITE_JUMPIFNULL);
4835 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4836 sqlite3VdbeResolveLabel(v, d2);
4837 }else{
4838 testcase( jumpIfNull==0 );
4839 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4840 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4841 }
drhcce7d172000-05-31 15:34:51 +00004842 break;
4843 }
4844 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004845 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004846 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004847 break;
4848 }
drh8abed7b2018-02-26 18:49:05 +00004849 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004850 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4851 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004852 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004853 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004854 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004855 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004856 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004857 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004858 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4859 isNot ? SQLITE_JUMPIFNULL : 0);
4860 }else{
4861 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4862 isNot ? SQLITE_JUMPIFNULL : 0);
4863 }
drh007c8432018-02-26 03:20:18 +00004864 break;
4865 }
drhde845c22016-03-17 19:07:52 +00004866 case TK_IS:
4867 case TK_ISNOT:
4868 testcase( op==TK_IS );
4869 testcase( op==TK_ISNOT );
4870 op = (op==TK_IS) ? TK_EQ : TK_NE;
4871 jumpIfNull = SQLITE_NULLEQ;
4872 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004873 case TK_LT:
4874 case TK_LE:
4875 case TK_GT:
4876 case TK_GE:
4877 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004878 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004879 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004880 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004881 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4882 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004883 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004884 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004885 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4886 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4887 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4888 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004889 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4890 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4891 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4892 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4893 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4894 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004895 testcase( regFree1==0 );
4896 testcase( regFree2==0 );
4897 break;
4898 }
drhcce7d172000-05-31 15:34:51 +00004899 case TK_ISNULL:
4900 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004901 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4902 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004903 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4904 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004905 VdbeCoverageIf(v, op==TK_ISNULL);
4906 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004907 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004908 break;
4909 }
drhfef52082000-06-06 01:50:43 +00004910 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004911 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004912 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004913 break;
4914 }
drh84e30ca2011-02-10 17:46:14 +00004915#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004916 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004917 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004918 int destIfNull = jumpIfNull ? dest : destIfFalse;
4919 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004920 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004921 sqlite3VdbeResolveLabel(v, destIfFalse);
4922 break;
4923 }
shanehbb201342011-02-09 19:55:20 +00004924#endif
drhcce7d172000-05-31 15:34:51 +00004925 default: {
dan7b35a772016-07-28 19:47:15 +00004926 default_expr:
drhad317272019-04-19 16:21:51 +00004927 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004928 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004929 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004930 /* No-op */
4931 }else{
4932 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4933 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004934 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004935 testcase( regFree1==0 );
4936 testcase( jumpIfNull==0 );
4937 }
drhcce7d172000-05-31 15:34:51 +00004938 break;
4939 }
4940 }
drh2dcef112008-01-12 19:03:48 +00004941 sqlite3ReleaseTempReg(pParse, regFree1);
4942 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004943}
4944
4945/*
drh66b89c82000-11-28 20:47:17 +00004946** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004947** to the label "dest" if the expression is false but execution
4948** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004949**
4950** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004951** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4952** is 0.
drhcce7d172000-05-31 15:34:51 +00004953*/
danielk19774adee202004-05-08 08:23:19 +00004954void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004955 Vdbe *v = pParse->pVdbe;
4956 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004957 int regFree1 = 0;
4958 int regFree2 = 0;
4959 int r1, r2;
4960
drh35573352008-01-08 23:54:25 +00004961 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004962 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004963 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00004964 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004965
4966 /* The value of pExpr->op and op are related as follows:
4967 **
4968 ** pExpr->op op
4969 ** --------- ----------
4970 ** TK_ISNULL OP_NotNull
4971 ** TK_NOTNULL OP_IsNull
4972 ** TK_NE OP_Eq
4973 ** TK_EQ OP_Ne
4974 ** TK_GT OP_Le
4975 ** TK_LE OP_Gt
4976 ** TK_GE OP_Lt
4977 ** TK_LT OP_Ge
4978 **
4979 ** For other values of pExpr->op, op is undefined and unused.
4980 ** The value of TK_ and OP_ constants are arranged such that we
4981 ** can compute the mapping above using the following expression.
4982 ** Assert()s verify that the computation is correct.
4983 */
4984 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4985
4986 /* Verify correct alignment of TK_ and OP_ constants
4987 */
4988 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4989 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4990 assert( pExpr->op!=TK_NE || op==OP_Eq );
4991 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4992 assert( pExpr->op!=TK_LT || op==OP_Ge );
4993 assert( pExpr->op!=TK_LE || op==OP_Gt );
4994 assert( pExpr->op!=TK_GT || op==OP_Le );
4995 assert( pExpr->op!=TK_GE || op==OP_Lt );
4996
danba00e302016-07-23 20:24:06 +00004997 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004998 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004999 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005000 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5001 if( pAlt!=pExpr ){
5002 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5003 }else if( pExpr->op==TK_AND ){
5004 testcase( jumpIfNull==0 );
5005 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5006 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5007 }else{
5008 int d2 = sqlite3VdbeMakeLabel(pParse);
5009 testcase( jumpIfNull==0 );
5010 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5011 jumpIfNull^SQLITE_JUMPIFNULL);
5012 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5013 sqlite3VdbeResolveLabel(v, d2);
5014 }
drhcce7d172000-05-31 15:34:51 +00005015 break;
5016 }
5017 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005018 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005019 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005020 break;
5021 }
drh8abed7b2018-02-26 18:49:05 +00005022 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005023 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5024 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005025 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005026 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005027 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005028 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005029 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005030 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005031 /* IS TRUE and IS NOT FALSE */
5032 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5033 isNot ? 0 : SQLITE_JUMPIFNULL);
5034
5035 }else{
5036 /* IS FALSE and IS NOT TRUE */
5037 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005038 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005039 }
drh007c8432018-02-26 03:20:18 +00005040 break;
5041 }
drhde845c22016-03-17 19:07:52 +00005042 case TK_IS:
5043 case TK_ISNOT:
5044 testcase( pExpr->op==TK_IS );
5045 testcase( pExpr->op==TK_ISNOT );
5046 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5047 jumpIfNull = SQLITE_NULLEQ;
5048 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00005049 case TK_LT:
5050 case TK_LE:
5051 case TK_GT:
5052 case TK_GE:
5053 case TK_NE:
5054 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005055 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005056 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005057 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5058 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005059 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005060 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005061 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5062 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5063 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5064 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005065 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5066 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5067 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5068 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5069 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5070 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005071 testcase( regFree1==0 );
5072 testcase( regFree2==0 );
5073 break;
5074 }
drhcce7d172000-05-31 15:34:51 +00005075 case TK_ISNULL:
5076 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005077 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5078 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005079 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5080 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005081 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005082 break;
5083 }
drhfef52082000-06-06 01:50:43 +00005084 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005085 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005086 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005087 break;
5088 }
drh84e30ca2011-02-10 17:46:14 +00005089#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005090 case TK_IN: {
5091 if( jumpIfNull ){
5092 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5093 }else{
drhec4ccdb2018-12-29 02:26:59 +00005094 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005095 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5096 sqlite3VdbeResolveLabel(v, destIfNull);
5097 }
5098 break;
5099 }
shanehbb201342011-02-09 19:55:20 +00005100#endif
drhcce7d172000-05-31 15:34:51 +00005101 default: {
danba00e302016-07-23 20:24:06 +00005102 default_expr:
drhad317272019-04-19 16:21:51 +00005103 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005104 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005105 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005106 /* no-op */
5107 }else{
5108 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5109 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005110 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005111 testcase( regFree1==0 );
5112 testcase( jumpIfNull==0 );
5113 }
drhcce7d172000-05-31 15:34:51 +00005114 break;
5115 }
5116 }
drh2dcef112008-01-12 19:03:48 +00005117 sqlite3ReleaseTempReg(pParse, regFree1);
5118 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005119}
drh22827922000-06-06 17:27:05 +00005120
5121/*
drh72bc8202015-06-11 13:58:35 +00005122** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5123** code generation, and that copy is deleted after code generation. This
5124** ensures that the original pExpr is unchanged.
5125*/
5126void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5127 sqlite3 *db = pParse->db;
5128 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5129 if( db->mallocFailed==0 ){
5130 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5131 }
5132 sqlite3ExprDelete(db, pCopy);
5133}
5134
dan5aa550c2017-06-24 18:10:29 +00005135/*
5136** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5137** type of expression.
5138**
5139** If pExpr is a simple SQL value - an integer, real, string, blob
5140** or NULL value - then the VDBE currently being prepared is configured
5141** to re-prepare each time a new value is bound to variable pVar.
5142**
5143** Additionally, if pExpr is a simple SQL value and the value is the
5144** same as that currently bound to variable pVar, non-zero is returned.
5145** Otherwise, if the values are not the same or if pExpr is not a simple
5146** SQL value, zero is returned.
5147*/
5148static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5149 int res = 0;
drhc0804222017-06-28 21:47:16 +00005150 int iVar;
5151 sqlite3_value *pL, *pR = 0;
5152
5153 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5154 if( pR ){
5155 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005156 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005157 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005158 if( pL ){
5159 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5160 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5161 }
5162 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005163 }
drhc0804222017-06-28 21:47:16 +00005164 sqlite3ValueFree(pR);
5165 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005166 }
5167
5168 return res;
5169}
drh72bc8202015-06-11 13:58:35 +00005170
5171/*
drh1d9da702010-01-07 15:17:02 +00005172** Do a deep comparison of two expression trees. Return 0 if the two
5173** expressions are completely identical. Return 1 if they differ only
5174** by a COLLATE operator at the top level. Return 2 if there are differences
5175** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005176**
drh619a1302013-08-01 13:04:46 +00005177** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5178** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5179**
drh66518ca2013-08-01 15:09:57 +00005180** The pA side might be using TK_REGISTER. If that is the case and pB is
5181** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5182**
drh1d9da702010-01-07 15:17:02 +00005183** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005184** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005185** identical, we return 2 just to be safe. So if this routine
5186** returns 2, then you do not really know for certain if the two
5187** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005188** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005189** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005190** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005191** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005192**
drhc0804222017-06-28 21:47:16 +00005193** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5194** pParse->pReprepare can be matched against literals in pB. The
5195** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5196** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5197** Argument pParse should normally be NULL. If it is not NULL and pA or
5198** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005199*/
dan5aa550c2017-06-24 18:10:29 +00005200int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005201 u32 combinedFlags;
5202 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005203 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005204 }
dan5aa550c2017-06-24 18:10:29 +00005205 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5206 return 0;
5207 }
drh10d1edf2013-11-15 15:52:39 +00005208 combinedFlags = pA->flags | pB->flags;
5209 if( combinedFlags & EP_IntValue ){
5210 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5211 return 0;
5212 }
drh1d9da702010-01-07 15:17:02 +00005213 return 2;
drh22827922000-06-06 17:27:05 +00005214 }
dan16dd3982018-12-20 15:04:38 +00005215 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005216 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005217 return 1;
5218 }
dan5aa550c2017-06-24 18:10:29 +00005219 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005220 return 1;
5221 }
5222 return 2;
5223 }
drh2edc5fd2015-11-24 02:10:52 +00005224 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005225 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005226 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005227#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005228 assert( pA->op==pB->op );
5229 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5230 return 2;
5231 }
drheda079c2018-09-20 19:02:15 +00005232 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005233 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5234 return 2;
5235 }
drheda079c2018-09-20 19:02:15 +00005236 }
5237#endif
drhf20bbc52019-01-17 01:06:00 +00005238 }else if( pA->op==TK_NULL ){
5239 return 0;
drhd5af5422018-04-13 14:27:01 +00005240 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005241 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005242 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005243 return 2;
drh2646da72005-12-09 20:02:05 +00005244 }
drh22827922000-06-06 17:27:05 +00005245 }
drh898c5272019-10-22 00:03:41 +00005246 if( (pA->flags & (EP_Distinct|EP_Commuted))
5247 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005248 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005249 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005250 if( (combinedFlags & EP_FixedCol)==0
5251 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005252 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005253 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005254 if( pA->op!=TK_STRING
5255 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005256 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005257 ){
drh10d1edf2013-11-15 15:52:39 +00005258 if( pA->iColumn!=pB->iColumn ) return 2;
drh04307c82019-10-31 13:16:26 +00005259 if( pA->op2!=pB->op2 ){
5260 if( pA->op==TK_TRUTH ) return 2;
5261 if( pA->op==TK_FUNCTION && iTab<0 ){
5262 /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
5263 ** INSERT INTO t1(a) VALUES(julianday('now')+10);
5264 ** Without this test, sqlite3ExprCodeAtInit() will run on the
5265 ** the julianday() of INSERT first, and remember that expression.
5266 ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
5267 ** constraint as redundant, reusing the one from the INSERT, even
5268 ** though the julianday() in INSERT lacks the critical NC_IsCheck
5269 ** flag. See ticket [830277d9db6c3ba1] (2019-10-30)
5270 */
5271 return 2;
5272 }
5273 }
drh0f28e1b2019-10-28 13:07:01 +00005274 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5275 return 2;
5276 }
drh10d1edf2013-11-15 15:52:39 +00005277 }
5278 }
drh1d9da702010-01-07 15:17:02 +00005279 return 0;
drh22827922000-06-06 17:27:05 +00005280}
5281
drh8c6f6662010-04-26 19:17:26 +00005282/*
danfbb6e9f2020-01-09 20:11:29 +00005283** Compare two ExprList objects. Return 0 if they are identical, 1
5284** if they are certainly different, or 2 if it is not possible to
5285** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005286**
drh619a1302013-08-01 13:04:46 +00005287** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5288** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5289**
drh8c6f6662010-04-26 19:17:26 +00005290** This routine might return non-zero for equivalent ExprLists. The
5291** only consequence will be disabled optimizations. But this routine
5292** must never return 0 if the two ExprList objects are different, or
5293** a malfunction will result.
5294**
5295** Two NULL pointers are considered to be the same. But a NULL pointer
5296** always differs from a non-NULL pointer.
5297*/
drh619a1302013-08-01 13:04:46 +00005298int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005299 int i;
5300 if( pA==0 && pB==0 ) return 0;
5301 if( pA==0 || pB==0 ) return 1;
5302 if( pA->nExpr!=pB->nExpr ) return 1;
5303 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005304 int res;
drh8c6f6662010-04-26 19:17:26 +00005305 Expr *pExprA = pA->a[i].pExpr;
5306 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005307 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005308 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005309 }
5310 return 0;
5311}
drh13449892005-09-07 21:22:45 +00005312
drh22827922000-06-06 17:27:05 +00005313/*
drhf9463df2017-02-11 14:59:58 +00005314** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5315** are ignored.
5316*/
5317int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005318 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005319 sqlite3ExprSkipCollateAndLikely(pA),
5320 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005321 iTab);
5322}
5323
5324/*
drhc51cf862019-05-11 19:36:03 +00005325** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005326**
5327** Or if seenNot is true, return non-zero if Expr p can only be
5328** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005329*/
5330static int exprImpliesNotNull(
5331 Parse *pParse, /* Parsing context */
5332 Expr *p, /* The expression to be checked */
5333 Expr *pNN, /* The expression that is NOT NULL */
5334 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005335 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005336){
5337 assert( p );
5338 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005339 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5340 return pNN->op!=TK_NULL;
5341 }
drhc51cf862019-05-11 19:36:03 +00005342 switch( p->op ){
5343 case TK_IN: {
5344 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5345 assert( ExprHasProperty(p,EP_xIsSelect)
5346 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005347 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005348 }
5349 case TK_BETWEEN: {
5350 ExprList *pList = p->x.pList;
5351 assert( pList!=0 );
5352 assert( pList->nExpr==2 );
5353 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005354 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5355 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005356 ){
5357 return 1;
5358 }
drh7a231b42019-08-30 15:11:08 +00005359 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005360 }
5361 case TK_EQ:
5362 case TK_NE:
5363 case TK_LT:
5364 case TK_LE:
5365 case TK_GT:
5366 case TK_GE:
5367 case TK_PLUS:
5368 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005369 case TK_BITOR:
5370 case TK_LSHIFT:
5371 case TK_RSHIFT:
5372 case TK_CONCAT:
5373 seenNot = 1;
5374 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005375 case TK_STAR:
5376 case TK_REM:
5377 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005378 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005379 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5380 /* Fall thru into the next case */
5381 }
5382 case TK_SPAN:
5383 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005384 case TK_UPLUS:
5385 case TK_UMINUS: {
5386 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5387 }
5388 case TK_TRUTH: {
5389 if( seenNot ) return 0;
5390 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005391 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005392 }
dan1cd382e2019-08-29 15:06:35 +00005393 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005394 case TK_NOT: {
5395 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5396 }
5397 }
5398 return 0;
5399}
5400
5401/*
drh4bd5f732013-07-31 23:22:39 +00005402** Return true if we can prove the pE2 will always be true if pE1 is
5403** true. Return false if we cannot complete the proof or if pE2 might
5404** be false. Examples:
5405**
drh619a1302013-08-01 13:04:46 +00005406** pE1: x==5 pE2: x==5 Result: true
5407** pE1: x>0 pE2: x==5 Result: false
5408** pE1: x=21 pE2: x=21 OR y=43 Result: true
5409** pE1: x!=123 pE2: x IS NOT NULL Result: true
5410** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5411** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5412** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005413**
5414** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5415** Expr.iTable<0 then assume a table number given by iTab.
5416**
drhc0804222017-06-28 21:47:16 +00005417** If pParse is not NULL, then the values of bound variables in pE1 are
5418** compared against literal values in pE2 and pParse->pVdbe->expmask is
5419** modified to record which bound variables are referenced. If pParse
5420** is NULL, then false will be returned if pE1 contains any bound variables.
5421**
drh4bd5f732013-07-31 23:22:39 +00005422** When in doubt, return false. Returning true might give a performance
5423** improvement. Returning false might cause a performance reduction, but
5424** it will always give the correct answer and is hence always safe.
5425*/
dan5aa550c2017-06-24 18:10:29 +00005426int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5427 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005428 return 1;
5429 }
5430 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005431 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5432 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005433 ){
5434 return 1;
5435 }
drh664d6d12019-05-04 17:32:07 +00005436 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005437 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005438 ){
drhc51cf862019-05-11 19:36:03 +00005439 return 1;
drh619a1302013-08-01 13:04:46 +00005440 }
5441 return 0;
drh4bd5f732013-07-31 23:22:39 +00005442}
5443
5444/*
drh6c68d752019-11-04 02:05:52 +00005445** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005446** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005447** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5448**
5449** This routine controls an optimization. False positives (setting
5450** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5451** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005452*/
5453static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005454 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005455 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005456 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5457 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005458 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005459 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005460 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005461 case TK_IS:
5462 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005463 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005464 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005465 case TK_IN:
drh25897872018-03-20 21:16:15 +00005466 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005467 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005468 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005469 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005470 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005471 testcase( pExpr->op==TK_IS );
5472 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005473 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005474 testcase( pExpr->op==TK_CASE );
5475 testcase( pExpr->op==TK_IN );
5476 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005477 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005478 return WRC_Prune;
5479 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005480 if( pWalker->u.iCur==pExpr->iTable ){
5481 pWalker->eCode = 1;
5482 return WRC_Abort;
5483 }
5484 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005485
dan9d23ea72019-08-29 19:34:29 +00005486 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005487 if( pWalker->eCode==0 ){
5488 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5489 if( pWalker->eCode ){
5490 pWalker->eCode = 0;
5491 sqlite3WalkExpr(pWalker, pExpr->pRight);
5492 }
dan9d23ea72019-08-29 19:34:29 +00005493 }
5494 return WRC_Prune;
5495
5496 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005497 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5498 assert( pWalker->eCode );
5499 return WRC_Abort;
5500 }
dan9d23ea72019-08-29 19:34:29 +00005501 return WRC_Prune;
5502
drh98811552018-04-03 14:04:48 +00005503 /* Virtual tables are allowed to use constraints like x=NULL. So
5504 ** a term of the form x=y does not prove that y is not null if x
5505 ** is the column of a virtual table */
5506 case TK_EQ:
5507 case TK_NE:
5508 case TK_LT:
5509 case TK_LE:
5510 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005511 case TK_GE: {
5512 Expr *pLeft = pExpr->pLeft;
5513 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005514 testcase( pExpr->op==TK_EQ );
5515 testcase( pExpr->op==TK_NE );
5516 testcase( pExpr->op==TK_LT );
5517 testcase( pExpr->op==TK_LE );
5518 testcase( pExpr->op==TK_GT );
5519 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005520 /* The y.pTab=0 assignment in wherecode.c always happens after the
5521 ** impliesNotNullRow() test */
5522 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5523 && IsVirtual(pLeft->y.pTab))
5524 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5525 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005526 ){
drh78d1d222020-02-17 19:25:07 +00005527 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005528 }
drh78d1d222020-02-17 19:25:07 +00005529 }
drh25897872018-03-20 21:16:15 +00005530 default:
5531 return WRC_Continue;
5532 }
5533}
5534
5535/*
5536** Return true (non-zero) if expression p can only be true if at least
5537** one column of table iTab is non-null. In other words, return true
5538** if expression p will always be NULL or false if every column of iTab
5539** is NULL.
5540**
drh821b6102018-03-24 18:01:51 +00005541** False negatives are acceptable. In other words, it is ok to return
5542** zero even if expression p will never be true of every column of iTab
5543** is NULL. A false negative is merely a missed optimization opportunity.
5544**
5545** False positives are not allowed, however. A false positive may result
5546** in an incorrect answer.
5547**
drh25897872018-03-20 21:16:15 +00005548** Terms of p that are marked with EP_FromJoin (and hence that come from
5549** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5550**
5551** This routine is used to check if a LEFT JOIN can be converted into
5552** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5553** clause requires that some column of the right table of the LEFT JOIN
5554** be non-NULL, then the LEFT JOIN can be safely converted into an
5555** ordinary join.
5556*/
5557int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5558 Walker w;
drh0d950af2019-08-22 16:38:42 +00005559 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005560 if( p==0 ) return 0;
5561 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005562 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005563 }else{
5564 while( p->op==TK_AND ){
5565 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5566 p = p->pRight;
5567 }
drhd6db6592019-04-01 19:42:42 +00005568 }
drh25897872018-03-20 21:16:15 +00005569 w.xExprCallback = impliesNotNullRow;
5570 w.xSelectCallback = 0;
5571 w.xSelectCallback2 = 0;
5572 w.eCode = 0;
5573 w.u.iCur = iTab;
5574 sqlite3WalkExpr(&w, p);
5575 return w.eCode;
5576}
5577
5578/*
drh030796d2012-08-23 16:18:10 +00005579** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005580** to determine if an expression can be evaluated by reference to the
5581** index only, without having to do a search for the corresponding
5582** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5583** is the cursor for the table.
5584*/
5585struct IdxCover {
5586 Index *pIdx; /* The index to be tested for coverage */
5587 int iCur; /* Cursor number for the table corresponding to the index */
5588};
5589
5590/*
5591** Check to see if there are references to columns in table
5592** pWalker->u.pIdxCover->iCur can be satisfied using the index
5593** pWalker->u.pIdxCover->pIdx.
5594*/
5595static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5596 if( pExpr->op==TK_COLUMN
5597 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005598 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005599 ){
5600 pWalker->eCode = 1;
5601 return WRC_Abort;
5602 }
5603 return WRC_Continue;
5604}
5605
5606/*
drhe604ec02016-07-27 19:20:58 +00005607** Determine if an index pIdx on table with cursor iCur contains will
5608** the expression pExpr. Return true if the index does cover the
5609** expression and false if the pExpr expression references table columns
5610** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005611**
5612** An index covering an expression means that the expression can be
5613** evaluated using only the index and without having to lookup the
5614** corresponding table entry.
5615*/
5616int sqlite3ExprCoveredByIndex(
5617 Expr *pExpr, /* The index to be tested */
5618 int iCur, /* The cursor number for the corresponding table */
5619 Index *pIdx /* The index that might be used for coverage */
5620){
5621 Walker w;
5622 struct IdxCover xcov;
5623 memset(&w, 0, sizeof(w));
5624 xcov.iCur = iCur;
5625 xcov.pIdx = pIdx;
5626 w.xExprCallback = exprIdxCover;
5627 w.u.pIdxCover = &xcov;
5628 sqlite3WalkExpr(&w, pExpr);
5629 return !w.eCode;
5630}
5631
5632
5633/*
5634** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005635** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005636** aggregate function, in order to implement the
5637** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005638*/
drh030796d2012-08-23 16:18:10 +00005639struct SrcCount {
5640 SrcList *pSrc; /* One particular FROM clause in a nested query */
5641 int nThis; /* Number of references to columns in pSrcList */
5642 int nOther; /* Number of references to columns in other FROM clauses */
5643};
5644
5645/*
5646** Count the number of references to columns.
5647*/
5648static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005649 /* There was once a NEVER() on the second term on the grounds that
5650 ** sqlite3FunctionUsesThisSrc() was always called before
5651 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5652 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5653 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5654 ** FunctionUsesThisSrc() when creating a new sub-select. */
5655 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005656 int i;
drh030796d2012-08-23 16:18:10 +00005657 struct SrcCount *p = pWalker->u.pSrcCount;
5658 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005659 int nSrc = pSrc ? pSrc->nSrc : 0;
5660 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005661 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005662 }
drh655814d2015-01-09 01:27:29 +00005663 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005664 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005665 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5666 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005667 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005668 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005669 p->nOther++;
5670 }
drh374fdce2012-04-17 16:38:53 +00005671 }
drh030796d2012-08-23 16:18:10 +00005672 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005673}
5674
5675/*
drh030796d2012-08-23 16:18:10 +00005676** Determine if any of the arguments to the pExpr Function reference
5677** pSrcList. Return true if they do. Also return true if the function
5678** has no arguments or has only constant arguments. Return false if pExpr
5679** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005680*/
drh030796d2012-08-23 16:18:10 +00005681int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005682 Walker w;
drh030796d2012-08-23 16:18:10 +00005683 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005684 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005685 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005686 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005687 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005688 w.u.pSrcCount = &cnt;
5689 cnt.pSrc = pSrcList;
5690 cnt.nThis = 0;
5691 cnt.nOther = 0;
5692 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005693#ifndef SQLITE_OMIT_WINDOWFUNC
5694 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5695 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5696 }
5697#endif
drh030796d2012-08-23 16:18:10 +00005698 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005699}
5700
5701/*
drh13449892005-09-07 21:22:45 +00005702** Add a new element to the pAggInfo->aCol[] array. Return the index of
5703** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005704*/
drh17435752007-08-16 04:30:38 +00005705static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005706 int i;
drhcf643722007-03-27 13:36:37 +00005707 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005708 db,
drhcf643722007-03-27 13:36:37 +00005709 pInfo->aCol,
5710 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005711 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005712 &i
5713 );
drh13449892005-09-07 21:22:45 +00005714 return i;
5715}
5716
5717/*
5718** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5719** the new element. Return a negative number if malloc fails.
5720*/
drh17435752007-08-16 04:30:38 +00005721static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005722 int i;
drhcf643722007-03-27 13:36:37 +00005723 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005724 db,
drhcf643722007-03-27 13:36:37 +00005725 pInfo->aFunc,
5726 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005727 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005728 &i
5729 );
drh13449892005-09-07 21:22:45 +00005730 return i;
5731}
drh22827922000-06-06 17:27:05 +00005732
5733/*
drh7d10d5a2008-08-20 16:35:10 +00005734** This is the xExprCallback for a tree walker. It is used to
5735** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005736** for additional information.
drh22827922000-06-06 17:27:05 +00005737*/
drh7d10d5a2008-08-20 16:35:10 +00005738static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005739 int i;
drh7d10d5a2008-08-20 16:35:10 +00005740 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005741 Parse *pParse = pNC->pParse;
5742 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005743 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005744
drh25c3b8c2018-04-16 10:34:13 +00005745 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005746 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005747 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005748 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005749 testcase( pExpr->op==TK_AGG_COLUMN );
5750 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005751 /* Check to see if the column is in one of the tables in the FROM
5752 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005753 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005754 struct SrcList_item *pItem = pSrcList->a;
5755 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5756 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005757 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005758 if( pExpr->iTable==pItem->iCursor ){
5759 /* If we reach this point, it means that pExpr refers to a table
5760 ** that is in the FROM clause of the aggregate query.
5761 **
5762 ** Make an entry for the column in pAggInfo->aCol[] if there
5763 ** is not an entry there already.
5764 */
drh7f906d62007-03-12 23:48:52 +00005765 int k;
drh13449892005-09-07 21:22:45 +00005766 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005767 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005768 if( pCol->iTable==pExpr->iTable &&
5769 pCol->iColumn==pExpr->iColumn ){
5770 break;
5771 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005772 }
danielk19771e536952007-08-16 10:09:01 +00005773 if( (k>=pAggInfo->nColumn)
5774 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5775 ){
drh7f906d62007-03-12 23:48:52 +00005776 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005777 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005778 pCol->iTable = pExpr->iTable;
5779 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005780 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005781 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005782 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005783 if( pAggInfo->pGroupBy ){
5784 int j, n;
5785 ExprList *pGB = pAggInfo->pGroupBy;
5786 struct ExprList_item *pTerm = pGB->a;
5787 n = pGB->nExpr;
5788 for(j=0; j<n; j++, pTerm++){
5789 Expr *pE = pTerm->pExpr;
5790 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5791 pE->iColumn==pExpr->iColumn ){
5792 pCol->iSorterColumn = j;
5793 break;
5794 }
5795 }
5796 }
5797 if( pCol->iSorterColumn<0 ){
5798 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5799 }
5800 }
5801 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5802 ** because it was there before or because we just created it).
5803 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5804 ** pAggInfo->aCol[] entry.
5805 */
drhebb6a652013-09-12 23:42:22 +00005806 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005807 pExpr->pAggInfo = pAggInfo;
5808 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005809 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005810 break;
5811 } /* endif pExpr->iTable==pItem->iCursor */
5812 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005813 }
drh7d10d5a2008-08-20 16:35:10 +00005814 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005815 }
5816 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005817 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005818 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005819 ){
drh13449892005-09-07 21:22:45 +00005820 /* Check to see if pExpr is a duplicate of another aggregate
5821 ** function that is already in the pAggInfo structure
5822 */
5823 struct AggInfo_func *pItem = pAggInfo->aFunc;
5824 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005825 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005826 break;
5827 }
drh22827922000-06-06 17:27:05 +00005828 }
drh13449892005-09-07 21:22:45 +00005829 if( i>=pAggInfo->nFunc ){
5830 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5831 */
danielk197714db2662006-01-09 16:12:04 +00005832 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005833 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005834 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005835 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005836 pItem = &pAggInfo->aFunc[i];
5837 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005838 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005839 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005840 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005841 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005842 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005843 if( pExpr->flags & EP_Distinct ){
5844 pItem->iDistinct = pParse->nTab++;
5845 }else{
5846 pItem->iDistinct = -1;
5847 }
drh13449892005-09-07 21:22:45 +00005848 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005849 }
drh13449892005-09-07 21:22:45 +00005850 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5851 */
drhc5cd1242013-09-12 16:50:49 +00005852 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005853 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005854 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005855 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005856 return WRC_Prune;
5857 }else{
5858 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005859 }
drh22827922000-06-06 17:27:05 +00005860 }
5861 }
drh7d10d5a2008-08-20 16:35:10 +00005862 return WRC_Continue;
5863}
5864static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005865 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005866 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005867 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005868}
drh979dd1b2017-05-29 14:26:07 +00005869static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5870 UNUSED_PARAMETER(pSelect);
5871 pWalker->walkerDepth--;
5872}
drh626a8792005-01-17 22:08:19 +00005873
5874/*
drhe8abb4c2012-11-02 18:24:57 +00005875** Analyze the pExpr expression looking for aggregate functions and
5876** for variables that need to be added to AggInfo object that pNC->pAggInfo
5877** points to. Additional entries are made on the AggInfo object as
5878** necessary.
drh626a8792005-01-17 22:08:19 +00005879**
5880** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005881** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005882*/
drhd2b3e232008-01-23 14:51:49 +00005883void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005884 Walker w;
5885 w.xExprCallback = analyzeAggregate;
5886 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005887 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5888 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005889 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005890 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005891 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005892 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005893}
drh5d9a4af2005-08-30 00:54:01 +00005894
5895/*
5896** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5897** expression list. Return the number of errors.
5898**
5899** If an error is found, the analysis is cut short.
5900*/
drhd2b3e232008-01-23 14:51:49 +00005901void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005902 struct ExprList_item *pItem;
5903 int i;
drh5d9a4af2005-08-30 00:54:01 +00005904 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005905 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5906 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005907 }
5908 }
drh5d9a4af2005-08-30 00:54:01 +00005909}
drh892d3172008-01-10 03:46:36 +00005910
5911/*
drhceea3322009-04-23 13:22:42 +00005912** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005913*/
5914int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005915 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005916 return ++pParse->nMem;
5917 }
danielk19772f425f62008-07-04 09:41:39 +00005918 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005919}
drhceea3322009-04-23 13:22:42 +00005920
5921/*
5922** Deallocate a register, making available for reuse for some other
5923** purpose.
drhceea3322009-04-23 13:22:42 +00005924*/
drh892d3172008-01-10 03:46:36 +00005925void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00005926 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00005927 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00005928 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5929 pParse->aTempReg[pParse->nTempReg++] = iReg;
5930 }
drh892d3172008-01-10 03:46:36 +00005931 }
5932}
5933
5934/*
drhed24da42016-09-06 14:37:05 +00005935** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005936*/
5937int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005938 int i, n;
drhed24da42016-09-06 14:37:05 +00005939 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005940 i = pParse->iRangeReg;
5941 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005942 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005943 pParse->iRangeReg += nReg;
5944 pParse->nRangeReg -= nReg;
5945 }else{
5946 i = pParse->nMem+1;
5947 pParse->nMem += nReg;
5948 }
5949 return i;
5950}
5951void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005952 if( nReg==1 ){
5953 sqlite3ReleaseTempReg(pParse, iReg);
5954 return;
5955 }
drh3aef2fb2020-01-02 17:46:02 +00005956 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00005957 if( nReg>pParse->nRangeReg ){
5958 pParse->nRangeReg = nReg;
5959 pParse->iRangeReg = iReg;
5960 }
5961}
drhcdc69552011-12-06 13:24:59 +00005962
5963/*
5964** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005965**
5966** Always invoke this procedure after coding a subroutine or co-routine
5967** that might be invoked from other parts of the code, to ensure that
5968** the sub/co-routine does not use registers in common with the code that
5969** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005970*/
5971void sqlite3ClearTempRegCache(Parse *pParse){
5972 pParse->nTempReg = 0;
5973 pParse->nRangeReg = 0;
5974}
drhbb9b5f22016-03-19 00:35:02 +00005975
5976/*
5977** Validate that no temporary register falls within the range of
5978** iFirst..iLast, inclusive. This routine is only call from within assert()
5979** statements.
5980*/
5981#ifdef SQLITE_DEBUG
5982int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5983 int i;
5984 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005985 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5986 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005987 ){
5988 return 0;
5989 }
5990 for(i=0; i<pParse->nTempReg; i++){
5991 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5992 return 0;
5993 }
5994 }
5995 return 1;
5996}
5997#endif /* SQLITE_DEBUG */