blob: be23a5bd5253bef7192933f13cae1703240b9085 [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 }
drhdb36e252019-10-22 19:51:29 +000073 if( op==TK_VECTOR ){
74 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75 }
drh11949042019-08-05 18:01:42 +000076 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000077}
78
drh53db1452004-05-20 13:54:53 +000079/*
drh8b4c40d2007-02-01 23:02:45 +000080** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000081** sequence named by pToken. Return a pointer to a new Expr node that
82** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000083**
84** If a memory allocation error occurs, that fact is recorded in pParse->db
85** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000086*/
drh4ef7efa2014-03-20 15:14:08 +000087Expr *sqlite3ExprAddCollateToken(
88 Parse *pParse, /* Parsing context */
89 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000090 const Token *pCollName, /* Name of collating sequence */
91 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000092){
drh0a8a4062012-12-07 18:38:16 +000093 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000094 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000095 if( pNew ){
96 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000097 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000098 pExpr = pNew;
99 }
drhae80dde2012-12-06 21:16:43 +0000100 }
drh0a8a4062012-12-07 18:38:16 +0000101 return pExpr;
102}
103Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000104 Token s;
105 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000106 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000107 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000108}
109
110/*
drh0d950af2019-08-22 16:38:42 +0000111** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000112*/
113Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000114 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
115 assert( pExpr->op==TK_COLLATE );
116 pExpr = pExpr->pLeft;
117 }
118 return pExpr;
119}
120
121/*
122** Skip over any TK_COLLATE operators and/or any unlikely()
123** or likelihood() or likely() functions at the root of an
124** expression.
125*/
126Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000127 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000128 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000129 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000131 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000132 pExpr = pExpr->x.pList->a[0].pExpr;
133 }else{
drh0b8d2552015-09-05 22:36:07 +0000134 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000135 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000136 }
drha4c3c872013-09-12 17:29:25 +0000137 }
drh0a8a4062012-12-07 18:38:16 +0000138 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000139}
140
141/*
drhae80dde2012-12-06 21:16:43 +0000142** Return the collation sequence for the expression pExpr. If
143** there is no defined collating sequence, return NULL.
144**
drh70efa842017-09-28 01:58:23 +0000145** See also: sqlite3ExprNNCollSeq()
146**
147** The sqlite3ExprNNCollSeq() works the same exact that it returns the
148** default collation if pExpr has no defined collation.
149**
drhae80dde2012-12-06 21:16:43 +0000150** The collating sequence might be determined by a COLLATE operator
151** or by the presence of a column with a defined collating sequence.
152** COLLATE operators take first precedence. Left operands take
153** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000154*/
danielk19777cedc8d2004-06-10 10:50:08 +0000155CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000156 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000157 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000158 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000159 while( p ){
drhae80dde2012-12-06 21:16:43 +0000160 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_REGISTER ) op = p->op2;
162 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000163 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000164 ){
drheda079c2018-09-20 19:02:15 +0000165 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000166 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000167 int j = p->iColumn;
168 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000169 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000170 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000171 }
172 break;
danielk19770202b292004-06-09 09:55:16 +0000173 }
drhe081d732018-07-27 18:19:12 +0000174 if( op==TK_CAST || op==TK_UPLUS ){
175 p = p->pLeft;
176 continue;
177 }
drh269d3222019-10-23 18:09:39 +0000178 if( op==TK_VECTOR ){
179 p = p->x.pList->a[0].pExpr;
180 continue;
181 }
drhcb0e04f2018-12-12 21:34:17 +0000182 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000183 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
184 break;
185 }
drhae80dde2012-12-06 21:16:43 +0000186 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000187 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000188 p = p->pLeft;
189 }else{
drh2308ed32015-02-09 16:09:34 +0000190 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000191 /* The Expr.x union is never used at the same time as Expr.pRight */
192 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000193 if( p->x.pList!=0
194 && !db->mallocFailed
195 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
196 ){
drh2308ed32015-02-09 16:09:34 +0000197 int i;
drh95768022019-11-10 10:08:03 +0000198 for(i=0; i<p->x.pList->nExpr; i++){
drh2308ed32015-02-09 16:09:34 +0000199 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
200 pNext = p->x.pList->a[i].pExpr;
201 break;
202 }
203 }
204 }
205 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000206 }
207 }else{
drh7d10d5a2008-08-20 16:35:10 +0000208 break;
209 }
danielk19770202b292004-06-09 09:55:16 +0000210 }
danielk19777cedc8d2004-06-10 10:50:08 +0000211 if( sqlite3CheckCollSeq(pParse, pColl) ){
212 pColl = 0;
213 }
214 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000215}
216
217/*
drh70efa842017-09-28 01:58:23 +0000218** Return the collation sequence for the expression pExpr. If
219** there is no defined collating sequence, return a pointer to the
220** defautl collation sequence.
221**
222** See also: sqlite3ExprCollSeq()
223**
224** The sqlite3ExprCollSeq() routine works the same except that it
225** returns NULL if there is no defined collation.
226*/
227CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
228 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
229 if( p==0 ) p = pParse->db->pDfltColl;
230 assert( p!=0 );
231 return p;
232}
233
234/*
235** Return TRUE if the two expressions have equivalent collating sequences.
236*/
237int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
238 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
239 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
240 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
241}
242
243/*
drh626a8792005-01-17 22:08:19 +0000244** pExpr is an operand of a comparison operator. aff2 is the
245** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000246** type affinity that should be used for the comparison operator.
247*/
danielk1977e014a832004-05-17 10:48:57 +0000248char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000249 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000250 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000251 /* Both sides of the comparison are columns. If one has numeric
252 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000253 */
drh8a512562005-11-14 22:29:05 +0000254 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000255 return SQLITE_AFF_NUMERIC;
256 }else{
drh05883a32015-06-02 15:32:08 +0000257 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000258 }
danielk1977e014a832004-05-17 10:48:57 +0000259 }else{
260 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000261 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
262 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
264}
265
drh53db1452004-05-20 13:54:53 +0000266/*
267** pExpr is a comparison operator. Return the type affinity that should
268** be applied to both operands prior to doing the comparison.
269*/
danielk1977e014a832004-05-17 10:48:57 +0000270static char comparisonAffinity(Expr *pExpr){
271 char aff;
272 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000274 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000275 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000276 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000277 if( pExpr->pRight ){
278 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000279 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
280 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000281 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000282 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000283 }
284 return aff;
285}
286
287/*
288** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289** idx_affinity is the affinity of an indexed column. Return true
290** if the index with affinity idx_affinity may be used to implement
291** the comparison in pExpr.
292*/
293int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
294 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000295 if( aff<SQLITE_AFF_TEXT ){
296 return 1;
drh8a512562005-11-14 22:29:05 +0000297 }
drh915e4342019-08-06 15:18:15 +0000298 if( aff==SQLITE_AFF_TEXT ){
299 return idx_affinity==SQLITE_AFF_TEXT;
300 }
301 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000302}
303
danielk1977a37cdde2004-05-16 11:15:36 +0000304/*
drh35573352008-01-08 23:54:25 +0000305** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000306** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000307*/
drh35573352008-01-08 23:54:25 +0000308static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
309 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000310 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000311 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000312}
313
drha2e00042002-01-22 03:13:42 +0000314/*
danielk19770202b292004-06-09 09:55:16 +0000315** Return a pointer to the collation sequence that should be used by
316** a binary comparison operator comparing pLeft and pRight.
317**
318** If the left hand expression has a collating sequence type, then it is
319** used. Otherwise the collation sequence for the right hand expression
320** is used, or the default (BINARY) if neither expression has a collating
321** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000322**
323** Argument pRight (but not pLeft) may be a null pointer. In this case,
324** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000325*/
drh0a0e1312007-08-07 17:04:59 +0000326CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000327 Parse *pParse,
328 Expr *pLeft,
329 Expr *pRight
330){
drhec41dda2007-02-07 13:09:45 +0000331 CollSeq *pColl;
332 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000333 if( pLeft->flags & EP_Collate ){
334 pColl = sqlite3ExprCollSeq(pParse, pLeft);
335 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
336 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000337 }else{
338 pColl = sqlite3ExprCollSeq(pParse, pLeft);
339 if( !pColl ){
340 pColl = sqlite3ExprCollSeq(pParse, pRight);
341 }
danielk19770202b292004-06-09 09:55:16 +0000342 }
343 return pColl;
344}
345
drh898c5272019-10-22 00:03:41 +0000346/* Expresssion p is a comparison operator. Return a collation sequence
347** appropriate for the comparison operator.
348**
349** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
350** However, if the OP_Commuted flag is set, then the order of the operands
351** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
352** correct collating sequence is found.
353*/
354CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
355 if( ExprHasProperty(p, EP_Commuted) ){
356 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
357 }else{
358 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
359 }
360}
361
danielk19770202b292004-06-09 09:55:16 +0000362/*
drhbe5c89a2004-07-26 00:31:09 +0000363** Generate code for a comparison operator.
364*/
365static int codeCompare(
366 Parse *pParse, /* The parsing (and code generating) context */
367 Expr *pLeft, /* The left operand */
368 Expr *pRight, /* The right operand */
369 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000370 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000371 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000372 int jumpIfNull, /* If true, jump if either operand is NULL */
373 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000374){
drh35573352008-01-08 23:54:25 +0000375 int p5;
376 int addr;
377 CollSeq *p4;
378
drh86541862019-12-19 20:37:32 +0000379 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000380 if( isCommuted ){
381 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
382 }else{
383 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
384 }
drh35573352008-01-08 23:54:25 +0000385 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
386 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
387 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000388 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000389 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000390}
391
dancfbb5e82016-07-13 19:48:13 +0000392/*
dan870a0702016-08-01 16:37:43 +0000393** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000394**
395** A vector is defined as any expression that results in two or more
396** columns of result. Every TK_VECTOR node is an vector because the
397** parser will not generate a TK_VECTOR with fewer than two entries.
398** But a TK_SELECT might be either a vector or a scalar. It is only
399** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000400*/
401int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000402 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000403}
404
405/*
dancfbb5e82016-07-13 19:48:13 +0000406** If the expression passed as the only argument is of type TK_VECTOR
407** return the number of expressions in the vector. Or, if the expression
408** is a sub-select, return the number of columns in the sub-select. For
409** any other type of expression, return 1.
410*/
dan71c57db2016-07-09 20:23:55 +0000411int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000412 u8 op = pExpr->op;
413 if( op==TK_REGISTER ) op = pExpr->op2;
414 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000415 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000416 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000417 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000418 }else{
419 return 1;
dan71c57db2016-07-09 20:23:55 +0000420 }
dan71c57db2016-07-09 20:23:55 +0000421}
422
danba00e302016-07-23 20:24:06 +0000423/*
drhfc7f27b2016-08-20 00:07:01 +0000424** Return a pointer to a subexpression of pVector that is the i-th
425** column of the vector (numbered starting with 0). The caller must
426** ensure that i is within range.
427**
drh76dbe7a2016-08-20 21:02:38 +0000428** If pVector is really a scalar (and "scalar" here includes subqueries
429** that return a single column!) then return pVector unmodified.
430**
drhfc7f27b2016-08-20 00:07:01 +0000431** pVector retains ownership of the returned subexpression.
432**
433** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000434** just the expression for the i-th term of the result set, and may
435** not be ready for evaluation because the table cursor has not yet
436** been positioned.
danba00e302016-07-23 20:24:06 +0000437*/
drhfc7f27b2016-08-20 00:07:01 +0000438Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000439 assert( i<sqlite3ExprVectorSize(pVector) );
440 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000441 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
442 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000443 return pVector->x.pSelect->pEList->a[i].pExpr;
444 }else{
445 return pVector->x.pList->a[i].pExpr;
446 }
dan71c57db2016-07-09 20:23:55 +0000447 }
dan870a0702016-08-01 16:37:43 +0000448 return pVector;
dan71c57db2016-07-09 20:23:55 +0000449}
drhfc7f27b2016-08-20 00:07:01 +0000450
drhfc7f27b2016-08-20 00:07:01 +0000451/*
452** Compute and return a new Expr object which when passed to
453** sqlite3ExprCode() will generate all necessary code to compute
454** the iField-th column of the vector expression pVector.
455**
drh8762ec12016-08-20 01:06:22 +0000456** It is ok for pVector to be a scalar (as long as iField==0).
457** In that case, this routine works like sqlite3ExprDup().
458**
drhfc7f27b2016-08-20 00:07:01 +0000459** The caller owns the returned Expr object and is responsible for
460** ensuring that the returned value eventually gets freed.
461**
drh8762ec12016-08-20 01:06:22 +0000462** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000463** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000464** valid for the life of the returned object. If pVector is a TK_VECTOR
465** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000466** returns.
drh8762ec12016-08-20 01:06:22 +0000467**
468** A trick to cause a TK_SELECT pVector to be deleted together with
469** the returned Expr object is to attach the pVector to the pRight field
470** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000471*/
472Expr *sqlite3ExprForVectorField(
473 Parse *pParse, /* Parsing context */
474 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000475 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000476){
477 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000478 if( pVector->op==TK_SELECT ){
479 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000480 /* The TK_SELECT_COLUMN Expr node:
481 **
drh966e2912017-01-03 02:58:01 +0000482 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000483 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000484 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000485 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000486 ** pLeft->iTable: First in an array of register holding result, or 0
487 ** if the result is not yet computed.
488 **
489 ** sqlite3ExprDelete() specifically skips the recursive delete of
490 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000491 ** can be attached to pRight to cause this node to take ownership of
492 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
493 ** with the same pLeft pointer to the pVector, but only one of them
494 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000495 */
drhabfd35e2016-12-06 22:47:23 +0000496 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000497 if( pRet ){
498 pRet->iColumn = iField;
499 pRet->pLeft = pVector;
500 }
drhfc7f27b2016-08-20 00:07:01 +0000501 assert( pRet==0 || pRet->iTable==0 );
502 }else{
drha1251bc2016-08-20 00:51:37 +0000503 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
504 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000505 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000506 }
507 return pRet;
508}
dan71c57db2016-07-09 20:23:55 +0000509
dan5c288b92016-07-30 21:02:33 +0000510/*
511** If expression pExpr is of type TK_SELECT, generate code to evaluate
512** it. Return the register in which the result is stored (or, if the
513** sub-select returns more than one column, the first in an array
514** of registers in which the result is stored).
515**
516** If pExpr is not a TK_SELECT expression, return 0.
517*/
518static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000519 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000520#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000521 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000522 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000523 }
danf9b2e052016-08-02 17:45:00 +0000524#endif
dan8da209b2016-07-26 18:06:08 +0000525 return reg;
526}
527
dan5c288b92016-07-30 21:02:33 +0000528/*
529** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000530** or TK_SELECT that returns more than one column. This function returns
531** the register number of a register that contains the value of
532** element iField of the vector.
533**
534** If pVector is a TK_SELECT expression, then code for it must have
535** already been generated using the exprCodeSubselect() routine. In this
536** case parameter regSelect should be the first in an array of registers
537** containing the results of the sub-select.
538**
539** If pVector is of type TK_VECTOR, then code for the requested field
540** is generated. In this case (*pRegFree) may be set to the number of
541** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000542**
543** Before returning, output parameter (*ppExpr) is set to point to the
544** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000545*/
546static int exprVectorRegister(
547 Parse *pParse, /* Parse context */
548 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000549 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000550 int regSelect, /* First in array of registers */
551 Expr **ppExpr, /* OUT: Expression element */
552 int *pRegFree /* OUT: Temp register to free */
553){
drh12abf402016-08-22 14:30:05 +0000554 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000555 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000556 if( op==TK_REGISTER ){
557 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
558 return pVector->iTable+iField;
559 }
560 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000561 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
562 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000563 }
dan870a0702016-08-01 16:37:43 +0000564 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000565 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
566}
567
568/*
569** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000570** the result of the comparison (1, 0, or NULL) and write that
571** result into register dest.
572**
573** The caller must satisfy the following preconditions:
574**
575** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
576** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
577** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000578*/
drh79752b62016-08-13 10:02:17 +0000579static void codeVectorCompare(
580 Parse *pParse, /* Code generator context */
581 Expr *pExpr, /* The comparison operation */
582 int dest, /* Write results into this register */
583 u8 op, /* Comparison operator */
584 u8 p5 /* SQLITE_NULLEQ or zero */
585){
dan71c57db2016-07-09 20:23:55 +0000586 Vdbe *v = pParse->pVdbe;
587 Expr *pLeft = pExpr->pLeft;
588 Expr *pRight = pExpr->pRight;
589 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000590 int i;
591 int regLeft = 0;
592 int regRight = 0;
593 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000594 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000595 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000596
drh70d6b832019-12-30 23:50:19 +0000597 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000598 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
599 sqlite3ErrorMsg(pParse, "row value misused");
600 return;
601 }
drhb29e60c2016-09-05 12:02:34 +0000602 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
603 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
604 || pExpr->op==TK_LT || pExpr->op==TK_GT
605 || pExpr->op==TK_LE || pExpr->op==TK_GE
606 );
607 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
608 || (pExpr->op==TK_ISNOT && op==TK_NE) );
609 assert( p5==0 || pExpr->op!=op );
610 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000611
drhb29e60c2016-09-05 12:02:34 +0000612 p5 |= SQLITE_STOREP2;
613 if( opx==TK_LE ) opx = TK_LT;
614 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000615
drhb29e60c2016-09-05 12:02:34 +0000616 regLeft = exprCodeSubselect(pParse, pLeft);
617 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000618
drhb29e60c2016-09-05 12:02:34 +0000619 for(i=0; 1 /*Loop exits by "break"*/; i++){
620 int regFree1 = 0, regFree2 = 0;
621 Expr *pL, *pR;
622 int r1, r2;
623 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000624 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
625 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000626 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000627 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
628 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
629 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
630 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
631 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
632 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
633 sqlite3ReleaseTempReg(pParse, regFree1);
634 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000635 if( i==nLeft-1 ){
636 break;
dan71c57db2016-07-09 20:23:55 +0000637 }
drhb29e60c2016-09-05 12:02:34 +0000638 if( opx==TK_EQ ){
639 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
640 p5 |= SQLITE_KEEPNULL;
641 }else if( opx==TK_NE ){
642 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
643 p5 |= SQLITE_KEEPNULL;
644 }else{
645 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
646 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
647 VdbeCoverageIf(v, op==TK_LT);
648 VdbeCoverageIf(v, op==TK_GT);
649 VdbeCoverageIf(v, op==TK_LE);
650 VdbeCoverageIf(v, op==TK_GE);
651 if( i==nLeft-2 ) opx = op;
652 }
dan71c57db2016-07-09 20:23:55 +0000653 }
drhb29e60c2016-09-05 12:02:34 +0000654 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000655}
656
danielk19774b5255a2008-06-05 16:47:39 +0000657#if SQLITE_MAX_EXPR_DEPTH>0
658/*
659** Check that argument nHeight is less than or equal to the maximum
660** expression depth allowed. If it is not, leave an error message in
661** pParse.
662*/
drh7d10d5a2008-08-20 16:35:10 +0000663int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000664 int rc = SQLITE_OK;
665 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
666 if( nHeight>mxHeight ){
667 sqlite3ErrorMsg(pParse,
668 "Expression tree is too large (maximum depth %d)", mxHeight
669 );
670 rc = SQLITE_ERROR;
671 }
672 return rc;
673}
674
675/* The following three functions, heightOfExpr(), heightOfExprList()
676** and heightOfSelect(), are used to determine the maximum height
677** of any expression tree referenced by the structure passed as the
678** first argument.
679**
680** If this maximum height is greater than the current value pointed
681** to by pnHeight, the second parameter, then set *pnHeight to that
682** value.
683*/
684static void heightOfExpr(Expr *p, int *pnHeight){
685 if( p ){
686 if( p->nHeight>*pnHeight ){
687 *pnHeight = p->nHeight;
688 }
689 }
690}
691static void heightOfExprList(ExprList *p, int *pnHeight){
692 if( p ){
693 int i;
694 for(i=0; i<p->nExpr; i++){
695 heightOfExpr(p->a[i].pExpr, pnHeight);
696 }
697 }
698}
dan1a3a3082018-01-18 19:00:54 +0000699static void heightOfSelect(Select *pSelect, int *pnHeight){
700 Select *p;
701 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000702 heightOfExpr(p->pWhere, pnHeight);
703 heightOfExpr(p->pHaving, pnHeight);
704 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000705 heightOfExprList(p->pEList, pnHeight);
706 heightOfExprList(p->pGroupBy, pnHeight);
707 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000708 }
709}
710
711/*
712** Set the Expr.nHeight variable in the structure passed as an
713** argument. An expression with no children, Expr.pList or
714** Expr.pSelect member has a height of 1. Any other expression
715** has a height equal to the maximum height of any other
716** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000717**
718** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
719** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000720*/
721static void exprSetHeight(Expr *p){
722 int nHeight = 0;
723 heightOfExpr(p->pLeft, &nHeight);
724 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000725 if( ExprHasProperty(p, EP_xIsSelect) ){
726 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000727 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000728 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000729 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000730 }
danielk19774b5255a2008-06-05 16:47:39 +0000731 p->nHeight = nHeight + 1;
732}
733
734/*
735** Set the Expr.nHeight variable using the exprSetHeight() function. If
736** the height is greater than the maximum allowed expression depth,
737** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000738**
739** Also propagate all EP_Propagate flags from the Expr.x.pList into
740** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000741*/
drh2308ed32015-02-09 16:09:34 +0000742void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000743 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000744 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000745 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000746}
747
748/*
749** Return the maximum height of any expression tree referenced
750** by the select statement passed as an argument.
751*/
752int sqlite3SelectExprHeight(Select *p){
753 int nHeight = 0;
754 heightOfSelect(p, &nHeight);
755 return nHeight;
756}
drh2308ed32015-02-09 16:09:34 +0000757#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
758/*
759** Propagate all EP_Propagate flags from the Expr.x.pList into
760** Expr.flags.
761*/
762void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
763 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
764 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
765 }
766}
767#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000768#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
769
drhbe5c89a2004-07-26 00:31:09 +0000770/*
drhb7916a72009-05-27 10:31:29 +0000771** This routine is the core allocator for Expr nodes.
772**
drha76b5df2002-02-23 02:32:10 +0000773** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000774** for this node and for the pToken argument is a single allocation
775** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000776** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000777**
778** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000779** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000780** parameter is ignored if pToken is NULL or if the token does not
781** appear to be quoted. If the quotes were of the form "..." (double-quotes)
782** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000783**
784** Special case: If op==TK_INTEGER and pToken points to a string that
785** can be translated into a 32-bit integer, then the token is not
786** stored in u.zToken. Instead, the integer values is written
787** into u.iValue and the EP_IntValue flag is set. No extra storage
788** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000789*/
drhb7916a72009-05-27 10:31:29 +0000790Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000791 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000792 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000793 const Token *pToken, /* Token argument. Might be NULL */
794 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000795){
drha76b5df2002-02-23 02:32:10 +0000796 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000797 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000798 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000799
drh575fad62016-02-05 13:38:36 +0000800 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000801 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000802 if( op!=TK_INTEGER || pToken->z==0
803 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
804 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000805 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000806 }
drhb7916a72009-05-27 10:31:29 +0000807 }
drh575fad62016-02-05 13:38:36 +0000808 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000809 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000810 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000811 pNew->op = (u8)op;
812 pNew->iAgg = -1;
813 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000814 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000815 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000816 pNew->u.iValue = iValue;
817 }else{
drh33e619f2009-05-28 01:00:55 +0000818 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000819 assert( pToken->z!=0 || pToken->n==0 );
820 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000821 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000822 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000823 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000824 }
drhb7916a72009-05-27 10:31:29 +0000825 }
826 }
827#if SQLITE_MAX_EXPR_DEPTH>0
828 pNew->nHeight = 1;
829#endif
830 }
drha76b5df2002-02-23 02:32:10 +0000831 return pNew;
832}
833
834/*
drhb7916a72009-05-27 10:31:29 +0000835** Allocate a new expression node from a zero-terminated token that has
836** already been dequoted.
837*/
838Expr *sqlite3Expr(
839 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
840 int op, /* Expression opcode */
841 const char *zToken /* Token argument. Might be NULL */
842){
843 Token x;
844 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000845 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000846 return sqlite3ExprAlloc(db, op, &x, 0);
847}
848
849/*
850** Attach subtrees pLeft and pRight to the Expr node pRoot.
851**
852** If pRoot==NULL that means that a memory allocation error has occurred.
853** In that case, delete the subtrees pLeft and pRight.
854*/
855void sqlite3ExprAttachSubtrees(
856 sqlite3 *db,
857 Expr *pRoot,
858 Expr *pLeft,
859 Expr *pRight
860){
861 if( pRoot==0 ){
862 assert( db->mallocFailed );
863 sqlite3ExprDelete(db, pLeft);
864 sqlite3ExprDelete(db, pRight);
865 }else{
866 if( pRight ){
867 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000868 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000869 }
870 if( pLeft ){
871 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000872 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000873 }
874 exprSetHeight(pRoot);
875 }
876}
877
878/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000879** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000880**
drhbf664462009-06-19 18:32:54 +0000881** One or both of the subtrees can be NULL. Return a pointer to the new
882** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
883** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000884*/
drh17435752007-08-16 04:30:38 +0000885Expr *sqlite3PExpr(
886 Parse *pParse, /* Parsing context */
887 int op, /* Expression opcode */
888 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000889 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000890){
drh5fb52ca2012-03-31 02:34:35 +0000891 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000892 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
893 if( p ){
894 memset(p, 0, sizeof(Expr));
895 p->op = op & 0xff;
896 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000897 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000898 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000899 }else{
900 sqlite3ExprDelete(pParse->db, pLeft);
901 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000902 }
drh4e0cff62004-11-05 05:10:28 +0000903 return p;
904}
905
906/*
drh08de4f72016-04-11 01:06:47 +0000907** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
908** do a memory allocation failure) then delete the pSelect object.
909*/
910void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
911 if( pExpr ){
912 pExpr->x.pSelect = pSelect;
913 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
914 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
915 }else{
916 assert( pParse->db->mallocFailed );
917 sqlite3SelectDelete(pParse->db, pSelect);
918 }
919}
920
921
922/*
drh91bb0ee2004-09-01 03:06:34 +0000923** Join two expressions using an AND operator. If either expression is
924** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000925**
926** If one side or the other of the AND is known to be false, then instead
927** of returning an AND expression, just return a constant expression with
928** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000929*/
drhd5c851c2019-04-19 13:38:34 +0000930Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
931 sqlite3 *db = pParse->db;
932 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000933 return pRight;
934 }else if( pRight==0 ){
935 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000936 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
937 && !IN_RENAME_OBJECT
938 ){
939 sqlite3ExprDelete(db, pLeft);
940 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000941 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000942 }else{
drhd5c851c2019-04-19 13:38:34 +0000943 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000944 }
945}
946
947/*
948** Construct a new expression node for a function with multiple
949** arguments.
950*/
drh954733b2018-07-27 23:33:16 +0000951Expr *sqlite3ExprFunction(
952 Parse *pParse, /* Parsing context */
953 ExprList *pList, /* Argument list */
954 Token *pToken, /* Name of the function */
955 int eDistinct /* SF_Distinct or SF_ALL or 0 */
956){
drha76b5df2002-02-23 02:32:10 +0000957 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000958 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000959 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000960 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000961 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000962 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000963 return 0;
964 }
drh954733b2018-07-27 23:33:16 +0000965 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
966 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
967 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000968 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000969 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000970 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000971 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000972 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000973 return pNew;
974}
975
976/*
drh0dfa5252020-01-08 17:28:19 +0000977** Check to see if a function is usable according to current access
978** rules:
979**
980** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
981**
982** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
983** top-level SQL
984**
985** If the function is not usable, create an error.
986*/
987void sqlite3ExprFunctionUsable(
988 Parse *pParse, /* Parsing and code generating context */
989 Expr *pExpr, /* The function invocation */
990 FuncDef *pDef /* The function being invoked */
991){
992 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +0000993 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
994 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +0000995 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
996 || (pParse->db->flags & SQLITE_TrustedSchema)==0
997 ){
998 /* Functions prohibited in triggers and views if:
999 ** (1) tagged with SQLITE_DIRECTONLY
1000 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1001 ** is tagged with SQLITE_FUNC_UNSAFE) and
1002 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1003 ** that the schema is possibly tainted).
1004 */
1005 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1006 }
1007 }
1008}
1009
1010/*
drhfa6bc002004-09-07 16:19:52 +00001011** Assign a variable number to an expression that encodes a wildcard
1012** in the original SQL statement.
1013**
1014** Wildcards consisting of a single "?" are assigned the next sequential
1015** variable number.
1016**
1017** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001018** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001019** the SQL statement comes from an external source.
1020**
drh51f49f12009-05-21 20:41:32 +00001021** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001022** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001023** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001024** assigned.
1025*/
drhde25a882016-10-03 15:28:24 +00001026void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001027 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001028 const char *z;
drhf326d662016-12-23 13:30:53 +00001029 ynVar x;
drh17435752007-08-16 04:30:38 +00001030
drhfa6bc002004-09-07 16:19:52 +00001031 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001032 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001033 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001034 assert( z!=0 );
1035 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001036 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001037 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001038 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001039 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001040 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001041 }else{
drhf326d662016-12-23 13:30:53 +00001042 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001043 if( z[0]=='?' ){
1044 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1045 ** use it as the variable number */
1046 i64 i;
drh18814df2017-01-31 03:52:34 +00001047 int bOk;
1048 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1049 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1050 bOk = 1;
1051 }else{
1052 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1053 }
drh124c0b42011-06-01 18:15:55 +00001054 testcase( i==0 );
1055 testcase( i==1 );
1056 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1057 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1058 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1059 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1060 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001061 return;
drhfa6bc002004-09-07 16:19:52 +00001062 }
drh8e74e7b2017-01-31 12:41:48 +00001063 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001064 if( x>pParse->nVar ){
1065 pParse->nVar = (int)x;
1066 doAdd = 1;
1067 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1068 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001069 }
1070 }else{
1071 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1072 ** number as the prior appearance of the same name, or if the name
1073 ** has never appeared before, reuse the same variable number
1074 */
drh9bf755c2016-12-23 03:59:31 +00001075 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1076 if( x==0 ){
1077 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001078 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001079 }
drhfa6bc002004-09-07 16:19:52 +00001080 }
drhf326d662016-12-23 13:30:53 +00001081 if( doAdd ){
1082 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1083 }
1084 }
1085 pExpr->iColumn = x;
1086 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001087 sqlite3ErrorMsg(pParse, "too many SQL variables");
1088 }
drhfa6bc002004-09-07 16:19:52 +00001089}
1090
1091/*
danf6963f92009-11-23 14:39:14 +00001092** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001093*/
drh4f0010b2016-04-11 14:49:39 +00001094static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1095 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001096 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1097 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001098
1099 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1100 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001101 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001102#ifdef SQLITE_DEBUG
1103 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1104 assert( p->pLeft==0 );
1105 assert( p->pRight==0 );
1106 assert( p->x.pSelect==0 );
1107 }
1108#endif
1109 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001110 /* The Expr.x union is never used at the same time as Expr.pRight */
1111 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001112 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001113 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001114 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001115 sqlite3ExprDeleteNN(db, p->pRight);
1116 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001117 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001118 sqlite3SelectDelete(db, p->x.pSelect);
1119 }else{
1120 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001121#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001122 if( ExprHasProperty(p, EP_WinFunc) ){
1123 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001124 }
dan6ba7ab02019-07-02 11:56:47 +00001125#endif
dan8117f112019-07-10 20:16:53 +00001126 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 }
drh209bc522016-09-23 21:36:24 +00001128 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001129 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001130 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001131 }
drha2e00042002-01-22 03:13:42 +00001132}
drh4f0010b2016-04-11 14:49:39 +00001133void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1134 if( p ) sqlite3ExprDeleteNN(db, p);
1135}
drha2e00042002-01-22 03:13:42 +00001136
drh8e34e402019-06-11 10:43:56 +00001137/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1138** expression.
1139*/
1140void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1141 if( p ){
1142 if( IN_RENAME_OBJECT ){
1143 sqlite3RenameExprUnmap(pParse, p);
1144 }
1145 sqlite3ExprDeleteNN(pParse->db, p);
1146 }
1147}
1148
drhd2687b72005-08-12 22:56:09 +00001149/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001150** Return the number of bytes allocated for the expression structure
1151** passed as the first argument. This is always one of EXPR_FULLSIZE,
1152** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1153*/
1154static int exprStructSize(Expr *p){
1155 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001156 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1157 return EXPR_FULLSIZE;
1158}
1159
1160/*
drh33e619f2009-05-28 01:00:55 +00001161** The dupedExpr*Size() routines each return the number of bytes required
1162** to store a copy of an expression or expression tree. They differ in
1163** how much of the tree is measured.
1164**
1165** dupedExprStructSize() Size of only the Expr structure
1166** dupedExprNodeSize() Size of Expr + space for token
1167** dupedExprSize() Expr + token + subtree components
1168**
1169***************************************************************************
1170**
1171** The dupedExprStructSize() function returns two values OR-ed together:
1172** (1) the space required for a copy of the Expr structure only and
1173** (2) the EP_xxx flags that indicate what the structure size should be.
1174** The return values is always one of:
1175**
1176** EXPR_FULLSIZE
1177** EXPR_REDUCEDSIZE | EP_Reduced
1178** EXPR_TOKENONLYSIZE | EP_TokenOnly
1179**
1180** The size of the structure can be found by masking the return value
1181** of this routine with 0xfff. The flags can be found by masking the
1182** return value with EP_Reduced|EP_TokenOnly.
1183**
1184** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1185** (unreduced) Expr objects as they or originally constructed by the parser.
1186** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001187** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001188** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001189** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001190** to reduce a pristine expression tree from the parser. The implementation
1191** of dupedExprStructSize() contain multiple assert() statements that attempt
1192** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001193*/
1194static int dupedExprStructSize(Expr *p, int flags){
1195 int nSize;
drh33e619f2009-05-28 01:00:55 +00001196 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001197 assert( EXPR_FULLSIZE<=0xfff );
1198 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001199 if( 0==flags || p->op==TK_SELECT_COLUMN
1200#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001201 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001202#endif
1203 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001204 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001205 }else{
drhc5cd1242013-09-12 16:50:49 +00001206 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001207 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001208 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001209 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001210 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001211 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1212 }else{
drhaecd8022013-09-13 18:15:15 +00001213 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001214 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1215 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001216 }
1217 return nSize;
1218}
1219
1220/*
drh33e619f2009-05-28 01:00:55 +00001221** This function returns the space in bytes required to store the copy
1222** of the Expr structure and a copy of the Expr.u.zToken string (if that
1223** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001224*/
1225static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001226 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1227 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001228 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001229 }
danielk1977bc739712009-03-23 04:33:32 +00001230 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001231}
1232
1233/*
1234** Return the number of bytes required to create a duplicate of the
1235** expression passed as the first argument. The second argument is a
1236** mask containing EXPRDUP_XXX flags.
1237**
1238** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001239** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001240**
1241** If the EXPRDUP_REDUCE flag is set, then the return value includes
1242** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1243** and Expr.pRight variables (but not for any structures pointed to or
1244** descended from the Expr.x.pList or Expr.x.pSelect variables).
1245*/
1246static int dupedExprSize(Expr *p, int flags){
1247 int nByte = 0;
1248 if( p ){
1249 nByte = dupedExprNodeSize(p, flags);
1250 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001251 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001252 }
1253 }
1254 return nByte;
1255}
1256
1257/*
1258** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1259** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001260** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001261** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001262** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001263** portion of the buffer copied into by this function.
1264*/
drh3c194692016-04-11 16:43:43 +00001265static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1266 Expr *pNew; /* Value to return */
1267 u8 *zAlloc; /* Memory space from which to build Expr object */
1268 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1269
drh575fad62016-02-05 13:38:36 +00001270 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001271 assert( p );
1272 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1273 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001274
drh3c194692016-04-11 16:43:43 +00001275 /* Figure out where to write the new Expr structure. */
1276 if( pzBuffer ){
1277 zAlloc = *pzBuffer;
1278 staticFlag = EP_Static;
1279 }else{
1280 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1281 staticFlag = 0;
1282 }
1283 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001284
drh3c194692016-04-11 16:43:43 +00001285 if( pNew ){
1286 /* Set nNewSize to the size allocated for the structure pointed to
1287 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1288 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1289 ** by the copy of the p->u.zToken string (if any).
1290 */
1291 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1292 const int nNewSize = nStructSize & 0xfff;
1293 int nToken;
1294 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1295 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001296 }else{
drh3c194692016-04-11 16:43:43 +00001297 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001298 }
drh3c194692016-04-11 16:43:43 +00001299 if( dupFlags ){
1300 assert( ExprHasProperty(p, EP_Reduced)==0 );
1301 memcpy(zAlloc, p, nNewSize);
1302 }else{
1303 u32 nSize = (u32)exprStructSize(p);
1304 memcpy(zAlloc, p, nSize);
1305 if( nSize<EXPR_FULLSIZE ){
1306 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1307 }
1308 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001309
drh3c194692016-04-11 16:43:43 +00001310 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1311 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1312 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1313 pNew->flags |= staticFlag;
1314
1315 /* Copy the p->u.zToken string, if any. */
1316 if( nToken ){
1317 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1318 memcpy(zToken, p->u.zToken, nToken);
1319 }
1320
drh209bc522016-09-23 21:36:24 +00001321 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001322 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1323 if( ExprHasProperty(p, EP_xIsSelect) ){
1324 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001325 }else{
drh3c194692016-04-11 16:43:43 +00001326 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001327 }
drh3c194692016-04-11 16:43:43 +00001328 }
1329
1330 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001331 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001332 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001333 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001334 pNew->pLeft = p->pLeft ?
1335 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1336 pNew->pRight = p->pRight ?
1337 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001338 }
dan67a9b8e2018-06-22 20:51:35 +00001339#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001340 if( ExprHasProperty(p, EP_WinFunc) ){
1341 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1342 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001343 }
dan67a9b8e2018-06-22 20:51:35 +00001344#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001345 if( pzBuffer ){
1346 *pzBuffer = zAlloc;
1347 }
1348 }else{
drh209bc522016-09-23 21:36:24 +00001349 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001350 if( pNew->op==TK_SELECT_COLUMN ){
1351 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001352 assert( p->iColumn==0 || p->pRight==0 );
1353 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001354 }else{
1355 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1356 }
drh3c194692016-04-11 16:43:43 +00001357 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001358 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001359 }
1360 }
1361 return pNew;
1362}
1363
1364/*
danbfe31e72014-01-15 14:17:31 +00001365** Create and return a deep copy of the object passed as the second
1366** argument. If an OOM condition is encountered, NULL is returned
1367** and the db->mallocFailed flag set.
1368*/
daneede6a52014-01-15 19:42:23 +00001369#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001370static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001371 With *pRet = 0;
1372 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001373 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001374 pRet = sqlite3DbMallocZero(db, nByte);
1375 if( pRet ){
1376 int i;
1377 pRet->nCte = p->nCte;
1378 for(i=0; i<p->nCte; i++){
1379 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1380 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1381 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1382 }
1383 }
1384 }
1385 return pRet;
1386}
daneede6a52014-01-15 19:42:23 +00001387#else
1388# define withDup(x,y) 0
1389#endif
dan4e9119d2014-01-13 15:12:23 +00001390
drha8389972018-12-06 22:04:19 +00001391#ifndef SQLITE_OMIT_WINDOWFUNC
1392/*
1393** The gatherSelectWindows() procedure and its helper routine
1394** gatherSelectWindowsCallback() are used to scan all the expressions
1395** an a newly duplicated SELECT statement and gather all of the Window
1396** objects found there, assembling them onto the linked list at Select->pWin.
1397*/
1398static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001399 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001400 Select *pSelect = pWalker->u.pSelect;
1401 Window *pWin = pExpr->y.pWin;
1402 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001403 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001404 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001405 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001406 }
1407 return WRC_Continue;
1408}
drha37b6a52018-12-06 22:12:18 +00001409static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1410 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1411}
drha8389972018-12-06 22:04:19 +00001412static void gatherSelectWindows(Select *p){
1413 Walker w;
1414 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001415 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1416 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001417 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001418 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001419 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001420}
1421#endif
1422
1423
drha76b5df2002-02-23 02:32:10 +00001424/*
drhff78bd22002-02-27 01:47:11 +00001425** The following group of routines make deep copies of expressions,
1426** expression lists, ID lists, and select statements. The copies can
1427** be deleted (by being passed to their respective ...Delete() routines)
1428** without effecting the originals.
1429**
danielk19774adee202004-05-08 08:23:19 +00001430** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1431** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001432** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001433**
drhad3cab52002-05-24 02:04:32 +00001434** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001435**
drhb7916a72009-05-27 10:31:29 +00001436** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001437** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1438** truncated version of the usual Expr structure that will be stored as
1439** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001440*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001441Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001442 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001443 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001444}
danielk19776ab3a2e2009-02-19 14:39:25 +00001445ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001446 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001447 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001448 int i;
drhb1637482017-01-03 00:27:16 +00001449 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001450 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001451 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001452 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001453 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001454 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001455 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001456 pOldItem = p->a;
1457 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001458 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001459 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001460 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001461 if( pOldExpr
1462 && pOldExpr->op==TK_SELECT_COLUMN
1463 && (pNewExpr = pItem->pExpr)!=0
1464 ){
1465 assert( pNewExpr->iColumn==0 || i>0 );
1466 if( pNewExpr->iColumn==0 ){
1467 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001468 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1469 }else{
1470 assert( i>0 );
1471 assert( pItem[-1].pExpr!=0 );
1472 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1473 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1474 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001475 }
1476 }
drh41cee662019-12-12 20:22:34 +00001477 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001478 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001479 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001480 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001481 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001482 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001483 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001484 }
1485 return pNew;
1486}
danielk197793758c82005-01-21 08:13:14 +00001487
1488/*
1489** If cursors, triggers, views and subqueries are all omitted from
1490** the build, then none of the following routines, except for
1491** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1492** called with a NULL argument.
1493*/
danielk19776a67fe82005-02-04 04:07:16 +00001494#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1495 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001496SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001497 SrcList *pNew;
1498 int i;
drh113088e2003-03-20 01:16:58 +00001499 int nByte;
drh575fad62016-02-05 13:38:36 +00001500 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001501 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001502 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001503 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001504 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001505 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001506 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001507 struct SrcList_item *pNewItem = &pNew->a[i];
1508 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001509 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001510 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001511 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1512 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1513 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001514 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001515 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001516 pNewItem->addrFillSub = pOldItem->addrFillSub;
1517 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001518 if( pNewItem->fg.isIndexedBy ){
1519 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1520 }
1521 pNewItem->pIBIndex = pOldItem->pIBIndex;
1522 if( pNewItem->fg.isTabFunc ){
1523 pNewItem->u1.pFuncArg =
1524 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1525 }
drhed8a3bb2005-06-06 21:19:56 +00001526 pTab = pNewItem->pTab = pOldItem->pTab;
1527 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001528 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001529 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001530 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1531 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001532 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001533 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001534 }
1535 return pNew;
1536}
drh17435752007-08-16 04:30:38 +00001537IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001538 IdList *pNew;
1539 int i;
drh575fad62016-02-05 13:38:36 +00001540 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001541 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001542 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001543 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001544 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001545 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001546 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001547 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001548 return 0;
1549 }
drh6c535152012-02-02 03:38:30 +00001550 /* Note that because the size of the allocation for p->a[] is not
1551 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1552 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001553 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001554 struct IdList_item *pNewItem = &pNew->a[i];
1555 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001556 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001557 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001558 }
1559 return pNew;
1560}
dana7466202017-02-03 14:44:52 +00001561Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1562 Select *pRet = 0;
1563 Select *pNext = 0;
1564 Select **pp = &pRet;
1565 Select *p;
1566
drh575fad62016-02-05 13:38:36 +00001567 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001568 for(p=pDup; p; p=p->pPrior){
1569 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1570 if( pNew==0 ) break;
1571 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1572 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1573 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1574 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1575 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1576 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1577 pNew->op = p->op;
1578 pNew->pNext = pNext;
1579 pNew->pPrior = 0;
1580 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001581 pNew->iLimit = 0;
1582 pNew->iOffset = 0;
1583 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1584 pNew->addrOpenEphm[0] = -1;
1585 pNew->addrOpenEphm[1] = -1;
1586 pNew->nSelectRow = p->nSelectRow;
1587 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001588#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001589 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001590 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001591 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001592#endif
drhfef37762018-07-10 19:48:35 +00001593 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001594 *pp = pNew;
1595 pp = &pNew->pPrior;
1596 pNext = pNew;
1597 }
1598
1599 return pRet;
drhff78bd22002-02-27 01:47:11 +00001600}
danielk197793758c82005-01-21 08:13:14 +00001601#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001602Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001603 assert( p==0 );
1604 return 0;
1605}
1606#endif
drhff78bd22002-02-27 01:47:11 +00001607
1608
1609/*
drha76b5df2002-02-23 02:32:10 +00001610** Add a new element to the end of an expression list. If pList is
1611** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001612**
drha19543f2017-09-15 15:17:48 +00001613** The pList argument must be either NULL or a pointer to an ExprList
1614** obtained from a prior call to sqlite3ExprListAppend(). This routine
1615** may not be used with an ExprList obtained from sqlite3ExprListDup().
1616** Reason: This routine assumes that the number of slots in pList->a[]
1617** is a power of two. That is true for sqlite3ExprListAppend() returns
1618** but is not necessarily true from the return value of sqlite3ExprListDup().
1619**
drhb7916a72009-05-27 10:31:29 +00001620** If a memory allocation error occurs, the entire list is freed and
1621** NULL is returned. If non-NULL is returned, then it is guaranteed
1622** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001623*/
drh17435752007-08-16 04:30:38 +00001624ExprList *sqlite3ExprListAppend(
1625 Parse *pParse, /* Parsing context */
1626 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001627 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001628){
drh43606172017-04-05 11:32:13 +00001629 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001630 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001631 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001632 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001633 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001634 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001635 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001636 }
drhc263f7c2016-01-18 13:18:54 +00001637 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001638 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001639 ExprList *pNew;
1640 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001641 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001642 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001643 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001644 }
drh43606172017-04-05 11:32:13 +00001645 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001646 }
drh43606172017-04-05 11:32:13 +00001647 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001648 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001649 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001650 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001651 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001652 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001653
1654no_mem:
1655 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001656 sqlite3ExprDelete(db, pExpr);
1657 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001658 return 0;
drha76b5df2002-02-23 02:32:10 +00001659}
1660
1661/*
drh8762ec12016-08-20 01:06:22 +00001662** pColumns and pExpr form a vector assignment which is part of the SET
1663** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001664**
1665** (a,b,c) = (expr1,expr2,expr3)
1666** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1667**
1668** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001669** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001670** TK_SELECT_COLUMN expressions.
1671*/
1672ExprList *sqlite3ExprListAppendVector(
1673 Parse *pParse, /* Parsing context */
1674 ExprList *pList, /* List to which to append. Might be NULL */
1675 IdList *pColumns, /* List of names of LHS of the assignment */
1676 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1677){
1678 sqlite3 *db = pParse->db;
1679 int n;
1680 int i;
drh66860af2016-08-23 18:30:10 +00001681 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001682 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1683 ** exit prior to this routine being invoked */
1684 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001685 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001686
1687 /* If the RHS is a vector, then we can immediately check to see that
1688 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1689 ** wildcards ("*") in the result set of the SELECT must be expanded before
1690 ** we can do the size check, so defer the size check until code generation.
1691 */
1692 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001693 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1694 pColumns->nId, n);
1695 goto vector_append_error;
1696 }
drh966e2912017-01-03 02:58:01 +00001697
1698 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001699 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001700 assert( pSubExpr!=0 || db->mallocFailed );
1701 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1702 if( pSubExpr==0 ) continue;
1703 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001704 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1705 if( pList ){
drh66860af2016-08-23 18:30:10 +00001706 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001707 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001708 pColumns->a[i].zName = 0;
1709 }
1710 }
drh966e2912017-01-03 02:58:01 +00001711
drhffe28052017-05-06 18:09:36 +00001712 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001713 Expr *pFirst = pList->a[iFirst].pExpr;
1714 assert( pFirst!=0 );
1715 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001716
drhf4dd26c2017-04-05 11:49:06 +00001717 /* Store the SELECT statement in pRight so it will be deleted when
1718 ** sqlite3ExprListDelete() is called */
1719 pFirst->pRight = pExpr;
1720 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001721
drhf4dd26c2017-04-05 11:49:06 +00001722 /* Remember the size of the LHS in iTable so that we can check that
1723 ** the RHS and LHS sizes match during code generation. */
1724 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001725 }
1726
1727vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001728 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001729 sqlite3IdListDelete(db, pColumns);
1730 return pList;
1731}
1732
1733/*
drhbc622bc2015-08-24 15:39:42 +00001734** Set the sort order for the last element on the given ExprList.
1735*/
dan6e118922019-08-12 16:36:38 +00001736void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001737 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001738 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001739 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001740
1741 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1742 assert( iSortOrder==SQLITE_SO_UNDEFINED
1743 || iSortOrder==SQLITE_SO_ASC
1744 || iSortOrder==SQLITE_SO_DESC
1745 );
1746 assert( eNulls==SQLITE_SO_UNDEFINED
1747 || eNulls==SQLITE_SO_ASC
1748 || eNulls==SQLITE_SO_DESC
1749 );
1750
dan9105fd52019-08-19 17:26:32 +00001751 pItem = &p->a[p->nExpr-1];
1752 assert( pItem->bNulls==0 );
1753 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1754 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001755 }
dan9105fd52019-08-19 17:26:32 +00001756 pItem->sortFlags = (u8)iSortOrder;
1757
1758 if( eNulls!=SQLITE_SO_UNDEFINED ){
1759 pItem->bNulls = 1;
1760 if( iSortOrder!=eNulls ){
1761 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1762 }
drhbc622bc2015-08-24 15:39:42 +00001763 }
drhbc622bc2015-08-24 15:39:42 +00001764}
1765
1766/*
drh41cee662019-12-12 20:22:34 +00001767** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001768** on the expression list.
1769**
1770** pList might be NULL following an OOM error. But pName should never be
1771** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1772** is set.
1773*/
1774void sqlite3ExprListSetName(
1775 Parse *pParse, /* Parsing context */
1776 ExprList *pList, /* List to which to add the span. */
1777 Token *pName, /* Name to be added */
1778 int dequote /* True to cause the name to be dequoted */
1779){
1780 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1781 if( pList ){
1782 struct ExprList_item *pItem;
1783 assert( pList->nExpr>0 );
1784 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001785 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001786 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001787 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1788 if( dequote ) sqlite3Dequote(pItem->zEName);
danc9461ec2018-08-29 21:00:16 +00001789 if( IN_RENAME_OBJECT ){
drh41cee662019-12-12 20:22:34 +00001790 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
dan5be60c52018-08-15 20:28:39 +00001791 }
drhb7916a72009-05-27 10:31:29 +00001792 }
1793}
1794
1795/*
1796** Set the ExprList.a[].zSpan element of the most recently added item
1797** on the expression list.
1798**
1799** pList might be NULL following an OOM error. But pSpan should never be
1800** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1801** is set.
1802*/
1803void sqlite3ExprListSetSpan(
1804 Parse *pParse, /* Parsing context */
1805 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001806 const char *zStart, /* Start of the span */
1807 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001808){
1809 sqlite3 *db = pParse->db;
1810 assert( pList!=0 || db->mallocFailed!=0 );
1811 if( pList ){
1812 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1813 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001814 if( pItem->zEName==0 ){
1815 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1816 pItem->eEName = ENAME_SPAN;
1817 }
drhb7916a72009-05-27 10:31:29 +00001818 }
1819}
1820
1821/*
danielk19777a15a4b2007-05-08 17:54:43 +00001822** If the expression list pEList contains more than iLimit elements,
1823** leave an error message in pParse.
1824*/
1825void sqlite3ExprListCheckLength(
1826 Parse *pParse,
1827 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001828 const char *zObject
1829){
drhb1a6c3c2008-03-20 16:30:17 +00001830 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001831 testcase( pEList && pEList->nExpr==mx );
1832 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001833 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001834 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1835 }
1836}
1837
1838/*
drha76b5df2002-02-23 02:32:10 +00001839** Delete an entire expression list.
1840*/
drhaffa8552016-04-11 18:25:05 +00001841static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001842 int i = pList->nExpr;
1843 struct ExprList_item *pItem = pList->a;
1844 assert( pList->nExpr>0 );
1845 do{
drh633e6d52008-07-28 19:34:53 +00001846 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001847 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001848 pItem++;
1849 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001850 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001851}
drhaffa8552016-04-11 18:25:05 +00001852void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1853 if( pList ) exprListDeleteNN(db, pList);
1854}
drha76b5df2002-02-23 02:32:10 +00001855
1856/*
drh2308ed32015-02-09 16:09:34 +00001857** Return the bitwise-OR of all Expr.flags fields in the given
1858** ExprList.
drh885a5b02015-02-09 15:21:36 +00001859*/
drh2308ed32015-02-09 16:09:34 +00001860u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001861 int i;
drh2308ed32015-02-09 16:09:34 +00001862 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001863 assert( pList!=0 );
1864 for(i=0; i<pList->nExpr; i++){
1865 Expr *pExpr = pList->a[i].pExpr;
1866 assert( pExpr!=0 );
1867 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001868 }
drh2308ed32015-02-09 16:09:34 +00001869 return m;
drh885a5b02015-02-09 15:21:36 +00001870}
1871
1872/*
drh7e6f9802017-09-04 00:33:04 +00001873** This is a SELECT-node callback for the expression walker that
1874** always "fails". By "fail" in this case, we mean set
1875** pWalker->eCode to zero and abort.
1876**
1877** This callback is used by multiple expression walkers.
1878*/
1879int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1880 UNUSED_PARAMETER(NotUsed);
1881 pWalker->eCode = 0;
1882 return WRC_Abort;
1883}
1884
1885/*
drh0cbec592020-01-03 02:20:37 +00001886** Check the input string to see if it is "true" or "false" (in any case).
1887**
1888** If the string is.... Return
1889** "true" EP_IsTrue
1890** "false" EP_IsFalse
1891** anything else 0
1892*/
1893u32 sqlite3IsTrueOrFalse(const char *zIn){
1894 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1895 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1896 return 0;
1897}
1898
1899
1900/*
drh171d16b2018-02-26 20:15:54 +00001901** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001902** then convert it into an TK_TRUEFALSE term. Return non-zero if
1903** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001904*/
1905int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001906 u32 v;
drh171d16b2018-02-26 20:15:54 +00001907 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001908 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001909 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001910 ){
1911 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001912 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001913 return 1;
1914 }
1915 return 0;
1916}
1917
drh43c4ac82018-02-26 21:26:27 +00001918/*
drh96acafb2018-02-27 14:49:25 +00001919** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001920** and 0 if it is FALSE.
1921*/
drh96acafb2018-02-27 14:49:25 +00001922int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001923 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001924 assert( pExpr->op==TK_TRUEFALSE );
1925 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1926 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1927 return pExpr->u.zToken[4]==0;
1928}
1929
drh17180fc2019-04-19 17:26:19 +00001930/*
1931** If pExpr is an AND or OR expression, try to simplify it by eliminating
1932** terms that are always true or false. Return the simplified expression.
1933** Or return the original expression if no simplification is possible.
1934**
1935** Examples:
1936**
1937** (x<10) AND true => (x<10)
1938** (x<10) AND false => false
1939** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1940** (x<10) AND (y=22 OR true) => (x<10)
1941** (y=22) OR true => true
1942*/
1943Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1944 assert( pExpr!=0 );
1945 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1946 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1947 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1948 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1949 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1950 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1951 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1952 }
1953 }
1954 return pExpr;
1955}
1956
drh171d16b2018-02-26 20:15:54 +00001957
1958/*
drh059b2d52014-10-24 19:28:09 +00001959** These routines are Walker callbacks used to check expressions to
1960** see if they are "constant" for some definition of constant. The
1961** Walker.eCode value determines the type of "constant" we are looking
1962** for.
drh73b211a2005-01-18 04:00:42 +00001963**
drh7d10d5a2008-08-20 16:35:10 +00001964** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001965**
drh059b2d52014-10-24 19:28:09 +00001966** sqlite3ExprIsConstant() pWalker->eCode==1
1967** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001968** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001969** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001970**
drh059b2d52014-10-24 19:28:09 +00001971** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1972** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001973**
drh014fff22020-01-08 22:22:36 +00001974** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1975** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
1976** when parsing an existing schema out of the sqlite_master table and 4
1977** when processing a new CREATE TABLE statement. A bound parameter raises
1978** an error for new statements, but is silently converted
drhfeada2d2014-09-24 13:20:22 +00001979** to NULL for existing schemas. This allows sqlite_master tables that
1980** contain a bound parameter because they were generated by older versions
1981** of SQLite to be parsed by newer versions of SQLite without raising a
1982** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001983*/
drh7d10d5a2008-08-20 16:35:10 +00001984static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001985
drh059b2d52014-10-24 19:28:09 +00001986 /* If pWalker->eCode is 2 then any term of the expression that comes from
1987 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001988 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001989 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1990 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001991 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001992 }
1993
drh626a8792005-01-17 22:08:19 +00001994 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001995 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001996 ** and either pWalker->eCode==4 or 5 or the function has the
1997 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001998 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00001999 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2000 && !ExprHasProperty(pExpr, EP_WinFunc)
2001 ){
drh014fff22020-01-08 22:22:36 +00002002 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002003 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002004 }else{
2005 pWalker->eCode = 0;
2006 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002007 }
drh626a8792005-01-17 22:08:19 +00002008 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002009 /* Convert "true" or "false" in a DEFAULT clause into the
2010 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002011 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002012 return WRC_Prune;
2013 }
2014 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00002015 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002016 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002017 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002018 testcase( pExpr->op==TK_ID );
2019 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002020 testcase( pExpr->op==TK_AGG_FUNCTION );
2021 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002022 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002023 return WRC_Continue;
2024 }
drh059b2d52014-10-24 19:28:09 +00002025 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2026 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002027 }
drhf43ce0b2017-05-25 00:08:48 +00002028 /* Fall through */
2029 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002030 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00002031 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002032 testcase( pExpr->op==TK_IF_NULL_ROW );
2033 pWalker->eCode = 0;
2034 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002035 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002036 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002037 /* Silently convert bound parameters that appear inside of CREATE
2038 ** statements into a NULL when parsing the CREATE statement text out
2039 ** of the sqlite_master table */
2040 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002041 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002042 /* A bound parameter in a CREATE statement that originates from
2043 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002044 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002045 return WRC_Abort;
2046 }
2047 /* Fall through */
drh626a8792005-01-17 22:08:19 +00002048 default:
drh6e341b92018-04-17 18:50:40 +00002049 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2050 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002051 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002052 }
2053}
drh059b2d52014-10-24 19:28:09 +00002054static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002055 Walker w;
drh059b2d52014-10-24 19:28:09 +00002056 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002057 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002058 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002059#ifdef SQLITE_DEBUG
2060 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2061#endif
drh059b2d52014-10-24 19:28:09 +00002062 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002063 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002064 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002065}
drh626a8792005-01-17 22:08:19 +00002066
2067/*
drh059b2d52014-10-24 19:28:09 +00002068** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002069** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002070**
2071** For the purposes of this function, a double-quoted string (ex: "abc")
2072** is considered a variable but a single-quoted string (ex: 'abc') is
2073** a constant.
drhfef52082000-06-06 01:50:43 +00002074*/
danielk19774adee202004-05-08 08:23:19 +00002075int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002076 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002077}
2078
2079/*
drh07aded62018-07-28 16:24:08 +00002080** Walk an expression tree. Return non-zero if
2081**
2082** (1) the expression is constant, and
2083** (2) the expression does originate in the ON or USING clause
2084** of a LEFT JOIN, and
2085** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2086** operands created by the constant propagation optimization.
2087**
2088** When this routine returns true, it indicates that the expression
2089** can be added to the pParse->pConstExpr list and evaluated once when
2090** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002091*/
2092int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002093 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002094}
2095
2096/*
drhfcb9f4f2015-06-01 18:13:16 +00002097** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002098** for any single row of the table with cursor iCur. In other words, the
2099** expression must not refer to any non-deterministic function nor any
2100** table other than iCur.
2101*/
2102int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2103 return exprIsConst(p, 3, iCur);
2104}
2105
danab31a842017-04-29 20:53:09 +00002106
2107/*
2108** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2109*/
2110static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2111 ExprList *pGroupBy = pWalker->u.pGroupBy;
2112 int i;
2113
2114 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2115 ** it constant. */
2116 for(i=0; i<pGroupBy->nExpr; i++){
2117 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002118 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002119 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002120 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002121 return WRC_Prune;
2122 }
2123 }
2124 }
2125
2126 /* Check if pExpr is a sub-select. If so, consider it variable. */
2127 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2128 pWalker->eCode = 0;
2129 return WRC_Abort;
2130 }
2131
2132 return exprNodeIsConstant(pWalker, pExpr);
2133}
2134
2135/*
2136** Walk the expression tree passed as the first argument. Return non-zero
2137** if the expression consists entirely of constants or copies of terms
2138** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002139**
2140** This routine is used to determine if a term of the HAVING clause can
2141** be promoted into the WHERE clause. In order for such a promotion to work,
2142** the value of the HAVING clause term must be the same for all members of
2143** a "group". The requirement that the GROUP BY term must be BINARY
2144** assumes that no other collating sequence will have a finer-grained
2145** grouping than binary. In other words (A=B COLLATE binary) implies
2146** A=B in every other collating sequence. The requirement that the
2147** GROUP BY be BINARY is stricter than necessary. It would also work
2148** to promote HAVING clauses that use the same alternative collating
2149** sequence as the GROUP BY term, but that is much harder to check,
2150** alternative collating sequences are uncommon, and this is only an
2151** optimization, so we take the easy way out and simply require the
2152** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002153*/
2154int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2155 Walker w;
danab31a842017-04-29 20:53:09 +00002156 w.eCode = 1;
2157 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002158 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002159 w.u.pGroupBy = pGroupBy;
2160 w.pParse = pParse;
2161 sqlite3WalkExpr(&w, p);
2162 return w.eCode;
2163}
2164
drh059b2d52014-10-24 19:28:09 +00002165/*
drh014fff22020-01-08 22:22:36 +00002166** Walk an expression tree for the DEFAULT field of a column definition
2167** in a CREATE TABLE statement. Return non-zero if the expression is
2168** acceptable for use as a DEFAULT. That is to say, return non-zero if
2169** the expression is constant or a function call with constant arguments.
2170** Return and 0 if there are any variables.
2171**
2172** isInit is true when parsing from sqlite_master. isInit is false when
2173** processing a new CREATE TABLE statement. When isInit is true, parameters
2174** (such as ? or $abc) in the expression are converted into NULL. When
2175** isInit is false, parameters raise an error. Parameters should not be
2176** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
2177** allowed it, so we need to support it when reading sqlite_master for
2178** backwards compatibility.
2179**
2180** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002181**
2182** For the purposes of this function, a double-quoted string (ex: "abc")
2183** is considered a variable but a single-quoted string (ex: 'abc') is
2184** a constant.
2185*/
drhfeada2d2014-09-24 13:20:22 +00002186int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2187 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002188 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002189}
2190
drh5b88bc42013-12-07 23:35:21 +00002191#ifdef SQLITE_ENABLE_CURSOR_HINTS
2192/*
2193** Walk an expression tree. Return 1 if the expression contains a
2194** subquery of some kind. Return 0 if there are no subqueries.
2195*/
2196int sqlite3ExprContainsSubquery(Expr *p){
2197 Walker w;
drhbec24762015-08-13 20:07:13 +00002198 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002199 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002200 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002201#ifdef SQLITE_DEBUG
2202 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2203#endif
drh5b88bc42013-12-07 23:35:21 +00002204 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002205 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002206}
2207#endif
2208
drheb55bd22005-06-30 17:04:21 +00002209/*
drh73b211a2005-01-18 04:00:42 +00002210** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002211** to fit in a 32-bit integer, return 1 and put the value of the integer
2212** in *pValue. If the expression is not an integer or if it is too big
2213** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002214*/
danielk19774adee202004-05-08 08:23:19 +00002215int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002216 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002217 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002218
2219 /* If an expression is an integer literal that fits in a signed 32-bit
2220 ** integer, then the EP_IntValue flag will have already been set */
2221 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2222 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2223
drh92b01d52008-06-24 00:32:35 +00002224 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002225 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002226 return 1;
2227 }
drhe4de1fe2002-06-02 16:09:01 +00002228 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002229 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002230 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002231 break;
drh4b59ab52002-08-24 18:24:51 +00002232 }
drhe4de1fe2002-06-02 16:09:01 +00002233 case TK_UMINUS: {
2234 int v;
danielk19774adee202004-05-08 08:23:19 +00002235 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002236 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002237 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002238 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002239 }
2240 break;
2241 }
2242 default: break;
2243 }
drh92b01d52008-06-24 00:32:35 +00002244 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002245}
2246
2247/*
drhbf48ce42020-02-17 00:12:04 +00002248** Return true if p is a Column node that references a virtual table.
2249*/
2250int sqlite3ExprIsVtabRef(Expr *p){
2251 if( p->op!=TK_COLUMN ) return 0;
2252 if( p->y.pTab==0 ) return 0;
2253 return IsVirtual(p->y.pTab);
2254}
2255
2256/*
drh039fc322009-11-17 18:31:47 +00002257** Return FALSE if there is no chance that the expression can be NULL.
2258**
2259** If the expression might be NULL or if the expression is too complex
2260** to tell return TRUE.
2261**
2262** This routine is used as an optimization, to skip OP_IsNull opcodes
2263** when we know that a value cannot be NULL. Hence, a false positive
2264** (returning TRUE when in fact the expression can never be NULL) might
2265** be a small performance hit but is otherwise harmless. On the other
2266** hand, a false negative (returning FALSE when the result could be NULL)
2267** will likely result in an incorrect answer. So when in doubt, return
2268** TRUE.
2269*/
2270int sqlite3ExprCanBeNull(const Expr *p){
2271 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002272 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2273 p = p->pLeft;
2274 }
drh039fc322009-11-17 18:31:47 +00002275 op = p->op;
2276 if( op==TK_REGISTER ) op = p->op2;
2277 switch( op ){
2278 case TK_INTEGER:
2279 case TK_STRING:
2280 case TK_FLOAT:
2281 case TK_BLOB:
2282 return 0;
drh7248a8b2014-08-04 18:50:54 +00002283 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002284 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002285 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002286 (p->iColumn>=0
2287 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2288 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002289 default:
2290 return 1;
2291 }
2292}
2293
2294/*
2295** Return TRUE if the given expression is a constant which would be
2296** unchanged by OP_Affinity with the affinity given in the second
2297** argument.
2298**
2299** This routine is used to determine if the OP_Affinity operation
2300** can be omitted. When in doubt return FALSE. A false negative
2301** is harmless. A false positive, however, can result in the wrong
2302** answer.
2303*/
2304int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2305 u8 op;
drhaf866402019-08-22 11:11:28 +00002306 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002307 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002308 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2309 if( p->op==TK_UMINUS ) unaryMinus = 1;
2310 p = p->pLeft;
2311 }
drh039fc322009-11-17 18:31:47 +00002312 op = p->op;
2313 if( op==TK_REGISTER ) op = p->op2;
2314 switch( op ){
2315 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002316 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002317 }
2318 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002319 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002320 }
2321 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002322 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002323 }
2324 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002325 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002326 }
drh2f2855b2009-11-18 01:25:26 +00002327 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002328 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002329 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002330 }
drh039fc322009-11-17 18:31:47 +00002331 default: {
2332 return 0;
2333 }
2334 }
2335}
2336
2337/*
drhc4a3c772001-04-04 11:48:57 +00002338** Return TRUE if the given string is a row-id column name.
2339*/
danielk19774adee202004-05-08 08:23:19 +00002340int sqlite3IsRowid(const char *z){
2341 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2342 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2343 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002344 return 0;
2345}
2346
danielk19779a96b662007-11-29 17:05:18 +00002347/*
drh69c355b2016-03-09 15:34:51 +00002348** pX is the RHS of an IN operator. If pX is a SELECT statement
2349** that can be simplified to a direct table access, then return
2350** a pointer to the SELECT statement. If pX is not a SELECT statement,
2351** or if the SELECT statement needs to be manifested into a transient
2352** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002353*/
2354#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002355static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002356 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002357 SrcList *pSrc;
2358 ExprList *pEList;
2359 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002360 int i;
drh69c355b2016-03-09 15:34:51 +00002361 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2362 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2363 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002364 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002365 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002366 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2367 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2368 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002369 }
drh2e26a602020-01-06 18:59:46 +00002370 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002371 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002372 if( p->pWhere ) return 0; /* Has no WHERE clause */
2373 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002374 assert( pSrc!=0 );
2375 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002376 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002377 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002378 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002379 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002380 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2381 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002382 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002383 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002384 for(i=0; i<pEList->nExpr; i++){
2385 Expr *pRes = pEList->a[i].pExpr;
2386 if( pRes->op!=TK_COLUMN ) return 0;
2387 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002388 }
drh69c355b2016-03-09 15:34:51 +00002389 return p;
drhb287f4b2008-04-25 00:08:38 +00002390}
2391#endif /* SQLITE_OMIT_SUBQUERY */
2392
danf9b2e052016-08-02 17:45:00 +00002393#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002394/*
drh4c259e92014-08-01 21:12:35 +00002395** Generate code that checks the left-most column of index table iCur to see if
2396** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002397** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2398** to be set to NULL if iCur contains one or more NULL values.
2399*/
2400static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002401 int addr1;
drh6be515e2014-08-01 21:00:53 +00002402 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002403 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002404 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2405 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002406 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002407 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002408}
danf9b2e052016-08-02 17:45:00 +00002409#endif
drh6be515e2014-08-01 21:00:53 +00002410
drhbb53ecb2014-08-02 21:03:33 +00002411
2412#ifndef SQLITE_OMIT_SUBQUERY
2413/*
2414** The argument is an IN operator with a list (not a subquery) on the
2415** right-hand side. Return TRUE if that list is constant.
2416*/
2417static int sqlite3InRhsIsConstant(Expr *pIn){
2418 Expr *pLHS;
2419 int res;
2420 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2421 pLHS = pIn->pLeft;
2422 pIn->pLeft = 0;
2423 res = sqlite3ExprIsConstant(pIn);
2424 pIn->pLeft = pLHS;
2425 return res;
2426}
2427#endif
2428
drh6be515e2014-08-01 21:00:53 +00002429/*
danielk19779a96b662007-11-29 17:05:18 +00002430** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002431** The pX parameter is the expression on the RHS of the IN operator, which
2432** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002433**
drhd4305ca2012-09-18 17:08:33 +00002434** The job of this routine is to find or create a b-tree object that can
2435** be used either to test for membership in the RHS set or to iterate through
2436** all members of the RHS set, skipping duplicates.
2437**
drh3a856252014-08-01 14:46:57 +00002438** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002439** and pX->iTable is set to the index of that cursor.
2440**
drhb74b1012009-05-28 21:04:37 +00002441** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002442**
drh1ccce442013-03-12 20:38:51 +00002443** IN_INDEX_ROWID - The cursor was opened on a database table.
2444** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2445** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2446** IN_INDEX_EPH - The cursor was opened on a specially created and
2447** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002448** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2449** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002450**
drhd4305ca2012-09-18 17:08:33 +00002451** An existing b-tree might be used if the RHS expression pX is a simple
2452** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002453**
dan553168c2016-08-01 20:14:31 +00002454** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002455**
drhd4305ca2012-09-18 17:08:33 +00002456** If the RHS of the IN operator is a list or a more complex subquery, then
2457** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002458** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002459** existing table.
drhd4305ca2012-09-18 17:08:33 +00002460**
drh7fc0ba02017-11-17 15:02:00 +00002461** The inFlags parameter must contain, at a minimum, one of the bits
2462** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2463** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2464** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2465** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002466**
2467** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2468** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002469** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002470** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2471** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002472**
drh3a856252014-08-01 14:46:57 +00002473** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2474** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002475** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2476** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002477**
drhbb53ecb2014-08-02 21:03:33 +00002478** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2479** if the RHS of the IN operator is a list (not a subquery) then this
2480** routine might decide that creating an ephemeral b-tree for membership
2481** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2482** calling routine should implement the IN operator using a sequence
2483** of Eq or Ne comparison operations.
2484**
drhb74b1012009-05-28 21:04:37 +00002485** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002486** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002487** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002488** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002489** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002490** to *prRhsHasNull. If there is no chance that the (...) contains a
2491** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002492**
drhe21a6e12014-08-01 18:00:24 +00002493** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002494** the value in that register will be NULL if the b-tree contains one or more
2495** NULL values, and it will be some non-NULL value if the b-tree contains no
2496** NULL values.
dan553168c2016-08-01 20:14:31 +00002497**
2498** If the aiMap parameter is not NULL, it must point to an array containing
2499** one element for each column returned by the SELECT statement on the RHS
2500** of the IN(...) operator. The i'th entry of the array is populated with the
2501** offset of the index column that matches the i'th column returned by the
2502** SELECT. For example, if the expression and selected index are:
2503**
2504** (?,?,?) IN (SELECT a, b, c FROM t1)
2505** CREATE INDEX i1 ON t1(b, c, a);
2506**
2507** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002508*/
danielk1977284f4ac2007-12-10 05:03:46 +00002509#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002510int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002511 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002512 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002513 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2514 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002515 int *aiMap, /* Mapping from Index fields to RHS fields */
2516 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002517){
drhb74b1012009-05-28 21:04:37 +00002518 Select *p; /* SELECT to the right of IN operator */
2519 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2520 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002521 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002522 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002523
drh1450bc62009-10-30 13:25:56 +00002524 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002525 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002526
dan7b35a772016-07-28 19:47:15 +00002527 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2528 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002529 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002530 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002531 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002532 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2533 int i;
2534 ExprList *pEList = pX->x.pSelect->pEList;
2535 for(i=0; i<pEList->nExpr; i++){
2536 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2537 }
2538 if( i==pEList->nExpr ){
2539 prRhsHasNull = 0;
2540 }
2541 }
2542
drhb74b1012009-05-28 21:04:37 +00002543 /* Check to see if an existing table or index can be used to
2544 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002545 ** ephemeral table. */
2546 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002547 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002548 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002549 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002550 ExprList *pEList = p->pEList;
2551 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002552
drhb07028f2011-10-14 21:49:18 +00002553 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2554 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2555 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2556 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002557
drhb22f7c82014-02-06 23:56:27 +00002558 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002559 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2560 sqlite3CodeVerifySchema(pParse, iDb);
2561 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002562
drha84a2832016-08-26 21:15:35 +00002563 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002564 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002565 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002566 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002567 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002568
2569 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2570 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002571 ExplainQueryPlan((pParse, 0,
2572 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002573 sqlite3VdbeJumpHere(v, iAddr);
2574 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002575 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002576 int affinity_ok = 1;
2577 int i;
2578
2579 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002580 ** comparison is the same as the affinity of each column in table
2581 ** on the RHS of the IN operator. If it not, it is not possible to
2582 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002583 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002584 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002585 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002586 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002587 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002588 testcase( cmpaff==SQLITE_AFF_BLOB );
2589 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002590 switch( cmpaff ){
2591 case SQLITE_AFF_BLOB:
2592 break;
2593 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002594 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2595 ** other has no affinity and the other side is TEXT. Hence,
2596 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2597 ** and for the term on the LHS of the IN to have no affinity. */
2598 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002599 break;
2600 default:
2601 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2602 }
2603 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002604
drha84a2832016-08-26 21:15:35 +00002605 if( affinity_ok ){
2606 /* Search for an existing index that will work for this IN operator */
2607 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2608 Bitmask colUsed; /* Columns of the index used */
2609 Bitmask mCol; /* Mask for the current column */
2610 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002611 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002612 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2613 ** BITMASK(nExpr) without overflowing */
2614 testcase( pIdx->nColumn==BMS-2 );
2615 testcase( pIdx->nColumn==BMS-1 );
2616 if( pIdx->nColumn>=BMS-1 ) continue;
2617 if( mustBeUnique ){
2618 if( pIdx->nKeyCol>nExpr
2619 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2620 ){
2621 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002622 }
danielk19770cdc0222008-06-26 18:04:03 +00002623 }
drha84a2832016-08-26 21:15:35 +00002624
2625 colUsed = 0; /* Columns of index used so far */
2626 for(i=0; i<nExpr; i++){
2627 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2628 Expr *pRhs = pEList->a[i].pExpr;
2629 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2630 int j;
2631
2632 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2633 for(j=0; j<nExpr; j++){
2634 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2635 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002636 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2637 continue;
2638 }
drha84a2832016-08-26 21:15:35 +00002639 break;
2640 }
2641 if( j==nExpr ) break;
2642 mCol = MASKBIT(j);
2643 if( mCol & colUsed ) break; /* Each column used only once */
2644 colUsed |= mCol;
2645 if( aiMap ) aiMap[i] = j;
2646 }
2647
2648 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2649 if( colUsed==(MASKBIT(nExpr)-1) ){
2650 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002651 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002652 ExplainQueryPlan((pParse, 0,
2653 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002654 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2655 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2656 VdbeComment((v, "%s", pIdx->zName));
2657 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2658 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2659
2660 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002661#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002662 i64 mask = (1<<nExpr)-1;
2663 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2664 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002665#endif
2666 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002667 if( nExpr==1 ){
2668 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2669 }
2670 }
2671 sqlite3VdbeJumpHere(v, iAddr);
2672 }
2673 } /* End loop over indexes */
2674 } /* End if( affinity_ok ) */
2675 } /* End if not an rowid index */
2676 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002677
drhbb53ecb2014-08-02 21:03:33 +00002678 /* If no preexisting index is available for the IN clause
2679 ** and IN_INDEX_NOOP is an allowed reply
2680 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002681 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002682 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002683 ** the IN operator so return IN_INDEX_NOOP.
2684 */
2685 if( eType==0
2686 && (inFlags & IN_INDEX_NOOP_OK)
2687 && !ExprHasProperty(pX, EP_xIsSelect)
2688 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2689 ){
2690 eType = IN_INDEX_NOOP;
2691 }
drhbb53ecb2014-08-02 21:03:33 +00002692
danielk19779a96b662007-11-29 17:05:18 +00002693 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002694 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002695 ** We will have to generate an ephemeral table to do the job.
2696 */
drh8e23daf2013-06-11 13:30:04 +00002697 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002698 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002699 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002700 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002701 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002702 }else if( prRhsHasNull ){
2703 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002704 }
drh85bcdce2018-12-23 21:27:29 +00002705 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002706 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002707 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002708 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002709 }
drhcf4d38a2010-07-28 02:53:36 +00002710 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002711 }
danba00e302016-07-23 20:24:06 +00002712
2713 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2714 int i, n;
2715 n = sqlite3ExprVectorSize(pX->pLeft);
2716 for(i=0; i<n; i++) aiMap[i] = i;
2717 }
drh2c041312018-12-24 02:34:49 +00002718 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002719 return eType;
2720}
danielk1977284f4ac2007-12-10 05:03:46 +00002721#endif
drh626a8792005-01-17 22:08:19 +00002722
danf9b2e052016-08-02 17:45:00 +00002723#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002724/*
2725** Argument pExpr is an (?, ?...) IN(...) expression. This
2726** function allocates and returns a nul-terminated string containing
2727** the affinities to be used for each column of the comparison.
2728**
2729** It is the responsibility of the caller to ensure that the returned
2730** string is eventually freed using sqlite3DbFree().
2731*/
dan71c57db2016-07-09 20:23:55 +00002732static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2733 Expr *pLeft = pExpr->pLeft;
2734 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002735 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002736 char *zRet;
2737
dan553168c2016-08-01 20:14:31 +00002738 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002739 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002740 if( zRet ){
2741 int i;
2742 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002743 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002744 char a = sqlite3ExprAffinity(pA);
2745 if( pSelect ){
2746 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2747 }else{
2748 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002749 }
dan71c57db2016-07-09 20:23:55 +00002750 }
2751 zRet[nVal] = '\0';
2752 }
2753 return zRet;
2754}
danf9b2e052016-08-02 17:45:00 +00002755#endif
dan71c57db2016-07-09 20:23:55 +00002756
dan8da209b2016-07-26 18:06:08 +00002757#ifndef SQLITE_OMIT_SUBQUERY
2758/*
2759** Load the Parse object passed as the first argument with an error
2760** message of the form:
2761**
2762** "sub-select returns N columns - expected M"
2763*/
2764void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002765 if( pParse->nErr==0 ){
2766 const char *zFmt = "sub-select returns %d columns - expected %d";
2767 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2768 }
dan8da209b2016-07-26 18:06:08 +00002769}
2770#endif
2771
drh626a8792005-01-17 22:08:19 +00002772/*
dan44c56042016-12-07 15:38:37 +00002773** Expression pExpr is a vector that has been used in a context where
2774** it is not permitted. If pExpr is a sub-select vector, this routine
2775** loads the Parse object with a message of the form:
2776**
2777** "sub-select returns N columns - expected 1"
2778**
2779** Or, if it is a regular scalar vector:
2780**
2781** "row value misused"
2782*/
2783void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2784#ifndef SQLITE_OMIT_SUBQUERY
2785 if( pExpr->flags & EP_xIsSelect ){
2786 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2787 }else
2788#endif
2789 {
2790 sqlite3ErrorMsg(pParse, "row value misused");
2791 }
2792}
2793
drh85bcdce2018-12-23 21:27:29 +00002794#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002795/*
drh85bcdce2018-12-23 21:27:29 +00002796** Generate code that will construct an ephemeral table containing all terms
2797** in the RHS of an IN operator. The IN operator can be in either of two
2798** forms:
drh626a8792005-01-17 22:08:19 +00002799**
drh9cbe6352005-11-29 03:13:21 +00002800** x IN (4,5,11) -- IN operator with list on right-hand side
2801** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002802**
drh2c041312018-12-24 02:34:49 +00002803** The pExpr parameter is the IN operator. The cursor number for the
2804** constructed ephermeral table is returned. The first time the ephemeral
2805** table is computed, the cursor number is also stored in pExpr->iTable,
2806** however the cursor number returned might not be the same, as it might
2807** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002808**
drh85bcdce2018-12-23 21:27:29 +00002809** If the LHS expression ("x" in the examples) is a column value, or
2810** the SELECT statement returns a column value, then the affinity of that
2811** column is used to build the index keys. If both 'x' and the
2812** SELECT... statement are columns, then numeric affinity is used
2813** if either column has NUMERIC or INTEGER affinity. If neither
2814** 'x' nor the SELECT... statement are columns, then numeric affinity
2815** is used.
drhcce7d172000-05-31 15:34:51 +00002816*/
drh85bcdce2018-12-23 21:27:29 +00002817void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002818 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002819 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002820 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002821){
drh2c041312018-12-24 02:34:49 +00002822 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002823 int addr; /* Address of OP_OpenEphemeral instruction */
2824 Expr *pLeft; /* the LHS of the IN operator */
2825 KeyInfo *pKeyInfo = 0; /* Key information */
2826 int nVal; /* Size of vector pLeft */
2827 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002828
drh2c041312018-12-24 02:34:49 +00002829 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002830 assert( v!=0 );
2831
drh2c041312018-12-24 02:34:49 +00002832 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002833 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002834 **
2835 ** * The right-hand side is a correlated subquery
2836 ** * The right-hand side is an expression list containing variables
2837 ** * We are inside a trigger
2838 **
drh2c041312018-12-24 02:34:49 +00002839 ** If all of the above are false, then we can compute the RHS just once
2840 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002841 */
drhefb699f2018-12-24 11:55:44 +00002842 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002843 /* Reuse of the RHS is allowed */
2844 /* If this routine has already been coded, but the previous code
2845 ** might not have been invoked yet, so invoke it now as a subroutine.
2846 */
2847 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002848 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002849 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2850 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2851 pExpr->x.pSelect->selId));
2852 }
drh2c041312018-12-24 02:34:49 +00002853 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2854 pExpr->y.sub.iAddr);
2855 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002856 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002857 return;
2858 }
2859
2860 /* Begin coding the subroutine */
2861 ExprSetProperty(pExpr, EP_Subrtn);
2862 pExpr->y.sub.regReturn = ++pParse->nMem;
2863 pExpr->y.sub.iAddr =
2864 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2865 VdbeComment((v, "return address"));
2866
2867 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002868 }
2869
drh85bcdce2018-12-23 21:27:29 +00002870 /* Check to see if this is a vector IN operator */
2871 pLeft = pExpr->pLeft;
2872 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002873
drh85bcdce2018-12-23 21:27:29 +00002874 /* Construct the ephemeral table that will contain the content of
2875 ** RHS of the IN operator.
2876 */
drh2c041312018-12-24 02:34:49 +00002877 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002878 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002879#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2880 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2881 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2882 }else{
2883 VdbeComment((v, "RHS of IN operator"));
2884 }
2885#endif
drh50ef6712019-02-22 23:29:56 +00002886 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002887
drh85bcdce2018-12-23 21:27:29 +00002888 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2889 /* Case 1: expr IN (SELECT ...)
2890 **
2891 ** Generate code to write the results of the select into the temporary
2892 ** table allocated and opened above.
2893 */
2894 Select *pSelect = pExpr->x.pSelect;
2895 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002896
drh2c041312018-12-24 02:34:49 +00002897 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2898 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002899 ));
drh85bcdce2018-12-23 21:27:29 +00002900 /* If the LHS and RHS of the IN operator do not match, that
2901 ** error will have been caught long before we reach this point. */
2902 if( ALWAYS(pEList->nExpr==nVal) ){
2903 SelectDest dest;
2904 int i;
drhbd462bc2018-12-24 20:21:06 +00002905 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002906 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2907 pSelect->iLimit = 0;
2908 testcase( pSelect->selFlags & SF_Distinct );
2909 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2910 if( sqlite3Select(pParse, pSelect, &dest) ){
2911 sqlite3DbFree(pParse->db, dest.zAffSdst);
2912 sqlite3KeyInfoUnref(pKeyInfo);
2913 return;
drhfef52082000-06-06 01:50:43 +00002914 }
drh85bcdce2018-12-23 21:27:29 +00002915 sqlite3DbFree(pParse->db, dest.zAffSdst);
2916 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2917 assert( pEList!=0 );
2918 assert( pEList->nExpr>0 );
2919 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2920 for(i=0; i<nVal; i++){
2921 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2922 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2923 pParse, p, pEList->a[i].pExpr
2924 );
danielk197741a05b72008-10-02 13:50:55 +00002925 }
drh85bcdce2018-12-23 21:27:29 +00002926 }
2927 }else if( ALWAYS(pExpr->x.pList!=0) ){
2928 /* Case 2: expr IN (exprlist)
2929 **
2930 ** For each expression, build an index key from the evaluation and
2931 ** store it in the temporary table. If <expr> is a column, then use
2932 ** that columns affinity when building index keys. If <expr> is not
2933 ** a column, use numeric affinity.
2934 */
2935 char affinity; /* Affinity of the LHS of the IN */
2936 int i;
2937 ExprList *pList = pExpr->x.pList;
2938 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002939 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002940 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002941 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002942 affinity = SQLITE_AFF_BLOB;
2943 }
2944 if( pKeyInfo ){
2945 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2946 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002947 }
2948
drh85bcdce2018-12-23 21:27:29 +00002949 /* Loop through each expression in <exprlist>. */
2950 r1 = sqlite3GetTempReg(pParse);
2951 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002952 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2953 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002954
2955 /* If the expression is not constant then we will need to
2956 ** disable the test that was generated above that makes sure
2957 ** this code only executes once. Because for a non-constant
2958 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002959 */
drh2c041312018-12-24 02:34:49 +00002960 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2961 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002962 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002963 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002964 }
drh1398ad32005-01-19 23:24:50 +00002965
drh85bcdce2018-12-23 21:27:29 +00002966 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002967 sqlite3ExprCode(pParse, pE2, r1);
2968 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2969 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002970 }
drh85bcdce2018-12-23 21:27:29 +00002971 sqlite3ReleaseTempReg(pParse, r1);
2972 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002973 }
drh85bcdce2018-12-23 21:27:29 +00002974 if( pKeyInfo ){
2975 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2976 }
drh2c041312018-12-24 02:34:49 +00002977 if( addrOnce ){
2978 sqlite3VdbeJumpHere(v, addrOnce);
2979 /* Subroutine return */
2980 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2981 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002982 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002983 }
2984}
2985#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002986
drh85bcdce2018-12-23 21:27:29 +00002987/*
2988** Generate code for scalar subqueries used as a subquery expression
2989** or EXISTS operator:
2990**
2991** (SELECT a FROM b) -- subquery
2992** EXISTS (SELECT a FROM b) -- EXISTS subquery
2993**
2994** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2995**
drhd86fe442019-08-26 13:45:49 +00002996** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002997** the result is stored in a contiguous array of registers and the
2998** return value is the register of the left-most result column.
2999** Return 0 if an error occurs.
3000*/
3001#ifndef SQLITE_OMIT_SUBQUERY
3002int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003003 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003004 int rReg = 0; /* Register storing resulting */
3005 Select *pSel; /* SELECT statement to encode */
3006 SelectDest dest; /* How to deal with SELECT result */
3007 int nReg; /* Registers to allocate */
3008 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003009
3010 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003011 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003012 testcase( pExpr->op==TK_EXISTS );
3013 testcase( pExpr->op==TK_SELECT );
3014 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3015 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3016 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003017
drh5198ff52018-12-24 12:09:47 +00003018 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003019 ** is encountered if any of the following is true:
3020 **
3021 ** * The right-hand side is a correlated subquery
3022 ** * The right-hand side is an expression list containing variables
3023 ** * We are inside a trigger
3024 **
3025 ** If all of the above are false, then we can run this code just once
3026 ** save the results, and reuse the same result on subsequent invocations.
3027 */
3028 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003029 /* If this routine has already been coded, then invoke it as a
3030 ** subroutine. */
3031 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003032 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003033 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3034 pExpr->y.sub.iAddr);
3035 return pExpr->iTable;
3036 }
3037
3038 /* Begin coding the subroutine */
3039 ExprSetProperty(pExpr, EP_Subrtn);
3040 pExpr->y.sub.regReturn = ++pParse->nMem;
3041 pExpr->y.sub.iAddr =
3042 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3043 VdbeComment((v, "return address"));
3044
drh2c041312018-12-24 02:34:49 +00003045 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003046 }
drh85bcdce2018-12-23 21:27:29 +00003047
3048 /* For a SELECT, generate code to put the values for all columns of
3049 ** the first row into an array of registers and return the index of
3050 ** the first register.
3051 **
3052 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3053 ** into a register and return that register number.
3054 **
3055 ** In both cases, the query is augmented with "LIMIT 1". Any
3056 ** preexisting limit is discarded in place of the new LIMIT 1.
3057 */
drhbd462bc2018-12-24 20:21:06 +00003058 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3059 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003060 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3061 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3062 pParse->nMem += nReg;
3063 if( pExpr->op==TK_SELECT ){
3064 dest.eDest = SRT_Mem;
3065 dest.iSdst = dest.iSDParm;
3066 dest.nSdst = nReg;
3067 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3068 VdbeComment((v, "Init subquery result"));
3069 }else{
3070 dest.eDest = SRT_Exists;
3071 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3072 VdbeComment((v, "Init EXISTS result"));
3073 }
drh85bcdce2018-12-23 21:27:29 +00003074 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003075 /* The subquery already has a limit. If the pre-existing limit is X
3076 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3077 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003078 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003079 if( pLimit ){
3080 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3081 pLimit = sqlite3PExpr(pParse, TK_NE,
3082 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3083 }
3084 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003085 pSel->pLimit->pLeft = pLimit;
3086 }else{
drh7ca13472019-09-23 11:55:22 +00003087 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003088 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003089 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3090 }
3091 pSel->iLimit = 0;
3092 if( sqlite3Select(pParse, pSel, &dest) ){
3093 return 0;
3094 }
drh2c041312018-12-24 02:34:49 +00003095 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003096 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003097 if( addrOnce ){
3098 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003099
drh5198ff52018-12-24 12:09:47 +00003100 /* Subroutine return */
3101 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3102 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003103 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003104 }
drh2c041312018-12-24 02:34:49 +00003105
drh1450bc62009-10-30 13:25:56 +00003106 return rReg;
drhcce7d172000-05-31 15:34:51 +00003107}
drh51522cd2005-01-20 13:36:19 +00003108#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003109
drhe3365e62009-11-12 17:52:24 +00003110#ifndef SQLITE_OMIT_SUBQUERY
3111/*
dan7b35a772016-07-28 19:47:15 +00003112** Expr pIn is an IN(...) expression. This function checks that the
3113** sub-select on the RHS of the IN() operator has the same number of
3114** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3115** a sub-query, that the LHS is a vector of size 1.
3116*/
3117int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3118 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3119 if( (pIn->flags & EP_xIsSelect) ){
3120 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3121 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3122 return 1;
3123 }
3124 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003125 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003126 return 1;
3127 }
3128 return 0;
3129}
3130#endif
3131
3132#ifndef SQLITE_OMIT_SUBQUERY
3133/*
drhe3365e62009-11-12 17:52:24 +00003134** Generate code for an IN expression.
3135**
3136** x IN (SELECT ...)
3137** x IN (value, value, ...)
3138**
drhecb87ac2016-08-25 15:46:25 +00003139** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003140** right-hand side (RHS) is an array of zero or more scalar values, or a
3141** subquery. If the RHS is a subquery, the number of result columns must
3142** match the number of columns in the vector on the LHS. If the RHS is
3143** a list of values, the LHS must be a scalar.
3144**
3145** The IN operator is true if the LHS value is contained within the RHS.
3146** The result is false if the LHS is definitely not in the RHS. The
3147** result is NULL if the presence of the LHS in the RHS cannot be
3148** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003149**
drh6be515e2014-08-01 21:00:53 +00003150** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003151** contained within the RHS. If due to NULLs we cannot determine if the LHS
3152** is contained in the RHS then jump to destIfNull. If the LHS is contained
3153** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003154**
3155** See the separate in-operator.md documentation file in the canonical
3156** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003157*/
3158static void sqlite3ExprCodeIN(
3159 Parse *pParse, /* Parsing and code generating context */
3160 Expr *pExpr, /* The IN expression */
3161 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3162 int destIfNull /* Jump here if the results are unknown due to NULLs */
3163){
3164 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003165 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003166 int rLhs; /* Register(s) holding the LHS values */
3167 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003168 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003169 int *aiMap = 0; /* Map from vector field to index column */
3170 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003171 int nVector; /* Size of vectors for this IN operator */
3172 int iDummy; /* Dummy parameter to exprCodeVector() */
3173 Expr *pLeft; /* The LHS of the IN operator */
3174 int i; /* loop counter */
3175 int destStep2; /* Where to jump when NULLs seen in step 2 */
3176 int destStep6 = 0; /* Start of code for Step 6 */
3177 int addrTruthOp; /* Address of opcode that determines the IN is true */
3178 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3179 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003180 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003181
drhe347d3e2016-08-25 21:14:34 +00003182 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003183 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003184 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003185 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3186 aiMap = (int*)sqlite3DbMallocZero(
3187 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3188 );
drhe347d3e2016-08-25 21:14:34 +00003189 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003190
danba00e302016-07-23 20:24:06 +00003191 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003192 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003193 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3194 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003195 v = pParse->pVdbe;
3196 assert( v!=0 ); /* OOM detected prior to this routine */
3197 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003198 eType = sqlite3FindInIndex(pParse, pExpr,
3199 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003200 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3201 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003202
danba00e302016-07-23 20:24:06 +00003203 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3204 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3205 );
drhecb87ac2016-08-25 15:46:25 +00003206#ifdef SQLITE_DEBUG
3207 /* Confirm that aiMap[] contains nVector integer values between 0 and
3208 ** nVector-1. */
3209 for(i=0; i<nVector; i++){
3210 int j, cnt;
3211 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3212 assert( cnt==1 );
3213 }
3214#endif
drhe3365e62009-11-12 17:52:24 +00003215
danba00e302016-07-23 20:24:06 +00003216 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3217 ** vector, then it is stored in an array of nVector registers starting
3218 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003219 **
3220 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3221 ** so that the fields are in the same order as an existing index. The
3222 ** aiMap[] array contains a mapping from the original LHS field order to
3223 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003224 */
drhe347d3e2016-08-25 21:14:34 +00003225 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3226 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003227 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003228 /* LHS fields are not reordered */
3229 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003230 }else{
3231 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003232 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003233 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003234 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003235 }
danba00e302016-07-23 20:24:06 +00003236 }
drhe3365e62009-11-12 17:52:24 +00003237
drhbb53ecb2014-08-02 21:03:33 +00003238 /* If sqlite3FindInIndex() did not find or create an index that is
3239 ** suitable for evaluating the IN operator, then evaluate using a
3240 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003241 **
3242 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003243 */
drhbb53ecb2014-08-02 21:03:33 +00003244 if( eType==IN_INDEX_NOOP ){
3245 ExprList *pList = pExpr->x.pList;
3246 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003247 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003248 int r2, regToFree;
3249 int regCkNull = 0;
3250 int ii;
drhdd668c22019-09-02 02:21:58 +00003251 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003252 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003253 if( destIfNull!=destIfFalse ){
3254 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003255 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003256 }
drhdd668c22019-09-02 02:21:58 +00003257 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003258 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003259 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003260 r2 = regToFree = sqlite3GetTempReg(pParse);
3261 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003262 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003263 }else{
3264 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003265 }
drha9769792014-08-04 16:39:39 +00003266 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003267 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3268 }
drhf6ea97e2020-01-04 15:21:47 +00003269 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003270 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003271 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3272 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003273 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003274 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3275 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3276 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3277 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003278 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003279 }else{
drh47994882019-12-22 23:48:36 +00003280 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003281 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003282 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3283 (void*)pColl, P4_COLLSEQ);
3284 VdbeCoverageIf(v, op==OP_Ne);
3285 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003286 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003287 }
drhbb53ecb2014-08-02 21:03:33 +00003288 }
3289 if( regCkNull ){
3290 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003291 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003292 }
3293 sqlite3VdbeResolveLabel(v, labelOk);
3294 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003295 goto sqlite3ExprCodeIN_finished;
3296 }
3297
3298 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3299 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3300 ** We will then skip the binary search of the RHS.
3301 */
3302 if( destIfNull==destIfFalse ){
3303 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003304 }else{
drhec4ccdb2018-12-29 02:26:59 +00003305 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003306 }
drh4eac5f02019-12-24 15:01:17 +00003307 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003308 for(i=0; i<nVector; i++){
3309 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3310 if( sqlite3ExprCanBeNull(p) ){
3311 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003312 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003313 }
drhe3365e62009-11-12 17:52:24 +00003314 }
drhe347d3e2016-08-25 21:14:34 +00003315
3316 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3317 ** of the RHS using the LHS as a probe. If found, the result is
3318 ** true.
3319 */
3320 if( eType==IN_INDEX_ROWID ){
3321 /* In this case, the RHS is the ROWID of table b-tree and so we also
3322 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3323 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003324 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003325 VdbeCoverage(v);
3326 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3327 }else{
3328 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3329 if( destIfFalse==destIfNull ){
3330 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003331 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003332 rLhs, nVector); VdbeCoverage(v);
3333 goto sqlite3ExprCodeIN_finished;
3334 }
3335 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003336 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003337 rLhs, nVector); VdbeCoverage(v);
3338 }
3339
3340 /* Step 4. If the RHS is known to be non-NULL and we did not find
3341 ** an match on the search above, then the result must be FALSE.
3342 */
3343 if( rRhsHasNull && nVector==1 ){
3344 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3345 VdbeCoverage(v);
3346 }
3347
3348 /* Step 5. If we do not care about the difference between NULL and
3349 ** FALSE, then just return false.
3350 */
3351 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3352
3353 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3354 ** If any comparison is NULL, then the result is NULL. If all
3355 ** comparisons are FALSE then the final result is FALSE.
3356 **
3357 ** For a scalar LHS, it is sufficient to check just the first row
3358 ** of the RHS.
3359 */
3360 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003361 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003362 VdbeCoverage(v);
3363 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003364 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003365 }else{
3366 /* For nVector==1, combine steps 6 and 7 by immediately returning
3367 ** FALSE if the first comparison is not NULL */
3368 destNotNull = destIfFalse;
3369 }
3370 for(i=0; i<nVector; i++){
3371 Expr *p;
3372 CollSeq *pColl;
3373 int r3 = sqlite3GetTempReg(pParse);
3374 p = sqlite3VectorFieldSubexpr(pLeft, i);
3375 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003376 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003377 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3378 (void*)pColl, P4_COLLSEQ);
3379 VdbeCoverage(v);
3380 sqlite3ReleaseTempReg(pParse, r3);
3381 }
3382 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3383 if( nVector>1 ){
3384 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003385 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003386 VdbeCoverage(v);
3387
3388 /* Step 7: If we reach this point, we know that the result must
3389 ** be false. */
3390 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3391 }
3392
3393 /* Jumps here in order to return true. */
3394 sqlite3VdbeJumpHere(v, addrTruthOp);
3395
3396sqlite3ExprCodeIN_finished:
3397 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003398 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003399sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003400 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003401 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003402}
3403#endif /* SQLITE_OMIT_SUBQUERY */
3404
drh13573c72010-01-12 17:04:07 +00003405#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003406/*
3407** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003408** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003409**
3410** The z[] string will probably not be zero-terminated. But the
3411** z[n] character is guaranteed to be something that does not look
3412** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003413*/
drhb7916a72009-05-27 10:31:29 +00003414static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003415 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003416 double value;
drh9339da12010-09-30 00:50:49 +00003417 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003418 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3419 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003420 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003421 }
3422}
drh13573c72010-01-12 17:04:07 +00003423#endif
drh598f1342007-10-23 15:39:45 +00003424
3425
3426/*
drhfec19aa2004-05-19 20:41:03 +00003427** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003428** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003429**
shaneh5f1d6b62010-09-30 16:51:25 +00003430** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003431*/
drh13573c72010-01-12 17:04:07 +00003432static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3433 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003434 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003435 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003436 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003437 if( negFlag ) i = -i;
3438 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003439 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003440 int c;
3441 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003442 const char *z = pExpr->u.zToken;
3443 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003444 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003445 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003446#ifdef SQLITE_OMIT_FLOATING_POINT
3447 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3448#else
drh1b7ddc52014-07-23 14:52:05 +00003449#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003450 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003451 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003452 }else
3453#endif
3454 {
drh9296c182014-07-23 13:40:49 +00003455 codeReal(v, z, negFlag, iMem);
3456 }
drh13573c72010-01-12 17:04:07 +00003457#endif
drh77320ea2016-11-30 14:47:37 +00003458 }else{
drh84d4f1a2017-09-20 10:47:10 +00003459 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003460 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003461 }
drhfec19aa2004-05-19 20:41:03 +00003462 }
3463}
3464
drh5cd79232009-05-25 11:46:29 +00003465
drh1f9ca2c2015-08-25 16:57:52 +00003466/* Generate code that will load into register regOut a value that is
3467** appropriate for the iIdxCol-th column of index pIdx.
3468*/
3469void sqlite3ExprCodeLoadIndexColumn(
3470 Parse *pParse, /* The parsing context */
3471 Index *pIdx, /* The index whose column is to be loaded */
3472 int iTabCur, /* Cursor pointing to a table row */
3473 int iIdxCol, /* The column of the index to be loaded */
3474 int regOut /* Store the index column value in this register */
3475){
3476 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003477 if( iTabCol==XN_EXPR ){
3478 assert( pIdx->aColExpr );
3479 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003480 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003481 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003482 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003483 }else{
drh6df9c4b2019-10-18 12:52:08 +00003484 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003485 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003486 }
drh1f9ca2c2015-08-25 16:57:52 +00003487}
3488
drhe70fa7f2019-10-22 21:01:34 +00003489#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3490/*
3491** Generate code that will compute the value of generated column pCol
3492** and store the result in register regOut
3493*/
3494void sqlite3ExprCodeGeneratedColumn(
3495 Parse *pParse,
3496 Column *pCol,
3497 int regOut
3498){
drh4dad7ed2019-12-16 16:52:22 +00003499 int iAddr;
3500 Vdbe *v = pParse->pVdbe;
3501 assert( v!=0 );
3502 assert( pParse->iSelfTab!=0 );
3503 if( pParse->iSelfTab>0 ){
3504 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3505 }else{
3506 iAddr = 0;
3507 }
drhe70fa7f2019-10-22 21:01:34 +00003508 sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3509 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003510 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003511 }
drh4dad7ed2019-12-16 16:52:22 +00003512 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003513}
3514#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3515
drh5cd79232009-05-25 11:46:29 +00003516/*
drh5c092e82010-05-14 19:24:02 +00003517** Generate code to extract the value of the iCol-th column of a table.
3518*/
3519void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003520 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003521 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003522 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003523 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003524 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003525){
drhab45fc02019-10-16 22:01:56 +00003526 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003527 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003528 if( pTab==0 ){
3529 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3530 return;
3531 }
drh5c092e82010-05-14 19:24:02 +00003532 if( iCol<0 || iCol==pTab->iPKey ){
3533 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3534 }else{
drh81f7b372019-10-16 12:18:59 +00003535 int op;
3536 int x;
3537 if( IsVirtual(pTab) ){
3538 op = OP_VColumn;
3539 x = iCol;
3540#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003541 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003542 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003543 if( pCol->colFlags & COLFLAG_BUSY ){
3544 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3545 }else{
3546 int savedSelfTab = pParse->iSelfTab;
3547 pCol->colFlags |= COLFLAG_BUSY;
3548 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003549 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003550 pParse->iSelfTab = savedSelfTab;
3551 pCol->colFlags &= ~COLFLAG_BUSY;
3552 }
drh81f7b372019-10-16 12:18:59 +00003553 return;
3554#endif
3555 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003556 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003557 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003558 op = OP_Column;
3559 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003560 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003561 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003562 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003563 }
3564 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003565 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3566 }
3567}
3568
3569/*
drh945498f2007-02-24 11:52:52 +00003570** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003571** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003572**
3573** There must be an open cursor to pTab in iTable when this routine
3574** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003575*/
drhe55cbd72008-03-31 23:48:03 +00003576int sqlite3ExprCodeGetColumn(
3577 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003578 Table *pTab, /* Description of the table we are reading from */
3579 int iColumn, /* Index of the table column */
3580 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003581 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003582 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003583){
drh81f7b372019-10-16 12:18:59 +00003584 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003585 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003586 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003587 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3588 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003589 }
drhe55cbd72008-03-31 23:48:03 +00003590 return iReg;
3591}
drhe55cbd72008-03-31 23:48:03 +00003592
3593/*
drhb21e7c72008-06-22 12:37:57 +00003594** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003595** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003596*/
drhb21e7c72008-06-22 12:37:57 +00003597void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003598 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003599}
3600
drh652fbf52008-04-01 01:42:41 +00003601/*
drh12abf402016-08-22 14:30:05 +00003602** Convert a scalar expression node to a TK_REGISTER referencing
3603** register iReg. The caller must ensure that iReg already contains
3604** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003605*/
dan069d1b12019-06-16 08:58:14 +00003606static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003607 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003608 p->op2 = p->op;
3609 p->op = TK_REGISTER;
3610 p->iTable = iReg;
3611 ExprClearProperty(p, EP_Skip);
3612}
3613
drh12abf402016-08-22 14:30:05 +00003614/*
3615** Evaluate an expression (either a vector or a scalar expression) and store
3616** the result in continguous temporary registers. Return the index of
3617** the first register used to store the result.
3618**
3619** If the returned result register is a temporary scalar, then also write
3620** that register number into *piFreeable. If the returned result register
3621** is not a temporary or if the expression is a vector set *piFreeable
3622** to 0.
3623*/
3624static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3625 int iResult;
3626 int nResult = sqlite3ExprVectorSize(p);
3627 if( nResult==1 ){
3628 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3629 }else{
3630 *piFreeable = 0;
3631 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003632#if SQLITE_OMIT_SUBQUERY
3633 iResult = 0;
3634#else
drh85bcdce2018-12-23 21:27:29 +00003635 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003636#endif
drh12abf402016-08-22 14:30:05 +00003637 }else{
3638 int i;
3639 iResult = pParse->nMem+1;
3640 pParse->nMem += nResult;
3641 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003642 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003643 }
3644 }
3645 }
3646 return iResult;
3647}
3648
drh25c42962020-01-01 13:55:08 +00003649/*
drh92a27f72020-02-04 01:41:44 +00003650** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3651** so that a subsequent copy will not be merged into this one.
3652*/
3653static void setDoNotMergeFlagOnCopy(Vdbe *v){
3654 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3655 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3656 }
3657}
3658
3659/*
drh25c42962020-01-01 13:55:08 +00003660** Generate code to implement special SQL functions that are implemented
3661** in-line rather than by using the usual callbacks.
3662*/
3663static int exprCodeInlineFunction(
3664 Parse *pParse, /* Parsing context */
3665 ExprList *pFarg, /* List of function arguments */
3666 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3667 int target /* Store function result in this register */
3668){
3669 int nFarg;
3670 Vdbe *v = pParse->pVdbe;
3671 assert( v!=0 );
3672 assert( pFarg!=0 );
3673 nFarg = pFarg->nExpr;
3674 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3675 switch( iFuncId ){
3676 case INLINEFUNC_coalesce: {
3677 /* Attempt a direct implementation of the built-in COALESCE() and
3678 ** IFNULL() functions. This avoids unnecessary evaluation of
3679 ** arguments past the first non-NULL argument.
3680 */
3681 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3682 int i;
3683 assert( nFarg>=2 );
3684 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3685 for(i=1; i<nFarg; i++){
3686 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3687 VdbeCoverage(v);
3688 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3689 }
drh92a27f72020-02-04 01:41:44 +00003690 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003691 sqlite3VdbeResolveLabel(v, endCoalesce);
3692 break;
3693 }
3694
drh171c50e2020-01-01 15:43:30 +00003695 default: {
drh25c42962020-01-01 13:55:08 +00003696 /* The UNLIKELY() function is a no-op. The result is the value
3697 ** of the first argument.
3698 */
drh171c50e2020-01-01 15:43:30 +00003699 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003700 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3701 break;
3702 }
3703
drh171c50e2020-01-01 15:43:30 +00003704 /***********************************************************************
3705 ** Test-only SQL functions that are only usable if enabled
3706 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3707 */
3708 case INLINEFUNC_expr_compare: {
3709 /* Compare two expressions using sqlite3ExprCompare() */
3710 assert( nFarg==2 );
3711 sqlite3VdbeAddOp2(v, OP_Integer,
3712 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3713 target);
3714 break;
3715 }
3716
3717 case INLINEFUNC_expr_implies_expr: {
3718 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3719 assert( nFarg==2 );
3720 sqlite3VdbeAddOp2(v, OP_Integer,
3721 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3722 target);
3723 break;
3724 }
3725
3726 case INLINEFUNC_implies_nonnull_row: {
3727 /* REsult of sqlite3ExprImpliesNonNullRow() */
3728 Expr *pA1;
3729 assert( nFarg==2 );
3730 pA1 = pFarg->a[1].pExpr;
3731 if( pA1->op==TK_COLUMN ){
3732 sqlite3VdbeAddOp2(v, OP_Integer,
3733 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3734 target);
3735 }else{
3736 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3737 }
3738 break;
3739 }
3740
drh25c42962020-01-01 13:55:08 +00003741#ifdef SQLITE_DEBUG
3742 case INLINEFUNC_affinity: {
3743 /* The AFFINITY() function evaluates to a string that describes
3744 ** the type affinity of the argument. This is used for testing of
3745 ** the SQLite type logic.
3746 */
3747 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3748 char aff;
3749 assert( nFarg==1 );
3750 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3751 sqlite3VdbeLoadString(v, target,
3752 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3753 break;
3754 }
3755#endif
3756 }
3757 return target;
3758}
3759
dan71c57db2016-07-09 20:23:55 +00003760
drha4c3c872013-09-12 17:29:25 +00003761/*
drhcce7d172000-05-31 15:34:51 +00003762** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003763** expression. Attempt to store the results in register "target".
3764** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003765**
drh8b213892008-08-29 02:14:02 +00003766** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003767** be stored in target. The result might be stored in some other
3768** register if it is convenient to do so. The calling function
3769** must check the return code and move the results to the desired
3770** register.
drhcce7d172000-05-31 15:34:51 +00003771*/
drh678ccce2008-03-31 18:19:54 +00003772int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003773 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3774 int op; /* The opcode being coded */
3775 int inReg = target; /* Results stored in register inReg */
3776 int regFree1 = 0; /* If non-zero free this temporary register */
3777 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003778 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003779 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003780 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003781
drh9cbf3422008-01-17 16:22:13 +00003782 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003783 if( v==0 ){
3784 assert( pParse->db->mallocFailed );
3785 return 0;
3786 }
drh389a1ad2008-01-03 23:44:53 +00003787
drh1efa8022018-04-28 04:16:43 +00003788expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003789 if( pExpr==0 ){
3790 op = TK_NULL;
3791 }else{
3792 op = pExpr->op;
3793 }
drhf2bc0132004-10-04 13:19:23 +00003794 switch( op ){
drh13449892005-09-07 21:22:45 +00003795 case TK_AGG_COLUMN: {
3796 AggInfo *pAggInfo = pExpr->pAggInfo;
3797 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3798 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003799 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003800 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003801 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003802 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003803 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003804 return target;
drh13449892005-09-07 21:22:45 +00003805 }
3806 /* Otherwise, fall thru into the TK_COLUMN case */
3807 }
drh967e8b72000-06-21 13:59:10 +00003808 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003809 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003810 int iReg;
drhefad2e22018-07-27 16:57:11 +00003811 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003812 /* This COLUMN expression is really a constant due to WHERE clause
3813 ** constraints, and that constant is coded by the pExpr->pLeft
3814 ** expresssion. However, make sure the constant has the correct
3815 ** datatype by applying the Affinity of the table column to the
3816 ** constant.
3817 */
drh57f7ece2019-11-21 18:28:44 +00003818 int aff;
drh67b9ba12019-12-20 20:45:02 +00003819 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003820 if( pExpr->y.pTab ){
3821 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3822 }else{
3823 aff = pExpr->affExpr;
3824 }
drh96fb16e2019-08-06 14:37:24 +00003825 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003826 static const char zAff[] = "B\000C\000D\000E";
3827 assert( SQLITE_AFF_BLOB=='A' );
3828 assert( SQLITE_AFF_TEXT=='B' );
3829 if( iReg!=target ){
3830 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3831 iReg = target;
3832 }
3833 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3834 &zAff[(aff-'B')*2], P4_STATIC);
3835 }
3836 return iReg;
drhefad2e22018-07-27 16:57:11 +00003837 }
drhb2b9d3d2013-08-01 01:14:43 +00003838 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003839 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003840 /* Other columns in the same row for CHECK constraints or
3841 ** generated columns or for inserting into partial index.
3842 ** The row is unpacked into registers beginning at
3843 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3844 ** immediately prior to the first column.
3845 */
3846 Column *pCol;
3847 Table *pTab = pExpr->y.pTab;
3848 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003849 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003850 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003851 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003852 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003853 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003854 return -1-pParse->iSelfTab;
3855 }
drhc5f808d2019-10-19 15:01:52 +00003856 pCol = pTab->aCol + iCol;
3857 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3858 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003859#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3860 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003861 if( pCol->colFlags & COLFLAG_BUSY ){
3862 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3863 pCol->zName);
3864 return 0;
3865 }
3866 pCol->colFlags |= COLFLAG_BUSY;
3867 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3868 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3869 }
3870 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003871 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003872 }else
3873#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3874 if( pCol->affinity==SQLITE_AFF_REAL ){
3875 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003876 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3877 return target;
3878 }else{
drh9942ef02019-10-18 02:19:18 +00003879 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003880 }
drhb2b9d3d2013-08-01 01:14:43 +00003881 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003882 /* Coding an expression that is part of an index where column names
3883 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003884 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003885 }
drh22827922000-06-06 17:27:05 +00003886 }
drh67b9ba12019-12-20 20:45:02 +00003887 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003888 pExpr->iColumn, iTab, target,
3889 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003890 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3891 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3892 }
3893 return iReg;
drhcce7d172000-05-31 15:34:51 +00003894 }
3895 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003896 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003897 return target;
drhfec19aa2004-05-19 20:41:03 +00003898 }
drh8abed7b2018-02-26 18:49:05 +00003899 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003900 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003901 return target;
3902 }
drh13573c72010-01-12 17:04:07 +00003903#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003904 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003905 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3906 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003907 return target;
drh598f1342007-10-23 15:39:45 +00003908 }
drh13573c72010-01-12 17:04:07 +00003909#endif
drhfec19aa2004-05-19 20:41:03 +00003910 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003911 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003912 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003913 return target;
drhcce7d172000-05-31 15:34:51 +00003914 }
drhaac30f92019-12-14 15:01:55 +00003915 default: {
drhc29af652019-12-18 21:22:40 +00003916 /* Make NULL the default case so that if a bug causes an illegal
3917 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003918 ** sanely and not crash. But keep the assert() to bring the problem
3919 ** to the attention of the developers. */
3920 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003921 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003922 return target;
drhf0863fe2005-06-12 21:35:51 +00003923 }
danielk19775338a5f2005-01-20 13:03:10 +00003924#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003925 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003926 int n;
3927 const char *z;
drhca48c902008-01-18 14:08:24 +00003928 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003929 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3930 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3931 assert( pExpr->u.zToken[1]=='\'' );
3932 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003933 n = sqlite3Strlen30(z) - 1;
3934 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003935 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3936 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003937 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003938 }
danielk19775338a5f2005-01-20 13:03:10 +00003939#endif
drh50457892003-09-06 01:10:47 +00003940 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003941 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3942 assert( pExpr->u.zToken!=0 );
3943 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003944 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3945 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003946 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003947 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003948 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003949 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003950 }
drhc332cc32016-09-19 10:24:19 +00003951 return target;
drh50457892003-09-06 01:10:47 +00003952 }
drh4e0cff62004-11-05 05:10:28 +00003953 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003954 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003955 }
drh487e2622005-06-25 18:42:14 +00003956#ifndef SQLITE_OMIT_CAST
3957 case TK_CAST: {
3958 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003959 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003960 if( inReg!=target ){
3961 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3962 inReg = target;
3963 }
drh4169e432014-08-25 20:11:52 +00003964 sqlite3VdbeAddOp2(v, OP_Cast, target,
3965 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003966 return inReg;
drh487e2622005-06-25 18:42:14 +00003967 }
3968#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003969 case TK_IS:
3970 case TK_ISNOT:
3971 op = (op==TK_IS) ? TK_EQ : TK_NE;
3972 p5 = SQLITE_NULLEQ;
3973 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003974 case TK_LT:
3975 case TK_LE:
3976 case TK_GT:
3977 case TK_GE:
3978 case TK_NE:
3979 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003980 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003981 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003982 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003983 }else{
3984 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3985 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3986 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00003987 r1, r2, inReg, SQLITE_STOREP2 | p5,
3988 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00003989 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3990 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3991 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3992 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3993 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3994 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3995 testcase( regFree1==0 );
3996 testcase( regFree2==0 );
3997 }
drh6a2fe092009-09-23 02:29:36 +00003998 break;
3999 }
drhcce7d172000-05-31 15:34:51 +00004000 case TK_AND:
4001 case TK_OR:
4002 case TK_PLUS:
4003 case TK_STAR:
4004 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004005 case TK_REM:
4006 case TK_BITAND:
4007 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004008 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004009 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004010 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004011 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004012 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4013 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4014 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4015 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4016 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4017 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4018 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4019 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4020 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4021 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4022 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004023 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4024 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004025 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004026 testcase( regFree1==0 );
4027 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004028 break;
4029 }
drhcce7d172000-05-31 15:34:51 +00004030 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004031 Expr *pLeft = pExpr->pLeft;
4032 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004033 if( pLeft->op==TK_INTEGER ){
4034 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004035 return target;
drh13573c72010-01-12 17:04:07 +00004036#ifndef SQLITE_OMIT_FLOATING_POINT
4037 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004038 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4039 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004040 return target;
drh13573c72010-01-12 17:04:07 +00004041#endif
drh3c84ddf2008-01-09 02:15:38 +00004042 }else{
drh10d1edf2013-11-15 15:52:39 +00004043 tempX.op = TK_INTEGER;
4044 tempX.flags = EP_IntValue|EP_TokenOnly;
4045 tempX.u.iValue = 0;
4046 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004047 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004048 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004049 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004050 }
drh3c84ddf2008-01-09 02:15:38 +00004051 break;
drh6e142f52000-06-08 13:36:40 +00004052 }
drhbf4133c2001-10-13 02:59:08 +00004053 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004054 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004055 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4056 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004057 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4058 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004059 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004060 break;
4061 }
drh8abed7b2018-02-26 18:49:05 +00004062 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004063 int isTrue; /* IS TRUE or IS NOT TRUE */
4064 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004065 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4066 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004067 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4068 bNormal = pExpr->op2==TK_IS;
4069 testcase( isTrue && bNormal);
4070 testcase( !isTrue && bNormal);
4071 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004072 break;
4073 }
drhcce7d172000-05-31 15:34:51 +00004074 case TK_ISNULL:
4075 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004076 int addr;
drh7d176102014-02-18 03:07:12 +00004077 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4078 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004079 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004080 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004081 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004082 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004083 VdbeCoverageIf(v, op==TK_ISNULL);
4084 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004085 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004086 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004087 break;
drhcce7d172000-05-31 15:34:51 +00004088 }
drh22827922000-06-06 17:27:05 +00004089 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004090 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00004091 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00004092 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4093 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004094 }else{
drhc332cc32016-09-19 10:24:19 +00004095 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004096 }
drh22827922000-06-06 17:27:05 +00004097 break;
4098 }
drhcce7d172000-05-31 15:34:51 +00004099 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004100 ExprList *pFarg; /* List of function arguments */
4101 int nFarg; /* Number of function arguments */
4102 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004103 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004104 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004105 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004106 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004107 u8 enc = ENC(db); /* The text encoding used by this database */
4108 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004109
dan67a9b8e2018-06-22 20:51:35 +00004110#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004111 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4112 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004113 }
dan67a9b8e2018-06-22 20:51:35 +00004114#endif
dan86fb6e12018-05-16 20:58:07 +00004115
drh1e9b53f2017-01-04 01:07:24 +00004116 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00004117 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00004118 ** out of the inner loop, even if that means an extra OP_Copy. */
4119 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004120 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004121 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00004122 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00004123 pFarg = 0;
4124 }else{
4125 pFarg = pExpr->x.pList;
4126 }
4127 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004128 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4129 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004130 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004131#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4132 if( pDef==0 && pParse->explain ){
4133 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4134 }
4135#endif
danb6e9f7a2018-05-19 14:15:29 +00004136 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004137 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004138 break;
4139 }
drh25c42962020-01-01 13:55:08 +00004140 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004141 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4142 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004143 return exprCodeInlineFunction(pParse, pFarg,
4144 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004145 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4146 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004147 }
4148
drhd1a01ed2013-11-21 16:08:52 +00004149 for(i=0; i<nFarg; i++){
4150 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004151 testcase( i==31 );
4152 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004153 }
4154 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4155 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4156 }
4157 }
drh12ffee82009-04-08 13:51:51 +00004158 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004159 if( constMask ){
4160 r1 = pParse->nMem+1;
4161 pParse->nMem += nFarg;
4162 }else{
4163 r1 = sqlite3GetTempRange(pParse, nFarg);
4164 }
drha748fdc2012-03-28 01:34:47 +00004165
4166 /* For length() and typeof() functions with a column argument,
4167 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4168 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4169 ** loading.
4170 */
drhd36e1042013-09-06 13:10:12 +00004171 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004172 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004173 assert( nFarg==1 );
4174 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004175 exprOp = pFarg->a[0].pExpr->op;
4176 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004177 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4178 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004179 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4180 pFarg->a[0].pExpr->op2 =
4181 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004182 }
4183 }
4184
drh5579d592015-08-26 14:01:41 +00004185 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004186 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004187 }else{
drh12ffee82009-04-08 13:51:51 +00004188 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004189 }
drhb7f6f682006-07-08 17:06:43 +00004190#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004191 /* Possibly overload the function if the first argument is
4192 ** a virtual table column.
4193 **
4194 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4195 ** second argument, not the first, as the argument to test to
4196 ** see if it is a column in a virtual table. This is done because
4197 ** the left operand of infix functions (the operand we want to
4198 ** control overloading) ends up as the second argument to the
4199 ** function. The expression "A glob B" is equivalent to
4200 ** "glob(B,A). We want to use the A in "A glob B" to test
4201 ** for function overloading. But we use the B term in "glob(B,A)".
4202 */
drh59155062018-05-26 18:03:48 +00004203 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004204 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4205 }else if( nFarg>0 ){
4206 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004207 }
4208#endif
drhd36e1042013-09-06 13:10:12 +00004209 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004210 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004211 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004212 }
drh092457b2017-12-29 15:04:49 +00004213#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4214 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004215 Expr *pArg = pFarg->a[0].pExpr;
4216 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004217 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004218 }else{
4219 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4220 }
drh092457b2017-12-29 15:04:49 +00004221 }else
4222#endif
4223 {
drh920cf592019-10-30 16:29:02 +00004224 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004225 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004226 }
drh13d79502019-12-23 02:18:49 +00004227 if( nFarg ){
4228 if( constMask==0 ){
4229 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4230 }else{
drh3aef2fb2020-01-02 17:46:02 +00004231 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004232 }
drh2dcef112008-01-12 19:03:48 +00004233 }
drhc332cc32016-09-19 10:24:19 +00004234 return target;
drhcce7d172000-05-31 15:34:51 +00004235 }
drhfe2093d2005-01-20 22:48:47 +00004236#ifndef SQLITE_OMIT_SUBQUERY
4237 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004238 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004239 int nCol;
drhc5499be2008-04-01 15:06:33 +00004240 testcase( op==TK_EXISTS );
4241 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004242 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4243 sqlite3SubselectError(pParse, nCol, 1);
4244 }else{
drh85bcdce2018-12-23 21:27:29 +00004245 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004246 }
drh19a775c2000-06-05 18:54:46 +00004247 break;
4248 }
drhfc7f27b2016-08-20 00:07:01 +00004249 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004250 int n;
drhfc7f27b2016-08-20 00:07:01 +00004251 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004252 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004253 }
drh966e2912017-01-03 02:58:01 +00004254 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004255 if( pExpr->iTable!=0
4256 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004257 ){
4258 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4259 pExpr->iTable, n);
4260 }
drhc332cc32016-09-19 10:24:19 +00004261 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004262 }
drhfef52082000-06-06 01:50:43 +00004263 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004264 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4265 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004266 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4267 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4268 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4269 sqlite3VdbeResolveLabel(v, destIfFalse);
4270 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4271 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004272 return target;
drhfef52082000-06-06 01:50:43 +00004273 }
drhe3365e62009-11-12 17:52:24 +00004274#endif /* SQLITE_OMIT_SUBQUERY */
4275
4276
drh2dcef112008-01-12 19:03:48 +00004277 /*
4278 ** x BETWEEN y AND z
4279 **
4280 ** This is equivalent to
4281 **
4282 ** x>=y AND x<=z
4283 **
4284 ** X is stored in pExpr->pLeft.
4285 ** Y is stored in pExpr->pList->a[0].pExpr.
4286 ** Z is stored in pExpr->pList->a[1].pExpr.
4287 */
drhfef52082000-06-06 01:50:43 +00004288 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004289 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004290 return target;
drhfef52082000-06-06 01:50:43 +00004291 }
drh94fa9c42016-02-27 21:16:04 +00004292 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004293 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004294 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004295 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004296 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004297 }
drh2dcef112008-01-12 19:03:48 +00004298
dan165921a2009-08-28 18:53:45 +00004299 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004300 /* If the opcode is TK_TRIGGER, then the expression is a reference
4301 ** to a column in the new.* or old.* pseudo-tables available to
4302 ** trigger programs. In this case Expr.iTable is set to 1 for the
4303 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4304 ** is set to the column of the pseudo-table to read, or to -1 to
4305 ** read the rowid field.
4306 **
4307 ** The expression is implemented using an OP_Param opcode. The p1
4308 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4309 ** to reference another column of the old.* pseudo-table, where
4310 ** i is the index of the column. For a new.rowid reference, p1 is
4311 ** set to (n+1), where n is the number of columns in each pseudo-table.
4312 ** For a reference to any other column in the new.* pseudo-table, p1
4313 ** is set to (n+2+i), where n and i are as defined previously. For
4314 ** example, if the table on which triggers are being fired is
4315 ** declared as:
4316 **
4317 ** CREATE TABLE t1(a, b);
4318 **
4319 ** Then p1 is interpreted as follows:
4320 **
4321 ** p1==0 -> old.rowid p1==3 -> new.rowid
4322 ** p1==1 -> old.a p1==4 -> new.a
4323 ** p1==2 -> old.b p1==5 -> new.b
4324 */
drheda079c2018-09-20 19:02:15 +00004325 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004326 int iCol = pExpr->iColumn;
4327 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004328 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004329
4330 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004331 assert( iCol>=-1 && iCol<pTab->nCol );
4332 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004333 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4334
4335 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004336 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004337 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004338 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004339 ));
dan65a7cd12009-09-01 12:16:01 +00004340
drh44dbca82010-01-13 04:22:20 +00004341#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004342 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004343 ** integer. Use OP_RealAffinity to make sure it is really real.
4344 **
4345 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4346 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004347 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004348 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4349 }
drh44dbca82010-01-13 04:22:20 +00004350#endif
dan165921a2009-08-28 18:53:45 +00004351 break;
4352 }
4353
dan71c57db2016-07-09 20:23:55 +00004354 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004355 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004356 break;
4357 }
4358
drh9e9a67a2019-08-17 17:07:15 +00004359 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4360 ** that derive from the right-hand table of a LEFT JOIN. The
4361 ** Expr.iTable value is the table number for the right-hand table.
4362 ** The expression is only evaluated if that table is not currently
4363 ** on a LEFT JOIN NULL row.
4364 */
drh31d6fd52017-04-14 19:03:10 +00004365 case TK_IF_NULL_ROW: {
4366 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004367 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004368 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004369 /* Temporarily disable factoring of constant expressions, since
4370 ** even though expressions may appear to be constant, they are not
4371 ** really constant because they originate from the right-hand side
4372 ** of a LEFT JOIN. */
4373 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004374 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004375 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004376 sqlite3VdbeJumpHere(v, addrINR);
4377 sqlite3VdbeChangeP3(v, addrINR, inReg);
4378 break;
4379 }
4380
drh2dcef112008-01-12 19:03:48 +00004381 /*
4382 ** Form A:
4383 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4384 **
4385 ** Form B:
4386 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4387 **
4388 ** Form A is can be transformed into the equivalent form B as follows:
4389 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4390 ** WHEN x=eN THEN rN ELSE y END
4391 **
4392 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004393 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4394 ** odd. The Y is also optional. If the number of elements in x.pList
4395 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004396 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4397 **
4398 ** The result of the expression is the Ri for the first matching Ei,
4399 ** or if there is no matching Ei, the ELSE term Y, or if there is
4400 ** no ELSE term, NULL.
4401 */
drhaac30f92019-12-14 15:01:55 +00004402 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004403 int endLabel; /* GOTO label for end of CASE stmt */
4404 int nextCase; /* GOTO label for next WHEN clause */
4405 int nExpr; /* 2x number of WHEN terms */
4406 int i; /* Loop counter */
4407 ExprList *pEList; /* List of WHEN terms */
4408 struct ExprList_item *aListelem; /* Array of WHEN terms */
4409 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004410 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004411 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004412 Expr *pDel = 0;
4413 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004414
danielk19776ab3a2e2009-02-19 14:39:25 +00004415 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004416 assert(pExpr->x.pList->nExpr > 0);
4417 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004418 aListelem = pEList->a;
4419 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004420 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004421 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004422 pDel = sqlite3ExprDup(db, pX, 0);
4423 if( db->mallocFailed ){
4424 sqlite3ExprDelete(db, pDel);
4425 break;
4426 }
drh33cd4902009-05-30 20:49:20 +00004427 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004428 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004429 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004430 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004431 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004432 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004433 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004434 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4435 ** The value in regFree1 might get SCopy-ed into the file result.
4436 ** So make sure that the regFree1 register is not reused for other
4437 ** purposes and possibly overwritten. */
4438 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004439 }
drhc5cd1242013-09-12 16:50:49 +00004440 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004441 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004442 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004443 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004444 }else{
drh2dcef112008-01-12 19:03:48 +00004445 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004446 }
drhec4ccdb2018-12-29 02:26:59 +00004447 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004448 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004449 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004450 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004451 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004452 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004453 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004454 }
drhc5cd1242013-09-12 16:50:49 +00004455 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004456 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004457 }else{
drh9de221d2008-01-05 06:51:30 +00004458 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004459 }
dan8b65e592019-07-17 14:34:17 +00004460 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004461 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004462 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004463 break;
4464 }
danielk19775338a5f2005-01-20 13:03:10 +00004465#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004466 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004467 assert( pExpr->affExpr==OE_Rollback
4468 || pExpr->affExpr==OE_Abort
4469 || pExpr->affExpr==OE_Fail
4470 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004471 );
dane0af83a2009-09-08 19:15:01 +00004472 if( !pParse->pTriggerTab ){
4473 sqlite3ErrorMsg(pParse,
4474 "RAISE() may only be used within a trigger-program");
4475 return 0;
4476 }
drh11949042019-08-05 18:01:42 +00004477 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004478 sqlite3MayAbort(pParse);
4479 }
dan165921a2009-08-28 18:53:45 +00004480 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004481 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004482 sqlite3VdbeAddOp4(
4483 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004484 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004485 }else{
drh433dccf2013-02-09 15:37:11 +00004486 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004487 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004488 }
4489
drhffe07b22005-11-03 00:41:17 +00004490 break;
drh17a7f8d2002-03-24 13:13:27 +00004491 }
danielk19775338a5f2005-01-20 13:03:10 +00004492#endif
drhffe07b22005-11-03 00:41:17 +00004493 }
drh2dcef112008-01-12 19:03:48 +00004494 sqlite3ReleaseTempReg(pParse, regFree1);
4495 sqlite3ReleaseTempReg(pParse, regFree2);
4496 return inReg;
4497}
4498
4499/*
drhd1a01ed2013-11-21 16:08:52 +00004500** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004501**
drhad879ff2017-01-04 04:10:02 +00004502** If regDest>=0 then the result is always stored in that register and the
4503** result is not reusable. If regDest<0 then this routine is free to
4504** store the value whereever it wants. The register where the expression
4505** is stored is returned. When regDest<0, two identical expressions will
4506** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004507*/
drh1e9b53f2017-01-04 01:07:24 +00004508int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004509 Parse *pParse, /* Parsing context */
4510 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004511 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004512){
drhd1a01ed2013-11-21 16:08:52 +00004513 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004514 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004515 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004516 if( regDest<0 && p ){
4517 struct ExprList_item *pItem;
4518 int i;
4519 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004520 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004521 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004522 }
4523 }
drh1e9b53f2017-01-04 01:07:24 +00004524 }
drhd1a01ed2013-11-21 16:08:52 +00004525 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4526 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004527 if( p ){
4528 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004529 pItem->reusable = regDest<0;
4530 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004531 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004532 }
drhd1a01ed2013-11-21 16:08:52 +00004533 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004534 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004535}
4536
4537/*
drh2dcef112008-01-12 19:03:48 +00004538** Generate code to evaluate an expression and store the results
4539** into a register. Return the register number where the results
4540** are stored.
4541**
4542** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004543** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004544** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004545**
4546** If pExpr is a constant, then this routine might generate this
4547** code to fill the register in the initialization section of the
4548** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004549*/
4550int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004551 int r2;
drh0d950af2019-08-22 16:38:42 +00004552 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004553 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004554 && pExpr->op!=TK_REGISTER
4555 && sqlite3ExprIsConstantNotJoin(pExpr)
4556 ){
drhf30a9692013-11-15 01:10:18 +00004557 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004558 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004559 }else{
drhf30a9692013-11-15 01:10:18 +00004560 int r1 = sqlite3GetTempReg(pParse);
4561 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4562 if( r2==r1 ){
4563 *pReg = r1;
4564 }else{
4565 sqlite3ReleaseTempReg(pParse, r1);
4566 *pReg = 0;
4567 }
drh2dcef112008-01-12 19:03:48 +00004568 }
4569 return r2;
4570}
4571
4572/*
4573** Generate code that will evaluate expression pExpr and store the
4574** results in register target. The results are guaranteed to appear
4575** in register target.
4576*/
drh05a86c52014-02-16 01:55:49 +00004577void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004578 int inReg;
4579
4580 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004581 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4582 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4583 if( inReg!=target && pParse->pVdbe ){
drh629b88c2020-01-02 02:50:45 +00004584 u8 op;
4585 if( ExprHasProperty(pExpr,EP_Subquery) ){
4586 op = OP_Copy;
4587 }else{
4588 op = OP_SCopy;
4589 }
4590 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004591 }
drhcce7d172000-05-31 15:34:51 +00004592}
4593
4594/*
drh1c75c9d2015-12-21 15:22:13 +00004595** Make a transient copy of expression pExpr and then code it using
4596** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4597** except that the input expression is guaranteed to be unchanged.
4598*/
4599void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4600 sqlite3 *db = pParse->db;
4601 pExpr = sqlite3ExprDup(db, pExpr, 0);
4602 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4603 sqlite3ExprDelete(db, pExpr);
4604}
4605
4606/*
drh05a86c52014-02-16 01:55:49 +00004607** Generate code that will evaluate expression pExpr and store the
4608** results in register target. The results are guaranteed to appear
4609** in register target. If the expression is constant, then this routine
4610** might choose to code the expression at initialization time.
4611*/
4612void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004613 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004614 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004615 }else{
4616 sqlite3ExprCode(pParse, pExpr, target);
4617 }
drhcce7d172000-05-31 15:34:51 +00004618}
4619
4620/*
drh268380c2004-02-25 13:47:31 +00004621** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004622** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004623**
drh3df6c3b2017-09-15 15:38:01 +00004624** Return the number of elements evaluated. The number returned will
4625** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4626** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004627**
4628** The SQLITE_ECEL_DUP flag prevents the arguments from being
4629** filled using OP_SCopy. OP_Copy must be used instead.
4630**
4631** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4632** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004633**
4634** The SQLITE_ECEL_REF flag means that expressions in the list with
4635** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4636** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004637** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4638** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004639*/
danielk19774adee202004-05-08 08:23:19 +00004640int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004641 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004642 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004643 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004644 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004645 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004646){
4647 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004648 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004649 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004650 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004651 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004652 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004653 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004654 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004655 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004656 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004657 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004658#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4659 if( pItem->bSorterRef ){
4660 i--;
4661 n--;
4662 }else
4663#endif
dan257c13f2016-11-10 20:14:06 +00004664 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4665 if( flags & SQLITE_ECEL_OMITREF ){
4666 i--;
4667 n--;
4668 }else{
4669 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4670 }
drhb8b06692018-08-04 15:16:20 +00004671 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4672 && sqlite3ExprIsConstantNotJoin(pExpr)
4673 ){
drhad879ff2017-01-04 04:10:02 +00004674 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004675 }else{
4676 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4677 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004678 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004679 if( copyOp==OP_Copy
4680 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4681 && pOp->p1+pOp->p3+1==inReg
4682 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004683 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004684 ){
4685 pOp->p3++;
4686 }else{
4687 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4688 }
drhd1a01ed2013-11-21 16:08:52 +00004689 }
drhd1766112008-09-17 00:13:12 +00004690 }
drh268380c2004-02-25 13:47:31 +00004691 }
drhf9b596e2004-05-26 16:54:42 +00004692 return n;
drh268380c2004-02-25 13:47:31 +00004693}
4694
4695/*
drh36c563a2009-11-12 13:32:22 +00004696** Generate code for a BETWEEN operator.
4697**
4698** x BETWEEN y AND z
4699**
4700** The above is equivalent to
4701**
4702** x>=y AND x<=z
4703**
4704** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004705** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004706**
4707** The xJumpIf parameter determines details:
4708**
4709** NULL: Store the boolean result in reg[dest]
4710** sqlite3ExprIfTrue: Jump to dest if true
4711** sqlite3ExprIfFalse: Jump to dest if false
4712**
4713** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004714*/
4715static void exprCodeBetween(
4716 Parse *pParse, /* Parsing and code generating context */
4717 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004718 int dest, /* Jump destination or storage location */
4719 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004720 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4721){
dan8b65e592019-07-17 14:34:17 +00004722 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004723 Expr compLeft; /* The x>=y term */
4724 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004725 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004726 Expr *pDel = 0;
4727 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004728
dan71c57db2016-07-09 20:23:55 +00004729 memset(&compLeft, 0, sizeof(Expr));
4730 memset(&compRight, 0, sizeof(Expr));
4731 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004732
4733 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004734 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4735 if( db->mallocFailed==0 ){
4736 exprAnd.op = TK_AND;
4737 exprAnd.pLeft = &compLeft;
4738 exprAnd.pRight = &compRight;
4739 compLeft.op = TK_GE;
4740 compLeft.pLeft = pDel;
4741 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4742 compRight.op = TK_LE;
4743 compRight.pLeft = pDel;
4744 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4745 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4746 if( xJump ){
4747 xJump(pParse, &exprAnd, dest, jumpIfNull);
4748 }else{
4749 /* Mark the expression is being from the ON or USING clause of a join
4750 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4751 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4752 ** for clarity, but we are out of bits in the Expr.flags field so we
4753 ** have to reuse the EP_FromJoin bit. Bummer. */
4754 pDel->flags |= EP_FromJoin;
4755 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4756 }
4757 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004758 }
dan8b65e592019-07-17 14:34:17 +00004759 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004760
4761 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004762 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4763 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4764 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4765 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4766 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4767 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4768 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4769 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004770 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004771}
4772
4773/*
drhcce7d172000-05-31 15:34:51 +00004774** Generate code for a boolean expression such that a jump is made
4775** to the label "dest" if the expression is true but execution
4776** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004777**
4778** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004779** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004780**
4781** This code depends on the fact that certain token values (ex: TK_EQ)
4782** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4783** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4784** the make process cause these values to align. Assert()s in the code
4785** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004786*/
danielk19774adee202004-05-08 08:23:19 +00004787void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004788 Vdbe *v = pParse->pVdbe;
4789 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004790 int regFree1 = 0;
4791 int regFree2 = 0;
4792 int r1, r2;
4793
drh35573352008-01-08 23:54:25 +00004794 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004795 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004796 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004797 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004798 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004799 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004800 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004801 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4802 if( pAlt!=pExpr ){
4803 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4804 }else if( op==TK_AND ){
4805 int d2 = sqlite3VdbeMakeLabel(pParse);
4806 testcase( jumpIfNull==0 );
4807 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4808 jumpIfNull^SQLITE_JUMPIFNULL);
4809 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4810 sqlite3VdbeResolveLabel(v, d2);
4811 }else{
4812 testcase( jumpIfNull==0 );
4813 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4814 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4815 }
drhcce7d172000-05-31 15:34:51 +00004816 break;
4817 }
4818 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004819 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004820 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004821 break;
4822 }
drh8abed7b2018-02-26 18:49:05 +00004823 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004824 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4825 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004826 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004827 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004828 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004829 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004830 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004831 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004832 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4833 isNot ? SQLITE_JUMPIFNULL : 0);
4834 }else{
4835 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4836 isNot ? SQLITE_JUMPIFNULL : 0);
4837 }
drh007c8432018-02-26 03:20:18 +00004838 break;
4839 }
drhde845c22016-03-17 19:07:52 +00004840 case TK_IS:
4841 case TK_ISNOT:
4842 testcase( op==TK_IS );
4843 testcase( op==TK_ISNOT );
4844 op = (op==TK_IS) ? TK_EQ : TK_NE;
4845 jumpIfNull = SQLITE_NULLEQ;
4846 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004847 case TK_LT:
4848 case TK_LE:
4849 case TK_GT:
4850 case TK_GE:
4851 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004852 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004853 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004854 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004855 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4856 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004857 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004858 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004859 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4860 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4861 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4862 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004863 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4864 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4865 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4866 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4867 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4868 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004869 testcase( regFree1==0 );
4870 testcase( regFree2==0 );
4871 break;
4872 }
drhcce7d172000-05-31 15:34:51 +00004873 case TK_ISNULL:
4874 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004875 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4876 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004877 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4878 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004879 VdbeCoverageIf(v, op==TK_ISNULL);
4880 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004881 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004882 break;
4883 }
drhfef52082000-06-06 01:50:43 +00004884 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004885 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004886 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004887 break;
4888 }
drh84e30ca2011-02-10 17:46:14 +00004889#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004890 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004891 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004892 int destIfNull = jumpIfNull ? dest : destIfFalse;
4893 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004894 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004895 sqlite3VdbeResolveLabel(v, destIfFalse);
4896 break;
4897 }
shanehbb201342011-02-09 19:55:20 +00004898#endif
drhcce7d172000-05-31 15:34:51 +00004899 default: {
dan7b35a772016-07-28 19:47:15 +00004900 default_expr:
drhad317272019-04-19 16:21:51 +00004901 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004902 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004903 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004904 /* No-op */
4905 }else{
4906 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4907 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004908 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004909 testcase( regFree1==0 );
4910 testcase( jumpIfNull==0 );
4911 }
drhcce7d172000-05-31 15:34:51 +00004912 break;
4913 }
4914 }
drh2dcef112008-01-12 19:03:48 +00004915 sqlite3ReleaseTempReg(pParse, regFree1);
4916 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004917}
4918
4919/*
drh66b89c82000-11-28 20:47:17 +00004920** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004921** to the label "dest" if the expression is false but execution
4922** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004923**
4924** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004925** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4926** is 0.
drhcce7d172000-05-31 15:34:51 +00004927*/
danielk19774adee202004-05-08 08:23:19 +00004928void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004929 Vdbe *v = pParse->pVdbe;
4930 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004931 int regFree1 = 0;
4932 int regFree2 = 0;
4933 int r1, r2;
4934
drh35573352008-01-08 23:54:25 +00004935 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004936 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004937 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004938
4939 /* The value of pExpr->op and op are related as follows:
4940 **
4941 ** pExpr->op op
4942 ** --------- ----------
4943 ** TK_ISNULL OP_NotNull
4944 ** TK_NOTNULL OP_IsNull
4945 ** TK_NE OP_Eq
4946 ** TK_EQ OP_Ne
4947 ** TK_GT OP_Le
4948 ** TK_LE OP_Gt
4949 ** TK_GE OP_Lt
4950 ** TK_LT OP_Ge
4951 **
4952 ** For other values of pExpr->op, op is undefined and unused.
4953 ** The value of TK_ and OP_ constants are arranged such that we
4954 ** can compute the mapping above using the following expression.
4955 ** Assert()s verify that the computation is correct.
4956 */
4957 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4958
4959 /* Verify correct alignment of TK_ and OP_ constants
4960 */
4961 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4962 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4963 assert( pExpr->op!=TK_NE || op==OP_Eq );
4964 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4965 assert( pExpr->op!=TK_LT || op==OP_Ge );
4966 assert( pExpr->op!=TK_LE || op==OP_Gt );
4967 assert( pExpr->op!=TK_GT || op==OP_Le );
4968 assert( pExpr->op!=TK_GE || op==OP_Lt );
4969
danba00e302016-07-23 20:24:06 +00004970 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004971 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004972 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004973 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4974 if( pAlt!=pExpr ){
4975 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4976 }else if( pExpr->op==TK_AND ){
4977 testcase( jumpIfNull==0 );
4978 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4979 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4980 }else{
4981 int d2 = sqlite3VdbeMakeLabel(pParse);
4982 testcase( jumpIfNull==0 );
4983 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4984 jumpIfNull^SQLITE_JUMPIFNULL);
4985 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4986 sqlite3VdbeResolveLabel(v, d2);
4987 }
drhcce7d172000-05-31 15:34:51 +00004988 break;
4989 }
4990 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004991 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004992 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004993 break;
4994 }
drh8abed7b2018-02-26 18:49:05 +00004995 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004996 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4997 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004998 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004999 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005000 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005001 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005002 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005003 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005004 /* IS TRUE and IS NOT FALSE */
5005 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5006 isNot ? 0 : SQLITE_JUMPIFNULL);
5007
5008 }else{
5009 /* IS FALSE and IS NOT TRUE */
5010 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005011 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005012 }
drh007c8432018-02-26 03:20:18 +00005013 break;
5014 }
drhde845c22016-03-17 19:07:52 +00005015 case TK_IS:
5016 case TK_ISNOT:
5017 testcase( pExpr->op==TK_IS );
5018 testcase( pExpr->op==TK_ISNOT );
5019 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5020 jumpIfNull = SQLITE_NULLEQ;
5021 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00005022 case TK_LT:
5023 case TK_LE:
5024 case TK_GT:
5025 case TK_GE:
5026 case TK_NE:
5027 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005028 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005029 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005030 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5031 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005032 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005033 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005034 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5035 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5036 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5037 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005038 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5039 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5040 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5041 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5042 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5043 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005044 testcase( regFree1==0 );
5045 testcase( regFree2==0 );
5046 break;
5047 }
drhcce7d172000-05-31 15:34:51 +00005048 case TK_ISNULL:
5049 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005050 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5051 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005052 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5053 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005054 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005055 break;
5056 }
drhfef52082000-06-06 01:50:43 +00005057 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005058 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005059 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005060 break;
5061 }
drh84e30ca2011-02-10 17:46:14 +00005062#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005063 case TK_IN: {
5064 if( jumpIfNull ){
5065 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5066 }else{
drhec4ccdb2018-12-29 02:26:59 +00005067 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005068 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5069 sqlite3VdbeResolveLabel(v, destIfNull);
5070 }
5071 break;
5072 }
shanehbb201342011-02-09 19:55:20 +00005073#endif
drhcce7d172000-05-31 15:34:51 +00005074 default: {
danba00e302016-07-23 20:24:06 +00005075 default_expr:
drhad317272019-04-19 16:21:51 +00005076 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005077 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005078 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005079 /* no-op */
5080 }else{
5081 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5082 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005083 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005084 testcase( regFree1==0 );
5085 testcase( jumpIfNull==0 );
5086 }
drhcce7d172000-05-31 15:34:51 +00005087 break;
5088 }
5089 }
drh2dcef112008-01-12 19:03:48 +00005090 sqlite3ReleaseTempReg(pParse, regFree1);
5091 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005092}
drh22827922000-06-06 17:27:05 +00005093
5094/*
drh72bc8202015-06-11 13:58:35 +00005095** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5096** code generation, and that copy is deleted after code generation. This
5097** ensures that the original pExpr is unchanged.
5098*/
5099void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5100 sqlite3 *db = pParse->db;
5101 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5102 if( db->mallocFailed==0 ){
5103 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5104 }
5105 sqlite3ExprDelete(db, pCopy);
5106}
5107
dan5aa550c2017-06-24 18:10:29 +00005108/*
5109** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5110** type of expression.
5111**
5112** If pExpr is a simple SQL value - an integer, real, string, blob
5113** or NULL value - then the VDBE currently being prepared is configured
5114** to re-prepare each time a new value is bound to variable pVar.
5115**
5116** Additionally, if pExpr is a simple SQL value and the value is the
5117** same as that currently bound to variable pVar, non-zero is returned.
5118** Otherwise, if the values are not the same or if pExpr is not a simple
5119** SQL value, zero is returned.
5120*/
5121static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5122 int res = 0;
drhc0804222017-06-28 21:47:16 +00005123 int iVar;
5124 sqlite3_value *pL, *pR = 0;
5125
5126 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5127 if( pR ){
5128 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005129 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005130 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005131 if( pL ){
5132 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5133 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5134 }
5135 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005136 }
drhc0804222017-06-28 21:47:16 +00005137 sqlite3ValueFree(pR);
5138 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005139 }
5140
5141 return res;
5142}
drh72bc8202015-06-11 13:58:35 +00005143
5144/*
drh1d9da702010-01-07 15:17:02 +00005145** Do a deep comparison of two expression trees. Return 0 if the two
5146** expressions are completely identical. Return 1 if they differ only
5147** by a COLLATE operator at the top level. Return 2 if there are differences
5148** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005149**
drh619a1302013-08-01 13:04:46 +00005150** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5151** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5152**
drh66518ca2013-08-01 15:09:57 +00005153** The pA side might be using TK_REGISTER. If that is the case and pB is
5154** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5155**
drh1d9da702010-01-07 15:17:02 +00005156** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005157** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005158** identical, we return 2 just to be safe. So if this routine
5159** returns 2, then you do not really know for certain if the two
5160** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005161** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005162** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005163** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005164** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005165**
drhc0804222017-06-28 21:47:16 +00005166** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5167** pParse->pReprepare can be matched against literals in pB. The
5168** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5169** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5170** Argument pParse should normally be NULL. If it is not NULL and pA or
5171** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005172*/
dan5aa550c2017-06-24 18:10:29 +00005173int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005174 u32 combinedFlags;
5175 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005176 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005177 }
dan5aa550c2017-06-24 18:10:29 +00005178 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5179 return 0;
5180 }
drh10d1edf2013-11-15 15:52:39 +00005181 combinedFlags = pA->flags | pB->flags;
5182 if( combinedFlags & EP_IntValue ){
5183 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5184 return 0;
5185 }
drh1d9da702010-01-07 15:17:02 +00005186 return 2;
drh22827922000-06-06 17:27:05 +00005187 }
dan16dd3982018-12-20 15:04:38 +00005188 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005189 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005190 return 1;
5191 }
dan5aa550c2017-06-24 18:10:29 +00005192 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005193 return 1;
5194 }
5195 return 2;
5196 }
drh2edc5fd2015-11-24 02:10:52 +00005197 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005198 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005199 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005200#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005201 assert( pA->op==pB->op );
5202 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5203 return 2;
5204 }
drheda079c2018-09-20 19:02:15 +00005205 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005206 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5207 return 2;
5208 }
drheda079c2018-09-20 19:02:15 +00005209 }
5210#endif
drhf20bbc52019-01-17 01:06:00 +00005211 }else if( pA->op==TK_NULL ){
5212 return 0;
drhd5af5422018-04-13 14:27:01 +00005213 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005214 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005215 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005216 return 2;
drh2646da72005-12-09 20:02:05 +00005217 }
drh22827922000-06-06 17:27:05 +00005218 }
drh898c5272019-10-22 00:03:41 +00005219 if( (pA->flags & (EP_Distinct|EP_Commuted))
5220 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drh89b6de02018-12-12 20:11:23 +00005221 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00005222 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005223 if( (combinedFlags & EP_FixedCol)==0
5224 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005225 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005226 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005227 if( pA->op!=TK_STRING
5228 && pA->op!=TK_TRUEFALSE
5229 && (combinedFlags & EP_Reduced)==0
5230 ){
drh10d1edf2013-11-15 15:52:39 +00005231 if( pA->iColumn!=pB->iColumn ) return 2;
drh04307c82019-10-31 13:16:26 +00005232 if( pA->op2!=pB->op2 ){
5233 if( pA->op==TK_TRUTH ) return 2;
5234 if( pA->op==TK_FUNCTION && iTab<0 ){
5235 /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
5236 ** INSERT INTO t1(a) VALUES(julianday('now')+10);
5237 ** Without this test, sqlite3ExprCodeAtInit() will run on the
5238 ** the julianday() of INSERT first, and remember that expression.
5239 ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
5240 ** constraint as redundant, reusing the one from the INSERT, even
5241 ** though the julianday() in INSERT lacks the critical NC_IsCheck
5242 ** flag. See ticket [830277d9db6c3ba1] (2019-10-30)
5243 */
5244 return 2;
5245 }
5246 }
drh0f28e1b2019-10-28 13:07:01 +00005247 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5248 return 2;
5249 }
drh10d1edf2013-11-15 15:52:39 +00005250 }
5251 }
drh1d9da702010-01-07 15:17:02 +00005252 return 0;
drh22827922000-06-06 17:27:05 +00005253}
5254
drh8c6f6662010-04-26 19:17:26 +00005255/*
danfbb6e9f2020-01-09 20:11:29 +00005256** Compare two ExprList objects. Return 0 if they are identical, 1
5257** if they are certainly different, or 2 if it is not possible to
5258** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005259**
drh619a1302013-08-01 13:04:46 +00005260** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5261** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5262**
drh8c6f6662010-04-26 19:17:26 +00005263** This routine might return non-zero for equivalent ExprLists. The
5264** only consequence will be disabled optimizations. But this routine
5265** must never return 0 if the two ExprList objects are different, or
5266** a malfunction will result.
5267**
5268** Two NULL pointers are considered to be the same. But a NULL pointer
5269** always differs from a non-NULL pointer.
5270*/
drh619a1302013-08-01 13:04:46 +00005271int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005272 int i;
5273 if( pA==0 && pB==0 ) return 0;
5274 if( pA==0 || pB==0 ) return 1;
5275 if( pA->nExpr!=pB->nExpr ) return 1;
5276 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005277 int res;
drh8c6f6662010-04-26 19:17:26 +00005278 Expr *pExprA = pA->a[i].pExpr;
5279 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005280 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005281 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005282 }
5283 return 0;
5284}
drh13449892005-09-07 21:22:45 +00005285
drh22827922000-06-06 17:27:05 +00005286/*
drhf9463df2017-02-11 14:59:58 +00005287** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5288** are ignored.
5289*/
5290int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005291 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005292 sqlite3ExprSkipCollateAndLikely(pA),
5293 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005294 iTab);
5295}
5296
5297/*
drhc51cf862019-05-11 19:36:03 +00005298** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005299**
5300** Or if seenNot is true, return non-zero if Expr p can only be
5301** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005302*/
5303static int exprImpliesNotNull(
5304 Parse *pParse, /* Parsing context */
5305 Expr *p, /* The expression to be checked */
5306 Expr *pNN, /* The expression that is NOT NULL */
5307 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005308 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005309){
5310 assert( p );
5311 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005312 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5313 return pNN->op!=TK_NULL;
5314 }
drhc51cf862019-05-11 19:36:03 +00005315 switch( p->op ){
5316 case TK_IN: {
5317 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5318 assert( ExprHasProperty(p,EP_xIsSelect)
5319 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005320 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005321 }
5322 case TK_BETWEEN: {
5323 ExprList *pList = p->x.pList;
5324 assert( pList!=0 );
5325 assert( pList->nExpr==2 );
5326 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005327 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5328 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005329 ){
5330 return 1;
5331 }
drh7a231b42019-08-30 15:11:08 +00005332 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005333 }
5334 case TK_EQ:
5335 case TK_NE:
5336 case TK_LT:
5337 case TK_LE:
5338 case TK_GT:
5339 case TK_GE:
5340 case TK_PLUS:
5341 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005342 case TK_BITOR:
5343 case TK_LSHIFT:
5344 case TK_RSHIFT:
5345 case TK_CONCAT:
5346 seenNot = 1;
5347 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005348 case TK_STAR:
5349 case TK_REM:
5350 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005351 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005352 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5353 /* Fall thru into the next case */
5354 }
5355 case TK_SPAN:
5356 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005357 case TK_UPLUS:
5358 case TK_UMINUS: {
5359 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5360 }
5361 case TK_TRUTH: {
5362 if( seenNot ) return 0;
5363 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005364 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005365 }
dan1cd382e2019-08-29 15:06:35 +00005366 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005367 case TK_NOT: {
5368 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5369 }
5370 }
5371 return 0;
5372}
5373
5374/*
drh4bd5f732013-07-31 23:22:39 +00005375** Return true if we can prove the pE2 will always be true if pE1 is
5376** true. Return false if we cannot complete the proof or if pE2 might
5377** be false. Examples:
5378**
drh619a1302013-08-01 13:04:46 +00005379** pE1: x==5 pE2: x==5 Result: true
5380** pE1: x>0 pE2: x==5 Result: false
5381** pE1: x=21 pE2: x=21 OR y=43 Result: true
5382** pE1: x!=123 pE2: x IS NOT NULL Result: true
5383** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5384** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5385** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005386**
5387** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5388** Expr.iTable<0 then assume a table number given by iTab.
5389**
drhc0804222017-06-28 21:47:16 +00005390** If pParse is not NULL, then the values of bound variables in pE1 are
5391** compared against literal values in pE2 and pParse->pVdbe->expmask is
5392** modified to record which bound variables are referenced. If pParse
5393** is NULL, then false will be returned if pE1 contains any bound variables.
5394**
drh4bd5f732013-07-31 23:22:39 +00005395** When in doubt, return false. Returning true might give a performance
5396** improvement. Returning false might cause a performance reduction, but
5397** it will always give the correct answer and is hence always safe.
5398*/
dan5aa550c2017-06-24 18:10:29 +00005399int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5400 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005401 return 1;
5402 }
5403 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005404 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5405 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005406 ){
5407 return 1;
5408 }
drh664d6d12019-05-04 17:32:07 +00005409 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005410 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005411 ){
drhc51cf862019-05-11 19:36:03 +00005412 return 1;
drh619a1302013-08-01 13:04:46 +00005413 }
5414 return 0;
drh4bd5f732013-07-31 23:22:39 +00005415}
5416
5417/*
drh6c68d752019-11-04 02:05:52 +00005418** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005419** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005420** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5421**
5422** This routine controls an optimization. False positives (setting
5423** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5424** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005425*/
5426static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005427 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005428 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005429 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5430 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005431 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005432 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005433 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005434 case TK_IS:
5435 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005436 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005437 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005438 case TK_IN:
drh25897872018-03-20 21:16:15 +00005439 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005440 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005441 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005442 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005443 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005444 testcase( pExpr->op==TK_IS );
5445 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005446 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005447 testcase( pExpr->op==TK_CASE );
5448 testcase( pExpr->op==TK_IN );
5449 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005450 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005451 return WRC_Prune;
5452 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005453 if( pWalker->u.iCur==pExpr->iTable ){
5454 pWalker->eCode = 1;
5455 return WRC_Abort;
5456 }
5457 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005458
dan9d23ea72019-08-29 19:34:29 +00005459 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005460 if( pWalker->eCode==0 ){
5461 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5462 if( pWalker->eCode ){
5463 pWalker->eCode = 0;
5464 sqlite3WalkExpr(pWalker, pExpr->pRight);
5465 }
dan9d23ea72019-08-29 19:34:29 +00005466 }
5467 return WRC_Prune;
5468
5469 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005470 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5471 assert( pWalker->eCode );
5472 return WRC_Abort;
5473 }
dan9d23ea72019-08-29 19:34:29 +00005474 return WRC_Prune;
5475
drh98811552018-04-03 14:04:48 +00005476 /* Virtual tables are allowed to use constraints like x=NULL. So
5477 ** a term of the form x=y does not prove that y is not null if x
5478 ** is the column of a virtual table */
5479 case TK_EQ:
5480 case TK_NE:
5481 case TK_LT:
5482 case TK_LE:
5483 case TK_GT:
5484 case TK_GE:
5485 testcase( pExpr->op==TK_EQ );
5486 testcase( pExpr->op==TK_NE );
5487 testcase( pExpr->op==TK_LT );
5488 testcase( pExpr->op==TK_LE );
5489 testcase( pExpr->op==TK_GT );
5490 testcase( pExpr->op==TK_GE );
drhbf48ce42020-02-17 00:12:04 +00005491 if( sqlite3ExprIsVtabRef(pExpr->pLeft)
5492 || sqlite3ExprIsVtabRef(pExpr->pRight)
drh98811552018-04-03 14:04:48 +00005493 ){
5494 return WRC_Prune;
5495 }
dan9d23ea72019-08-29 19:34:29 +00005496
drh25897872018-03-20 21:16:15 +00005497 default:
5498 return WRC_Continue;
5499 }
5500}
5501
5502/*
5503** Return true (non-zero) if expression p can only be true if at least
5504** one column of table iTab is non-null. In other words, return true
5505** if expression p will always be NULL or false if every column of iTab
5506** is NULL.
5507**
drh821b6102018-03-24 18:01:51 +00005508** False negatives are acceptable. In other words, it is ok to return
5509** zero even if expression p will never be true of every column of iTab
5510** is NULL. A false negative is merely a missed optimization opportunity.
5511**
5512** False positives are not allowed, however. A false positive may result
5513** in an incorrect answer.
5514**
drh25897872018-03-20 21:16:15 +00005515** Terms of p that are marked with EP_FromJoin (and hence that come from
5516** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5517**
5518** This routine is used to check if a LEFT JOIN can be converted into
5519** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5520** clause requires that some column of the right table of the LEFT JOIN
5521** be non-NULL, then the LEFT JOIN can be safely converted into an
5522** ordinary join.
5523*/
5524int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5525 Walker w;
drh0d950af2019-08-22 16:38:42 +00005526 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005527 if( p==0 ) return 0;
5528 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005529 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005530 }else{
5531 while( p->op==TK_AND ){
5532 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5533 p = p->pRight;
5534 }
drhd6db6592019-04-01 19:42:42 +00005535 }
drh25897872018-03-20 21:16:15 +00005536 w.xExprCallback = impliesNotNullRow;
5537 w.xSelectCallback = 0;
5538 w.xSelectCallback2 = 0;
5539 w.eCode = 0;
5540 w.u.iCur = iTab;
5541 sqlite3WalkExpr(&w, p);
5542 return w.eCode;
5543}
5544
5545/*
drh030796d2012-08-23 16:18:10 +00005546** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005547** to determine if an expression can be evaluated by reference to the
5548** index only, without having to do a search for the corresponding
5549** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5550** is the cursor for the table.
5551*/
5552struct IdxCover {
5553 Index *pIdx; /* The index to be tested for coverage */
5554 int iCur; /* Cursor number for the table corresponding to the index */
5555};
5556
5557/*
5558** Check to see if there are references to columns in table
5559** pWalker->u.pIdxCover->iCur can be satisfied using the index
5560** pWalker->u.pIdxCover->pIdx.
5561*/
5562static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5563 if( pExpr->op==TK_COLUMN
5564 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005565 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005566 ){
5567 pWalker->eCode = 1;
5568 return WRC_Abort;
5569 }
5570 return WRC_Continue;
5571}
5572
5573/*
drhe604ec02016-07-27 19:20:58 +00005574** Determine if an index pIdx on table with cursor iCur contains will
5575** the expression pExpr. Return true if the index does cover the
5576** expression and false if the pExpr expression references table columns
5577** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005578**
5579** An index covering an expression means that the expression can be
5580** evaluated using only the index and without having to lookup the
5581** corresponding table entry.
5582*/
5583int sqlite3ExprCoveredByIndex(
5584 Expr *pExpr, /* The index to be tested */
5585 int iCur, /* The cursor number for the corresponding table */
5586 Index *pIdx /* The index that might be used for coverage */
5587){
5588 Walker w;
5589 struct IdxCover xcov;
5590 memset(&w, 0, sizeof(w));
5591 xcov.iCur = iCur;
5592 xcov.pIdx = pIdx;
5593 w.xExprCallback = exprIdxCover;
5594 w.u.pIdxCover = &xcov;
5595 sqlite3WalkExpr(&w, pExpr);
5596 return !w.eCode;
5597}
5598
5599
5600/*
5601** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005602** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005603** aggregate function, in order to implement the
5604** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005605*/
drh030796d2012-08-23 16:18:10 +00005606struct SrcCount {
5607 SrcList *pSrc; /* One particular FROM clause in a nested query */
5608 int nThis; /* Number of references to columns in pSrcList */
5609 int nOther; /* Number of references to columns in other FROM clauses */
5610};
5611
5612/*
5613** Count the number of references to columns.
5614*/
5615static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005616 /* There was once a NEVER() on the second term on the grounds that
5617 ** sqlite3FunctionUsesThisSrc() was always called before
5618 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5619 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5620 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5621 ** FunctionUsesThisSrc() when creating a new sub-select. */
5622 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005623 int i;
drh030796d2012-08-23 16:18:10 +00005624 struct SrcCount *p = pWalker->u.pSrcCount;
5625 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005626 int nSrc = pSrc ? pSrc->nSrc : 0;
5627 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005628 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005629 }
drh655814d2015-01-09 01:27:29 +00005630 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005631 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005632 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5633 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005634 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005635 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005636 p->nOther++;
5637 }
drh374fdce2012-04-17 16:38:53 +00005638 }
drh030796d2012-08-23 16:18:10 +00005639 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005640}
5641
5642/*
drh030796d2012-08-23 16:18:10 +00005643** Determine if any of the arguments to the pExpr Function reference
5644** pSrcList. Return true if they do. Also return true if the function
5645** has no arguments or has only constant arguments. Return false if pExpr
5646** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005647*/
drh030796d2012-08-23 16:18:10 +00005648int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005649 Walker w;
drh030796d2012-08-23 16:18:10 +00005650 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005651 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005652 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005653 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005654 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005655 w.u.pSrcCount = &cnt;
5656 cnt.pSrc = pSrcList;
5657 cnt.nThis = 0;
5658 cnt.nOther = 0;
5659 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005660#ifndef SQLITE_OMIT_WINDOWFUNC
5661 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5662 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5663 }
5664#endif
drh030796d2012-08-23 16:18:10 +00005665 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005666}
5667
5668/*
drh13449892005-09-07 21:22:45 +00005669** Add a new element to the pAggInfo->aCol[] array. Return the index of
5670** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005671*/
drh17435752007-08-16 04:30:38 +00005672static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005673 int i;
drhcf643722007-03-27 13:36:37 +00005674 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005675 db,
drhcf643722007-03-27 13:36:37 +00005676 pInfo->aCol,
5677 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005678 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005679 &i
5680 );
drh13449892005-09-07 21:22:45 +00005681 return i;
5682}
5683
5684/*
5685** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5686** the new element. Return a negative number if malloc fails.
5687*/
drh17435752007-08-16 04:30:38 +00005688static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005689 int i;
drhcf643722007-03-27 13:36:37 +00005690 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005691 db,
drhcf643722007-03-27 13:36:37 +00005692 pInfo->aFunc,
5693 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005694 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005695 &i
5696 );
drh13449892005-09-07 21:22:45 +00005697 return i;
5698}
drh22827922000-06-06 17:27:05 +00005699
5700/*
drh7d10d5a2008-08-20 16:35:10 +00005701** This is the xExprCallback for a tree walker. It is used to
5702** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005703** for additional information.
drh22827922000-06-06 17:27:05 +00005704*/
drh7d10d5a2008-08-20 16:35:10 +00005705static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005706 int i;
drh7d10d5a2008-08-20 16:35:10 +00005707 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005708 Parse *pParse = pNC->pParse;
5709 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005710 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005711
drh25c3b8c2018-04-16 10:34:13 +00005712 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005713 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005714 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005715 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005716 testcase( pExpr->op==TK_AGG_COLUMN );
5717 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005718 /* Check to see if the column is in one of the tables in the FROM
5719 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005720 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005721 struct SrcList_item *pItem = pSrcList->a;
5722 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5723 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005724 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005725 if( pExpr->iTable==pItem->iCursor ){
5726 /* If we reach this point, it means that pExpr refers to a table
5727 ** that is in the FROM clause of the aggregate query.
5728 **
5729 ** Make an entry for the column in pAggInfo->aCol[] if there
5730 ** is not an entry there already.
5731 */
drh7f906d62007-03-12 23:48:52 +00005732 int k;
drh13449892005-09-07 21:22:45 +00005733 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005734 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005735 if( pCol->iTable==pExpr->iTable &&
5736 pCol->iColumn==pExpr->iColumn ){
5737 break;
5738 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005739 }
danielk19771e536952007-08-16 10:09:01 +00005740 if( (k>=pAggInfo->nColumn)
5741 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5742 ){
drh7f906d62007-03-12 23:48:52 +00005743 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005744 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005745 pCol->iTable = pExpr->iTable;
5746 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005747 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005748 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005749 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005750 if( pAggInfo->pGroupBy ){
5751 int j, n;
5752 ExprList *pGB = pAggInfo->pGroupBy;
5753 struct ExprList_item *pTerm = pGB->a;
5754 n = pGB->nExpr;
5755 for(j=0; j<n; j++, pTerm++){
5756 Expr *pE = pTerm->pExpr;
5757 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5758 pE->iColumn==pExpr->iColumn ){
5759 pCol->iSorterColumn = j;
5760 break;
5761 }
5762 }
5763 }
5764 if( pCol->iSorterColumn<0 ){
5765 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5766 }
5767 }
5768 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5769 ** because it was there before or because we just created it).
5770 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5771 ** pAggInfo->aCol[] entry.
5772 */
drhebb6a652013-09-12 23:42:22 +00005773 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005774 pExpr->pAggInfo = pAggInfo;
5775 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005776 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005777 break;
5778 } /* endif pExpr->iTable==pItem->iCursor */
5779 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005780 }
drh7d10d5a2008-08-20 16:35:10 +00005781 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005782 }
5783 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005784 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005785 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005786 ){
drh13449892005-09-07 21:22:45 +00005787 /* Check to see if pExpr is a duplicate of another aggregate
5788 ** function that is already in the pAggInfo structure
5789 */
5790 struct AggInfo_func *pItem = pAggInfo->aFunc;
5791 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005792 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005793 break;
5794 }
drh22827922000-06-06 17:27:05 +00005795 }
drh13449892005-09-07 21:22:45 +00005796 if( i>=pAggInfo->nFunc ){
5797 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5798 */
danielk197714db2662006-01-09 16:12:04 +00005799 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005800 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005801 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005802 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005803 pItem = &pAggInfo->aFunc[i];
5804 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005805 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005806 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005807 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005808 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005809 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005810 if( pExpr->flags & EP_Distinct ){
5811 pItem->iDistinct = pParse->nTab++;
5812 }else{
5813 pItem->iDistinct = -1;
5814 }
drh13449892005-09-07 21:22:45 +00005815 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005816 }
drh13449892005-09-07 21:22:45 +00005817 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5818 */
drhc5cd1242013-09-12 16:50:49 +00005819 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005820 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005821 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005822 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005823 return WRC_Prune;
5824 }else{
5825 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005826 }
drh22827922000-06-06 17:27:05 +00005827 }
5828 }
drh7d10d5a2008-08-20 16:35:10 +00005829 return WRC_Continue;
5830}
5831static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005832 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005833 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005834 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005835}
drh979dd1b2017-05-29 14:26:07 +00005836static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5837 UNUSED_PARAMETER(pSelect);
5838 pWalker->walkerDepth--;
5839}
drh626a8792005-01-17 22:08:19 +00005840
5841/*
drhe8abb4c2012-11-02 18:24:57 +00005842** Analyze the pExpr expression looking for aggregate functions and
5843** for variables that need to be added to AggInfo object that pNC->pAggInfo
5844** points to. Additional entries are made on the AggInfo object as
5845** necessary.
drh626a8792005-01-17 22:08:19 +00005846**
5847** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005848** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005849*/
drhd2b3e232008-01-23 14:51:49 +00005850void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005851 Walker w;
5852 w.xExprCallback = analyzeAggregate;
5853 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005854 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5855 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005856 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005857 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005858 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005859 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005860}
drh5d9a4af2005-08-30 00:54:01 +00005861
5862/*
5863** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5864** expression list. Return the number of errors.
5865**
5866** If an error is found, the analysis is cut short.
5867*/
drhd2b3e232008-01-23 14:51:49 +00005868void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005869 struct ExprList_item *pItem;
5870 int i;
drh5d9a4af2005-08-30 00:54:01 +00005871 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005872 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5873 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005874 }
5875 }
drh5d9a4af2005-08-30 00:54:01 +00005876}
drh892d3172008-01-10 03:46:36 +00005877
5878/*
drhceea3322009-04-23 13:22:42 +00005879** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005880*/
5881int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005882 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005883 return ++pParse->nMem;
5884 }
danielk19772f425f62008-07-04 09:41:39 +00005885 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005886}
drhceea3322009-04-23 13:22:42 +00005887
5888/*
5889** Deallocate a register, making available for reuse for some other
5890** purpose.
drhceea3322009-04-23 13:22:42 +00005891*/
drh892d3172008-01-10 03:46:36 +00005892void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00005893 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00005894 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00005895 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5896 pParse->aTempReg[pParse->nTempReg++] = iReg;
5897 }
drh892d3172008-01-10 03:46:36 +00005898 }
5899}
5900
5901/*
drhed24da42016-09-06 14:37:05 +00005902** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005903*/
5904int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005905 int i, n;
drhed24da42016-09-06 14:37:05 +00005906 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005907 i = pParse->iRangeReg;
5908 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005909 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005910 pParse->iRangeReg += nReg;
5911 pParse->nRangeReg -= nReg;
5912 }else{
5913 i = pParse->nMem+1;
5914 pParse->nMem += nReg;
5915 }
5916 return i;
5917}
5918void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005919 if( nReg==1 ){
5920 sqlite3ReleaseTempReg(pParse, iReg);
5921 return;
5922 }
drh3aef2fb2020-01-02 17:46:02 +00005923 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00005924 if( nReg>pParse->nRangeReg ){
5925 pParse->nRangeReg = nReg;
5926 pParse->iRangeReg = iReg;
5927 }
5928}
drhcdc69552011-12-06 13:24:59 +00005929
5930/*
5931** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005932**
5933** Always invoke this procedure after coding a subroutine or co-routine
5934** that might be invoked from other parts of the code, to ensure that
5935** the sub/co-routine does not use registers in common with the code that
5936** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005937*/
5938void sqlite3ClearTempRegCache(Parse *pParse){
5939 pParse->nTempReg = 0;
5940 pParse->nRangeReg = 0;
5941}
drhbb9b5f22016-03-19 00:35:02 +00005942
5943/*
5944** Validate that no temporary register falls within the range of
5945** iFirst..iLast, inclusive. This routine is only call from within assert()
5946** statements.
5947*/
5948#ifdef SQLITE_DEBUG
5949int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5950 int i;
5951 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005952 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5953 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005954 ){
5955 return 0;
5956 }
5957 for(i=0; i<pParse->nTempReg; i++){
5958 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5959 return 0;
5960 }
5961 }
5962 return 1;
5963}
5964#endif /* SQLITE_DEBUG */