blob: c57a0000d53c98174ba6ddee23dd18f2e15165f8 [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*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(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 }
drh11949042019-08-05 18:01:42 +000073 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000074}
75
drh53db1452004-05-20 13:54:53 +000076/*
drh8b4c40d2007-02-01 23:02:45 +000077** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000078** sequence named by pToken. Return a pointer to a new Expr node that
79** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000080**
81** If a memory allocation error occurs, that fact is recorded in pParse->db
82** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000083*/
drh4ef7efa2014-03-20 15:14:08 +000084Expr *sqlite3ExprAddCollateToken(
85 Parse *pParse, /* Parsing context */
86 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000087 const Token *pCollName, /* Name of collating sequence */
88 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000089){
drh0a8a4062012-12-07 18:38:16 +000090 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000091 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000092 if( pNew ){
93 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000094 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000095 pExpr = pNew;
96 }
drhae80dde2012-12-06 21:16:43 +000097 }
drh0a8a4062012-12-07 18:38:16 +000098 return pExpr;
99}
100Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000101 Token s;
102 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000103 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000104 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000105}
106
107/*
drh0d950af2019-08-22 16:38:42 +0000108** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000109*/
110Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000111 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
112 assert( pExpr->op==TK_COLLATE );
113 pExpr = pExpr->pLeft;
114 }
115 return pExpr;
116}
117
118/*
119** Skip over any TK_COLLATE operators and/or any unlikely()
120** or likelihood() or likely() functions at the root of an
121** expression.
122*/
123Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000124 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000125 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000126 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
127 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000128 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000129 pExpr = pExpr->x.pList->a[0].pExpr;
130 }else{
drh0b8d2552015-09-05 22:36:07 +0000131 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000132 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000133 }
drha4c3c872013-09-12 17:29:25 +0000134 }
drh0a8a4062012-12-07 18:38:16 +0000135 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000136}
137
138/*
drhae80dde2012-12-06 21:16:43 +0000139** Return the collation sequence for the expression pExpr. If
140** there is no defined collating sequence, return NULL.
141**
drh70efa842017-09-28 01:58:23 +0000142** See also: sqlite3ExprNNCollSeq()
143**
144** The sqlite3ExprNNCollSeq() works the same exact that it returns the
145** default collation if pExpr has no defined collation.
146**
drhae80dde2012-12-06 21:16:43 +0000147** The collating sequence might be determined by a COLLATE operator
148** or by the presence of a column with a defined collating sequence.
149** COLLATE operators take first precedence. Left operands take
150** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000151*/
danielk19777cedc8d2004-06-10 10:50:08 +0000152CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000153 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000154 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000155 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000156 while( p ){
drhae80dde2012-12-06 21:16:43 +0000157 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000158 if( op==TK_REGISTER ) op = p->op2;
159 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000160 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000161 ){
drheda079c2018-09-20 19:02:15 +0000162 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000163 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000164 int j = p->iColumn;
165 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000166 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000167 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000168 }
169 break;
danielk19770202b292004-06-09 09:55:16 +0000170 }
drhe081d732018-07-27 18:19:12 +0000171 if( op==TK_CAST || op==TK_UPLUS ){
172 p = p->pLeft;
173 continue;
174 }
drhcb0e04f2018-12-12 21:34:17 +0000175 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000176 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
177 break;
178 }
drhae80dde2012-12-06 21:16:43 +0000179 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000180 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000181 p = p->pLeft;
182 }else{
drh2308ed32015-02-09 16:09:34 +0000183 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000184 /* The Expr.x union is never used at the same time as Expr.pRight */
185 assert( p->x.pList==0 || p->pRight==0 );
186 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
187 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
188 ** least one EP_Collate. Thus the following two ALWAYS. */
drh92a28242019-10-09 15:37:58 +0000189 if( p->x.pList!=0
190 && !db->mallocFailed
191 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
192 ){
drh2308ed32015-02-09 16:09:34 +0000193 int i;
drh6728cd92015-02-09 18:28:03 +0000194 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000195 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
196 pNext = p->x.pList->a[i].pExpr;
197 break;
198 }
199 }
200 }
201 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000202 }
203 }else{
drh7d10d5a2008-08-20 16:35:10 +0000204 break;
205 }
danielk19770202b292004-06-09 09:55:16 +0000206 }
danielk19777cedc8d2004-06-10 10:50:08 +0000207 if( sqlite3CheckCollSeq(pParse, pColl) ){
208 pColl = 0;
209 }
210 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000211}
212
213/*
drh70efa842017-09-28 01:58:23 +0000214** Return the collation sequence for the expression pExpr. If
215** there is no defined collating sequence, return a pointer to the
216** defautl collation sequence.
217**
218** See also: sqlite3ExprCollSeq()
219**
220** The sqlite3ExprCollSeq() routine works the same except that it
221** returns NULL if there is no defined collation.
222*/
223CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
224 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
225 if( p==0 ) p = pParse->db->pDfltColl;
226 assert( p!=0 );
227 return p;
228}
229
230/*
231** Return TRUE if the two expressions have equivalent collating sequences.
232*/
233int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
234 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
235 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
236 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
237}
238
239/*
drh626a8792005-01-17 22:08:19 +0000240** pExpr is an operand of a comparison operator. aff2 is the
241** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000242** type affinity that should be used for the comparison operator.
243*/
danielk1977e014a832004-05-17 10:48:57 +0000244char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000245 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000246 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000247 /* Both sides of the comparison are columns. If one has numeric
248 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000249 */
drh8a512562005-11-14 22:29:05 +0000250 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000251 return SQLITE_AFF_NUMERIC;
252 }else{
drh05883a32015-06-02 15:32:08 +0000253 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000254 }
danielk1977e014a832004-05-17 10:48:57 +0000255 }else{
256 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000257 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
258 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000259 }
260}
261
drh53db1452004-05-20 13:54:53 +0000262/*
263** pExpr is a comparison operator. Return the type affinity that should
264** be applied to both operands prior to doing the comparison.
265*/
danielk1977e014a832004-05-17 10:48:57 +0000266static char comparisonAffinity(Expr *pExpr){
267 char aff;
268 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
269 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000270 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000271 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000272 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000273 if( pExpr->pRight ){
274 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000275 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
276 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000277 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000278 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000279 }
280 return aff;
281}
282
283/*
284** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
285** idx_affinity is the affinity of an indexed column. Return true
286** if the index with affinity idx_affinity may be used to implement
287** the comparison in pExpr.
288*/
289int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
290 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000291 if( aff<SQLITE_AFF_TEXT ){
292 return 1;
drh8a512562005-11-14 22:29:05 +0000293 }
drh915e4342019-08-06 15:18:15 +0000294 if( aff==SQLITE_AFF_TEXT ){
295 return idx_affinity==SQLITE_AFF_TEXT;
296 }
297 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000298}
299
danielk1977a37cdde2004-05-16 11:15:36 +0000300/*
drh35573352008-01-08 23:54:25 +0000301** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000302** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000303*/
drh35573352008-01-08 23:54:25 +0000304static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
305 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000306 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000307 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000308}
309
drha2e00042002-01-22 03:13:42 +0000310/*
danielk19770202b292004-06-09 09:55:16 +0000311** Return a pointer to the collation sequence that should be used by
312** a binary comparison operator comparing pLeft and pRight.
313**
314** If the left hand expression has a collating sequence type, then it is
315** used. Otherwise the collation sequence for the right hand expression
316** is used, or the default (BINARY) if neither expression has a collating
317** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000318**
319** Argument pRight (but not pLeft) may be a null pointer. In this case,
320** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000321*/
drh0a0e1312007-08-07 17:04:59 +0000322CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000323 Parse *pParse,
324 Expr *pLeft,
325 Expr *pRight
326){
drhec41dda2007-02-07 13:09:45 +0000327 CollSeq *pColl;
328 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000329 if( pLeft->flags & EP_Collate ){
330 pColl = sqlite3ExprCollSeq(pParse, pLeft);
331 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
332 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000333 }else{
334 pColl = sqlite3ExprCollSeq(pParse, pLeft);
335 if( !pColl ){
336 pColl = sqlite3ExprCollSeq(pParse, pRight);
337 }
danielk19770202b292004-06-09 09:55:16 +0000338 }
339 return pColl;
340}
341
342/*
drhbe5c89a2004-07-26 00:31:09 +0000343** Generate code for a comparison operator.
344*/
345static int codeCompare(
346 Parse *pParse, /* The parsing (and code generating) context */
347 Expr *pLeft, /* The left operand */
348 Expr *pRight, /* The right operand */
349 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000350 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000351 int dest, /* Jump here if true. */
352 int jumpIfNull /* If true, jump if either operand is NULL */
353){
drh35573352008-01-08 23:54:25 +0000354 int p5;
355 int addr;
356 CollSeq *p4;
357
358 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
359 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
360 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
361 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000362 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000363 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000364}
365
dancfbb5e82016-07-13 19:48:13 +0000366/*
dan870a0702016-08-01 16:37:43 +0000367** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000368**
369** A vector is defined as any expression that results in two or more
370** columns of result. Every TK_VECTOR node is an vector because the
371** parser will not generate a TK_VECTOR with fewer than two entries.
372** But a TK_SELECT might be either a vector or a scalar. It is only
373** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000374*/
375int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000376 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000377}
378
379/*
dancfbb5e82016-07-13 19:48:13 +0000380** If the expression passed as the only argument is of type TK_VECTOR
381** return the number of expressions in the vector. Or, if the expression
382** is a sub-select, return the number of columns in the sub-select. For
383** any other type of expression, return 1.
384*/
dan71c57db2016-07-09 20:23:55 +0000385int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000386 u8 op = pExpr->op;
387 if( op==TK_REGISTER ) op = pExpr->op2;
388 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000389 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000390 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000391 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000392 }else{
393 return 1;
dan71c57db2016-07-09 20:23:55 +0000394 }
dan71c57db2016-07-09 20:23:55 +0000395}
396
danba00e302016-07-23 20:24:06 +0000397/*
drhfc7f27b2016-08-20 00:07:01 +0000398** Return a pointer to a subexpression of pVector that is the i-th
399** column of the vector (numbered starting with 0). The caller must
400** ensure that i is within range.
401**
drh76dbe7a2016-08-20 21:02:38 +0000402** If pVector is really a scalar (and "scalar" here includes subqueries
403** that return a single column!) then return pVector unmodified.
404**
drhfc7f27b2016-08-20 00:07:01 +0000405** pVector retains ownership of the returned subexpression.
406**
407** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000408** just the expression for the i-th term of the result set, and may
409** not be ready for evaluation because the table cursor has not yet
410** been positioned.
danba00e302016-07-23 20:24:06 +0000411*/
drhfc7f27b2016-08-20 00:07:01 +0000412Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000413 assert( i<sqlite3ExprVectorSize(pVector) );
414 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000415 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
416 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000417 return pVector->x.pSelect->pEList->a[i].pExpr;
418 }else{
419 return pVector->x.pList->a[i].pExpr;
420 }
dan71c57db2016-07-09 20:23:55 +0000421 }
dan870a0702016-08-01 16:37:43 +0000422 return pVector;
dan71c57db2016-07-09 20:23:55 +0000423}
drhfc7f27b2016-08-20 00:07:01 +0000424
drhfc7f27b2016-08-20 00:07:01 +0000425/*
426** Compute and return a new Expr object which when passed to
427** sqlite3ExprCode() will generate all necessary code to compute
428** the iField-th column of the vector expression pVector.
429**
drh8762ec12016-08-20 01:06:22 +0000430** It is ok for pVector to be a scalar (as long as iField==0).
431** In that case, this routine works like sqlite3ExprDup().
432**
drhfc7f27b2016-08-20 00:07:01 +0000433** The caller owns the returned Expr object and is responsible for
434** ensuring that the returned value eventually gets freed.
435**
drh8762ec12016-08-20 01:06:22 +0000436** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000437** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000438** valid for the life of the returned object. If pVector is a TK_VECTOR
439** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000440** returns.
drh8762ec12016-08-20 01:06:22 +0000441**
442** A trick to cause a TK_SELECT pVector to be deleted together with
443** the returned Expr object is to attach the pVector to the pRight field
444** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000445*/
446Expr *sqlite3ExprForVectorField(
447 Parse *pParse, /* Parsing context */
448 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000449 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000450){
451 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000452 if( pVector->op==TK_SELECT ){
453 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000454 /* The TK_SELECT_COLUMN Expr node:
455 **
drh966e2912017-01-03 02:58:01 +0000456 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000457 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000458 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000459 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000460 ** pLeft->iTable: First in an array of register holding result, or 0
461 ** if the result is not yet computed.
462 **
463 ** sqlite3ExprDelete() specifically skips the recursive delete of
464 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000465 ** can be attached to pRight to cause this node to take ownership of
466 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
467 ** with the same pLeft pointer to the pVector, but only one of them
468 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000469 */
drhabfd35e2016-12-06 22:47:23 +0000470 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000471 if( pRet ){
472 pRet->iColumn = iField;
473 pRet->pLeft = pVector;
474 }
drhfc7f27b2016-08-20 00:07:01 +0000475 assert( pRet==0 || pRet->iTable==0 );
476 }else{
drha1251bc2016-08-20 00:51:37 +0000477 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
478 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000479 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000480 }
481 return pRet;
482}
dan71c57db2016-07-09 20:23:55 +0000483
dan5c288b92016-07-30 21:02:33 +0000484/*
485** If expression pExpr is of type TK_SELECT, generate code to evaluate
486** it. Return the register in which the result is stored (or, if the
487** sub-select returns more than one column, the first in an array
488** of registers in which the result is stored).
489**
490** If pExpr is not a TK_SELECT expression, return 0.
491*/
492static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000493 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000494#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000495 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000496 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000497 }
danf9b2e052016-08-02 17:45:00 +0000498#endif
dan8da209b2016-07-26 18:06:08 +0000499 return reg;
500}
501
dan5c288b92016-07-30 21:02:33 +0000502/*
503** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000504** or TK_SELECT that returns more than one column. This function returns
505** the register number of a register that contains the value of
506** element iField of the vector.
507**
508** If pVector is a TK_SELECT expression, then code for it must have
509** already been generated using the exprCodeSubselect() routine. In this
510** case parameter regSelect should be the first in an array of registers
511** containing the results of the sub-select.
512**
513** If pVector is of type TK_VECTOR, then code for the requested field
514** is generated. In this case (*pRegFree) may be set to the number of
515** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000516**
517** Before returning, output parameter (*ppExpr) is set to point to the
518** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000519*/
520static int exprVectorRegister(
521 Parse *pParse, /* Parse context */
522 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000523 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000524 int regSelect, /* First in array of registers */
525 Expr **ppExpr, /* OUT: Expression element */
526 int *pRegFree /* OUT: Temp register to free */
527){
drh12abf402016-08-22 14:30:05 +0000528 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000529 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000530 if( op==TK_REGISTER ){
531 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
532 return pVector->iTable+iField;
533 }
534 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000535 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
536 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000537 }
dan870a0702016-08-01 16:37:43 +0000538 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000539 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
540}
541
542/*
543** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000544** the result of the comparison (1, 0, or NULL) and write that
545** result into register dest.
546**
547** The caller must satisfy the following preconditions:
548**
549** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
550** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
551** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000552*/
drh79752b62016-08-13 10:02:17 +0000553static void codeVectorCompare(
554 Parse *pParse, /* Code generator context */
555 Expr *pExpr, /* The comparison operation */
556 int dest, /* Write results into this register */
557 u8 op, /* Comparison operator */
558 u8 p5 /* SQLITE_NULLEQ or zero */
559){
dan71c57db2016-07-09 20:23:55 +0000560 Vdbe *v = pParse->pVdbe;
561 Expr *pLeft = pExpr->pLeft;
562 Expr *pRight = pExpr->pRight;
563 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000564 int i;
565 int regLeft = 0;
566 int regRight = 0;
567 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000568 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000569
drh245ce622017-01-01 12:44:07 +0000570 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
571 sqlite3ErrorMsg(pParse, "row value misused");
572 return;
573 }
drhb29e60c2016-09-05 12:02:34 +0000574 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
575 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
576 || pExpr->op==TK_LT || pExpr->op==TK_GT
577 || pExpr->op==TK_LE || pExpr->op==TK_GE
578 );
579 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
580 || (pExpr->op==TK_ISNOT && op==TK_NE) );
581 assert( p5==0 || pExpr->op!=op );
582 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000583
drhb29e60c2016-09-05 12:02:34 +0000584 p5 |= SQLITE_STOREP2;
585 if( opx==TK_LE ) opx = TK_LT;
586 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000587
drhb29e60c2016-09-05 12:02:34 +0000588 regLeft = exprCodeSubselect(pParse, pLeft);
589 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000590
drhb29e60c2016-09-05 12:02:34 +0000591 for(i=0; 1 /*Loop exits by "break"*/; i++){
592 int regFree1 = 0, regFree2 = 0;
593 Expr *pL, *pR;
594 int r1, r2;
595 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000596 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
597 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
598 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
599 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
600 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
601 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
602 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
603 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
604 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
605 sqlite3ReleaseTempReg(pParse, regFree1);
606 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000607 if( i==nLeft-1 ){
608 break;
dan71c57db2016-07-09 20:23:55 +0000609 }
drhb29e60c2016-09-05 12:02:34 +0000610 if( opx==TK_EQ ){
611 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
612 p5 |= SQLITE_KEEPNULL;
613 }else if( opx==TK_NE ){
614 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
615 p5 |= SQLITE_KEEPNULL;
616 }else{
617 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
618 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
619 VdbeCoverageIf(v, op==TK_LT);
620 VdbeCoverageIf(v, op==TK_GT);
621 VdbeCoverageIf(v, op==TK_LE);
622 VdbeCoverageIf(v, op==TK_GE);
623 if( i==nLeft-2 ) opx = op;
624 }
dan71c57db2016-07-09 20:23:55 +0000625 }
drhb29e60c2016-09-05 12:02:34 +0000626 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000627}
628
danielk19774b5255a2008-06-05 16:47:39 +0000629#if SQLITE_MAX_EXPR_DEPTH>0
630/*
631** Check that argument nHeight is less than or equal to the maximum
632** expression depth allowed. If it is not, leave an error message in
633** pParse.
634*/
drh7d10d5a2008-08-20 16:35:10 +0000635int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000636 int rc = SQLITE_OK;
637 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
638 if( nHeight>mxHeight ){
639 sqlite3ErrorMsg(pParse,
640 "Expression tree is too large (maximum depth %d)", mxHeight
641 );
642 rc = SQLITE_ERROR;
643 }
644 return rc;
645}
646
647/* The following three functions, heightOfExpr(), heightOfExprList()
648** and heightOfSelect(), are used to determine the maximum height
649** of any expression tree referenced by the structure passed as the
650** first argument.
651**
652** If this maximum height is greater than the current value pointed
653** to by pnHeight, the second parameter, then set *pnHeight to that
654** value.
655*/
656static void heightOfExpr(Expr *p, int *pnHeight){
657 if( p ){
658 if( p->nHeight>*pnHeight ){
659 *pnHeight = p->nHeight;
660 }
661 }
662}
663static void heightOfExprList(ExprList *p, int *pnHeight){
664 if( p ){
665 int i;
666 for(i=0; i<p->nExpr; i++){
667 heightOfExpr(p->a[i].pExpr, pnHeight);
668 }
669 }
670}
dan1a3a3082018-01-18 19:00:54 +0000671static void heightOfSelect(Select *pSelect, int *pnHeight){
672 Select *p;
673 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000674 heightOfExpr(p->pWhere, pnHeight);
675 heightOfExpr(p->pHaving, pnHeight);
676 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000677 heightOfExprList(p->pEList, pnHeight);
678 heightOfExprList(p->pGroupBy, pnHeight);
679 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000680 }
681}
682
683/*
684** Set the Expr.nHeight variable in the structure passed as an
685** argument. An expression with no children, Expr.pList or
686** Expr.pSelect member has a height of 1. Any other expression
687** has a height equal to the maximum height of any other
688** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000689**
690** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
691** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000692*/
693static void exprSetHeight(Expr *p){
694 int nHeight = 0;
695 heightOfExpr(p->pLeft, &nHeight);
696 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000697 if( ExprHasProperty(p, EP_xIsSelect) ){
698 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000699 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000700 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000701 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000702 }
danielk19774b5255a2008-06-05 16:47:39 +0000703 p->nHeight = nHeight + 1;
704}
705
706/*
707** Set the Expr.nHeight variable using the exprSetHeight() function. If
708** the height is greater than the maximum allowed expression depth,
709** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000710**
711** Also propagate all EP_Propagate flags from the Expr.x.pList into
712** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000713*/
drh2308ed32015-02-09 16:09:34 +0000714void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000715 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000716 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000717 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000718}
719
720/*
721** Return the maximum height of any expression tree referenced
722** by the select statement passed as an argument.
723*/
724int sqlite3SelectExprHeight(Select *p){
725 int nHeight = 0;
726 heightOfSelect(p, &nHeight);
727 return nHeight;
728}
drh2308ed32015-02-09 16:09:34 +0000729#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
730/*
731** Propagate all EP_Propagate flags from the Expr.x.pList into
732** Expr.flags.
733*/
734void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
735 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
736 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
737 }
738}
739#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000740#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
741
drhbe5c89a2004-07-26 00:31:09 +0000742/*
drhb7916a72009-05-27 10:31:29 +0000743** This routine is the core allocator for Expr nodes.
744**
drha76b5df2002-02-23 02:32:10 +0000745** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000746** for this node and for the pToken argument is a single allocation
747** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000748** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000749**
750** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000751** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000752** parameter is ignored if pToken is NULL or if the token does not
753** appear to be quoted. If the quotes were of the form "..." (double-quotes)
754** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000755**
756** Special case: If op==TK_INTEGER and pToken points to a string that
757** can be translated into a 32-bit integer, then the token is not
758** stored in u.zToken. Instead, the integer values is written
759** into u.iValue and the EP_IntValue flag is set. No extra storage
760** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000761*/
drhb7916a72009-05-27 10:31:29 +0000762Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000763 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000764 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000765 const Token *pToken, /* Token argument. Might be NULL */
766 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000767){
drha76b5df2002-02-23 02:32:10 +0000768 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000769 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000770 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000771
drh575fad62016-02-05 13:38:36 +0000772 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000773 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000774 if( op!=TK_INTEGER || pToken->z==0
775 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
776 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000777 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000778 }
drhb7916a72009-05-27 10:31:29 +0000779 }
drh575fad62016-02-05 13:38:36 +0000780 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000781 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000782 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000783 pNew->op = (u8)op;
784 pNew->iAgg = -1;
785 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000786 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000787 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000788 pNew->u.iValue = iValue;
789 }else{
drh33e619f2009-05-28 01:00:55 +0000790 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000791 assert( pToken->z!=0 || pToken->n==0 );
792 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000793 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000794 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000795 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000796 }
drhb7916a72009-05-27 10:31:29 +0000797 }
798 }
799#if SQLITE_MAX_EXPR_DEPTH>0
800 pNew->nHeight = 1;
801#endif
802 }
drha76b5df2002-02-23 02:32:10 +0000803 return pNew;
804}
805
806/*
drhb7916a72009-05-27 10:31:29 +0000807** Allocate a new expression node from a zero-terminated token that has
808** already been dequoted.
809*/
810Expr *sqlite3Expr(
811 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
812 int op, /* Expression opcode */
813 const char *zToken /* Token argument. Might be NULL */
814){
815 Token x;
816 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000817 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000818 return sqlite3ExprAlloc(db, op, &x, 0);
819}
820
821/*
822** Attach subtrees pLeft and pRight to the Expr node pRoot.
823**
824** If pRoot==NULL that means that a memory allocation error has occurred.
825** In that case, delete the subtrees pLeft and pRight.
826*/
827void sqlite3ExprAttachSubtrees(
828 sqlite3 *db,
829 Expr *pRoot,
830 Expr *pLeft,
831 Expr *pRight
832){
833 if( pRoot==0 ){
834 assert( db->mallocFailed );
835 sqlite3ExprDelete(db, pLeft);
836 sqlite3ExprDelete(db, pRight);
837 }else{
838 if( pRight ){
839 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000840 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000841 }
842 if( pLeft ){
843 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000844 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000845 }
846 exprSetHeight(pRoot);
847 }
848}
849
850/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000851** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000852**
drhbf664462009-06-19 18:32:54 +0000853** One or both of the subtrees can be NULL. Return a pointer to the new
854** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
855** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000856*/
drh17435752007-08-16 04:30:38 +0000857Expr *sqlite3PExpr(
858 Parse *pParse, /* Parsing context */
859 int op, /* Expression opcode */
860 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000861 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000862){
drh5fb52ca2012-03-31 02:34:35 +0000863 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000864 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
865 if( p ){
866 memset(p, 0, sizeof(Expr));
867 p->op = op & 0xff;
868 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000869 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000870 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000871 }else{
872 sqlite3ExprDelete(pParse->db, pLeft);
873 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000874 }
drh4e0cff62004-11-05 05:10:28 +0000875 return p;
876}
877
878/*
drh08de4f72016-04-11 01:06:47 +0000879** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
880** do a memory allocation failure) then delete the pSelect object.
881*/
882void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
883 if( pExpr ){
884 pExpr->x.pSelect = pSelect;
885 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
886 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
887 }else{
888 assert( pParse->db->mallocFailed );
889 sqlite3SelectDelete(pParse->db, pSelect);
890 }
891}
892
893
894/*
drh91bb0ee2004-09-01 03:06:34 +0000895** Join two expressions using an AND operator. If either expression is
896** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000897**
898** If one side or the other of the AND is known to be false, then instead
899** of returning an AND expression, just return a constant expression with
900** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000901*/
drhd5c851c2019-04-19 13:38:34 +0000902Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
903 sqlite3 *db = pParse->db;
904 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000905 return pRight;
906 }else if( pRight==0 ){
907 return pLeft;
drhad317272019-04-19 16:21:51 +0000908 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000909 sqlite3ExprUnmapAndDelete(pParse, pLeft);
910 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000911 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000912 }else{
drhd5c851c2019-04-19 13:38:34 +0000913 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000914 }
915}
916
917/*
918** Construct a new expression node for a function with multiple
919** arguments.
920*/
drh954733b2018-07-27 23:33:16 +0000921Expr *sqlite3ExprFunction(
922 Parse *pParse, /* Parsing context */
923 ExprList *pList, /* Argument list */
924 Token *pToken, /* Name of the function */
925 int eDistinct /* SF_Distinct or SF_ALL or 0 */
926){
drha76b5df2002-02-23 02:32:10 +0000927 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000928 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000929 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000930 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000931 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000932 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000933 return 0;
934 }
drh954733b2018-07-27 23:33:16 +0000935 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
936 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
937 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000938 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000939 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000940 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000941 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000942 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000943 return pNew;
944}
945
946/*
drhfa6bc002004-09-07 16:19:52 +0000947** Assign a variable number to an expression that encodes a wildcard
948** in the original SQL statement.
949**
950** Wildcards consisting of a single "?" are assigned the next sequential
951** variable number.
952**
953** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000954** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000955** the SQL statement comes from an external source.
956**
drh51f49f12009-05-21 20:41:32 +0000957** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000958** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000959** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000960** assigned.
961*/
drhde25a882016-10-03 15:28:24 +0000962void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000963 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000964 const char *z;
drhf326d662016-12-23 13:30:53 +0000965 ynVar x;
drh17435752007-08-16 04:30:38 +0000966
drhfa6bc002004-09-07 16:19:52 +0000967 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000968 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000969 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000970 assert( z!=0 );
971 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000972 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000973 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000974 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000975 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000976 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000977 }else{
drhf326d662016-12-23 13:30:53 +0000978 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000979 if( z[0]=='?' ){
980 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
981 ** use it as the variable number */
982 i64 i;
drh18814df2017-01-31 03:52:34 +0000983 int bOk;
984 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
985 i = z[1]-'0'; /* The common case of ?N for a single digit N */
986 bOk = 1;
987 }else{
988 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
989 }
drh124c0b42011-06-01 18:15:55 +0000990 testcase( i==0 );
991 testcase( i==1 );
992 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
993 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
994 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
995 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
996 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000997 return;
drhfa6bc002004-09-07 16:19:52 +0000998 }
drh8e74e7b2017-01-31 12:41:48 +0000999 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001000 if( x>pParse->nVar ){
1001 pParse->nVar = (int)x;
1002 doAdd = 1;
1003 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1004 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001005 }
1006 }else{
1007 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1008 ** number as the prior appearance of the same name, or if the name
1009 ** has never appeared before, reuse the same variable number
1010 */
drh9bf755c2016-12-23 03:59:31 +00001011 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1012 if( x==0 ){
1013 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001014 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001015 }
drhfa6bc002004-09-07 16:19:52 +00001016 }
drhf326d662016-12-23 13:30:53 +00001017 if( doAdd ){
1018 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1019 }
1020 }
1021 pExpr->iColumn = x;
1022 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001023 sqlite3ErrorMsg(pParse, "too many SQL variables");
1024 }
drhfa6bc002004-09-07 16:19:52 +00001025}
1026
1027/*
danf6963f92009-11-23 14:39:14 +00001028** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001029*/
drh4f0010b2016-04-11 14:49:39 +00001030static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1031 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001032 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1033 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001034
1035 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1036 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001037 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001038#ifdef SQLITE_DEBUG
1039 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1040 assert( p->pLeft==0 );
1041 assert( p->pRight==0 );
1042 assert( p->x.pSelect==0 );
1043 }
1044#endif
1045 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001046 /* The Expr.x union is never used at the same time as Expr.pRight */
1047 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001048 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001049 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001050 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001051 sqlite3ExprDeleteNN(db, p->pRight);
1052 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001053 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001054 sqlite3SelectDelete(db, p->x.pSelect);
1055 }else{
1056 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001057#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001058 if( ExprHasProperty(p, EP_WinFunc) ){
1059 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001060 }
dan6ba7ab02019-07-02 11:56:47 +00001061#endif
dan8117f112019-07-10 20:16:53 +00001062 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001063 }
drh209bc522016-09-23 21:36:24 +00001064 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001065 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001066 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001067 }
drha2e00042002-01-22 03:13:42 +00001068}
drh4f0010b2016-04-11 14:49:39 +00001069void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1070 if( p ) sqlite3ExprDeleteNN(db, p);
1071}
drha2e00042002-01-22 03:13:42 +00001072
drh8e34e402019-06-11 10:43:56 +00001073/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1074** expression.
1075*/
1076void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1077 if( p ){
1078 if( IN_RENAME_OBJECT ){
1079 sqlite3RenameExprUnmap(pParse, p);
1080 }
1081 sqlite3ExprDeleteNN(pParse->db, p);
1082 }
1083}
1084
drhd2687b72005-08-12 22:56:09 +00001085/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001086** Return the number of bytes allocated for the expression structure
1087** passed as the first argument. This is always one of EXPR_FULLSIZE,
1088** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1089*/
1090static int exprStructSize(Expr *p){
1091 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001092 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1093 return EXPR_FULLSIZE;
1094}
1095
1096/*
drh33e619f2009-05-28 01:00:55 +00001097** The dupedExpr*Size() routines each return the number of bytes required
1098** to store a copy of an expression or expression tree. They differ in
1099** how much of the tree is measured.
1100**
1101** dupedExprStructSize() Size of only the Expr structure
1102** dupedExprNodeSize() Size of Expr + space for token
1103** dupedExprSize() Expr + token + subtree components
1104**
1105***************************************************************************
1106**
1107** The dupedExprStructSize() function returns two values OR-ed together:
1108** (1) the space required for a copy of the Expr structure only and
1109** (2) the EP_xxx flags that indicate what the structure size should be.
1110** The return values is always one of:
1111**
1112** EXPR_FULLSIZE
1113** EXPR_REDUCEDSIZE | EP_Reduced
1114** EXPR_TOKENONLYSIZE | EP_TokenOnly
1115**
1116** The size of the structure can be found by masking the return value
1117** of this routine with 0xfff. The flags can be found by masking the
1118** return value with EP_Reduced|EP_TokenOnly.
1119**
1120** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1121** (unreduced) Expr objects as they or originally constructed by the parser.
1122** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001123** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001124** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001125** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001126** to reduce a pristine expression tree from the parser. The implementation
1127** of dupedExprStructSize() contain multiple assert() statements that attempt
1128** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001129*/
1130static int dupedExprStructSize(Expr *p, int flags){
1131 int nSize;
drh33e619f2009-05-28 01:00:55 +00001132 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001133 assert( EXPR_FULLSIZE<=0xfff );
1134 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001135 if( 0==flags || p->op==TK_SELECT_COLUMN
1136#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001137 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001138#endif
1139 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001140 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001141 }else{
drhc5cd1242013-09-12 16:50:49 +00001142 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001143 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001144 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001145 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001146 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001147 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1148 }else{
drhaecd8022013-09-13 18:15:15 +00001149 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001150 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1151 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001152 }
1153 return nSize;
1154}
1155
1156/*
drh33e619f2009-05-28 01:00:55 +00001157** This function returns the space in bytes required to store the copy
1158** of the Expr structure and a copy of the Expr.u.zToken string (if that
1159** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001160*/
1161static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001162 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1163 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001164 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001165 }
danielk1977bc739712009-03-23 04:33:32 +00001166 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001167}
1168
1169/*
1170** Return the number of bytes required to create a duplicate of the
1171** expression passed as the first argument. The second argument is a
1172** mask containing EXPRDUP_XXX flags.
1173**
1174** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001175** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001176**
1177** If the EXPRDUP_REDUCE flag is set, then the return value includes
1178** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1179** and Expr.pRight variables (but not for any structures pointed to or
1180** descended from the Expr.x.pList or Expr.x.pSelect variables).
1181*/
1182static int dupedExprSize(Expr *p, int flags){
1183 int nByte = 0;
1184 if( p ){
1185 nByte = dupedExprNodeSize(p, flags);
1186 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001187 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001188 }
1189 }
1190 return nByte;
1191}
1192
1193/*
1194** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1195** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001196** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001197** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001198** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001199** portion of the buffer copied into by this function.
1200*/
drh3c194692016-04-11 16:43:43 +00001201static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1202 Expr *pNew; /* Value to return */
1203 u8 *zAlloc; /* Memory space from which to build Expr object */
1204 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1205
drh575fad62016-02-05 13:38:36 +00001206 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001207 assert( p );
1208 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1209 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001210
drh3c194692016-04-11 16:43:43 +00001211 /* Figure out where to write the new Expr structure. */
1212 if( pzBuffer ){
1213 zAlloc = *pzBuffer;
1214 staticFlag = EP_Static;
1215 }else{
1216 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1217 staticFlag = 0;
1218 }
1219 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001220
drh3c194692016-04-11 16:43:43 +00001221 if( pNew ){
1222 /* Set nNewSize to the size allocated for the structure pointed to
1223 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1224 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1225 ** by the copy of the p->u.zToken string (if any).
1226 */
1227 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1228 const int nNewSize = nStructSize & 0xfff;
1229 int nToken;
1230 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1231 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001232 }else{
drh3c194692016-04-11 16:43:43 +00001233 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001234 }
drh3c194692016-04-11 16:43:43 +00001235 if( dupFlags ){
1236 assert( ExprHasProperty(p, EP_Reduced)==0 );
1237 memcpy(zAlloc, p, nNewSize);
1238 }else{
1239 u32 nSize = (u32)exprStructSize(p);
1240 memcpy(zAlloc, p, nSize);
1241 if( nSize<EXPR_FULLSIZE ){
1242 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1243 }
1244 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001245
drh3c194692016-04-11 16:43:43 +00001246 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1247 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1248 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1249 pNew->flags |= staticFlag;
1250
1251 /* Copy the p->u.zToken string, if any. */
1252 if( nToken ){
1253 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1254 memcpy(zToken, p->u.zToken, nToken);
1255 }
1256
drh209bc522016-09-23 21:36:24 +00001257 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001258 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1259 if( ExprHasProperty(p, EP_xIsSelect) ){
1260 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001261 }else{
drh3c194692016-04-11 16:43:43 +00001262 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001263 }
drh3c194692016-04-11 16:43:43 +00001264 }
1265
1266 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001267 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001268 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001269 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001270 pNew->pLeft = p->pLeft ?
1271 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1272 pNew->pRight = p->pRight ?
1273 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001274 }
dan67a9b8e2018-06-22 20:51:35 +00001275#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001276 if( ExprHasProperty(p, EP_WinFunc) ){
1277 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1278 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001279 }
dan67a9b8e2018-06-22 20:51:35 +00001280#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001281 if( pzBuffer ){
1282 *pzBuffer = zAlloc;
1283 }
1284 }else{
drh209bc522016-09-23 21:36:24 +00001285 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001286 if( pNew->op==TK_SELECT_COLUMN ){
1287 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001288 assert( p->iColumn==0 || p->pRight==0 );
1289 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001290 }else{
1291 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1292 }
drh3c194692016-04-11 16:43:43 +00001293 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001294 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001295 }
1296 }
1297 return pNew;
1298}
1299
1300/*
danbfe31e72014-01-15 14:17:31 +00001301** Create and return a deep copy of the object passed as the second
1302** argument. If an OOM condition is encountered, NULL is returned
1303** and the db->mallocFailed flag set.
1304*/
daneede6a52014-01-15 19:42:23 +00001305#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001306static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001307 With *pRet = 0;
1308 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001309 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001310 pRet = sqlite3DbMallocZero(db, nByte);
1311 if( pRet ){
1312 int i;
1313 pRet->nCte = p->nCte;
1314 for(i=0; i<p->nCte; i++){
1315 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1316 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1317 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1318 }
1319 }
1320 }
1321 return pRet;
1322}
daneede6a52014-01-15 19:42:23 +00001323#else
1324# define withDup(x,y) 0
1325#endif
dan4e9119d2014-01-13 15:12:23 +00001326
drha8389972018-12-06 22:04:19 +00001327#ifndef SQLITE_OMIT_WINDOWFUNC
1328/*
1329** The gatherSelectWindows() procedure and its helper routine
1330** gatherSelectWindowsCallback() are used to scan all the expressions
1331** an a newly duplicated SELECT statement and gather all of the Window
1332** objects found there, assembling them onto the linked list at Select->pWin.
1333*/
1334static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001335 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001336 Select *pSelect = pWalker->u.pSelect;
1337 Window *pWin = pExpr->y.pWin;
1338 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001339 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001340 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001341 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001342 }
1343 return WRC_Continue;
1344}
drha37b6a52018-12-06 22:12:18 +00001345static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1346 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1347}
drha8389972018-12-06 22:04:19 +00001348static void gatherSelectWindows(Select *p){
1349 Walker w;
1350 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001351 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1352 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001353 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001354 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001355 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001356}
1357#endif
1358
1359
drha76b5df2002-02-23 02:32:10 +00001360/*
drhff78bd22002-02-27 01:47:11 +00001361** The following group of routines make deep copies of expressions,
1362** expression lists, ID lists, and select statements. The copies can
1363** be deleted (by being passed to their respective ...Delete() routines)
1364** without effecting the originals.
1365**
danielk19774adee202004-05-08 08:23:19 +00001366** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1367** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001368** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001369**
drhad3cab52002-05-24 02:04:32 +00001370** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001371**
drhb7916a72009-05-27 10:31:29 +00001372** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001373** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1374** truncated version of the usual Expr structure that will be stored as
1375** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001376*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001377Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001378 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001379 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001380}
danielk19776ab3a2e2009-02-19 14:39:25 +00001381ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001382 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001383 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001384 int i;
drhb1637482017-01-03 00:27:16 +00001385 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001386 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001387 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001388 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001389 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001390 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001391 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001392 pOldItem = p->a;
1393 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001394 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001395 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001396 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001397 if( pOldExpr
1398 && pOldExpr->op==TK_SELECT_COLUMN
1399 && (pNewExpr = pItem->pExpr)!=0
1400 ){
1401 assert( pNewExpr->iColumn==0 || i>0 );
1402 if( pNewExpr->iColumn==0 ){
1403 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001404 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1405 }else{
1406 assert( i>0 );
1407 assert( pItem[-1].pExpr!=0 );
1408 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1409 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1410 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001411 }
1412 }
drh17435752007-08-16 04:30:38 +00001413 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001414 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
dan6e118922019-08-12 16:36:38 +00001415 pItem->sortFlags = pOldItem->sortFlags;
drh3e7bc9c2004-02-21 19:17:17 +00001416 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001417 pItem->bNulls = pOldItem->bNulls;
drh2c036cf2013-06-26 00:34:13 +00001418 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001419 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001420 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001421 }
1422 return pNew;
1423}
danielk197793758c82005-01-21 08:13:14 +00001424
1425/*
1426** If cursors, triggers, views and subqueries are all omitted from
1427** the build, then none of the following routines, except for
1428** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1429** called with a NULL argument.
1430*/
danielk19776a67fe82005-02-04 04:07:16 +00001431#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1432 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001433SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001434 SrcList *pNew;
1435 int i;
drh113088e2003-03-20 01:16:58 +00001436 int nByte;
drh575fad62016-02-05 13:38:36 +00001437 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001438 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001439 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001440 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001441 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001442 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001443 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001444 struct SrcList_item *pNewItem = &pNew->a[i];
1445 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001446 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001447 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001448 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1449 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1450 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001451 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001452 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001453 pNewItem->addrFillSub = pOldItem->addrFillSub;
1454 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001455 if( pNewItem->fg.isIndexedBy ){
1456 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1457 }
1458 pNewItem->pIBIndex = pOldItem->pIBIndex;
1459 if( pNewItem->fg.isTabFunc ){
1460 pNewItem->u1.pFuncArg =
1461 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1462 }
drhed8a3bb2005-06-06 21:19:56 +00001463 pTab = pNewItem->pTab = pOldItem->pTab;
1464 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001465 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001466 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001467 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1468 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001469 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001470 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001471 }
1472 return pNew;
1473}
drh17435752007-08-16 04:30:38 +00001474IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001475 IdList *pNew;
1476 int i;
drh575fad62016-02-05 13:38:36 +00001477 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001478 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001479 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001480 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001481 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001482 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001483 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001484 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001485 return 0;
1486 }
drh6c535152012-02-02 03:38:30 +00001487 /* Note that because the size of the allocation for p->a[] is not
1488 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1489 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001490 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001491 struct IdList_item *pNewItem = &pNew->a[i];
1492 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001493 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001494 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001495 }
1496 return pNew;
1497}
dana7466202017-02-03 14:44:52 +00001498Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1499 Select *pRet = 0;
1500 Select *pNext = 0;
1501 Select **pp = &pRet;
1502 Select *p;
1503
drh575fad62016-02-05 13:38:36 +00001504 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001505 for(p=pDup; p; p=p->pPrior){
1506 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1507 if( pNew==0 ) break;
1508 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1509 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1510 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1511 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1512 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1513 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1514 pNew->op = p->op;
1515 pNew->pNext = pNext;
1516 pNew->pPrior = 0;
1517 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001518 pNew->iLimit = 0;
1519 pNew->iOffset = 0;
1520 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1521 pNew->addrOpenEphm[0] = -1;
1522 pNew->addrOpenEphm[1] = -1;
1523 pNew->nSelectRow = p->nSelectRow;
1524 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001525#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001526 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001527 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001528 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001529#endif
drhfef37762018-07-10 19:48:35 +00001530 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001531 *pp = pNew;
1532 pp = &pNew->pPrior;
1533 pNext = pNew;
1534 }
1535
1536 return pRet;
drhff78bd22002-02-27 01:47:11 +00001537}
danielk197793758c82005-01-21 08:13:14 +00001538#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001539Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001540 assert( p==0 );
1541 return 0;
1542}
1543#endif
drhff78bd22002-02-27 01:47:11 +00001544
1545
1546/*
drha76b5df2002-02-23 02:32:10 +00001547** Add a new element to the end of an expression list. If pList is
1548** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001549**
drha19543f2017-09-15 15:17:48 +00001550** The pList argument must be either NULL or a pointer to an ExprList
1551** obtained from a prior call to sqlite3ExprListAppend(). This routine
1552** may not be used with an ExprList obtained from sqlite3ExprListDup().
1553** Reason: This routine assumes that the number of slots in pList->a[]
1554** is a power of two. That is true for sqlite3ExprListAppend() returns
1555** but is not necessarily true from the return value of sqlite3ExprListDup().
1556**
drhb7916a72009-05-27 10:31:29 +00001557** If a memory allocation error occurs, the entire list is freed and
1558** NULL is returned. If non-NULL is returned, then it is guaranteed
1559** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001560*/
drh17435752007-08-16 04:30:38 +00001561ExprList *sqlite3ExprListAppend(
1562 Parse *pParse, /* Parsing context */
1563 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001564 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001565){
drh43606172017-04-05 11:32:13 +00001566 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001567 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001568 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001569 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001570 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001571 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001572 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001573 }
drhc263f7c2016-01-18 13:18:54 +00001574 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001575 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001576 ExprList *pNew;
1577 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001578 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001579 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001580 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001581 }
drh43606172017-04-05 11:32:13 +00001582 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001583 }
drh43606172017-04-05 11:32:13 +00001584 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001585 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1586 assert( offsetof(struct ExprList_item,pExpr)==0 );
1587 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001588 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001589 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001590
1591no_mem:
1592 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001593 sqlite3ExprDelete(db, pExpr);
1594 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001595 return 0;
drha76b5df2002-02-23 02:32:10 +00001596}
1597
1598/*
drh8762ec12016-08-20 01:06:22 +00001599** pColumns and pExpr form a vector assignment which is part of the SET
1600** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001601**
1602** (a,b,c) = (expr1,expr2,expr3)
1603** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1604**
1605** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001606** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001607** TK_SELECT_COLUMN expressions.
1608*/
1609ExprList *sqlite3ExprListAppendVector(
1610 Parse *pParse, /* Parsing context */
1611 ExprList *pList, /* List to which to append. Might be NULL */
1612 IdList *pColumns, /* List of names of LHS of the assignment */
1613 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1614){
1615 sqlite3 *db = pParse->db;
1616 int n;
1617 int i;
drh66860af2016-08-23 18:30:10 +00001618 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001619 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1620 ** exit prior to this routine being invoked */
1621 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001622 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001623
1624 /* If the RHS is a vector, then we can immediately check to see that
1625 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1626 ** wildcards ("*") in the result set of the SELECT must be expanded before
1627 ** we can do the size check, so defer the size check until code generation.
1628 */
1629 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001630 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1631 pColumns->nId, n);
1632 goto vector_append_error;
1633 }
drh966e2912017-01-03 02:58:01 +00001634
1635 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001636 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001637 assert( pSubExpr!=0 || db->mallocFailed );
1638 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1639 if( pSubExpr==0 ) continue;
1640 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001641 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1642 if( pList ){
drh66860af2016-08-23 18:30:10 +00001643 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001644 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1645 pColumns->a[i].zName = 0;
1646 }
1647 }
drh966e2912017-01-03 02:58:01 +00001648
drhffe28052017-05-06 18:09:36 +00001649 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001650 Expr *pFirst = pList->a[iFirst].pExpr;
1651 assert( pFirst!=0 );
1652 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001653
drhf4dd26c2017-04-05 11:49:06 +00001654 /* Store the SELECT statement in pRight so it will be deleted when
1655 ** sqlite3ExprListDelete() is called */
1656 pFirst->pRight = pExpr;
1657 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001658
drhf4dd26c2017-04-05 11:49:06 +00001659 /* Remember the size of the LHS in iTable so that we can check that
1660 ** the RHS and LHS sizes match during code generation. */
1661 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001662 }
1663
1664vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001665 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001666 sqlite3IdListDelete(db, pColumns);
1667 return pList;
1668}
1669
1670/*
drhbc622bc2015-08-24 15:39:42 +00001671** Set the sort order for the last element on the given ExprList.
1672*/
dan6e118922019-08-12 16:36:38 +00001673void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001674 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001675 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001676 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001677
1678 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1679 assert( iSortOrder==SQLITE_SO_UNDEFINED
1680 || iSortOrder==SQLITE_SO_ASC
1681 || iSortOrder==SQLITE_SO_DESC
1682 );
1683 assert( eNulls==SQLITE_SO_UNDEFINED
1684 || eNulls==SQLITE_SO_ASC
1685 || eNulls==SQLITE_SO_DESC
1686 );
1687
dan9105fd52019-08-19 17:26:32 +00001688 pItem = &p->a[p->nExpr-1];
1689 assert( pItem->bNulls==0 );
1690 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1691 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001692 }
dan9105fd52019-08-19 17:26:32 +00001693 pItem->sortFlags = (u8)iSortOrder;
1694
1695 if( eNulls!=SQLITE_SO_UNDEFINED ){
1696 pItem->bNulls = 1;
1697 if( iSortOrder!=eNulls ){
1698 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1699 }
drhbc622bc2015-08-24 15:39:42 +00001700 }
drhbc622bc2015-08-24 15:39:42 +00001701}
1702
1703/*
drhb7916a72009-05-27 10:31:29 +00001704** Set the ExprList.a[].zName element of the most recently added item
1705** on the expression list.
1706**
1707** pList might be NULL following an OOM error. But pName should never be
1708** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1709** is set.
1710*/
1711void sqlite3ExprListSetName(
1712 Parse *pParse, /* Parsing context */
1713 ExprList *pList, /* List to which to add the span. */
1714 Token *pName, /* Name to be added */
1715 int dequote /* True to cause the name to be dequoted */
1716){
1717 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1718 if( pList ){
1719 struct ExprList_item *pItem;
1720 assert( pList->nExpr>0 );
1721 pItem = &pList->a[pList->nExpr-1];
1722 assert( pItem->zName==0 );
1723 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001724 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001725 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001726 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001727 }
drhb7916a72009-05-27 10:31:29 +00001728 }
1729}
1730
1731/*
1732** Set the ExprList.a[].zSpan element of the most recently added item
1733** on the expression list.
1734**
1735** pList might be NULL following an OOM error. But pSpan should never be
1736** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1737** is set.
1738*/
1739void sqlite3ExprListSetSpan(
1740 Parse *pParse, /* Parsing context */
1741 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001742 const char *zStart, /* Start of the span */
1743 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001744){
1745 sqlite3 *db = pParse->db;
1746 assert( pList!=0 || db->mallocFailed!=0 );
1747 if( pList ){
1748 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1749 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001750 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001751 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001752 }
1753}
1754
1755/*
danielk19777a15a4b2007-05-08 17:54:43 +00001756** If the expression list pEList contains more than iLimit elements,
1757** leave an error message in pParse.
1758*/
1759void sqlite3ExprListCheckLength(
1760 Parse *pParse,
1761 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001762 const char *zObject
1763){
drhb1a6c3c2008-03-20 16:30:17 +00001764 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001765 testcase( pEList && pEList->nExpr==mx );
1766 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001767 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001768 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1769 }
1770}
1771
1772/*
drha76b5df2002-02-23 02:32:10 +00001773** Delete an entire expression list.
1774*/
drhaffa8552016-04-11 18:25:05 +00001775static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001776 int i = pList->nExpr;
1777 struct ExprList_item *pItem = pList->a;
1778 assert( pList->nExpr>0 );
1779 do{
drh633e6d52008-07-28 19:34:53 +00001780 sqlite3ExprDelete(db, pItem->pExpr);
1781 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001782 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001783 pItem++;
1784 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001785 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001786}
drhaffa8552016-04-11 18:25:05 +00001787void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1788 if( pList ) exprListDeleteNN(db, pList);
1789}
drha76b5df2002-02-23 02:32:10 +00001790
1791/*
drh2308ed32015-02-09 16:09:34 +00001792** Return the bitwise-OR of all Expr.flags fields in the given
1793** ExprList.
drh885a5b02015-02-09 15:21:36 +00001794*/
drh2308ed32015-02-09 16:09:34 +00001795u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001796 int i;
drh2308ed32015-02-09 16:09:34 +00001797 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001798 assert( pList!=0 );
1799 for(i=0; i<pList->nExpr; i++){
1800 Expr *pExpr = pList->a[i].pExpr;
1801 assert( pExpr!=0 );
1802 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001803 }
drh2308ed32015-02-09 16:09:34 +00001804 return m;
drh885a5b02015-02-09 15:21:36 +00001805}
1806
1807/*
drh7e6f9802017-09-04 00:33:04 +00001808** This is a SELECT-node callback for the expression walker that
1809** always "fails". By "fail" in this case, we mean set
1810** pWalker->eCode to zero and abort.
1811**
1812** This callback is used by multiple expression walkers.
1813*/
1814int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1815 UNUSED_PARAMETER(NotUsed);
1816 pWalker->eCode = 0;
1817 return WRC_Abort;
1818}
1819
1820/*
drh171d16b2018-02-26 20:15:54 +00001821** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001822** then convert it into an TK_TRUEFALSE term. Return non-zero if
1823** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001824*/
1825int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1826 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001827 if( !ExprHasProperty(pExpr, EP_Quoted)
1828 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1829 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001830 ){
1831 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001832 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001833 return 1;
1834 }
1835 return 0;
1836}
1837
drh43c4ac82018-02-26 21:26:27 +00001838/*
drh96acafb2018-02-27 14:49:25 +00001839** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001840** and 0 if it is FALSE.
1841*/
drh96acafb2018-02-27 14:49:25 +00001842int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001843 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001844 assert( pExpr->op==TK_TRUEFALSE );
1845 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1846 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1847 return pExpr->u.zToken[4]==0;
1848}
1849
drh17180fc2019-04-19 17:26:19 +00001850/*
1851** If pExpr is an AND or OR expression, try to simplify it by eliminating
1852** terms that are always true or false. Return the simplified expression.
1853** Or return the original expression if no simplification is possible.
1854**
1855** Examples:
1856**
1857** (x<10) AND true => (x<10)
1858** (x<10) AND false => false
1859** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1860** (x<10) AND (y=22 OR true) => (x<10)
1861** (y=22) OR true => true
1862*/
1863Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1864 assert( pExpr!=0 );
1865 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1866 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1867 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1868 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1869 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1870 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1871 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1872 }
1873 }
1874 return pExpr;
1875}
1876
drh171d16b2018-02-26 20:15:54 +00001877
1878/*
drh059b2d52014-10-24 19:28:09 +00001879** These routines are Walker callbacks used to check expressions to
1880** see if they are "constant" for some definition of constant. The
1881** Walker.eCode value determines the type of "constant" we are looking
1882** for.
drh73b211a2005-01-18 04:00:42 +00001883**
drh7d10d5a2008-08-20 16:35:10 +00001884** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001885**
drh059b2d52014-10-24 19:28:09 +00001886** sqlite3ExprIsConstant() pWalker->eCode==1
1887** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001888** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001889** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001890**
drh059b2d52014-10-24 19:28:09 +00001891** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1892** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001893**
drhfeada2d2014-09-24 13:20:22 +00001894** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001895** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1896** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001897** parameter raises an error for new statements, but is silently converted
1898** to NULL for existing schemas. This allows sqlite_master tables that
1899** contain a bound parameter because they were generated by older versions
1900** of SQLite to be parsed by newer versions of SQLite without raising a
1901** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001902*/
drh7d10d5a2008-08-20 16:35:10 +00001903static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001904
drh059b2d52014-10-24 19:28:09 +00001905 /* If pWalker->eCode is 2 then any term of the expression that comes from
1906 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001907 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001908 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1909 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001910 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001911 }
1912
drh626a8792005-01-17 22:08:19 +00001913 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001914 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001915 ** and either pWalker->eCode==4 or 5 or the function has the
1916 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001917 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001918 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001919 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001920 }else{
1921 pWalker->eCode = 0;
1922 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001923 }
drh626a8792005-01-17 22:08:19 +00001924 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001925 /* Convert "true" or "false" in a DEFAULT clause into the
1926 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001927 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001928 return WRC_Prune;
1929 }
1930 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001931 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001932 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001933 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001934 testcase( pExpr->op==TK_ID );
1935 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001936 testcase( pExpr->op==TK_AGG_FUNCTION );
1937 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001938 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001939 return WRC_Continue;
1940 }
drh059b2d52014-10-24 19:28:09 +00001941 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1942 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001943 }
drhf43ce0b2017-05-25 00:08:48 +00001944 /* Fall through */
1945 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001946 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001947 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001948 testcase( pExpr->op==TK_IF_NULL_ROW );
1949 pWalker->eCode = 0;
1950 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001951 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001952 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001953 /* Silently convert bound parameters that appear inside of CREATE
1954 ** statements into a NULL when parsing the CREATE statement text out
1955 ** of the sqlite_master table */
1956 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001957 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001958 /* A bound parameter in a CREATE statement that originates from
1959 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001960 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001961 return WRC_Abort;
1962 }
1963 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001964 default:
drh6e341b92018-04-17 18:50:40 +00001965 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1966 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001967 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001968 }
1969}
drh059b2d52014-10-24 19:28:09 +00001970static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001971 Walker w;
drh059b2d52014-10-24 19:28:09 +00001972 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001973 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001974 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001975#ifdef SQLITE_DEBUG
1976 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1977#endif
drh059b2d52014-10-24 19:28:09 +00001978 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001979 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001980 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001981}
drh626a8792005-01-17 22:08:19 +00001982
1983/*
drh059b2d52014-10-24 19:28:09 +00001984** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001985** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001986**
1987** For the purposes of this function, a double-quoted string (ex: "abc")
1988** is considered a variable but a single-quoted string (ex: 'abc') is
1989** a constant.
drhfef52082000-06-06 01:50:43 +00001990*/
danielk19774adee202004-05-08 08:23:19 +00001991int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001992 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001993}
1994
1995/*
drh07aded62018-07-28 16:24:08 +00001996** Walk an expression tree. Return non-zero if
1997**
1998** (1) the expression is constant, and
1999** (2) the expression does originate in the ON or USING clause
2000** of a LEFT JOIN, and
2001** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2002** operands created by the constant propagation optimization.
2003**
2004** When this routine returns true, it indicates that the expression
2005** can be added to the pParse->pConstExpr list and evaluated once when
2006** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002007*/
2008int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002009 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002010}
2011
2012/*
drhfcb9f4f2015-06-01 18:13:16 +00002013** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002014** for any single row of the table with cursor iCur. In other words, the
2015** expression must not refer to any non-deterministic function nor any
2016** table other than iCur.
2017*/
2018int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2019 return exprIsConst(p, 3, iCur);
2020}
2021
danab31a842017-04-29 20:53:09 +00002022
2023/*
2024** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2025*/
2026static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2027 ExprList *pGroupBy = pWalker->u.pGroupBy;
2028 int i;
2029
2030 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2031 ** it constant. */
2032 for(i=0; i<pGroupBy->nExpr; i++){
2033 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002034 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002035 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002036 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002037 return WRC_Prune;
2038 }
2039 }
2040 }
2041
2042 /* Check if pExpr is a sub-select. If so, consider it variable. */
2043 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2044 pWalker->eCode = 0;
2045 return WRC_Abort;
2046 }
2047
2048 return exprNodeIsConstant(pWalker, pExpr);
2049}
2050
2051/*
2052** Walk the expression tree passed as the first argument. Return non-zero
2053** if the expression consists entirely of constants or copies of terms
2054** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002055**
2056** This routine is used to determine if a term of the HAVING clause can
2057** be promoted into the WHERE clause. In order for such a promotion to work,
2058** the value of the HAVING clause term must be the same for all members of
2059** a "group". The requirement that the GROUP BY term must be BINARY
2060** assumes that no other collating sequence will have a finer-grained
2061** grouping than binary. In other words (A=B COLLATE binary) implies
2062** A=B in every other collating sequence. The requirement that the
2063** GROUP BY be BINARY is stricter than necessary. It would also work
2064** to promote HAVING clauses that use the same alternative collating
2065** sequence as the GROUP BY term, but that is much harder to check,
2066** alternative collating sequences are uncommon, and this is only an
2067** optimization, so we take the easy way out and simply require the
2068** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002069*/
2070int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2071 Walker w;
danab31a842017-04-29 20:53:09 +00002072 w.eCode = 1;
2073 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002074 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002075 w.u.pGroupBy = pGroupBy;
2076 w.pParse = pParse;
2077 sqlite3WalkExpr(&w, p);
2078 return w.eCode;
2079}
2080
drh059b2d52014-10-24 19:28:09 +00002081/*
2082** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002083** or a function call with constant arguments. Return and 0 if there
2084** are any variables.
2085**
2086** For the purposes of this function, a double-quoted string (ex: "abc")
2087** is considered a variable but a single-quoted string (ex: 'abc') is
2088** a constant.
2089*/
drhfeada2d2014-09-24 13:20:22 +00002090int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2091 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002092 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002093}
2094
drh5b88bc42013-12-07 23:35:21 +00002095#ifdef SQLITE_ENABLE_CURSOR_HINTS
2096/*
2097** Walk an expression tree. Return 1 if the expression contains a
2098** subquery of some kind. Return 0 if there are no subqueries.
2099*/
2100int sqlite3ExprContainsSubquery(Expr *p){
2101 Walker w;
drhbec24762015-08-13 20:07:13 +00002102 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002103 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002104 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002105#ifdef SQLITE_DEBUG
2106 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2107#endif
drh5b88bc42013-12-07 23:35:21 +00002108 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002109 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002110}
2111#endif
2112
drheb55bd22005-06-30 17:04:21 +00002113/*
drh73b211a2005-01-18 04:00:42 +00002114** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002115** to fit in a 32-bit integer, return 1 and put the value of the integer
2116** in *pValue. If the expression is not an integer or if it is too big
2117** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002118*/
danielk19774adee202004-05-08 08:23:19 +00002119int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002120 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002121 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002122
2123 /* If an expression is an integer literal that fits in a signed 32-bit
2124 ** integer, then the EP_IntValue flag will have already been set */
2125 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2126 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2127
drh92b01d52008-06-24 00:32:35 +00002128 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002129 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002130 return 1;
2131 }
drhe4de1fe2002-06-02 16:09:01 +00002132 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002133 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002134 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002135 break;
drh4b59ab52002-08-24 18:24:51 +00002136 }
drhe4de1fe2002-06-02 16:09:01 +00002137 case TK_UMINUS: {
2138 int v;
danielk19774adee202004-05-08 08:23:19 +00002139 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002140 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002141 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002142 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002143 }
2144 break;
2145 }
2146 default: break;
2147 }
drh92b01d52008-06-24 00:32:35 +00002148 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002149}
2150
2151/*
drh039fc322009-11-17 18:31:47 +00002152** Return FALSE if there is no chance that the expression can be NULL.
2153**
2154** If the expression might be NULL or if the expression is too complex
2155** to tell return TRUE.
2156**
2157** This routine is used as an optimization, to skip OP_IsNull opcodes
2158** when we know that a value cannot be NULL. Hence, a false positive
2159** (returning TRUE when in fact the expression can never be NULL) might
2160** be a small performance hit but is otherwise harmless. On the other
2161** hand, a false negative (returning FALSE when the result could be NULL)
2162** will likely result in an incorrect answer. So when in doubt, return
2163** TRUE.
2164*/
2165int sqlite3ExprCanBeNull(const Expr *p){
2166 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002167 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2168 p = p->pLeft;
2169 }
drh039fc322009-11-17 18:31:47 +00002170 op = p->op;
2171 if( op==TK_REGISTER ) op = p->op2;
2172 switch( op ){
2173 case TK_INTEGER:
2174 case TK_STRING:
2175 case TK_FLOAT:
2176 case TK_BLOB:
2177 return 0;
drh7248a8b2014-08-04 18:50:54 +00002178 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002179 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002180 p->y.pTab==0 || /* Reference to column of index on expression */
2181 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002182 default:
2183 return 1;
2184 }
2185}
2186
2187/*
2188** Return TRUE if the given expression is a constant which would be
2189** unchanged by OP_Affinity with the affinity given in the second
2190** argument.
2191**
2192** This routine is used to determine if the OP_Affinity operation
2193** can be omitted. When in doubt return FALSE. A false negative
2194** is harmless. A false positive, however, can result in the wrong
2195** answer.
2196*/
2197int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2198 u8 op;
drhaf866402019-08-22 11:11:28 +00002199 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002200 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002201 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2202 if( p->op==TK_UMINUS ) unaryMinus = 1;
2203 p = p->pLeft;
2204 }
drh039fc322009-11-17 18:31:47 +00002205 op = p->op;
2206 if( op==TK_REGISTER ) op = p->op2;
2207 switch( op ){
2208 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002209 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002210 }
2211 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002212 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002213 }
2214 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002215 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002216 }
2217 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002218 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002219 }
drh2f2855b2009-11-18 01:25:26 +00002220 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002221 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002222 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002223 }
drh039fc322009-11-17 18:31:47 +00002224 default: {
2225 return 0;
2226 }
2227 }
2228}
2229
2230/*
drhc4a3c772001-04-04 11:48:57 +00002231** Return TRUE if the given string is a row-id column name.
2232*/
danielk19774adee202004-05-08 08:23:19 +00002233int sqlite3IsRowid(const char *z){
2234 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2235 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2236 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002237 return 0;
2238}
2239
danielk19779a96b662007-11-29 17:05:18 +00002240/*
drh69c355b2016-03-09 15:34:51 +00002241** pX is the RHS of an IN operator. If pX is a SELECT statement
2242** that can be simplified to a direct table access, then return
2243** a pointer to the SELECT statement. If pX is not a SELECT statement,
2244** or if the SELECT statement needs to be manifested into a transient
2245** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002246*/
2247#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002248static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002249 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002250 SrcList *pSrc;
2251 ExprList *pEList;
2252 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002253 int i;
drh69c355b2016-03-09 15:34:51 +00002254 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2255 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2256 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002257 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002258 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002259 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2260 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2261 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002262 }
drhb74b1012009-05-28 21:04:37 +00002263 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002264 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002265 if( p->pWhere ) return 0; /* Has no WHERE clause */
2266 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002267 assert( pSrc!=0 );
2268 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002269 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002270 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002271 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002272 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002273 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2274 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002275 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002276 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002277 for(i=0; i<pEList->nExpr; i++){
2278 Expr *pRes = pEList->a[i].pExpr;
2279 if( pRes->op!=TK_COLUMN ) return 0;
2280 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002281 }
drh69c355b2016-03-09 15:34:51 +00002282 return p;
drhb287f4b2008-04-25 00:08:38 +00002283}
2284#endif /* SQLITE_OMIT_SUBQUERY */
2285
danf9b2e052016-08-02 17:45:00 +00002286#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002287/*
drh4c259e92014-08-01 21:12:35 +00002288** Generate code that checks the left-most column of index table iCur to see if
2289** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002290** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2291** to be set to NULL if iCur contains one or more NULL values.
2292*/
2293static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002294 int addr1;
drh6be515e2014-08-01 21:00:53 +00002295 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002296 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002297 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2298 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002299 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002300 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002301}
danf9b2e052016-08-02 17:45:00 +00002302#endif
drh6be515e2014-08-01 21:00:53 +00002303
drhbb53ecb2014-08-02 21:03:33 +00002304
2305#ifndef SQLITE_OMIT_SUBQUERY
2306/*
2307** The argument is an IN operator with a list (not a subquery) on the
2308** right-hand side. Return TRUE if that list is constant.
2309*/
2310static int sqlite3InRhsIsConstant(Expr *pIn){
2311 Expr *pLHS;
2312 int res;
2313 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2314 pLHS = pIn->pLeft;
2315 pIn->pLeft = 0;
2316 res = sqlite3ExprIsConstant(pIn);
2317 pIn->pLeft = pLHS;
2318 return res;
2319}
2320#endif
2321
drh6be515e2014-08-01 21:00:53 +00002322/*
danielk19779a96b662007-11-29 17:05:18 +00002323** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002324** The pX parameter is the expression on the RHS of the IN operator, which
2325** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002326**
drhd4305ca2012-09-18 17:08:33 +00002327** The job of this routine is to find or create a b-tree object that can
2328** be used either to test for membership in the RHS set or to iterate through
2329** all members of the RHS set, skipping duplicates.
2330**
drh3a856252014-08-01 14:46:57 +00002331** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002332** and pX->iTable is set to the index of that cursor.
2333**
drhb74b1012009-05-28 21:04:37 +00002334** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002335**
drh1ccce442013-03-12 20:38:51 +00002336** IN_INDEX_ROWID - The cursor was opened on a database table.
2337** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2338** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2339** IN_INDEX_EPH - The cursor was opened on a specially created and
2340** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002341** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2342** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002343**
drhd4305ca2012-09-18 17:08:33 +00002344** An existing b-tree might be used if the RHS expression pX is a simple
2345** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002346**
dan553168c2016-08-01 20:14:31 +00002347** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002348**
drhd4305ca2012-09-18 17:08:33 +00002349** If the RHS of the IN operator is a list or a more complex subquery, then
2350** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002351** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002352** existing table.
drhd4305ca2012-09-18 17:08:33 +00002353**
drh7fc0ba02017-11-17 15:02:00 +00002354** The inFlags parameter must contain, at a minimum, one of the bits
2355** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2356** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2357** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2358** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002359**
2360** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2361** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002362** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002363** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2364** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002365**
drh3a856252014-08-01 14:46:57 +00002366** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2367** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002368** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2369** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002370**
drhbb53ecb2014-08-02 21:03:33 +00002371** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2372** if the RHS of the IN operator is a list (not a subquery) then this
2373** routine might decide that creating an ephemeral b-tree for membership
2374** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2375** calling routine should implement the IN operator using a sequence
2376** of Eq or Ne comparison operations.
2377**
drhb74b1012009-05-28 21:04:37 +00002378** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002379** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002380** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002381** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002382** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002383** to *prRhsHasNull. If there is no chance that the (...) contains a
2384** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002385**
drhe21a6e12014-08-01 18:00:24 +00002386** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002387** the value in that register will be NULL if the b-tree contains one or more
2388** NULL values, and it will be some non-NULL value if the b-tree contains no
2389** NULL values.
dan553168c2016-08-01 20:14:31 +00002390**
2391** If the aiMap parameter is not NULL, it must point to an array containing
2392** one element for each column returned by the SELECT statement on the RHS
2393** of the IN(...) operator. The i'th entry of the array is populated with the
2394** offset of the index column that matches the i'th column returned by the
2395** SELECT. For example, if the expression and selected index are:
2396**
2397** (?,?,?) IN (SELECT a, b, c FROM t1)
2398** CREATE INDEX i1 ON t1(b, c, a);
2399**
2400** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002401*/
danielk1977284f4ac2007-12-10 05:03:46 +00002402#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002403int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002404 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002405 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002406 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2407 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002408 int *aiMap, /* Mapping from Index fields to RHS fields */
2409 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002410){
drhb74b1012009-05-28 21:04:37 +00002411 Select *p; /* SELECT to the right of IN operator */
2412 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2413 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002414 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002415 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002416
drh1450bc62009-10-30 13:25:56 +00002417 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002418 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002419
dan7b35a772016-07-28 19:47:15 +00002420 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2421 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002422 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002423 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002424 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002425 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2426 int i;
2427 ExprList *pEList = pX->x.pSelect->pEList;
2428 for(i=0; i<pEList->nExpr; i++){
2429 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2430 }
2431 if( i==pEList->nExpr ){
2432 prRhsHasNull = 0;
2433 }
2434 }
2435
drhb74b1012009-05-28 21:04:37 +00002436 /* Check to see if an existing table or index can be used to
2437 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002438 ** ephemeral table. */
2439 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002440 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002441 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002442 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002443 ExprList *pEList = p->pEList;
2444 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002445
drhb07028f2011-10-14 21:49:18 +00002446 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2447 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2448 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2449 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002450
drhb22f7c82014-02-06 23:56:27 +00002451 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002452 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2453 sqlite3CodeVerifySchema(pParse, iDb);
2454 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002455
drha84a2832016-08-26 21:15:35 +00002456 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002457 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002458 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002459 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002460 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002461
2462 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2463 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002464 ExplainQueryPlan((pParse, 0,
2465 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002466 sqlite3VdbeJumpHere(v, iAddr);
2467 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002468 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002469 int affinity_ok = 1;
2470 int i;
2471
2472 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002473 ** comparison is the same as the affinity of each column in table
2474 ** on the RHS of the IN operator. If it not, it is not possible to
2475 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002476 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002477 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002478 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002479 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002480 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002481 testcase( cmpaff==SQLITE_AFF_BLOB );
2482 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002483 switch( cmpaff ){
2484 case SQLITE_AFF_BLOB:
2485 break;
2486 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002487 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2488 ** other has no affinity and the other side is TEXT. Hence,
2489 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2490 ** and for the term on the LHS of the IN to have no affinity. */
2491 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002492 break;
2493 default:
2494 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2495 }
2496 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002497
drha84a2832016-08-26 21:15:35 +00002498 if( affinity_ok ){
2499 /* Search for an existing index that will work for this IN operator */
2500 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2501 Bitmask colUsed; /* Columns of the index used */
2502 Bitmask mCol; /* Mask for the current column */
2503 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002504 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002505 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2506 ** BITMASK(nExpr) without overflowing */
2507 testcase( pIdx->nColumn==BMS-2 );
2508 testcase( pIdx->nColumn==BMS-1 );
2509 if( pIdx->nColumn>=BMS-1 ) continue;
2510 if( mustBeUnique ){
2511 if( pIdx->nKeyCol>nExpr
2512 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2513 ){
2514 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002515 }
danielk19770cdc0222008-06-26 18:04:03 +00002516 }
drha84a2832016-08-26 21:15:35 +00002517
2518 colUsed = 0; /* Columns of index used so far */
2519 for(i=0; i<nExpr; i++){
2520 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2521 Expr *pRhs = pEList->a[i].pExpr;
2522 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2523 int j;
2524
2525 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2526 for(j=0; j<nExpr; j++){
2527 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2528 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002529 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2530 continue;
2531 }
drha84a2832016-08-26 21:15:35 +00002532 break;
2533 }
2534 if( j==nExpr ) break;
2535 mCol = MASKBIT(j);
2536 if( mCol & colUsed ) break; /* Each column used only once */
2537 colUsed |= mCol;
2538 if( aiMap ) aiMap[i] = j;
2539 }
2540
2541 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2542 if( colUsed==(MASKBIT(nExpr)-1) ){
2543 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002544 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002545 ExplainQueryPlan((pParse, 0,
2546 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002547 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2548 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2549 VdbeComment((v, "%s", pIdx->zName));
2550 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2551 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2552
2553 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002554#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002555 i64 mask = (1<<nExpr)-1;
2556 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2557 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002558#endif
2559 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002560 if( nExpr==1 ){
2561 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2562 }
2563 }
2564 sqlite3VdbeJumpHere(v, iAddr);
2565 }
2566 } /* End loop over indexes */
2567 } /* End if( affinity_ok ) */
2568 } /* End if not an rowid index */
2569 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002570
drhbb53ecb2014-08-02 21:03:33 +00002571 /* If no preexisting index is available for the IN clause
2572 ** and IN_INDEX_NOOP is an allowed reply
2573 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002574 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002575 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002576 ** the IN operator so return IN_INDEX_NOOP.
2577 */
2578 if( eType==0
2579 && (inFlags & IN_INDEX_NOOP_OK)
2580 && !ExprHasProperty(pX, EP_xIsSelect)
2581 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2582 ){
2583 eType = IN_INDEX_NOOP;
2584 }
drhbb53ecb2014-08-02 21:03:33 +00002585
danielk19779a96b662007-11-29 17:05:18 +00002586 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002587 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002588 ** We will have to generate an ephemeral table to do the job.
2589 */
drh8e23daf2013-06-11 13:30:04 +00002590 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002591 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002592 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002593 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002594 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002595 }else if( prRhsHasNull ){
2596 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002597 }
drh85bcdce2018-12-23 21:27:29 +00002598 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002599 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002600 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002601 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002602 }
drhcf4d38a2010-07-28 02:53:36 +00002603 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002604 }
danba00e302016-07-23 20:24:06 +00002605
2606 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2607 int i, n;
2608 n = sqlite3ExprVectorSize(pX->pLeft);
2609 for(i=0; i<n; i++) aiMap[i] = i;
2610 }
drh2c041312018-12-24 02:34:49 +00002611 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002612 return eType;
2613}
danielk1977284f4ac2007-12-10 05:03:46 +00002614#endif
drh626a8792005-01-17 22:08:19 +00002615
danf9b2e052016-08-02 17:45:00 +00002616#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002617/*
2618** Argument pExpr is an (?, ?...) IN(...) expression. This
2619** function allocates and returns a nul-terminated string containing
2620** the affinities to be used for each column of the comparison.
2621**
2622** It is the responsibility of the caller to ensure that the returned
2623** string is eventually freed using sqlite3DbFree().
2624*/
dan71c57db2016-07-09 20:23:55 +00002625static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2626 Expr *pLeft = pExpr->pLeft;
2627 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002628 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002629 char *zRet;
2630
dan553168c2016-08-01 20:14:31 +00002631 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002632 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002633 if( zRet ){
2634 int i;
2635 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002636 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002637 char a = sqlite3ExprAffinity(pA);
2638 if( pSelect ){
2639 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2640 }else{
2641 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002642 }
dan71c57db2016-07-09 20:23:55 +00002643 }
2644 zRet[nVal] = '\0';
2645 }
2646 return zRet;
2647}
danf9b2e052016-08-02 17:45:00 +00002648#endif
dan71c57db2016-07-09 20:23:55 +00002649
dan8da209b2016-07-26 18:06:08 +00002650#ifndef SQLITE_OMIT_SUBQUERY
2651/*
2652** Load the Parse object passed as the first argument with an error
2653** message of the form:
2654**
2655** "sub-select returns N columns - expected M"
2656*/
2657void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2658 const char *zFmt = "sub-select returns %d columns - expected %d";
2659 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2660}
2661#endif
2662
drh626a8792005-01-17 22:08:19 +00002663/*
dan44c56042016-12-07 15:38:37 +00002664** Expression pExpr is a vector that has been used in a context where
2665** it is not permitted. If pExpr is a sub-select vector, this routine
2666** loads the Parse object with a message of the form:
2667**
2668** "sub-select returns N columns - expected 1"
2669**
2670** Or, if it is a regular scalar vector:
2671**
2672** "row value misused"
2673*/
2674void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2675#ifndef SQLITE_OMIT_SUBQUERY
2676 if( pExpr->flags & EP_xIsSelect ){
2677 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2678 }else
2679#endif
2680 {
2681 sqlite3ErrorMsg(pParse, "row value misused");
2682 }
2683}
2684
drh85bcdce2018-12-23 21:27:29 +00002685#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002686/*
drh85bcdce2018-12-23 21:27:29 +00002687** Generate code that will construct an ephemeral table containing all terms
2688** in the RHS of an IN operator. The IN operator can be in either of two
2689** forms:
drh626a8792005-01-17 22:08:19 +00002690**
drh9cbe6352005-11-29 03:13:21 +00002691** x IN (4,5,11) -- IN operator with list on right-hand side
2692** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002693**
drh2c041312018-12-24 02:34:49 +00002694** The pExpr parameter is the IN operator. The cursor number for the
2695** constructed ephermeral table is returned. The first time the ephemeral
2696** table is computed, the cursor number is also stored in pExpr->iTable,
2697** however the cursor number returned might not be the same, as it might
2698** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002699**
drh85bcdce2018-12-23 21:27:29 +00002700** If the LHS expression ("x" in the examples) is a column value, or
2701** the SELECT statement returns a column value, then the affinity of that
2702** column is used to build the index keys. If both 'x' and the
2703** SELECT... statement are columns, then numeric affinity is used
2704** if either column has NUMERIC or INTEGER affinity. If neither
2705** 'x' nor the SELECT... statement are columns, then numeric affinity
2706** is used.
drhcce7d172000-05-31 15:34:51 +00002707*/
drh85bcdce2018-12-23 21:27:29 +00002708void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002709 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002710 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002711 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002712){
drh2c041312018-12-24 02:34:49 +00002713 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002714 int addr; /* Address of OP_OpenEphemeral instruction */
2715 Expr *pLeft; /* the LHS of the IN operator */
2716 KeyInfo *pKeyInfo = 0; /* Key information */
2717 int nVal; /* Size of vector pLeft */
2718 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002719
drh2c041312018-12-24 02:34:49 +00002720 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002721 assert( v!=0 );
2722
drh2c041312018-12-24 02:34:49 +00002723 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002724 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002725 **
2726 ** * The right-hand side is a correlated subquery
2727 ** * The right-hand side is an expression list containing variables
2728 ** * We are inside a trigger
2729 **
drh2c041312018-12-24 02:34:49 +00002730 ** If all of the above are false, then we can compute the RHS just once
2731 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002732 */
drhefb699f2018-12-24 11:55:44 +00002733 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002734 /* Reuse of the RHS is allowed */
2735 /* If this routine has already been coded, but the previous code
2736 ** might not have been invoked yet, so invoke it now as a subroutine.
2737 */
2738 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002739 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002740 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2741 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2742 pExpr->x.pSelect->selId));
2743 }
drh2c041312018-12-24 02:34:49 +00002744 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2745 pExpr->y.sub.iAddr);
2746 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002747 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002748 return;
2749 }
2750
2751 /* Begin coding the subroutine */
2752 ExprSetProperty(pExpr, EP_Subrtn);
2753 pExpr->y.sub.regReturn = ++pParse->nMem;
2754 pExpr->y.sub.iAddr =
2755 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2756 VdbeComment((v, "return address"));
2757
2758 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002759 }
2760
drh85bcdce2018-12-23 21:27:29 +00002761 /* Check to see if this is a vector IN operator */
2762 pLeft = pExpr->pLeft;
2763 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002764
drh85bcdce2018-12-23 21:27:29 +00002765 /* Construct the ephemeral table that will contain the content of
2766 ** RHS of the IN operator.
2767 */
drh2c041312018-12-24 02:34:49 +00002768 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002769 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002770#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2771 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2772 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2773 }else{
2774 VdbeComment((v, "RHS of IN operator"));
2775 }
2776#endif
drh50ef6712019-02-22 23:29:56 +00002777 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002778
drh85bcdce2018-12-23 21:27:29 +00002779 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2780 /* Case 1: expr IN (SELECT ...)
2781 **
2782 ** Generate code to write the results of the select into the temporary
2783 ** table allocated and opened above.
2784 */
2785 Select *pSelect = pExpr->x.pSelect;
2786 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002787
drh2c041312018-12-24 02:34:49 +00002788 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2789 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002790 ));
drh85bcdce2018-12-23 21:27:29 +00002791 /* If the LHS and RHS of the IN operator do not match, that
2792 ** error will have been caught long before we reach this point. */
2793 if( ALWAYS(pEList->nExpr==nVal) ){
2794 SelectDest dest;
2795 int i;
drhbd462bc2018-12-24 20:21:06 +00002796 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002797 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2798 pSelect->iLimit = 0;
2799 testcase( pSelect->selFlags & SF_Distinct );
2800 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2801 if( sqlite3Select(pParse, pSelect, &dest) ){
2802 sqlite3DbFree(pParse->db, dest.zAffSdst);
2803 sqlite3KeyInfoUnref(pKeyInfo);
2804 return;
drhfef52082000-06-06 01:50:43 +00002805 }
drh85bcdce2018-12-23 21:27:29 +00002806 sqlite3DbFree(pParse->db, dest.zAffSdst);
2807 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2808 assert( pEList!=0 );
2809 assert( pEList->nExpr>0 );
2810 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2811 for(i=0; i<nVal; i++){
2812 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2813 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2814 pParse, p, pEList->a[i].pExpr
2815 );
danielk197741a05b72008-10-02 13:50:55 +00002816 }
drh85bcdce2018-12-23 21:27:29 +00002817 }
2818 }else if( ALWAYS(pExpr->x.pList!=0) ){
2819 /* Case 2: expr IN (exprlist)
2820 **
2821 ** For each expression, build an index key from the evaluation and
2822 ** store it in the temporary table. If <expr> is a column, then use
2823 ** that columns affinity when building index keys. If <expr> is not
2824 ** a column, use numeric affinity.
2825 */
2826 char affinity; /* Affinity of the LHS of the IN */
2827 int i;
2828 ExprList *pList = pExpr->x.pList;
2829 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002830 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002831 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002832 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002833 affinity = SQLITE_AFF_BLOB;
2834 }
2835 if( pKeyInfo ){
2836 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2837 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002838 }
2839
drh85bcdce2018-12-23 21:27:29 +00002840 /* Loop through each expression in <exprlist>. */
2841 r1 = sqlite3GetTempReg(pParse);
2842 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002843 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2844 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002845
2846 /* If the expression is not constant then we will need to
2847 ** disable the test that was generated above that makes sure
2848 ** this code only executes once. Because for a non-constant
2849 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002850 */
drh2c041312018-12-24 02:34:49 +00002851 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2852 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002853 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002854 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002855 }
drh1398ad32005-01-19 23:24:50 +00002856
drh85bcdce2018-12-23 21:27:29 +00002857 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002858 sqlite3ExprCode(pParse, pE2, r1);
2859 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2860 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002861 }
drh85bcdce2018-12-23 21:27:29 +00002862 sqlite3ReleaseTempReg(pParse, r1);
2863 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002864 }
drh85bcdce2018-12-23 21:27:29 +00002865 if( pKeyInfo ){
2866 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2867 }
drh2c041312018-12-24 02:34:49 +00002868 if( addrOnce ){
2869 sqlite3VdbeJumpHere(v, addrOnce);
2870 /* Subroutine return */
2871 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2872 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002873 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002874 }
2875}
2876#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002877
drh85bcdce2018-12-23 21:27:29 +00002878/*
2879** Generate code for scalar subqueries used as a subquery expression
2880** or EXISTS operator:
2881**
2882** (SELECT a FROM b) -- subquery
2883** EXISTS (SELECT a FROM b) -- EXISTS subquery
2884**
2885** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2886**
drhd86fe442019-08-26 13:45:49 +00002887** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002888** the result is stored in a contiguous array of registers and the
2889** return value is the register of the left-most result column.
2890** Return 0 if an error occurs.
2891*/
2892#ifndef SQLITE_OMIT_SUBQUERY
2893int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002894 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002895 int rReg = 0; /* Register storing resulting */
2896 Select *pSel; /* SELECT statement to encode */
2897 SelectDest dest; /* How to deal with SELECT result */
2898 int nReg; /* Registers to allocate */
2899 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002900
2901 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002902 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002903 testcase( pExpr->op==TK_EXISTS );
2904 testcase( pExpr->op==TK_SELECT );
2905 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2906 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2907 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002908
drh5198ff52018-12-24 12:09:47 +00002909 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002910 ** is encountered if any of the following is true:
2911 **
2912 ** * The right-hand side is a correlated subquery
2913 ** * The right-hand side is an expression list containing variables
2914 ** * We are inside a trigger
2915 **
2916 ** If all of the above are false, then we can run this code just once
2917 ** save the results, and reuse the same result on subsequent invocations.
2918 */
2919 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002920 /* If this routine has already been coded, then invoke it as a
2921 ** subroutine. */
2922 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002923 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002924 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2925 pExpr->y.sub.iAddr);
2926 return pExpr->iTable;
2927 }
2928
2929 /* Begin coding the subroutine */
2930 ExprSetProperty(pExpr, EP_Subrtn);
2931 pExpr->y.sub.regReturn = ++pParse->nMem;
2932 pExpr->y.sub.iAddr =
2933 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2934 VdbeComment((v, "return address"));
2935
drh2c041312018-12-24 02:34:49 +00002936 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002937 }
drh85bcdce2018-12-23 21:27:29 +00002938
2939 /* For a SELECT, generate code to put the values for all columns of
2940 ** the first row into an array of registers and return the index of
2941 ** the first register.
2942 **
2943 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2944 ** into a register and return that register number.
2945 **
2946 ** In both cases, the query is augmented with "LIMIT 1". Any
2947 ** preexisting limit is discarded in place of the new LIMIT 1.
2948 */
drhbd462bc2018-12-24 20:21:06 +00002949 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2950 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002951 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2952 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2953 pParse->nMem += nReg;
2954 if( pExpr->op==TK_SELECT ){
2955 dest.eDest = SRT_Mem;
2956 dest.iSdst = dest.iSDParm;
2957 dest.nSdst = nReg;
2958 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2959 VdbeComment((v, "Init subquery result"));
2960 }else{
2961 dest.eDest = SRT_Exists;
2962 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2963 VdbeComment((v, "Init EXISTS result"));
2964 }
drh85bcdce2018-12-23 21:27:29 +00002965 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00002966 /* The subquery already has a limit. If the pre-existing limit is X
2967 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
2968 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00002969 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00002970 if( pLimit ){
2971 pLimit->affExpr = SQLITE_AFF_NUMERIC;
2972 pLimit = sqlite3PExpr(pParse, TK_NE,
2973 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
2974 }
2975 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00002976 pSel->pLimit->pLeft = pLimit;
2977 }else{
drh7ca13472019-09-23 11:55:22 +00002978 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00002979 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00002980 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2981 }
2982 pSel->iLimit = 0;
2983 if( sqlite3Select(pParse, pSel, &dest) ){
2984 return 0;
2985 }
drh2c041312018-12-24 02:34:49 +00002986 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002987 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002988 if( addrOnce ){
2989 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002990
drh5198ff52018-12-24 12:09:47 +00002991 /* Subroutine return */
2992 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2993 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002994 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00002995 }
drh2c041312018-12-24 02:34:49 +00002996
drh1450bc62009-10-30 13:25:56 +00002997 return rReg;
drhcce7d172000-05-31 15:34:51 +00002998}
drh51522cd2005-01-20 13:36:19 +00002999#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003000
drhe3365e62009-11-12 17:52:24 +00003001#ifndef SQLITE_OMIT_SUBQUERY
3002/*
dan7b35a772016-07-28 19:47:15 +00003003** Expr pIn is an IN(...) expression. This function checks that the
3004** sub-select on the RHS of the IN() operator has the same number of
3005** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3006** a sub-query, that the LHS is a vector of size 1.
3007*/
3008int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3009 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3010 if( (pIn->flags & EP_xIsSelect) ){
3011 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3012 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3013 return 1;
3014 }
3015 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003016 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003017 return 1;
3018 }
3019 return 0;
3020}
3021#endif
3022
3023#ifndef SQLITE_OMIT_SUBQUERY
3024/*
drhe3365e62009-11-12 17:52:24 +00003025** Generate code for an IN expression.
3026**
3027** x IN (SELECT ...)
3028** x IN (value, value, ...)
3029**
drhecb87ac2016-08-25 15:46:25 +00003030** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003031** right-hand side (RHS) is an array of zero or more scalar values, or a
3032** subquery. If the RHS is a subquery, the number of result columns must
3033** match the number of columns in the vector on the LHS. If the RHS is
3034** a list of values, the LHS must be a scalar.
3035**
3036** The IN operator is true if the LHS value is contained within the RHS.
3037** The result is false if the LHS is definitely not in the RHS. The
3038** result is NULL if the presence of the LHS in the RHS cannot be
3039** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003040**
drh6be515e2014-08-01 21:00:53 +00003041** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003042** contained within the RHS. If due to NULLs we cannot determine if the LHS
3043** is contained in the RHS then jump to destIfNull. If the LHS is contained
3044** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003045**
3046** See the separate in-operator.md documentation file in the canonical
3047** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003048*/
3049static void sqlite3ExprCodeIN(
3050 Parse *pParse, /* Parsing and code generating context */
3051 Expr *pExpr, /* The IN expression */
3052 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3053 int destIfNull /* Jump here if the results are unknown due to NULLs */
3054){
3055 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003056 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003057 int rLhs; /* Register(s) holding the LHS values */
3058 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003059 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003060 int *aiMap = 0; /* Map from vector field to index column */
3061 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003062 int nVector; /* Size of vectors for this IN operator */
3063 int iDummy; /* Dummy parameter to exprCodeVector() */
3064 Expr *pLeft; /* The LHS of the IN operator */
3065 int i; /* loop counter */
3066 int destStep2; /* Where to jump when NULLs seen in step 2 */
3067 int destStep6 = 0; /* Start of code for Step 6 */
3068 int addrTruthOp; /* Address of opcode that determines the IN is true */
3069 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3070 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003071 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003072
drhe347d3e2016-08-25 21:14:34 +00003073 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003074 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003075 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003076 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3077 aiMap = (int*)sqlite3DbMallocZero(
3078 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3079 );
drhe347d3e2016-08-25 21:14:34 +00003080 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003081
danba00e302016-07-23 20:24:06 +00003082 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003083 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003084 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3085 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003086 v = pParse->pVdbe;
3087 assert( v!=0 ); /* OOM detected prior to this routine */
3088 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003089 eType = sqlite3FindInIndex(pParse, pExpr,
3090 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003091 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3092 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003093
danba00e302016-07-23 20:24:06 +00003094 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3095 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3096 );
drhecb87ac2016-08-25 15:46:25 +00003097#ifdef SQLITE_DEBUG
3098 /* Confirm that aiMap[] contains nVector integer values between 0 and
3099 ** nVector-1. */
3100 for(i=0; i<nVector; i++){
3101 int j, cnt;
3102 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3103 assert( cnt==1 );
3104 }
3105#endif
drhe3365e62009-11-12 17:52:24 +00003106
danba00e302016-07-23 20:24:06 +00003107 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3108 ** vector, then it is stored in an array of nVector registers starting
3109 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003110 **
3111 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3112 ** so that the fields are in the same order as an existing index. The
3113 ** aiMap[] array contains a mapping from the original LHS field order to
3114 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003115 */
drhe347d3e2016-08-25 21:14:34 +00003116 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3117 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003118 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003119 /* LHS fields are not reordered */
3120 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003121 }else{
3122 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003123 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003124 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003125 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003126 }
danba00e302016-07-23 20:24:06 +00003127 }
drhe3365e62009-11-12 17:52:24 +00003128
drhbb53ecb2014-08-02 21:03:33 +00003129 /* If sqlite3FindInIndex() did not find or create an index that is
3130 ** suitable for evaluating the IN operator, then evaluate using a
3131 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003132 **
3133 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003134 */
drhbb53ecb2014-08-02 21:03:33 +00003135 if( eType==IN_INDEX_NOOP ){
3136 ExprList *pList = pExpr->x.pList;
3137 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003138 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003139 int r2, regToFree;
3140 int regCkNull = 0;
3141 int ii;
drhdd668c22019-09-02 02:21:58 +00003142 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003143 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003144 if( destIfNull!=destIfFalse ){
3145 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003146 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003147 }
drhdd668c22019-09-02 02:21:58 +00003148 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003149 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003150 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003151 r2 = regToFree = sqlite3GetTempReg(pParse);
3152 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003153 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003154 }else{
3155 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003156 }
drha9769792014-08-04 16:39:39 +00003157 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003158 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3159 }
3160 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003161 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003162 (void*)pColl, P4_COLLSEQ);
3163 VdbeCoverageIf(v, ii<pList->nExpr-1);
3164 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003165 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003166 }else{
3167 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003168 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003169 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003170 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003171 }
3172 sqlite3ReleaseTempReg(pParse, regToFree);
3173 }
3174 if( regCkNull ){
3175 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003176 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003177 }
3178 sqlite3VdbeResolveLabel(v, labelOk);
3179 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003180 goto sqlite3ExprCodeIN_finished;
3181 }
3182
3183 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3184 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3185 ** We will then skip the binary search of the RHS.
3186 */
3187 if( destIfNull==destIfFalse ){
3188 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003189 }else{
drhec4ccdb2018-12-29 02:26:59 +00003190 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003191 }
3192 for(i=0; i<nVector; i++){
3193 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3194 if( sqlite3ExprCanBeNull(p) ){
3195 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003196 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003197 }
drhe3365e62009-11-12 17:52:24 +00003198 }
drhe347d3e2016-08-25 21:14:34 +00003199
3200 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3201 ** of the RHS using the LHS as a probe. If found, the result is
3202 ** true.
3203 */
3204 if( eType==IN_INDEX_ROWID ){
3205 /* In this case, the RHS is the ROWID of table b-tree and so we also
3206 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3207 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003208 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003209 VdbeCoverage(v);
3210 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3211 }else{
3212 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3213 if( destIfFalse==destIfNull ){
3214 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003215 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003216 rLhs, nVector); VdbeCoverage(v);
3217 goto sqlite3ExprCodeIN_finished;
3218 }
3219 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003220 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003221 rLhs, nVector); VdbeCoverage(v);
3222 }
3223
3224 /* Step 4. If the RHS is known to be non-NULL and we did not find
3225 ** an match on the search above, then the result must be FALSE.
3226 */
3227 if( rRhsHasNull && nVector==1 ){
3228 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3229 VdbeCoverage(v);
3230 }
3231
3232 /* Step 5. If we do not care about the difference between NULL and
3233 ** FALSE, then just return false.
3234 */
3235 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3236
3237 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3238 ** If any comparison is NULL, then the result is NULL. If all
3239 ** comparisons are FALSE then the final result is FALSE.
3240 **
3241 ** For a scalar LHS, it is sufficient to check just the first row
3242 ** of the RHS.
3243 */
3244 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003245 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003246 VdbeCoverage(v);
3247 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003248 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003249 }else{
3250 /* For nVector==1, combine steps 6 and 7 by immediately returning
3251 ** FALSE if the first comparison is not NULL */
3252 destNotNull = destIfFalse;
3253 }
3254 for(i=0; i<nVector; i++){
3255 Expr *p;
3256 CollSeq *pColl;
3257 int r3 = sqlite3GetTempReg(pParse);
3258 p = sqlite3VectorFieldSubexpr(pLeft, i);
3259 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003260 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003261 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3262 (void*)pColl, P4_COLLSEQ);
3263 VdbeCoverage(v);
3264 sqlite3ReleaseTempReg(pParse, r3);
3265 }
3266 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3267 if( nVector>1 ){
3268 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003269 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003270 VdbeCoverage(v);
3271
3272 /* Step 7: If we reach this point, we know that the result must
3273 ** be false. */
3274 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3275 }
3276
3277 /* Jumps here in order to return true. */
3278 sqlite3VdbeJumpHere(v, addrTruthOp);
3279
3280sqlite3ExprCodeIN_finished:
3281 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003282 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003283sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003284 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003285 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003286}
3287#endif /* SQLITE_OMIT_SUBQUERY */
3288
drh13573c72010-01-12 17:04:07 +00003289#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003290/*
3291** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003292** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003293**
3294** The z[] string will probably not be zero-terminated. But the
3295** z[n] character is guaranteed to be something that does not look
3296** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003297*/
drhb7916a72009-05-27 10:31:29 +00003298static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003299 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003300 double value;
drh9339da12010-09-30 00:50:49 +00003301 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003302 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3303 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003304 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003305 }
3306}
drh13573c72010-01-12 17:04:07 +00003307#endif
drh598f1342007-10-23 15:39:45 +00003308
3309
3310/*
drhfec19aa2004-05-19 20:41:03 +00003311** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003312** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003313**
shaneh5f1d6b62010-09-30 16:51:25 +00003314** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003315*/
drh13573c72010-01-12 17:04:07 +00003316static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3317 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003318 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003319 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003320 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003321 if( negFlag ) i = -i;
3322 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003323 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003324 int c;
3325 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003326 const char *z = pExpr->u.zToken;
3327 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003328 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003329 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003330#ifdef SQLITE_OMIT_FLOATING_POINT
3331 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3332#else
drh1b7ddc52014-07-23 14:52:05 +00003333#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003334 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003335 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003336 }else
3337#endif
3338 {
drh9296c182014-07-23 13:40:49 +00003339 codeReal(v, z, negFlag, iMem);
3340 }
drh13573c72010-01-12 17:04:07 +00003341#endif
drh77320ea2016-11-30 14:47:37 +00003342 }else{
drh84d4f1a2017-09-20 10:47:10 +00003343 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003344 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003345 }
drhfec19aa2004-05-19 20:41:03 +00003346 }
3347}
3348
drh5cd79232009-05-25 11:46:29 +00003349
drh1f9ca2c2015-08-25 16:57:52 +00003350/* Generate code that will load into register regOut a value that is
3351** appropriate for the iIdxCol-th column of index pIdx.
3352*/
3353void sqlite3ExprCodeLoadIndexColumn(
3354 Parse *pParse, /* The parsing context */
3355 Index *pIdx, /* The index whose column is to be loaded */
3356 int iTabCur, /* Cursor pointing to a table row */
3357 int iIdxCol, /* The column of the index to be loaded */
3358 int regOut /* Store the index column value in this register */
3359){
3360 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003361 if( iTabCol==XN_EXPR ){
3362 assert( pIdx->aColExpr );
3363 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003364 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003365 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003366 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003367 }else{
drh6df9c4b2019-10-18 12:52:08 +00003368 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003369 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003370 }
drh1f9ca2c2015-08-25 16:57:52 +00003371}
3372
drh5cd79232009-05-25 11:46:29 +00003373/*
drh5c092e82010-05-14 19:24:02 +00003374** Generate code to extract the value of the iCol-th column of a table.
3375*/
3376void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003377 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003378 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003379 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003380 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003381 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003382){
drhab45fc02019-10-16 22:01:56 +00003383 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003384 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003385 if( pTab==0 ){
3386 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3387 return;
3388 }
drh5c092e82010-05-14 19:24:02 +00003389 if( iCol<0 || iCol==pTab->iPKey ){
3390 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3391 }else{
drh81f7b372019-10-16 12:18:59 +00003392 int op;
3393 int x;
3394 if( IsVirtual(pTab) ){
3395 op = OP_VColumn;
3396 x = iCol;
3397#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003398 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003399 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003400 if( pCol->colFlags & COLFLAG_BUSY ){
3401 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3402 }else{
3403 int savedSelfTab = pParse->iSelfTab;
3404 pCol->colFlags |= COLFLAG_BUSY;
3405 pParse->iSelfTab = iTabCur+1;
3406 sqlite3ExprCode(pParse, pTab->aCol[iCol].pDflt, regOut);
3407 pParse->iSelfTab = savedSelfTab;
3408 pCol->colFlags &= ~COLFLAG_BUSY;
3409 }
drh81f7b372019-10-16 12:18:59 +00003410 return;
3411#endif
3412 }else if( !HasRowid(pTab) ){
drhb9bcf7c2019-10-19 13:29:10 +00003413 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003414 op = OP_Column;
3415 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003416 x = sqlite3TableColumnToStorage(pTab,iCol);
drh81f7b372019-10-16 12:18:59 +00003417 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003418 }
3419 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003420 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3421 }
3422}
3423
3424/*
drh945498f2007-02-24 11:52:52 +00003425** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003426** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003427**
3428** There must be an open cursor to pTab in iTable when this routine
3429** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003430*/
drhe55cbd72008-03-31 23:48:03 +00003431int sqlite3ExprCodeGetColumn(
3432 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003433 Table *pTab, /* Description of the table we are reading from */
3434 int iColumn, /* Index of the table column */
3435 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003436 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003437 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003438){
drh81f7b372019-10-16 12:18:59 +00003439 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003440 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003441 if( p5 ){
drh81f7b372019-10-16 12:18:59 +00003442 sqlite3VdbeChangeP5(pParse->pVdbe, p5);
drha748fdc2012-03-28 01:34:47 +00003443 }
drhe55cbd72008-03-31 23:48:03 +00003444 return iReg;
3445}
drhe55cbd72008-03-31 23:48:03 +00003446
3447/*
drhb21e7c72008-06-22 12:37:57 +00003448** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003449** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003450*/
drhb21e7c72008-06-22 12:37:57 +00003451void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003452 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003453 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003454}
3455
drh652fbf52008-04-01 01:42:41 +00003456/*
drh12abf402016-08-22 14:30:05 +00003457** Convert a scalar expression node to a TK_REGISTER referencing
3458** register iReg. The caller must ensure that iReg already contains
3459** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003460*/
dan069d1b12019-06-16 08:58:14 +00003461static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003462 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003463 p->op2 = p->op;
3464 p->op = TK_REGISTER;
3465 p->iTable = iReg;
3466 ExprClearProperty(p, EP_Skip);
3467}
3468
drh12abf402016-08-22 14:30:05 +00003469/*
3470** Evaluate an expression (either a vector or a scalar expression) and store
3471** the result in continguous temporary registers. Return the index of
3472** the first register used to store the result.
3473**
3474** If the returned result register is a temporary scalar, then also write
3475** that register number into *piFreeable. If the returned result register
3476** is not a temporary or if the expression is a vector set *piFreeable
3477** to 0.
3478*/
3479static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3480 int iResult;
3481 int nResult = sqlite3ExprVectorSize(p);
3482 if( nResult==1 ){
3483 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3484 }else{
3485 *piFreeable = 0;
3486 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003487#if SQLITE_OMIT_SUBQUERY
3488 iResult = 0;
3489#else
drh85bcdce2018-12-23 21:27:29 +00003490 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003491#endif
drh12abf402016-08-22 14:30:05 +00003492 }else{
3493 int i;
3494 iResult = pParse->nMem+1;
3495 pParse->nMem += nResult;
3496 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003497 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003498 }
3499 }
3500 }
3501 return iResult;
3502}
3503
dan71c57db2016-07-09 20:23:55 +00003504
drha4c3c872013-09-12 17:29:25 +00003505/*
drhcce7d172000-05-31 15:34:51 +00003506** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003507** expression. Attempt to store the results in register "target".
3508** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003509**
drh8b213892008-08-29 02:14:02 +00003510** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003511** be stored in target. The result might be stored in some other
3512** register if it is convenient to do so. The calling function
3513** must check the return code and move the results to the desired
3514** register.
drhcce7d172000-05-31 15:34:51 +00003515*/
drh678ccce2008-03-31 18:19:54 +00003516int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003517 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3518 int op; /* The opcode being coded */
3519 int inReg = target; /* Results stored in register inReg */
3520 int regFree1 = 0; /* If non-zero free this temporary register */
3521 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003522 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003523 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003524 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003525
drh9cbf3422008-01-17 16:22:13 +00003526 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003527 if( v==0 ){
3528 assert( pParse->db->mallocFailed );
3529 return 0;
3530 }
drh389a1ad2008-01-03 23:44:53 +00003531
drh1efa8022018-04-28 04:16:43 +00003532expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003533 if( pExpr==0 ){
3534 op = TK_NULL;
3535 }else{
3536 op = pExpr->op;
3537 }
drhf2bc0132004-10-04 13:19:23 +00003538 switch( op ){
drh13449892005-09-07 21:22:45 +00003539 case TK_AGG_COLUMN: {
3540 AggInfo *pAggInfo = pExpr->pAggInfo;
3541 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3542 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003543 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003544 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003545 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003546 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003547 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003548 return target;
drh13449892005-09-07 21:22:45 +00003549 }
3550 /* Otherwise, fall thru into the TK_COLUMN case */
3551 }
drh967e8b72000-06-21 13:59:10 +00003552 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003553 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003554 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003555 /* This COLUMN expression is really a constant due to WHERE clause
3556 ** constraints, and that constant is coded by the pExpr->pLeft
3557 ** expresssion. However, make sure the constant has the correct
3558 ** datatype by applying the Affinity of the table column to the
3559 ** constant.
3560 */
3561 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003562 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00003563 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003564 static const char zAff[] = "B\000C\000D\000E";
3565 assert( SQLITE_AFF_BLOB=='A' );
3566 assert( SQLITE_AFF_TEXT=='B' );
3567 if( iReg!=target ){
3568 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3569 iReg = target;
3570 }
3571 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3572 &zAff[(aff-'B')*2], P4_STATIC);
3573 }
3574 return iReg;
drhefad2e22018-07-27 16:57:11 +00003575 }
drhb2b9d3d2013-08-01 01:14:43 +00003576 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003577 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003578 /* Other columns in the same row for CHECK constraints or
3579 ** generated columns or for inserting into partial index.
3580 ** The row is unpacked into registers beginning at
3581 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3582 ** immediately prior to the first column.
3583 */
3584 Column *pCol;
3585 Table *pTab = pExpr->y.pTab;
3586 int iSrc;
3587 assert( pTab!=0 );
drhbffdd632019-09-02 00:58:44 +00003588 assert( pExpr->iColumn>=XN_ROWID );
3589 assert( pExpr->iColumn<pExpr->y.pTab->nCol );
drh9942ef02019-10-18 02:19:18 +00003590 if( pExpr->iColumn<0 ){
3591 return -1-pParse->iSelfTab;
3592 }
3593 pCol = pTab->aCol + pExpr->iColumn;
drhb9bcf7c2019-10-19 13:29:10 +00003594 iSrc = sqlite3TableColumnToStorage(pTab, pExpr->iColumn)
3595 - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003596#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3597 if( pCol->colFlags & COLFLAG_GENERATED ){
3598 if( pCol->colFlags & COLFLAG_BUSY ){
3599 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3600 pCol->zName);
3601 return 0;
3602 }
3603 pCol->colFlags |= COLFLAG_BUSY;
3604 if( pCol->colFlags & COLFLAG_VIRTUAL ){
3605 target = sqlite3ExprCodeTarget(pParse, pCol->pDflt, target);
3606 }else{
3607 target = iSrc;
3608 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3609 sqlite3ExprCode(pParse, pCol->pDflt, iSrc);
3610 }
3611 }
3612 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3613 return target;
3614 }else
3615#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3616 if( pCol->affinity==SQLITE_AFF_REAL ){
3617 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003618 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3619 return target;
3620 }else{
drh9942ef02019-10-18 02:19:18 +00003621 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003622 }
drhb2b9d3d2013-08-01 01:14:43 +00003623 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003624 /* Coding an expression that is part of an index where column names
3625 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003626 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003627 }
drh22827922000-06-06 17:27:05 +00003628 }
drheda079c2018-09-20 19:02:15 +00003629 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003630 pExpr->iColumn, iTab, target,
3631 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003632 }
3633 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003634 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003635 return target;
drhfec19aa2004-05-19 20:41:03 +00003636 }
drh8abed7b2018-02-26 18:49:05 +00003637 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003638 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003639 return target;
3640 }
drh13573c72010-01-12 17:04:07 +00003641#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003642 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003643 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3644 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003645 return target;
drh598f1342007-10-23 15:39:45 +00003646 }
drh13573c72010-01-12 17:04:07 +00003647#endif
drhfec19aa2004-05-19 20:41:03 +00003648 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003649 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003650 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003651 return target;
drhcce7d172000-05-31 15:34:51 +00003652 }
drhf0863fe2005-06-12 21:35:51 +00003653 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003654 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003655 return target;
drhf0863fe2005-06-12 21:35:51 +00003656 }
danielk19775338a5f2005-01-20 13:03:10 +00003657#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003658 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003659 int n;
3660 const char *z;
drhca48c902008-01-18 14:08:24 +00003661 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003662 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3663 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3664 assert( pExpr->u.zToken[1]=='\'' );
3665 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003666 n = sqlite3Strlen30(z) - 1;
3667 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003668 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3669 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003670 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003671 }
danielk19775338a5f2005-01-20 13:03:10 +00003672#endif
drh50457892003-09-06 01:10:47 +00003673 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003674 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3675 assert( pExpr->u.zToken!=0 );
3676 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003677 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3678 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003679 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003680 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003681 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003682 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003683 }
drhc332cc32016-09-19 10:24:19 +00003684 return target;
drh50457892003-09-06 01:10:47 +00003685 }
drh4e0cff62004-11-05 05:10:28 +00003686 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003687 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003688 }
drh487e2622005-06-25 18:42:14 +00003689#ifndef SQLITE_OMIT_CAST
3690 case TK_CAST: {
3691 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003692 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003693 if( inReg!=target ){
3694 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3695 inReg = target;
3696 }
drh4169e432014-08-25 20:11:52 +00003697 sqlite3VdbeAddOp2(v, OP_Cast, target,
3698 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003699 return inReg;
drh487e2622005-06-25 18:42:14 +00003700 }
3701#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003702 case TK_IS:
3703 case TK_ISNOT:
3704 op = (op==TK_IS) ? TK_EQ : TK_NE;
3705 p5 = SQLITE_NULLEQ;
3706 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003707 case TK_LT:
3708 case TK_LE:
3709 case TK_GT:
3710 case TK_GE:
3711 case TK_NE:
3712 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003713 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003714 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003715 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003716 }else{
3717 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3718 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3719 codeCompare(pParse, pLeft, pExpr->pRight, op,
3720 r1, r2, inReg, SQLITE_STOREP2 | p5);
3721 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3722 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3723 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3724 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3725 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3726 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3727 testcase( regFree1==0 );
3728 testcase( regFree2==0 );
3729 }
drh6a2fe092009-09-23 02:29:36 +00003730 break;
3731 }
drhcce7d172000-05-31 15:34:51 +00003732 case TK_AND:
3733 case TK_OR:
3734 case TK_PLUS:
3735 case TK_STAR:
3736 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003737 case TK_REM:
3738 case TK_BITAND:
3739 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003740 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003741 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003742 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003743 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003744 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3745 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3746 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3747 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3748 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3749 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3750 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3751 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3752 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3753 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3754 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003755 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3756 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003757 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003758 testcase( regFree1==0 );
3759 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003760 break;
3761 }
drhcce7d172000-05-31 15:34:51 +00003762 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003763 Expr *pLeft = pExpr->pLeft;
3764 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003765 if( pLeft->op==TK_INTEGER ){
3766 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003767 return target;
drh13573c72010-01-12 17:04:07 +00003768#ifndef SQLITE_OMIT_FLOATING_POINT
3769 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003770 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3771 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003772 return target;
drh13573c72010-01-12 17:04:07 +00003773#endif
drh3c84ddf2008-01-09 02:15:38 +00003774 }else{
drh10d1edf2013-11-15 15:52:39 +00003775 tempX.op = TK_INTEGER;
3776 tempX.flags = EP_IntValue|EP_TokenOnly;
3777 tempX.u.iValue = 0;
3778 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003779 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003780 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003781 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003782 }
drh3c84ddf2008-01-09 02:15:38 +00003783 break;
drh6e142f52000-06-08 13:36:40 +00003784 }
drhbf4133c2001-10-13 02:59:08 +00003785 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003786 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003787 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3788 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003789 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3790 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003791 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003792 break;
3793 }
drh8abed7b2018-02-26 18:49:05 +00003794 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003795 int isTrue; /* IS TRUE or IS NOT TRUE */
3796 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003797 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3798 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003799 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3800 bNormal = pExpr->op2==TK_IS;
3801 testcase( isTrue && bNormal);
3802 testcase( !isTrue && bNormal);
3803 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003804 break;
3805 }
drhcce7d172000-05-31 15:34:51 +00003806 case TK_ISNULL:
3807 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003808 int addr;
drh7d176102014-02-18 03:07:12 +00003809 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3810 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003811 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003812 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003813 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003814 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003815 VdbeCoverageIf(v, op==TK_ISNULL);
3816 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003817 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003818 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003819 break;
drhcce7d172000-05-31 15:34:51 +00003820 }
drh22827922000-06-06 17:27:05 +00003821 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003822 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003823 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003824 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3825 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003826 }else{
drhc332cc32016-09-19 10:24:19 +00003827 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003828 }
drh22827922000-06-06 17:27:05 +00003829 break;
3830 }
drhcce7d172000-05-31 15:34:51 +00003831 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003832 ExprList *pFarg; /* List of function arguments */
3833 int nFarg; /* Number of function arguments */
3834 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003835 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003836 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003837 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003838 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003839 u8 enc = ENC(db); /* The text encoding used by this database */
3840 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003841
dan67a9b8e2018-06-22 20:51:35 +00003842#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003843 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3844 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003845 }
dan67a9b8e2018-06-22 20:51:35 +00003846#endif
dan86fb6e12018-05-16 20:58:07 +00003847
drh1e9b53f2017-01-04 01:07:24 +00003848 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003849 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003850 ** out of the inner loop, even if that means an extra OP_Copy. */
3851 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003852 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003853 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003854 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003855 pFarg = 0;
3856 }else{
3857 pFarg = pExpr->x.pList;
3858 }
3859 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003860 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3861 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003862 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003863#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3864 if( pDef==0 && pParse->explain ){
3865 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3866 }
3867#endif
danb6e9f7a2018-05-19 14:15:29 +00003868 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003869 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003870 break;
3871 }
drhae6bb952009-11-11 00:24:31 +00003872
3873 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003874 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003875 ** arguments past the first non-NULL argument.
3876 */
drhd36e1042013-09-06 13:10:12 +00003877 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003878 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003879 assert( nFarg>=2 );
3880 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3881 for(i=1; i<nFarg; i++){
3882 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003883 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003884 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003885 }
3886 sqlite3VdbeResolveLabel(v, endCoalesce);
3887 break;
3888 }
3889
drhcca9f3d2013-09-06 15:23:29 +00003890 /* The UNLIKELY() function is a no-op. The result is the value
3891 ** of the first argument.
3892 */
3893 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3894 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003895 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003896 }
drhae6bb952009-11-11 00:24:31 +00003897
drh54240752017-01-03 14:39:30 +00003898#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003899 /* The AFFINITY() function evaluates to a string that describes
3900 ** the type affinity of the argument. This is used for testing of
3901 ** the SQLite type logic.
3902 */
3903 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3904 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3905 char aff;
3906 assert( nFarg==1 );
3907 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3908 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003909 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003910 return target;
3911 }
drh54240752017-01-03 14:39:30 +00003912#endif
drha1a523a2016-12-26 00:18:36 +00003913
drhd1a01ed2013-11-21 16:08:52 +00003914 for(i=0; i<nFarg; i++){
3915 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003916 testcase( i==31 );
3917 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003918 }
3919 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3920 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3921 }
3922 }
drh12ffee82009-04-08 13:51:51 +00003923 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003924 if( constMask ){
3925 r1 = pParse->nMem+1;
3926 pParse->nMem += nFarg;
3927 }else{
3928 r1 = sqlite3GetTempRange(pParse, nFarg);
3929 }
drha748fdc2012-03-28 01:34:47 +00003930
3931 /* For length() and typeof() functions with a column argument,
3932 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3933 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3934 ** loading.
3935 */
drhd36e1042013-09-06 13:10:12 +00003936 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003937 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003938 assert( nFarg==1 );
3939 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003940 exprOp = pFarg->a[0].pExpr->op;
3941 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003942 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3943 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003944 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3945 pFarg->a[0].pExpr->op2 =
3946 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003947 }
3948 }
3949
drh5579d592015-08-26 14:01:41 +00003950 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003951 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003952 }else{
drh12ffee82009-04-08 13:51:51 +00003953 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003954 }
drhb7f6f682006-07-08 17:06:43 +00003955#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003956 /* Possibly overload the function if the first argument is
3957 ** a virtual table column.
3958 **
3959 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3960 ** second argument, not the first, as the argument to test to
3961 ** see if it is a column in a virtual table. This is done because
3962 ** the left operand of infix functions (the operand we want to
3963 ** control overloading) ends up as the second argument to the
3964 ** function. The expression "A glob B" is equivalent to
3965 ** "glob(B,A). We want to use the A in "A glob B" to test
3966 ** for function overloading. But we use the B term in "glob(B,A)".
3967 */
drh59155062018-05-26 18:03:48 +00003968 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003969 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3970 }else if( nFarg>0 ){
3971 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003972 }
3973#endif
drhd36e1042013-09-06 13:10:12 +00003974 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003975 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003976 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003977 }
drh092457b2017-12-29 15:04:49 +00003978#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3979 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003980 Expr *pArg = pFarg->a[0].pExpr;
3981 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003982 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003983 }else{
3984 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3985 }
drh092457b2017-12-29 15:04:49 +00003986 }else
3987#endif
3988 {
drh2fc865c2017-12-16 20:20:37 +00003989 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3990 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3991 sqlite3VdbeChangeP5(v, (u8)nFarg);
3992 }
drhd1a01ed2013-11-21 16:08:52 +00003993 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003994 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003995 }
drhc332cc32016-09-19 10:24:19 +00003996 return target;
drhcce7d172000-05-31 15:34:51 +00003997 }
drhfe2093d2005-01-20 22:48:47 +00003998#ifndef SQLITE_OMIT_SUBQUERY
3999 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004000 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004001 int nCol;
drhc5499be2008-04-01 15:06:33 +00004002 testcase( op==TK_EXISTS );
4003 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004004 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4005 sqlite3SubselectError(pParse, nCol, 1);
4006 }else{
drh85bcdce2018-12-23 21:27:29 +00004007 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004008 }
drh19a775c2000-06-05 18:54:46 +00004009 break;
4010 }
drhfc7f27b2016-08-20 00:07:01 +00004011 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004012 int n;
drhfc7f27b2016-08-20 00:07:01 +00004013 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004014 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004015 }
drh966e2912017-01-03 02:58:01 +00004016 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004017 if( pExpr->iTable!=0
4018 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004019 ){
4020 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4021 pExpr->iTable, n);
4022 }
drhc332cc32016-09-19 10:24:19 +00004023 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004024 }
drhfef52082000-06-06 01:50:43 +00004025 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004026 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4027 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004028 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4029 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4030 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4031 sqlite3VdbeResolveLabel(v, destIfFalse);
4032 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4033 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004034 return target;
drhfef52082000-06-06 01:50:43 +00004035 }
drhe3365e62009-11-12 17:52:24 +00004036#endif /* SQLITE_OMIT_SUBQUERY */
4037
4038
drh2dcef112008-01-12 19:03:48 +00004039 /*
4040 ** x BETWEEN y AND z
4041 **
4042 ** This is equivalent to
4043 **
4044 ** x>=y AND x<=z
4045 **
4046 ** X is stored in pExpr->pLeft.
4047 ** Y is stored in pExpr->pList->a[0].pExpr.
4048 ** Z is stored in pExpr->pList->a[1].pExpr.
4049 */
drhfef52082000-06-06 01:50:43 +00004050 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004051 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004052 return target;
drhfef52082000-06-06 01:50:43 +00004053 }
drh94fa9c42016-02-27 21:16:04 +00004054 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004055 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004056 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004057 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004058 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004059 }
drh2dcef112008-01-12 19:03:48 +00004060
dan165921a2009-08-28 18:53:45 +00004061 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004062 /* If the opcode is TK_TRIGGER, then the expression is a reference
4063 ** to a column in the new.* or old.* pseudo-tables available to
4064 ** trigger programs. In this case Expr.iTable is set to 1 for the
4065 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4066 ** is set to the column of the pseudo-table to read, or to -1 to
4067 ** read the rowid field.
4068 **
4069 ** The expression is implemented using an OP_Param opcode. The p1
4070 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4071 ** to reference another column of the old.* pseudo-table, where
4072 ** i is the index of the column. For a new.rowid reference, p1 is
4073 ** set to (n+1), where n is the number of columns in each pseudo-table.
4074 ** For a reference to any other column in the new.* pseudo-table, p1
4075 ** is set to (n+2+i), where n and i are as defined previously. For
4076 ** example, if the table on which triggers are being fired is
4077 ** declared as:
4078 **
4079 ** CREATE TABLE t1(a, b);
4080 **
4081 ** Then p1 is interpreted as follows:
4082 **
4083 ** p1==0 -> old.rowid p1==3 -> new.rowid
4084 ** p1==1 -> old.a p1==4 -> new.a
4085 ** p1==2 -> old.b p1==5 -> new.b
4086 */
drheda079c2018-09-20 19:02:15 +00004087 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00004088 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
4089
4090 assert( pExpr->iTable==0 || pExpr->iTable==1 );
4091 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
4092 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
4093 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4094
4095 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004096 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004097 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00004098 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00004099 ));
dan65a7cd12009-09-01 12:16:01 +00004100
drh44dbca82010-01-13 04:22:20 +00004101#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004102 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004103 ** integer. Use OP_RealAffinity to make sure it is really real.
4104 **
4105 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4106 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004107 if( pExpr->iColumn>=0
4108 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4109 ){
4110 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4111 }
drh44dbca82010-01-13 04:22:20 +00004112#endif
dan165921a2009-08-28 18:53:45 +00004113 break;
4114 }
4115
dan71c57db2016-07-09 20:23:55 +00004116 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004117 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004118 break;
4119 }
4120
drh9e9a67a2019-08-17 17:07:15 +00004121 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4122 ** that derive from the right-hand table of a LEFT JOIN. The
4123 ** Expr.iTable value is the table number for the right-hand table.
4124 ** The expression is only evaluated if that table is not currently
4125 ** on a LEFT JOIN NULL row.
4126 */
drh31d6fd52017-04-14 19:03:10 +00004127 case TK_IF_NULL_ROW: {
4128 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004129 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004130 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004131 /* Temporarily disable factoring of constant expressions, since
4132 ** even though expressions may appear to be constant, they are not
4133 ** really constant because they originate from the right-hand side
4134 ** of a LEFT JOIN. */
4135 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004136 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004137 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004138 sqlite3VdbeJumpHere(v, addrINR);
4139 sqlite3VdbeChangeP3(v, addrINR, inReg);
4140 break;
4141 }
4142
drh2dcef112008-01-12 19:03:48 +00004143 /*
4144 ** Form A:
4145 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4146 **
4147 ** Form B:
4148 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4149 **
4150 ** Form A is can be transformed into the equivalent form B as follows:
4151 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4152 ** WHEN x=eN THEN rN ELSE y END
4153 **
4154 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004155 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4156 ** odd. The Y is also optional. If the number of elements in x.pList
4157 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004158 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4159 **
4160 ** The result of the expression is the Ri for the first matching Ei,
4161 ** or if there is no matching Ei, the ELSE term Y, or if there is
4162 ** no ELSE term, NULL.
4163 */
drh33cd4902009-05-30 20:49:20 +00004164 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004165 int endLabel; /* GOTO label for end of CASE stmt */
4166 int nextCase; /* GOTO label for next WHEN clause */
4167 int nExpr; /* 2x number of WHEN terms */
4168 int i; /* Loop counter */
4169 ExprList *pEList; /* List of WHEN terms */
4170 struct ExprList_item *aListelem; /* Array of WHEN terms */
4171 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004172 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004173 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004174 Expr *pDel = 0;
4175 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004176
danielk19776ab3a2e2009-02-19 14:39:25 +00004177 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004178 assert(pExpr->x.pList->nExpr > 0);
4179 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004180 aListelem = pEList->a;
4181 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004182 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004183 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004184 pDel = sqlite3ExprDup(db, pX, 0);
4185 if( db->mallocFailed ){
4186 sqlite3ExprDelete(db, pDel);
4187 break;
4188 }
drh33cd4902009-05-30 20:49:20 +00004189 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004190 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004191 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004192 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004193 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004194 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004195 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004196 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4197 ** The value in regFree1 might get SCopy-ed into the file result.
4198 ** So make sure that the regFree1 register is not reused for other
4199 ** purposes and possibly overwritten. */
4200 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004201 }
drhc5cd1242013-09-12 16:50:49 +00004202 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004203 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004204 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004205 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004206 }else{
drh2dcef112008-01-12 19:03:48 +00004207 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004208 }
drhec4ccdb2018-12-29 02:26:59 +00004209 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004210 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004211 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004212 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004213 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004214 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004215 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004216 }
drhc5cd1242013-09-12 16:50:49 +00004217 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004218 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004219 }else{
drh9de221d2008-01-05 06:51:30 +00004220 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004221 }
dan8b65e592019-07-17 14:34:17 +00004222 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004223 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004224 break;
4225 }
danielk19775338a5f2005-01-20 13:03:10 +00004226#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004227 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004228 assert( pExpr->affExpr==OE_Rollback
4229 || pExpr->affExpr==OE_Abort
4230 || pExpr->affExpr==OE_Fail
4231 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004232 );
dane0af83a2009-09-08 19:15:01 +00004233 if( !pParse->pTriggerTab ){
4234 sqlite3ErrorMsg(pParse,
4235 "RAISE() may only be used within a trigger-program");
4236 return 0;
4237 }
drh11949042019-08-05 18:01:42 +00004238 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004239 sqlite3MayAbort(pParse);
4240 }
dan165921a2009-08-28 18:53:45 +00004241 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004242 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004243 sqlite3VdbeAddOp4(
4244 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004245 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004246 }else{
drh433dccf2013-02-09 15:37:11 +00004247 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004248 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004249 }
4250
drhffe07b22005-11-03 00:41:17 +00004251 break;
drh17a7f8d2002-03-24 13:13:27 +00004252 }
danielk19775338a5f2005-01-20 13:03:10 +00004253#endif
drhffe07b22005-11-03 00:41:17 +00004254 }
drh2dcef112008-01-12 19:03:48 +00004255 sqlite3ReleaseTempReg(pParse, regFree1);
4256 sqlite3ReleaseTempReg(pParse, regFree2);
4257 return inReg;
4258}
4259
4260/*
drhd1a01ed2013-11-21 16:08:52 +00004261** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004262**
drhad879ff2017-01-04 04:10:02 +00004263** If regDest>=0 then the result is always stored in that register and the
4264** result is not reusable. If regDest<0 then this routine is free to
4265** store the value whereever it wants. The register where the expression
4266** is stored is returned. When regDest<0, two identical expressions will
4267** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004268*/
drh1e9b53f2017-01-04 01:07:24 +00004269int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004270 Parse *pParse, /* Parsing context */
4271 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004272 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004273){
drhd1a01ed2013-11-21 16:08:52 +00004274 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004275 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004276 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004277 if( regDest<0 && p ){
4278 struct ExprList_item *pItem;
4279 int i;
4280 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004281 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004282 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004283 }
4284 }
drh1e9b53f2017-01-04 01:07:24 +00004285 }
drhd1a01ed2013-11-21 16:08:52 +00004286 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4287 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004288 if( p ){
4289 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004290 pItem->reusable = regDest<0;
4291 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004292 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004293 }
drhd1a01ed2013-11-21 16:08:52 +00004294 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004295 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004296}
4297
4298/*
drh2dcef112008-01-12 19:03:48 +00004299** Generate code to evaluate an expression and store the results
4300** into a register. Return the register number where the results
4301** are stored.
4302**
4303** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004304** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004305** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004306**
4307** If pExpr is a constant, then this routine might generate this
4308** code to fill the register in the initialization section of the
4309** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004310*/
4311int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004312 int r2;
drh0d950af2019-08-22 16:38:42 +00004313 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004314 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004315 && pExpr->op!=TK_REGISTER
4316 && sqlite3ExprIsConstantNotJoin(pExpr)
4317 ){
drhf30a9692013-11-15 01:10:18 +00004318 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004319 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004320 }else{
drhf30a9692013-11-15 01:10:18 +00004321 int r1 = sqlite3GetTempReg(pParse);
4322 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4323 if( r2==r1 ){
4324 *pReg = r1;
4325 }else{
4326 sqlite3ReleaseTempReg(pParse, r1);
4327 *pReg = 0;
4328 }
drh2dcef112008-01-12 19:03:48 +00004329 }
4330 return r2;
4331}
4332
4333/*
4334** Generate code that will evaluate expression pExpr and store the
4335** results in register target. The results are guaranteed to appear
4336** in register target.
4337*/
drh05a86c52014-02-16 01:55:49 +00004338void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004339 int inReg;
4340
4341 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004342 if( pExpr && pExpr->op==TK_REGISTER ){
4343 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4344 }else{
4345 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004346 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004347 if( inReg!=target && pParse->pVdbe ){
4348 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4349 }
drhcce7d172000-05-31 15:34:51 +00004350 }
drhcce7d172000-05-31 15:34:51 +00004351}
4352
4353/*
drh1c75c9d2015-12-21 15:22:13 +00004354** Make a transient copy of expression pExpr and then code it using
4355** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4356** except that the input expression is guaranteed to be unchanged.
4357*/
4358void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4359 sqlite3 *db = pParse->db;
4360 pExpr = sqlite3ExprDup(db, pExpr, 0);
4361 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4362 sqlite3ExprDelete(db, pExpr);
4363}
4364
4365/*
drh05a86c52014-02-16 01:55:49 +00004366** Generate code that will evaluate expression pExpr and store the
4367** results in register target. The results are guaranteed to appear
4368** in register target. If the expression is constant, then this routine
4369** might choose to code the expression at initialization time.
4370*/
4371void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004372 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004373 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004374 }else{
4375 sqlite3ExprCode(pParse, pExpr, target);
4376 }
drhcce7d172000-05-31 15:34:51 +00004377}
4378
4379/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004380** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004381** in register target.
drh25303782004-12-07 15:41:48 +00004382**
drh2dcef112008-01-12 19:03:48 +00004383** Also make a copy of the expression results into another "cache" register
4384** and modify the expression so that the next time it is evaluated,
4385** the result is a copy of the cache register.
4386**
4387** This routine is used for expressions that are used multiple
4388** times. They are evaluated once and the results of the expression
4389** are reused.
drh25303782004-12-07 15:41:48 +00004390*/
drh05a86c52014-02-16 01:55:49 +00004391void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004392 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004393 int iMem;
4394
drhde4fcfd2008-01-19 23:50:26 +00004395 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004396 assert( pExpr->op!=TK_REGISTER );
4397 sqlite3ExprCode(pParse, pExpr, target);
4398 iMem = ++pParse->nMem;
4399 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4400 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004401}
drh2dcef112008-01-12 19:03:48 +00004402
drh678ccce2008-03-31 18:19:54 +00004403/*
drh268380c2004-02-25 13:47:31 +00004404** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004405** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004406**
drh3df6c3b2017-09-15 15:38:01 +00004407** Return the number of elements evaluated. The number returned will
4408** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4409** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004410**
4411** The SQLITE_ECEL_DUP flag prevents the arguments from being
4412** filled using OP_SCopy. OP_Copy must be used instead.
4413**
4414** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4415** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004416**
4417** The SQLITE_ECEL_REF flag means that expressions in the list with
4418** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4419** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004420** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4421** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004422*/
danielk19774adee202004-05-08 08:23:19 +00004423int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004424 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004425 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004426 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004427 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004428 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004429){
4430 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004431 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004432 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004433 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004434 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004435 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004436 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004437 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004438 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004439 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004440 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004441#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4442 if( pItem->bSorterRef ){
4443 i--;
4444 n--;
4445 }else
4446#endif
dan257c13f2016-11-10 20:14:06 +00004447 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4448 if( flags & SQLITE_ECEL_OMITREF ){
4449 i--;
4450 n--;
4451 }else{
4452 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4453 }
drhb8b06692018-08-04 15:16:20 +00004454 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4455 && sqlite3ExprIsConstantNotJoin(pExpr)
4456 ){
drhad879ff2017-01-04 04:10:02 +00004457 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004458 }else{
4459 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4460 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004461 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004462 if( copyOp==OP_Copy
4463 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4464 && pOp->p1+pOp->p3+1==inReg
4465 && pOp->p2+pOp->p3+1==target+i
4466 ){
4467 pOp->p3++;
4468 }else{
4469 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4470 }
drhd1a01ed2013-11-21 16:08:52 +00004471 }
drhd1766112008-09-17 00:13:12 +00004472 }
drh268380c2004-02-25 13:47:31 +00004473 }
drhf9b596e2004-05-26 16:54:42 +00004474 return n;
drh268380c2004-02-25 13:47:31 +00004475}
4476
4477/*
drh36c563a2009-11-12 13:32:22 +00004478** Generate code for a BETWEEN operator.
4479**
4480** x BETWEEN y AND z
4481**
4482** The above is equivalent to
4483**
4484** x>=y AND x<=z
4485**
4486** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004487** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004488**
4489** The xJumpIf parameter determines details:
4490**
4491** NULL: Store the boolean result in reg[dest]
4492** sqlite3ExprIfTrue: Jump to dest if true
4493** sqlite3ExprIfFalse: Jump to dest if false
4494**
4495** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004496*/
4497static void exprCodeBetween(
4498 Parse *pParse, /* Parsing and code generating context */
4499 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004500 int dest, /* Jump destination or storage location */
4501 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004502 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4503){
dan8b65e592019-07-17 14:34:17 +00004504 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004505 Expr compLeft; /* The x>=y term */
4506 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004507 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004508 Expr *pDel = 0;
4509 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004510
dan71c57db2016-07-09 20:23:55 +00004511 memset(&compLeft, 0, sizeof(Expr));
4512 memset(&compRight, 0, sizeof(Expr));
4513 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004514
4515 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004516 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4517 if( db->mallocFailed==0 ){
4518 exprAnd.op = TK_AND;
4519 exprAnd.pLeft = &compLeft;
4520 exprAnd.pRight = &compRight;
4521 compLeft.op = TK_GE;
4522 compLeft.pLeft = pDel;
4523 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4524 compRight.op = TK_LE;
4525 compRight.pLeft = pDel;
4526 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4527 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4528 if( xJump ){
4529 xJump(pParse, &exprAnd, dest, jumpIfNull);
4530 }else{
4531 /* Mark the expression is being from the ON or USING clause of a join
4532 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4533 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4534 ** for clarity, but we are out of bits in the Expr.flags field so we
4535 ** have to reuse the EP_FromJoin bit. Bummer. */
4536 pDel->flags |= EP_FromJoin;
4537 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4538 }
4539 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004540 }
dan8b65e592019-07-17 14:34:17 +00004541 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004542
4543 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004544 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4545 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4546 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4547 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4548 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4549 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4550 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4551 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004552 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004553}
4554
4555/*
drhcce7d172000-05-31 15:34:51 +00004556** Generate code for a boolean expression such that a jump is made
4557** to the label "dest" if the expression is true but execution
4558** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004559**
4560** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004561** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004562**
4563** This code depends on the fact that certain token values (ex: TK_EQ)
4564** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4565** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4566** the make process cause these values to align. Assert()s in the code
4567** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004568*/
danielk19774adee202004-05-08 08:23:19 +00004569void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004570 Vdbe *v = pParse->pVdbe;
4571 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004572 int regFree1 = 0;
4573 int regFree2 = 0;
4574 int r1, r2;
4575
drh35573352008-01-08 23:54:25 +00004576 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004577 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004578 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004579 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004580 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004581 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004582 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004583 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4584 if( pAlt!=pExpr ){
4585 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4586 }else if( op==TK_AND ){
4587 int d2 = sqlite3VdbeMakeLabel(pParse);
4588 testcase( jumpIfNull==0 );
4589 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4590 jumpIfNull^SQLITE_JUMPIFNULL);
4591 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4592 sqlite3VdbeResolveLabel(v, d2);
4593 }else{
4594 testcase( jumpIfNull==0 );
4595 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4596 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4597 }
drhcce7d172000-05-31 15:34:51 +00004598 break;
4599 }
4600 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004601 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004602 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004603 break;
4604 }
drh8abed7b2018-02-26 18:49:05 +00004605 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004606 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4607 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004608 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004609 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004610 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004611 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004612 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004613 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004614 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4615 isNot ? SQLITE_JUMPIFNULL : 0);
4616 }else{
4617 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4618 isNot ? SQLITE_JUMPIFNULL : 0);
4619 }
drh007c8432018-02-26 03:20:18 +00004620 break;
4621 }
drhde845c22016-03-17 19:07:52 +00004622 case TK_IS:
4623 case TK_ISNOT:
4624 testcase( op==TK_IS );
4625 testcase( op==TK_ISNOT );
4626 op = (op==TK_IS) ? TK_EQ : TK_NE;
4627 jumpIfNull = SQLITE_NULLEQ;
4628 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004629 case TK_LT:
4630 case TK_LE:
4631 case TK_GT:
4632 case TK_GE:
4633 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004634 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004635 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004636 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004637 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4638 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004639 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004640 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004641 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4642 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4643 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4644 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004645 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4646 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4647 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4648 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4649 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4650 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004651 testcase( regFree1==0 );
4652 testcase( regFree2==0 );
4653 break;
4654 }
drhcce7d172000-05-31 15:34:51 +00004655 case TK_ISNULL:
4656 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004657 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4658 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004659 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4660 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004661 VdbeCoverageIf(v, op==TK_ISNULL);
4662 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004663 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004664 break;
4665 }
drhfef52082000-06-06 01:50:43 +00004666 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004667 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004668 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004669 break;
4670 }
drh84e30ca2011-02-10 17:46:14 +00004671#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004672 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004673 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004674 int destIfNull = jumpIfNull ? dest : destIfFalse;
4675 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004676 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004677 sqlite3VdbeResolveLabel(v, destIfFalse);
4678 break;
4679 }
shanehbb201342011-02-09 19:55:20 +00004680#endif
drhcce7d172000-05-31 15:34:51 +00004681 default: {
dan7b35a772016-07-28 19:47:15 +00004682 default_expr:
drhad317272019-04-19 16:21:51 +00004683 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004684 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004685 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004686 /* No-op */
4687 }else{
4688 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4689 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004690 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004691 testcase( regFree1==0 );
4692 testcase( jumpIfNull==0 );
4693 }
drhcce7d172000-05-31 15:34:51 +00004694 break;
4695 }
4696 }
drh2dcef112008-01-12 19:03:48 +00004697 sqlite3ReleaseTempReg(pParse, regFree1);
4698 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004699}
4700
4701/*
drh66b89c82000-11-28 20:47:17 +00004702** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004703** to the label "dest" if the expression is false but execution
4704** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004705**
4706** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004707** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4708** is 0.
drhcce7d172000-05-31 15:34:51 +00004709*/
danielk19774adee202004-05-08 08:23:19 +00004710void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004711 Vdbe *v = pParse->pVdbe;
4712 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004713 int regFree1 = 0;
4714 int regFree2 = 0;
4715 int r1, r2;
4716
drh35573352008-01-08 23:54:25 +00004717 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004718 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004719 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004720
4721 /* The value of pExpr->op and op are related as follows:
4722 **
4723 ** pExpr->op op
4724 ** --------- ----------
4725 ** TK_ISNULL OP_NotNull
4726 ** TK_NOTNULL OP_IsNull
4727 ** TK_NE OP_Eq
4728 ** TK_EQ OP_Ne
4729 ** TK_GT OP_Le
4730 ** TK_LE OP_Gt
4731 ** TK_GE OP_Lt
4732 ** TK_LT OP_Ge
4733 **
4734 ** For other values of pExpr->op, op is undefined and unused.
4735 ** The value of TK_ and OP_ constants are arranged such that we
4736 ** can compute the mapping above using the following expression.
4737 ** Assert()s verify that the computation is correct.
4738 */
4739 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4740
4741 /* Verify correct alignment of TK_ and OP_ constants
4742 */
4743 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4744 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4745 assert( pExpr->op!=TK_NE || op==OP_Eq );
4746 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4747 assert( pExpr->op!=TK_LT || op==OP_Ge );
4748 assert( pExpr->op!=TK_LE || op==OP_Gt );
4749 assert( pExpr->op!=TK_GT || op==OP_Le );
4750 assert( pExpr->op!=TK_GE || op==OP_Lt );
4751
danba00e302016-07-23 20:24:06 +00004752 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004753 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004754 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004755 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4756 if( pAlt!=pExpr ){
4757 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4758 }else if( pExpr->op==TK_AND ){
4759 testcase( jumpIfNull==0 );
4760 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4761 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4762 }else{
4763 int d2 = sqlite3VdbeMakeLabel(pParse);
4764 testcase( jumpIfNull==0 );
4765 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4766 jumpIfNull^SQLITE_JUMPIFNULL);
4767 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4768 sqlite3VdbeResolveLabel(v, d2);
4769 }
drhcce7d172000-05-31 15:34:51 +00004770 break;
4771 }
4772 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004773 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004774 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004775 break;
4776 }
drh8abed7b2018-02-26 18:49:05 +00004777 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004778 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4779 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004780 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004781 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004782 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004783 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004784 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004785 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004786 /* IS TRUE and IS NOT FALSE */
4787 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4788 isNot ? 0 : SQLITE_JUMPIFNULL);
4789
4790 }else{
4791 /* IS FALSE and IS NOT TRUE */
4792 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004793 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004794 }
drh007c8432018-02-26 03:20:18 +00004795 break;
4796 }
drhde845c22016-03-17 19:07:52 +00004797 case TK_IS:
4798 case TK_ISNOT:
4799 testcase( pExpr->op==TK_IS );
4800 testcase( pExpr->op==TK_ISNOT );
4801 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4802 jumpIfNull = SQLITE_NULLEQ;
4803 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004804 case TK_LT:
4805 case TK_LE:
4806 case TK_GT:
4807 case TK_GE:
4808 case TK_NE:
4809 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004810 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004811 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004812 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4813 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004814 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004815 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004816 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4817 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4818 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4819 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004820 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4821 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4822 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4823 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4824 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4825 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004826 testcase( regFree1==0 );
4827 testcase( regFree2==0 );
4828 break;
4829 }
drhcce7d172000-05-31 15:34:51 +00004830 case TK_ISNULL:
4831 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004832 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4833 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004834 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4835 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004836 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004837 break;
4838 }
drhfef52082000-06-06 01:50:43 +00004839 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004840 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004841 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004842 break;
4843 }
drh84e30ca2011-02-10 17:46:14 +00004844#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004845 case TK_IN: {
4846 if( jumpIfNull ){
4847 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4848 }else{
drhec4ccdb2018-12-29 02:26:59 +00004849 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004850 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4851 sqlite3VdbeResolveLabel(v, destIfNull);
4852 }
4853 break;
4854 }
shanehbb201342011-02-09 19:55:20 +00004855#endif
drhcce7d172000-05-31 15:34:51 +00004856 default: {
danba00e302016-07-23 20:24:06 +00004857 default_expr:
drhad317272019-04-19 16:21:51 +00004858 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004859 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004860 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004861 /* no-op */
4862 }else{
4863 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4864 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004865 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004866 testcase( regFree1==0 );
4867 testcase( jumpIfNull==0 );
4868 }
drhcce7d172000-05-31 15:34:51 +00004869 break;
4870 }
4871 }
drh2dcef112008-01-12 19:03:48 +00004872 sqlite3ReleaseTempReg(pParse, regFree1);
4873 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004874}
drh22827922000-06-06 17:27:05 +00004875
4876/*
drh72bc8202015-06-11 13:58:35 +00004877** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4878** code generation, and that copy is deleted after code generation. This
4879** ensures that the original pExpr is unchanged.
4880*/
4881void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4882 sqlite3 *db = pParse->db;
4883 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4884 if( db->mallocFailed==0 ){
4885 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4886 }
4887 sqlite3ExprDelete(db, pCopy);
4888}
4889
dan5aa550c2017-06-24 18:10:29 +00004890/*
4891** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4892** type of expression.
4893**
4894** If pExpr is a simple SQL value - an integer, real, string, blob
4895** or NULL value - then the VDBE currently being prepared is configured
4896** to re-prepare each time a new value is bound to variable pVar.
4897**
4898** Additionally, if pExpr is a simple SQL value and the value is the
4899** same as that currently bound to variable pVar, non-zero is returned.
4900** Otherwise, if the values are not the same or if pExpr is not a simple
4901** SQL value, zero is returned.
4902*/
4903static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4904 int res = 0;
drhc0804222017-06-28 21:47:16 +00004905 int iVar;
4906 sqlite3_value *pL, *pR = 0;
4907
4908 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4909 if( pR ){
4910 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004911 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004912 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004913 if( pL ){
4914 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4915 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4916 }
4917 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004918 }
drhc0804222017-06-28 21:47:16 +00004919 sqlite3ValueFree(pR);
4920 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004921 }
4922
4923 return res;
4924}
drh72bc8202015-06-11 13:58:35 +00004925
4926/*
drh1d9da702010-01-07 15:17:02 +00004927** Do a deep comparison of two expression trees. Return 0 if the two
4928** expressions are completely identical. Return 1 if they differ only
4929** by a COLLATE operator at the top level. Return 2 if there are differences
4930** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004931**
drh619a1302013-08-01 13:04:46 +00004932** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4933** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4934**
drh66518ca2013-08-01 15:09:57 +00004935** The pA side might be using TK_REGISTER. If that is the case and pB is
4936** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4937**
drh1d9da702010-01-07 15:17:02 +00004938** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004939** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004940** identical, we return 2 just to be safe. So if this routine
4941** returns 2, then you do not really know for certain if the two
4942** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004943** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004944** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004945** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004946** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004947**
drhc0804222017-06-28 21:47:16 +00004948** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4949** pParse->pReprepare can be matched against literals in pB. The
4950** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4951** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4952** Argument pParse should normally be NULL. If it is not NULL and pA or
4953** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004954*/
dan5aa550c2017-06-24 18:10:29 +00004955int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004956 u32 combinedFlags;
4957 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004958 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004959 }
dan5aa550c2017-06-24 18:10:29 +00004960 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4961 return 0;
4962 }
drh10d1edf2013-11-15 15:52:39 +00004963 combinedFlags = pA->flags | pB->flags;
4964 if( combinedFlags & EP_IntValue ){
4965 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4966 return 0;
4967 }
drh1d9da702010-01-07 15:17:02 +00004968 return 2;
drh22827922000-06-06 17:27:05 +00004969 }
dan16dd3982018-12-20 15:04:38 +00004970 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004971 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004972 return 1;
4973 }
dan5aa550c2017-06-24 18:10:29 +00004974 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004975 return 1;
4976 }
4977 return 2;
4978 }
drh2edc5fd2015-11-24 02:10:52 +00004979 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00004980 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00004981 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004982#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00004983 assert( pA->op==pB->op );
4984 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4985 return 2;
4986 }
drheda079c2018-09-20 19:02:15 +00004987 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00004988 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
4989 return 2;
4990 }
drheda079c2018-09-20 19:02:15 +00004991 }
4992#endif
drhf20bbc52019-01-17 01:06:00 +00004993 }else if( pA->op==TK_NULL ){
4994 return 0;
drhd5af5422018-04-13 14:27:01 +00004995 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004996 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004997 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004998 return 2;
drh2646da72005-12-09 20:02:05 +00004999 }
drh22827922000-06-06 17:27:05 +00005000 }
drh10d1edf2013-11-15 15:52:39 +00005001 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00005002 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00005003 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005004 if( (combinedFlags & EP_FixedCol)==0
5005 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005006 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005007 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005008 if( pA->op!=TK_STRING
5009 && pA->op!=TK_TRUEFALSE
5010 && (combinedFlags & EP_Reduced)==0
5011 ){
drh10d1edf2013-11-15 15:52:39 +00005012 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00005013 if( pA->op2!=pB->op2 ) return 2;
drhebc64082019-09-27 15:15:38 +00005014 if( pA->op!=TK_IN
5015 && pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00005016 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005017 }
5018 }
drh1d9da702010-01-07 15:17:02 +00005019 return 0;
drh22827922000-06-06 17:27:05 +00005020}
5021
drh8c6f6662010-04-26 19:17:26 +00005022/*
5023** Compare two ExprList objects. Return 0 if they are identical and
5024** non-zero if they differ in any way.
5025**
drh619a1302013-08-01 13:04:46 +00005026** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5027** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5028**
drh8c6f6662010-04-26 19:17:26 +00005029** This routine might return non-zero for equivalent ExprLists. The
5030** only consequence will be disabled optimizations. But this routine
5031** must never return 0 if the two ExprList objects are different, or
5032** a malfunction will result.
5033**
5034** Two NULL pointers are considered to be the same. But a NULL pointer
5035** always differs from a non-NULL pointer.
5036*/
drh619a1302013-08-01 13:04:46 +00005037int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005038 int i;
5039 if( pA==0 && pB==0 ) return 0;
5040 if( pA==0 || pB==0 ) return 1;
5041 if( pA->nExpr!=pB->nExpr ) return 1;
5042 for(i=0; i<pA->nExpr; i++){
5043 Expr *pExprA = pA->a[i].pExpr;
5044 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005045 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00005046 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00005047 }
5048 return 0;
5049}
drh13449892005-09-07 21:22:45 +00005050
drh22827922000-06-06 17:27:05 +00005051/*
drhf9463df2017-02-11 14:59:58 +00005052** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5053** are ignored.
5054*/
5055int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005056 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005057 sqlite3ExprSkipCollateAndLikely(pA),
5058 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005059 iTab);
5060}
5061
5062/*
drhc51cf862019-05-11 19:36:03 +00005063** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005064**
5065** Or if seenNot is true, return non-zero if Expr p can only be
5066** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005067*/
5068static int exprImpliesNotNull(
5069 Parse *pParse, /* Parsing context */
5070 Expr *p, /* The expression to be checked */
5071 Expr *pNN, /* The expression that is NOT NULL */
5072 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005073 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005074){
5075 assert( p );
5076 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005077 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5078 return pNN->op!=TK_NULL;
5079 }
drhc51cf862019-05-11 19:36:03 +00005080 switch( p->op ){
5081 case TK_IN: {
5082 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5083 assert( ExprHasProperty(p,EP_xIsSelect)
5084 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005085 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005086 }
5087 case TK_BETWEEN: {
5088 ExprList *pList = p->x.pList;
5089 assert( pList!=0 );
5090 assert( pList->nExpr==2 );
5091 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005092 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5093 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005094 ){
5095 return 1;
5096 }
drh7a231b42019-08-30 15:11:08 +00005097 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005098 }
5099 case TK_EQ:
5100 case TK_NE:
5101 case TK_LT:
5102 case TK_LE:
5103 case TK_GT:
5104 case TK_GE:
5105 case TK_PLUS:
5106 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005107 case TK_BITOR:
5108 case TK_LSHIFT:
5109 case TK_RSHIFT:
5110 case TK_CONCAT:
5111 seenNot = 1;
5112 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005113 case TK_STAR:
5114 case TK_REM:
5115 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005116 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005117 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5118 /* Fall thru into the next case */
5119 }
5120 case TK_SPAN:
5121 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005122 case TK_UPLUS:
5123 case TK_UMINUS: {
5124 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5125 }
5126 case TK_TRUTH: {
5127 if( seenNot ) return 0;
5128 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005129 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005130 }
dan1cd382e2019-08-29 15:06:35 +00005131 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005132 case TK_NOT: {
5133 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5134 }
5135 }
5136 return 0;
5137}
5138
5139/*
drh4bd5f732013-07-31 23:22:39 +00005140** Return true if we can prove the pE2 will always be true if pE1 is
5141** true. Return false if we cannot complete the proof or if pE2 might
5142** be false. Examples:
5143**
drh619a1302013-08-01 13:04:46 +00005144** pE1: x==5 pE2: x==5 Result: true
5145** pE1: x>0 pE2: x==5 Result: false
5146** pE1: x=21 pE2: x=21 OR y=43 Result: true
5147** pE1: x!=123 pE2: x IS NOT NULL Result: true
5148** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5149** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5150** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005151**
5152** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5153** Expr.iTable<0 then assume a table number given by iTab.
5154**
drhc0804222017-06-28 21:47:16 +00005155** If pParse is not NULL, then the values of bound variables in pE1 are
5156** compared against literal values in pE2 and pParse->pVdbe->expmask is
5157** modified to record which bound variables are referenced. If pParse
5158** is NULL, then false will be returned if pE1 contains any bound variables.
5159**
drh4bd5f732013-07-31 23:22:39 +00005160** When in doubt, return false. Returning true might give a performance
5161** improvement. Returning false might cause a performance reduction, but
5162** it will always give the correct answer and is hence always safe.
5163*/
dan5aa550c2017-06-24 18:10:29 +00005164int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5165 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005166 return 1;
5167 }
5168 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005169 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5170 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005171 ){
5172 return 1;
5173 }
drh664d6d12019-05-04 17:32:07 +00005174 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005175 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005176 ){
drhc51cf862019-05-11 19:36:03 +00005177 return 1;
drh619a1302013-08-01 13:04:46 +00005178 }
5179 return 0;
drh4bd5f732013-07-31 23:22:39 +00005180}
5181
5182/*
drh25897872018-03-20 21:16:15 +00005183** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5184** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005185** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5186**
5187** This routine controls an optimization. False positives (setting
5188** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5189** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005190*/
5191static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005192 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005193 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005194 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5195 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005196 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005197 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005198 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005199 case TK_IS:
5200 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005201 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005202 case TK_IN:
drh25897872018-03-20 21:16:15 +00005203 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005204 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005205 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005206 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005207 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005208 testcase( pExpr->op==TK_IS );
5209 testcase( pExpr->op==TK_OR );
5210 testcase( pExpr->op==TK_CASE );
5211 testcase( pExpr->op==TK_IN );
5212 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005213 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005214 return WRC_Prune;
5215 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005216 if( pWalker->u.iCur==pExpr->iTable ){
5217 pWalker->eCode = 1;
5218 return WRC_Abort;
5219 }
5220 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005221
dan9d23ea72019-08-29 19:34:29 +00005222 case TK_AND:
dan0287c952019-10-10 17:09:44 +00005223 assert( pWalker->eCode==0 );
5224 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5225 if( pWalker->eCode ){
5226 pWalker->eCode = 0;
5227 sqlite3WalkExpr(pWalker, pExpr->pRight);
dan9d23ea72019-08-29 19:34:29 +00005228 }
5229 return WRC_Prune;
5230
5231 case TK_BETWEEN:
5232 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5233 return WRC_Prune;
5234
drh98811552018-04-03 14:04:48 +00005235 /* Virtual tables are allowed to use constraints like x=NULL. So
5236 ** a term of the form x=y does not prove that y is not null if x
5237 ** is the column of a virtual table */
5238 case TK_EQ:
5239 case TK_NE:
5240 case TK_LT:
5241 case TK_LE:
5242 case TK_GT:
5243 case TK_GE:
5244 testcase( pExpr->op==TK_EQ );
5245 testcase( pExpr->op==TK_NE );
5246 testcase( pExpr->op==TK_LT );
5247 testcase( pExpr->op==TK_LE );
5248 testcase( pExpr->op==TK_GT );
5249 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005250 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5251 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005252 ){
5253 return WRC_Prune;
5254 }
dan9d23ea72019-08-29 19:34:29 +00005255
drh25897872018-03-20 21:16:15 +00005256 default:
5257 return WRC_Continue;
5258 }
5259}
5260
5261/*
5262** Return true (non-zero) if expression p can only be true if at least
5263** one column of table iTab is non-null. In other words, return true
5264** if expression p will always be NULL or false if every column of iTab
5265** is NULL.
5266**
drh821b6102018-03-24 18:01:51 +00005267** False negatives are acceptable. In other words, it is ok to return
5268** zero even if expression p will never be true of every column of iTab
5269** is NULL. A false negative is merely a missed optimization opportunity.
5270**
5271** False positives are not allowed, however. A false positive may result
5272** in an incorrect answer.
5273**
drh25897872018-03-20 21:16:15 +00005274** Terms of p that are marked with EP_FromJoin (and hence that come from
5275** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5276**
5277** This routine is used to check if a LEFT JOIN can be converted into
5278** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5279** clause requires that some column of the right table of the LEFT JOIN
5280** be non-NULL, then the LEFT JOIN can be safely converted into an
5281** ordinary join.
5282*/
5283int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5284 Walker w;
drh0d950af2019-08-22 16:38:42 +00005285 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005286 if( p==0 ) return 0;
5287 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005288 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005289 }else{
5290 while( p->op==TK_AND ){
5291 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5292 p = p->pRight;
5293 }
drhd6db6592019-04-01 19:42:42 +00005294 }
drh25897872018-03-20 21:16:15 +00005295 w.xExprCallback = impliesNotNullRow;
5296 w.xSelectCallback = 0;
5297 w.xSelectCallback2 = 0;
5298 w.eCode = 0;
5299 w.u.iCur = iTab;
5300 sqlite3WalkExpr(&w, p);
5301 return w.eCode;
5302}
5303
5304/*
drh030796d2012-08-23 16:18:10 +00005305** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005306** to determine if an expression can be evaluated by reference to the
5307** index only, without having to do a search for the corresponding
5308** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5309** is the cursor for the table.
5310*/
5311struct IdxCover {
5312 Index *pIdx; /* The index to be tested for coverage */
5313 int iCur; /* Cursor number for the table corresponding to the index */
5314};
5315
5316/*
5317** Check to see if there are references to columns in table
5318** pWalker->u.pIdxCover->iCur can be satisfied using the index
5319** pWalker->u.pIdxCover->pIdx.
5320*/
5321static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5322 if( pExpr->op==TK_COLUMN
5323 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005324 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005325 ){
5326 pWalker->eCode = 1;
5327 return WRC_Abort;
5328 }
5329 return WRC_Continue;
5330}
5331
5332/*
drhe604ec02016-07-27 19:20:58 +00005333** Determine if an index pIdx on table with cursor iCur contains will
5334** the expression pExpr. Return true if the index does cover the
5335** expression and false if the pExpr expression references table columns
5336** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005337**
5338** An index covering an expression means that the expression can be
5339** evaluated using only the index and without having to lookup the
5340** corresponding table entry.
5341*/
5342int sqlite3ExprCoveredByIndex(
5343 Expr *pExpr, /* The index to be tested */
5344 int iCur, /* The cursor number for the corresponding table */
5345 Index *pIdx /* The index that might be used for coverage */
5346){
5347 Walker w;
5348 struct IdxCover xcov;
5349 memset(&w, 0, sizeof(w));
5350 xcov.iCur = iCur;
5351 xcov.pIdx = pIdx;
5352 w.xExprCallback = exprIdxCover;
5353 w.u.pIdxCover = &xcov;
5354 sqlite3WalkExpr(&w, pExpr);
5355 return !w.eCode;
5356}
5357
5358
5359/*
5360** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005361** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005362** aggregate function, in order to implement the
5363** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005364*/
drh030796d2012-08-23 16:18:10 +00005365struct SrcCount {
5366 SrcList *pSrc; /* One particular FROM clause in a nested query */
5367 int nThis; /* Number of references to columns in pSrcList */
5368 int nOther; /* Number of references to columns in other FROM clauses */
5369};
5370
5371/*
5372** Count the number of references to columns.
5373*/
5374static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005375 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5376 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5377 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5378 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5379 ** NEVER() will need to be removed. */
5380 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005381 int i;
drh030796d2012-08-23 16:18:10 +00005382 struct SrcCount *p = pWalker->u.pSrcCount;
5383 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005384 int nSrc = pSrc ? pSrc->nSrc : 0;
5385 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005386 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005387 }
drh655814d2015-01-09 01:27:29 +00005388 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005389 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005390 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5391 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005392 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005393 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005394 p->nOther++;
5395 }
drh374fdce2012-04-17 16:38:53 +00005396 }
drh030796d2012-08-23 16:18:10 +00005397 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005398}
5399
5400/*
drh030796d2012-08-23 16:18:10 +00005401** Determine if any of the arguments to the pExpr Function reference
5402** pSrcList. Return true if they do. Also return true if the function
5403** has no arguments or has only constant arguments. Return false if pExpr
5404** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005405*/
drh030796d2012-08-23 16:18:10 +00005406int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005407 Walker w;
drh030796d2012-08-23 16:18:10 +00005408 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005409 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005410 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005411 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005412 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005413 w.u.pSrcCount = &cnt;
5414 cnt.pSrc = pSrcList;
5415 cnt.nThis = 0;
5416 cnt.nOther = 0;
5417 sqlite3WalkExprList(&w, pExpr->x.pList);
5418 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005419}
5420
5421/*
drh13449892005-09-07 21:22:45 +00005422** Add a new element to the pAggInfo->aCol[] array. Return the index of
5423** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005424*/
drh17435752007-08-16 04:30:38 +00005425static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005426 int i;
drhcf643722007-03-27 13:36:37 +00005427 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005428 db,
drhcf643722007-03-27 13:36:37 +00005429 pInfo->aCol,
5430 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005431 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005432 &i
5433 );
drh13449892005-09-07 21:22:45 +00005434 return i;
5435}
5436
5437/*
5438** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5439** the new element. Return a negative number if malloc fails.
5440*/
drh17435752007-08-16 04:30:38 +00005441static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005442 int i;
drhcf643722007-03-27 13:36:37 +00005443 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005444 db,
drhcf643722007-03-27 13:36:37 +00005445 pInfo->aFunc,
5446 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005447 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005448 &i
5449 );
drh13449892005-09-07 21:22:45 +00005450 return i;
5451}
drh22827922000-06-06 17:27:05 +00005452
5453/*
drh7d10d5a2008-08-20 16:35:10 +00005454** This is the xExprCallback for a tree walker. It is used to
5455** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005456** for additional information.
drh22827922000-06-06 17:27:05 +00005457*/
drh7d10d5a2008-08-20 16:35:10 +00005458static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005459 int i;
drh7d10d5a2008-08-20 16:35:10 +00005460 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005461 Parse *pParse = pNC->pParse;
5462 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005463 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005464
drh25c3b8c2018-04-16 10:34:13 +00005465 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005466 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005467 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005468 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005469 testcase( pExpr->op==TK_AGG_COLUMN );
5470 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005471 /* Check to see if the column is in one of the tables in the FROM
5472 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005473 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005474 struct SrcList_item *pItem = pSrcList->a;
5475 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5476 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005477 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005478 if( pExpr->iTable==pItem->iCursor ){
5479 /* If we reach this point, it means that pExpr refers to a table
5480 ** that is in the FROM clause of the aggregate query.
5481 **
5482 ** Make an entry for the column in pAggInfo->aCol[] if there
5483 ** is not an entry there already.
5484 */
drh7f906d62007-03-12 23:48:52 +00005485 int k;
drh13449892005-09-07 21:22:45 +00005486 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005487 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005488 if( pCol->iTable==pExpr->iTable &&
5489 pCol->iColumn==pExpr->iColumn ){
5490 break;
5491 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005492 }
danielk19771e536952007-08-16 10:09:01 +00005493 if( (k>=pAggInfo->nColumn)
5494 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5495 ){
drh7f906d62007-03-12 23:48:52 +00005496 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005497 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005498 pCol->iTable = pExpr->iTable;
5499 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005500 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005501 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005502 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005503 if( pAggInfo->pGroupBy ){
5504 int j, n;
5505 ExprList *pGB = pAggInfo->pGroupBy;
5506 struct ExprList_item *pTerm = pGB->a;
5507 n = pGB->nExpr;
5508 for(j=0; j<n; j++, pTerm++){
5509 Expr *pE = pTerm->pExpr;
5510 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5511 pE->iColumn==pExpr->iColumn ){
5512 pCol->iSorterColumn = j;
5513 break;
5514 }
5515 }
5516 }
5517 if( pCol->iSorterColumn<0 ){
5518 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5519 }
5520 }
5521 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5522 ** because it was there before or because we just created it).
5523 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5524 ** pAggInfo->aCol[] entry.
5525 */
drhebb6a652013-09-12 23:42:22 +00005526 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005527 pExpr->pAggInfo = pAggInfo;
5528 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005529 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005530 break;
5531 } /* endif pExpr->iTable==pItem->iCursor */
5532 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005533 }
drh7d10d5a2008-08-20 16:35:10 +00005534 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005535 }
5536 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005537 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005538 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005539 ){
drh13449892005-09-07 21:22:45 +00005540 /* Check to see if pExpr is a duplicate of another aggregate
5541 ** function that is already in the pAggInfo structure
5542 */
5543 struct AggInfo_func *pItem = pAggInfo->aFunc;
5544 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005545 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005546 break;
5547 }
drh22827922000-06-06 17:27:05 +00005548 }
drh13449892005-09-07 21:22:45 +00005549 if( i>=pAggInfo->nFunc ){
5550 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5551 */
danielk197714db2662006-01-09 16:12:04 +00005552 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005553 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005554 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005555 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005556 pItem = &pAggInfo->aFunc[i];
5557 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005558 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005559 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005560 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005561 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005562 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005563 if( pExpr->flags & EP_Distinct ){
5564 pItem->iDistinct = pParse->nTab++;
5565 }else{
5566 pItem->iDistinct = -1;
5567 }
drh13449892005-09-07 21:22:45 +00005568 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005569 }
drh13449892005-09-07 21:22:45 +00005570 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5571 */
drhc5cd1242013-09-12 16:50:49 +00005572 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005573 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005574 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005575 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005576 return WRC_Prune;
5577 }else{
5578 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005579 }
drh22827922000-06-06 17:27:05 +00005580 }
5581 }
drh7d10d5a2008-08-20 16:35:10 +00005582 return WRC_Continue;
5583}
5584static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005585 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005586 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005587 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005588}
drh979dd1b2017-05-29 14:26:07 +00005589static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5590 UNUSED_PARAMETER(pSelect);
5591 pWalker->walkerDepth--;
5592}
drh626a8792005-01-17 22:08:19 +00005593
5594/*
drhe8abb4c2012-11-02 18:24:57 +00005595** Analyze the pExpr expression looking for aggregate functions and
5596** for variables that need to be added to AggInfo object that pNC->pAggInfo
5597** points to. Additional entries are made on the AggInfo object as
5598** necessary.
drh626a8792005-01-17 22:08:19 +00005599**
5600** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005601** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005602*/
drhd2b3e232008-01-23 14:51:49 +00005603void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005604 Walker w;
5605 w.xExprCallback = analyzeAggregate;
5606 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005607 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5608 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005609 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005610 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005611 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005612 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005613}
drh5d9a4af2005-08-30 00:54:01 +00005614
5615/*
5616** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5617** expression list. Return the number of errors.
5618**
5619** If an error is found, the analysis is cut short.
5620*/
drhd2b3e232008-01-23 14:51:49 +00005621void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005622 struct ExprList_item *pItem;
5623 int i;
drh5d9a4af2005-08-30 00:54:01 +00005624 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005625 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5626 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005627 }
5628 }
drh5d9a4af2005-08-30 00:54:01 +00005629}
drh892d3172008-01-10 03:46:36 +00005630
5631/*
drhceea3322009-04-23 13:22:42 +00005632** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005633*/
5634int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005635 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005636 return ++pParse->nMem;
5637 }
danielk19772f425f62008-07-04 09:41:39 +00005638 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005639}
drhceea3322009-04-23 13:22:42 +00005640
5641/*
5642** Deallocate a register, making available for reuse for some other
5643** purpose.
drhceea3322009-04-23 13:22:42 +00005644*/
drh892d3172008-01-10 03:46:36 +00005645void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005646 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005647 pParse->aTempReg[pParse->nTempReg++] = iReg;
5648 }
5649}
5650
5651/*
drhed24da42016-09-06 14:37:05 +00005652** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005653*/
5654int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005655 int i, n;
drhed24da42016-09-06 14:37:05 +00005656 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005657 i = pParse->iRangeReg;
5658 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005659 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005660 pParse->iRangeReg += nReg;
5661 pParse->nRangeReg -= nReg;
5662 }else{
5663 i = pParse->nMem+1;
5664 pParse->nMem += nReg;
5665 }
5666 return i;
5667}
5668void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005669 if( nReg==1 ){
5670 sqlite3ReleaseTempReg(pParse, iReg);
5671 return;
5672 }
drh892d3172008-01-10 03:46:36 +00005673 if( nReg>pParse->nRangeReg ){
5674 pParse->nRangeReg = nReg;
5675 pParse->iRangeReg = iReg;
5676 }
5677}
drhcdc69552011-12-06 13:24:59 +00005678
5679/*
5680** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005681**
5682** Always invoke this procedure after coding a subroutine or co-routine
5683** that might be invoked from other parts of the code, to ensure that
5684** the sub/co-routine does not use registers in common with the code that
5685** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005686*/
5687void sqlite3ClearTempRegCache(Parse *pParse){
5688 pParse->nTempReg = 0;
5689 pParse->nRangeReg = 0;
5690}
drhbb9b5f22016-03-19 00:35:02 +00005691
5692/*
5693** Validate that no temporary register falls within the range of
5694** iFirst..iLast, inclusive. This routine is only call from within assert()
5695** statements.
5696*/
5697#ifdef SQLITE_DEBUG
5698int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5699 int i;
5700 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005701 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5702 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005703 ){
5704 return 0;
5705 }
5706 for(i=0; i<pParse->nTempReg; i++){
5707 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5708 return 0;
5709 }
5710 }
5711 return 1;
5712}
5713#endif /* SQLITE_DEBUG */