blob: 6948c5a0fe307c8c6ba7a5c9b30ae51b8832a660 [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;
mistachkin9bec6fb2014-06-26 21:28:21 +000047 if( pExpr->flags & EP_Generic ) return 0;
drha7d6db62019-06-11 21:02:15 +000048 while( ExprHasProperty(pExpr, EP_Skip) ){
49 assert( pExpr->op==TK_COLLATE );
50 pExpr = pExpr->pLeft;
51 assert( pExpr!=0 );
52 }
drh580c8c12012-12-08 03:34:04 +000053 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000054 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000055 assert( pExpr->flags&EP_xIsSelect );
56 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000057 }
drhdb45bd52016-08-22 00:48:58 +000058 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000059#ifndef SQLITE_OMIT_CAST
60 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000061 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000062 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000063 }
64#endif
drheda079c2018-09-20 19:02:15 +000065 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
66 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000067 }
dan80aa5452016-09-03 19:52:12 +000068 if( op==TK_SELECT_COLUMN ){
69 assert( pExpr->pLeft->flags&EP_xIsSelect );
70 return sqlite3ExprAffinity(
71 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
72 );
73 }
drh11949042019-08-05 18:01:42 +000074 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000075}
76
drh53db1452004-05-20 13:54:53 +000077/*
drh8b4c40d2007-02-01 23:02:45 +000078** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000079** sequence named by pToken. Return a pointer to a new Expr node that
80** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000081**
82** If a memory allocation error occurs, that fact is recorded in pParse->db
83** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000084*/
drh4ef7efa2014-03-20 15:14:08 +000085Expr *sqlite3ExprAddCollateToken(
86 Parse *pParse, /* Parsing context */
87 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000088 const Token *pCollName, /* Name of collating sequence */
89 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000090){
drh0a8a4062012-12-07 18:38:16 +000091 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000092 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000093 if( pNew ){
94 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000095 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000096 pExpr = pNew;
97 }
drhae80dde2012-12-06 21:16:43 +000098 }
drh0a8a4062012-12-07 18:38:16 +000099 return pExpr;
100}
101Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000102 Token s;
103 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000104 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000105 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000106}
107
108/*
drh0b8d2552015-09-05 22:36:07 +0000109** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000110** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000111*/
112Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000113 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000114 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000115 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
116 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000117 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000118 pExpr = pExpr->x.pList->a[0].pExpr;
119 }else{
drh0b8d2552015-09-05 22:36:07 +0000120 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000121 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000122 }
drha4c3c872013-09-12 17:29:25 +0000123 }
drh0a8a4062012-12-07 18:38:16 +0000124 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000125}
126
127/*
drhae80dde2012-12-06 21:16:43 +0000128** Return the collation sequence for the expression pExpr. If
129** there is no defined collating sequence, return NULL.
130**
drh70efa842017-09-28 01:58:23 +0000131** See also: sqlite3ExprNNCollSeq()
132**
133** The sqlite3ExprNNCollSeq() works the same exact that it returns the
134** default collation if pExpr has no defined collation.
135**
drhae80dde2012-12-06 21:16:43 +0000136** The collating sequence might be determined by a COLLATE operator
137** or by the presence of a column with a defined collating sequence.
138** COLLATE operators take first precedence. Left operands take
139** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000140*/
danielk19777cedc8d2004-06-10 10:50:08 +0000141CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000142 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000143 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000144 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000145 while( p ){
drhae80dde2012-12-06 21:16:43 +0000146 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000147 if( p->flags & EP_Generic ) break;
drhcb0e04f2018-12-12 21:34:17 +0000148 if( op==TK_REGISTER ) op = p->op2;
149 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000150 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000151 ){
drheda079c2018-09-20 19:02:15 +0000152 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000153 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000154 int j = p->iColumn;
155 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000156 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000157 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000158 }
159 break;
danielk19770202b292004-06-09 09:55:16 +0000160 }
drhe081d732018-07-27 18:19:12 +0000161 if( op==TK_CAST || op==TK_UPLUS ){
162 p = p->pLeft;
163 continue;
164 }
drhcb0e04f2018-12-12 21:34:17 +0000165 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000166 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
167 break;
168 }
drhae80dde2012-12-06 21:16:43 +0000169 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000170 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000171 p = p->pLeft;
172 }else{
drh2308ed32015-02-09 16:09:34 +0000173 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000174 /* The Expr.x union is never used at the same time as Expr.pRight */
175 assert( p->x.pList==0 || p->pRight==0 );
176 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
177 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
178 ** least one EP_Collate. Thus the following two ALWAYS. */
179 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000180 int i;
drh6728cd92015-02-09 18:28:03 +0000181 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000182 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
183 pNext = p->x.pList->a[i].pExpr;
184 break;
185 }
186 }
187 }
188 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000189 }
190 }else{
drh7d10d5a2008-08-20 16:35:10 +0000191 break;
192 }
danielk19770202b292004-06-09 09:55:16 +0000193 }
danielk19777cedc8d2004-06-10 10:50:08 +0000194 if( sqlite3CheckCollSeq(pParse, pColl) ){
195 pColl = 0;
196 }
197 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000198}
199
200/*
drh70efa842017-09-28 01:58:23 +0000201** Return the collation sequence for the expression pExpr. If
202** there is no defined collating sequence, return a pointer to the
203** defautl collation sequence.
204**
205** See also: sqlite3ExprCollSeq()
206**
207** The sqlite3ExprCollSeq() routine works the same except that it
208** returns NULL if there is no defined collation.
209*/
210CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
211 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
212 if( p==0 ) p = pParse->db->pDfltColl;
213 assert( p!=0 );
214 return p;
215}
216
217/*
218** Return TRUE if the two expressions have equivalent collating sequences.
219*/
220int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
221 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
222 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
223 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
224}
225
226/*
drh626a8792005-01-17 22:08:19 +0000227** pExpr is an operand of a comparison operator. aff2 is the
228** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000229** type affinity that should be used for the comparison operator.
230*/
danielk1977e014a832004-05-17 10:48:57 +0000231char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000232 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000233 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000234 /* Both sides of the comparison are columns. If one has numeric
235 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000236 */
drh8a512562005-11-14 22:29:05 +0000237 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000238 return SQLITE_AFF_NUMERIC;
239 }else{
drh05883a32015-06-02 15:32:08 +0000240 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000241 }
danielk1977e014a832004-05-17 10:48:57 +0000242 }else{
243 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000244 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
245 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000246 }
247}
248
drh53db1452004-05-20 13:54:53 +0000249/*
250** pExpr is a comparison operator. Return the type affinity that should
251** be applied to both operands prior to doing the comparison.
252*/
danielk1977e014a832004-05-17 10:48:57 +0000253static char comparisonAffinity(Expr *pExpr){
254 char aff;
255 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
256 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000257 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000258 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000259 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000260 if( pExpr->pRight ){
261 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000262 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
263 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000264 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000265 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000266 }
267 return aff;
268}
269
270/*
271** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
272** idx_affinity is the affinity of an indexed column. Return true
273** if the index with affinity idx_affinity may be used to implement
274** the comparison in pExpr.
275*/
276int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
277 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000278 if( aff<SQLITE_AFF_TEXT ){
279 return 1;
drh8a512562005-11-14 22:29:05 +0000280 }
drh915e4342019-08-06 15:18:15 +0000281 if( aff==SQLITE_AFF_TEXT ){
282 return idx_affinity==SQLITE_AFF_TEXT;
283 }
284 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000285}
286
danielk1977a37cdde2004-05-16 11:15:36 +0000287/*
drh35573352008-01-08 23:54:25 +0000288** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000289** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000290*/
drh35573352008-01-08 23:54:25 +0000291static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
292 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000293 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000294 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000295}
296
drha2e00042002-01-22 03:13:42 +0000297/*
danielk19770202b292004-06-09 09:55:16 +0000298** Return a pointer to the collation sequence that should be used by
299** a binary comparison operator comparing pLeft and pRight.
300**
301** If the left hand expression has a collating sequence type, then it is
302** used. Otherwise the collation sequence for the right hand expression
303** is used, or the default (BINARY) if neither expression has a collating
304** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000305**
306** Argument pRight (but not pLeft) may be a null pointer. In this case,
307** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000308*/
drh0a0e1312007-08-07 17:04:59 +0000309CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000310 Parse *pParse,
311 Expr *pLeft,
312 Expr *pRight
313){
drhec41dda2007-02-07 13:09:45 +0000314 CollSeq *pColl;
315 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000316 if( pLeft->flags & EP_Collate ){
317 pColl = sqlite3ExprCollSeq(pParse, pLeft);
318 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
319 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000320 }else{
321 pColl = sqlite3ExprCollSeq(pParse, pLeft);
322 if( !pColl ){
323 pColl = sqlite3ExprCollSeq(pParse, pRight);
324 }
danielk19770202b292004-06-09 09:55:16 +0000325 }
326 return pColl;
327}
328
329/*
drhbe5c89a2004-07-26 00:31:09 +0000330** Generate code for a comparison operator.
331*/
332static int codeCompare(
333 Parse *pParse, /* The parsing (and code generating) context */
334 Expr *pLeft, /* The left operand */
335 Expr *pRight, /* The right operand */
336 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000337 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000338 int dest, /* Jump here if true. */
339 int jumpIfNull /* If true, jump if either operand is NULL */
340){
drh35573352008-01-08 23:54:25 +0000341 int p5;
342 int addr;
343 CollSeq *p4;
344
345 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
346 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
347 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
348 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000349 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000350 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000351}
352
dancfbb5e82016-07-13 19:48:13 +0000353/*
dan870a0702016-08-01 16:37:43 +0000354** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000355**
356** A vector is defined as any expression that results in two or more
357** columns of result. Every TK_VECTOR node is an vector because the
358** parser will not generate a TK_VECTOR with fewer than two entries.
359** But a TK_SELECT might be either a vector or a scalar. It is only
360** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000361*/
362int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000363 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000364}
365
366/*
dancfbb5e82016-07-13 19:48:13 +0000367** If the expression passed as the only argument is of type TK_VECTOR
368** return the number of expressions in the vector. Or, if the expression
369** is a sub-select, return the number of columns in the sub-select. For
370** any other type of expression, return 1.
371*/
dan71c57db2016-07-09 20:23:55 +0000372int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000373 u8 op = pExpr->op;
374 if( op==TK_REGISTER ) op = pExpr->op2;
375 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000376 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000377 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000378 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000379 }else{
380 return 1;
dan71c57db2016-07-09 20:23:55 +0000381 }
dan71c57db2016-07-09 20:23:55 +0000382}
383
danba00e302016-07-23 20:24:06 +0000384/*
drhfc7f27b2016-08-20 00:07:01 +0000385** Return a pointer to a subexpression of pVector that is the i-th
386** column of the vector (numbered starting with 0). The caller must
387** ensure that i is within range.
388**
drh76dbe7a2016-08-20 21:02:38 +0000389** If pVector is really a scalar (and "scalar" here includes subqueries
390** that return a single column!) then return pVector unmodified.
391**
drhfc7f27b2016-08-20 00:07:01 +0000392** pVector retains ownership of the returned subexpression.
393**
394** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000395** just the expression for the i-th term of the result set, and may
396** not be ready for evaluation because the table cursor has not yet
397** been positioned.
danba00e302016-07-23 20:24:06 +0000398*/
drhfc7f27b2016-08-20 00:07:01 +0000399Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000400 assert( i<sqlite3ExprVectorSize(pVector) );
401 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000402 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
403 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000404 return pVector->x.pSelect->pEList->a[i].pExpr;
405 }else{
406 return pVector->x.pList->a[i].pExpr;
407 }
dan71c57db2016-07-09 20:23:55 +0000408 }
dan870a0702016-08-01 16:37:43 +0000409 return pVector;
dan71c57db2016-07-09 20:23:55 +0000410}
drhfc7f27b2016-08-20 00:07:01 +0000411
drhfc7f27b2016-08-20 00:07:01 +0000412/*
413** Compute and return a new Expr object which when passed to
414** sqlite3ExprCode() will generate all necessary code to compute
415** the iField-th column of the vector expression pVector.
416**
drh8762ec12016-08-20 01:06:22 +0000417** It is ok for pVector to be a scalar (as long as iField==0).
418** In that case, this routine works like sqlite3ExprDup().
419**
drhfc7f27b2016-08-20 00:07:01 +0000420** The caller owns the returned Expr object and is responsible for
421** ensuring that the returned value eventually gets freed.
422**
drh8762ec12016-08-20 01:06:22 +0000423** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000424** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000425** valid for the life of the returned object. If pVector is a TK_VECTOR
426** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000427** returns.
drh8762ec12016-08-20 01:06:22 +0000428**
429** A trick to cause a TK_SELECT pVector to be deleted together with
430** the returned Expr object is to attach the pVector to the pRight field
431** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000432*/
433Expr *sqlite3ExprForVectorField(
434 Parse *pParse, /* Parsing context */
435 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000436 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000437){
438 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000439 if( pVector->op==TK_SELECT ){
440 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000441 /* The TK_SELECT_COLUMN Expr node:
442 **
drh966e2912017-01-03 02:58:01 +0000443 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000444 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000445 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000446 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000447 ** pLeft->iTable: First in an array of register holding result, or 0
448 ** if the result is not yet computed.
449 **
450 ** sqlite3ExprDelete() specifically skips the recursive delete of
451 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000452 ** can be attached to pRight to cause this node to take ownership of
453 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
454 ** with the same pLeft pointer to the pVector, but only one of them
455 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000456 */
drhabfd35e2016-12-06 22:47:23 +0000457 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000458 if( pRet ){
459 pRet->iColumn = iField;
460 pRet->pLeft = pVector;
461 }
drhfc7f27b2016-08-20 00:07:01 +0000462 assert( pRet==0 || pRet->iTable==0 );
463 }else{
drha1251bc2016-08-20 00:51:37 +0000464 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
465 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000466 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000467 }
468 return pRet;
469}
dan71c57db2016-07-09 20:23:55 +0000470
dan5c288b92016-07-30 21:02:33 +0000471/*
472** If expression pExpr is of type TK_SELECT, generate code to evaluate
473** it. Return the register in which the result is stored (or, if the
474** sub-select returns more than one column, the first in an array
475** of registers in which the result is stored).
476**
477** If pExpr is not a TK_SELECT expression, return 0.
478*/
479static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000480 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000481#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000482 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000483 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000484 }
danf9b2e052016-08-02 17:45:00 +0000485#endif
dan8da209b2016-07-26 18:06:08 +0000486 return reg;
487}
488
dan5c288b92016-07-30 21:02:33 +0000489/*
490** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000491** or TK_SELECT that returns more than one column. This function returns
492** the register number of a register that contains the value of
493** element iField of the vector.
494**
495** If pVector is a TK_SELECT expression, then code for it must have
496** already been generated using the exprCodeSubselect() routine. In this
497** case parameter regSelect should be the first in an array of registers
498** containing the results of the sub-select.
499**
500** If pVector is of type TK_VECTOR, then code for the requested field
501** is generated. In this case (*pRegFree) may be set to the number of
502** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000503**
504** Before returning, output parameter (*ppExpr) is set to point to the
505** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000506*/
507static int exprVectorRegister(
508 Parse *pParse, /* Parse context */
509 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000510 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000511 int regSelect, /* First in array of registers */
512 Expr **ppExpr, /* OUT: Expression element */
513 int *pRegFree /* OUT: Temp register to free */
514){
drh12abf402016-08-22 14:30:05 +0000515 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000516 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000517 if( op==TK_REGISTER ){
518 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
519 return pVector->iTable+iField;
520 }
521 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000522 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
523 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000524 }
dan870a0702016-08-01 16:37:43 +0000525 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000526 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
527}
528
529/*
530** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000531** the result of the comparison (1, 0, or NULL) and write that
532** result into register dest.
533**
534** The caller must satisfy the following preconditions:
535**
536** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
537** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
538** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000539*/
drh79752b62016-08-13 10:02:17 +0000540static void codeVectorCompare(
541 Parse *pParse, /* Code generator context */
542 Expr *pExpr, /* The comparison operation */
543 int dest, /* Write results into this register */
544 u8 op, /* Comparison operator */
545 u8 p5 /* SQLITE_NULLEQ or zero */
546){
dan71c57db2016-07-09 20:23:55 +0000547 Vdbe *v = pParse->pVdbe;
548 Expr *pLeft = pExpr->pLeft;
549 Expr *pRight = pExpr->pRight;
550 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000551 int i;
552 int regLeft = 0;
553 int regRight = 0;
554 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000555 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000556
drh245ce622017-01-01 12:44:07 +0000557 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
558 sqlite3ErrorMsg(pParse, "row value misused");
559 return;
560 }
drhb29e60c2016-09-05 12:02:34 +0000561 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
562 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
563 || pExpr->op==TK_LT || pExpr->op==TK_GT
564 || pExpr->op==TK_LE || pExpr->op==TK_GE
565 );
566 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
567 || (pExpr->op==TK_ISNOT && op==TK_NE) );
568 assert( p5==0 || pExpr->op!=op );
569 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000570
drhb29e60c2016-09-05 12:02:34 +0000571 p5 |= SQLITE_STOREP2;
572 if( opx==TK_LE ) opx = TK_LT;
573 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000574
drhb29e60c2016-09-05 12:02:34 +0000575 regLeft = exprCodeSubselect(pParse, pLeft);
576 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000577
drhb29e60c2016-09-05 12:02:34 +0000578 for(i=0; 1 /*Loop exits by "break"*/; i++){
579 int regFree1 = 0, regFree2 = 0;
580 Expr *pL, *pR;
581 int r1, r2;
582 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000583 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
584 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
585 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
586 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
587 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
588 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
589 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
590 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
591 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
592 sqlite3ReleaseTempReg(pParse, regFree1);
593 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000594 if( i==nLeft-1 ){
595 break;
dan71c57db2016-07-09 20:23:55 +0000596 }
drhb29e60c2016-09-05 12:02:34 +0000597 if( opx==TK_EQ ){
598 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
599 p5 |= SQLITE_KEEPNULL;
600 }else if( opx==TK_NE ){
601 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
602 p5 |= SQLITE_KEEPNULL;
603 }else{
604 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
605 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
606 VdbeCoverageIf(v, op==TK_LT);
607 VdbeCoverageIf(v, op==TK_GT);
608 VdbeCoverageIf(v, op==TK_LE);
609 VdbeCoverageIf(v, op==TK_GE);
610 if( i==nLeft-2 ) opx = op;
611 }
dan71c57db2016-07-09 20:23:55 +0000612 }
drhb29e60c2016-09-05 12:02:34 +0000613 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000614}
615
danielk19774b5255a2008-06-05 16:47:39 +0000616#if SQLITE_MAX_EXPR_DEPTH>0
617/*
618** Check that argument nHeight is less than or equal to the maximum
619** expression depth allowed. If it is not, leave an error message in
620** pParse.
621*/
drh7d10d5a2008-08-20 16:35:10 +0000622int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000623 int rc = SQLITE_OK;
624 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
625 if( nHeight>mxHeight ){
626 sqlite3ErrorMsg(pParse,
627 "Expression tree is too large (maximum depth %d)", mxHeight
628 );
629 rc = SQLITE_ERROR;
630 }
631 return rc;
632}
633
634/* The following three functions, heightOfExpr(), heightOfExprList()
635** and heightOfSelect(), are used to determine the maximum height
636** of any expression tree referenced by the structure passed as the
637** first argument.
638**
639** If this maximum height is greater than the current value pointed
640** to by pnHeight, the second parameter, then set *pnHeight to that
641** value.
642*/
643static void heightOfExpr(Expr *p, int *pnHeight){
644 if( p ){
645 if( p->nHeight>*pnHeight ){
646 *pnHeight = p->nHeight;
647 }
648 }
649}
650static void heightOfExprList(ExprList *p, int *pnHeight){
651 if( p ){
652 int i;
653 for(i=0; i<p->nExpr; i++){
654 heightOfExpr(p->a[i].pExpr, pnHeight);
655 }
656 }
657}
dan1a3a3082018-01-18 19:00:54 +0000658static void heightOfSelect(Select *pSelect, int *pnHeight){
659 Select *p;
660 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000661 heightOfExpr(p->pWhere, pnHeight);
662 heightOfExpr(p->pHaving, pnHeight);
663 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000664 heightOfExprList(p->pEList, pnHeight);
665 heightOfExprList(p->pGroupBy, pnHeight);
666 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000667 }
668}
669
670/*
671** Set the Expr.nHeight variable in the structure passed as an
672** argument. An expression with no children, Expr.pList or
673** Expr.pSelect member has a height of 1. Any other expression
674** has a height equal to the maximum height of any other
675** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000676**
677** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
678** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000679*/
680static void exprSetHeight(Expr *p){
681 int nHeight = 0;
682 heightOfExpr(p->pLeft, &nHeight);
683 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000684 if( ExprHasProperty(p, EP_xIsSelect) ){
685 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000686 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000687 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000688 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000689 }
danielk19774b5255a2008-06-05 16:47:39 +0000690 p->nHeight = nHeight + 1;
691}
692
693/*
694** Set the Expr.nHeight variable using the exprSetHeight() function. If
695** the height is greater than the maximum allowed expression depth,
696** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000697**
698** Also propagate all EP_Propagate flags from the Expr.x.pList into
699** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000700*/
drh2308ed32015-02-09 16:09:34 +0000701void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000702 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000703 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000704 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000705}
706
707/*
708** Return the maximum height of any expression tree referenced
709** by the select statement passed as an argument.
710*/
711int sqlite3SelectExprHeight(Select *p){
712 int nHeight = 0;
713 heightOfSelect(p, &nHeight);
714 return nHeight;
715}
drh2308ed32015-02-09 16:09:34 +0000716#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
717/*
718** Propagate all EP_Propagate flags from the Expr.x.pList into
719** Expr.flags.
720*/
721void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
722 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
723 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
724 }
725}
726#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000727#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
728
drhbe5c89a2004-07-26 00:31:09 +0000729/*
drhb7916a72009-05-27 10:31:29 +0000730** This routine is the core allocator for Expr nodes.
731**
drha76b5df2002-02-23 02:32:10 +0000732** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000733** for this node and for the pToken argument is a single allocation
734** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000735** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000736**
737** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000738** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000739** parameter is ignored if pToken is NULL or if the token does not
740** appear to be quoted. If the quotes were of the form "..." (double-quotes)
741** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000742**
743** Special case: If op==TK_INTEGER and pToken points to a string that
744** can be translated into a 32-bit integer, then the token is not
745** stored in u.zToken. Instead, the integer values is written
746** into u.iValue and the EP_IntValue flag is set. No extra storage
747** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000748*/
drhb7916a72009-05-27 10:31:29 +0000749Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000750 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000751 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000752 const Token *pToken, /* Token argument. Might be NULL */
753 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000754){
drha76b5df2002-02-23 02:32:10 +0000755 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000756 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000757 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000758
drh575fad62016-02-05 13:38:36 +0000759 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000760 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000761 if( op!=TK_INTEGER || pToken->z==0
762 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
763 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000764 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000765 }
drhb7916a72009-05-27 10:31:29 +0000766 }
drh575fad62016-02-05 13:38:36 +0000767 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000768 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000769 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000770 pNew->op = (u8)op;
771 pNew->iAgg = -1;
772 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000773 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000774 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000775 pNew->u.iValue = iValue;
776 }else{
drh33e619f2009-05-28 01:00:55 +0000777 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000778 assert( pToken->z!=0 || pToken->n==0 );
779 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000780 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000781 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000782 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000783 }
drhb7916a72009-05-27 10:31:29 +0000784 }
785 }
786#if SQLITE_MAX_EXPR_DEPTH>0
787 pNew->nHeight = 1;
788#endif
789 }
drha76b5df2002-02-23 02:32:10 +0000790 return pNew;
791}
792
793/*
drhb7916a72009-05-27 10:31:29 +0000794** Allocate a new expression node from a zero-terminated token that has
795** already been dequoted.
796*/
797Expr *sqlite3Expr(
798 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
799 int op, /* Expression opcode */
800 const char *zToken /* Token argument. Might be NULL */
801){
802 Token x;
803 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000804 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000805 return sqlite3ExprAlloc(db, op, &x, 0);
806}
807
808/*
809** Attach subtrees pLeft and pRight to the Expr node pRoot.
810**
811** If pRoot==NULL that means that a memory allocation error has occurred.
812** In that case, delete the subtrees pLeft and pRight.
813*/
814void sqlite3ExprAttachSubtrees(
815 sqlite3 *db,
816 Expr *pRoot,
817 Expr *pLeft,
818 Expr *pRight
819){
820 if( pRoot==0 ){
821 assert( db->mallocFailed );
822 sqlite3ExprDelete(db, pLeft);
823 sqlite3ExprDelete(db, pRight);
824 }else{
825 if( pRight ){
826 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000827 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000828 }
829 if( pLeft ){
830 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000831 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000832 }
833 exprSetHeight(pRoot);
834 }
835}
836
837/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000838** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000839**
drhbf664462009-06-19 18:32:54 +0000840** One or both of the subtrees can be NULL. Return a pointer to the new
841** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
842** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000843*/
drh17435752007-08-16 04:30:38 +0000844Expr *sqlite3PExpr(
845 Parse *pParse, /* Parsing context */
846 int op, /* Expression opcode */
847 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000848 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000849){
drh5fb52ca2012-03-31 02:34:35 +0000850 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000851 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
852 if( p ){
853 memset(p, 0, sizeof(Expr));
854 p->op = op & 0xff;
855 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000856 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000857 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000858 }else{
859 sqlite3ExprDelete(pParse->db, pLeft);
860 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000861 }
drh4e0cff62004-11-05 05:10:28 +0000862 return p;
863}
864
865/*
drh08de4f72016-04-11 01:06:47 +0000866** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
867** do a memory allocation failure) then delete the pSelect object.
868*/
869void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
870 if( pExpr ){
871 pExpr->x.pSelect = pSelect;
872 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
873 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
874 }else{
875 assert( pParse->db->mallocFailed );
876 sqlite3SelectDelete(pParse->db, pSelect);
877 }
878}
879
880
881/*
drh91bb0ee2004-09-01 03:06:34 +0000882** Join two expressions using an AND operator. If either expression is
883** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000884**
885** If one side or the other of the AND is known to be false, then instead
886** of returning an AND expression, just return a constant expression with
887** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000888*/
drhd5c851c2019-04-19 13:38:34 +0000889Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
890 sqlite3 *db = pParse->db;
891 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000892 return pRight;
893 }else if( pRight==0 ){
894 return pLeft;
drhad317272019-04-19 16:21:51 +0000895 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000896 sqlite3ExprUnmapAndDelete(pParse, pLeft);
897 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5fb52ca2012-03-31 02:34:35 +0000898 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000899 }else{
drhd5c851c2019-04-19 13:38:34 +0000900 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000901 }
902}
903
904/*
905** Construct a new expression node for a function with multiple
906** arguments.
907*/
drh954733b2018-07-27 23:33:16 +0000908Expr *sqlite3ExprFunction(
909 Parse *pParse, /* Parsing context */
910 ExprList *pList, /* Argument list */
911 Token *pToken, /* Name of the function */
912 int eDistinct /* SF_Distinct or SF_ALL or 0 */
913){
drha76b5df2002-02-23 02:32:10 +0000914 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000915 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000916 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000917 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000918 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000919 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000920 return 0;
921 }
drh954733b2018-07-27 23:33:16 +0000922 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
923 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
924 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000925 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000926 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000927 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000928 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000929 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000930 return pNew;
931}
932
933/*
drhfa6bc002004-09-07 16:19:52 +0000934** Assign a variable number to an expression that encodes a wildcard
935** in the original SQL statement.
936**
937** Wildcards consisting of a single "?" are assigned the next sequential
938** variable number.
939**
940** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000941** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000942** the SQL statement comes from an external source.
943**
drh51f49f12009-05-21 20:41:32 +0000944** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000945** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000946** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000947** assigned.
948*/
drhde25a882016-10-03 15:28:24 +0000949void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000950 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000951 const char *z;
drhf326d662016-12-23 13:30:53 +0000952 ynVar x;
drh17435752007-08-16 04:30:38 +0000953
drhfa6bc002004-09-07 16:19:52 +0000954 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000955 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000956 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000957 assert( z!=0 );
958 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000959 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000960 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000961 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000962 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000963 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000964 }else{
drhf326d662016-12-23 13:30:53 +0000965 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000966 if( z[0]=='?' ){
967 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
968 ** use it as the variable number */
969 i64 i;
drh18814df2017-01-31 03:52:34 +0000970 int bOk;
971 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
972 i = z[1]-'0'; /* The common case of ?N for a single digit N */
973 bOk = 1;
974 }else{
975 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
976 }
drh124c0b42011-06-01 18:15:55 +0000977 testcase( i==0 );
978 testcase( i==1 );
979 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
980 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
981 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
982 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
983 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000984 return;
drhfa6bc002004-09-07 16:19:52 +0000985 }
drh8e74e7b2017-01-31 12:41:48 +0000986 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +0000987 if( x>pParse->nVar ){
988 pParse->nVar = (int)x;
989 doAdd = 1;
990 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
991 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +0000992 }
993 }else{
994 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
995 ** number as the prior appearance of the same name, or if the name
996 ** has never appeared before, reuse the same variable number
997 */
drh9bf755c2016-12-23 03:59:31 +0000998 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
999 if( x==0 ){
1000 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001001 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001002 }
drhfa6bc002004-09-07 16:19:52 +00001003 }
drhf326d662016-12-23 13:30:53 +00001004 if( doAdd ){
1005 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1006 }
1007 }
1008 pExpr->iColumn = x;
1009 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001010 sqlite3ErrorMsg(pParse, "too many SQL variables");
1011 }
drhfa6bc002004-09-07 16:19:52 +00001012}
1013
1014/*
danf6963f92009-11-23 14:39:14 +00001015** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001016*/
drh4f0010b2016-04-11 14:49:39 +00001017static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1018 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001019 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1020 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001021
1022 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1023 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001024 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001025#ifdef SQLITE_DEBUG
1026 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1027 assert( p->pLeft==0 );
1028 assert( p->pRight==0 );
1029 assert( p->x.pSelect==0 );
1030 }
1031#endif
1032 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001033 /* The Expr.x union is never used at the same time as Expr.pRight */
1034 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001035 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001036 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001037 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001038 sqlite3ExprDeleteNN(db, p->pRight);
1039 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001040 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001041 sqlite3SelectDelete(db, p->x.pSelect);
1042 }else{
1043 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001044#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001045 if( ExprHasProperty(p, EP_WinFunc) ){
1046 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001047 }
dan6ba7ab02019-07-02 11:56:47 +00001048#endif
dan8117f112019-07-10 20:16:53 +00001049 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001050 }
drh209bc522016-09-23 21:36:24 +00001051 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001052 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001053 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001054 }
drha2e00042002-01-22 03:13:42 +00001055}
drh4f0010b2016-04-11 14:49:39 +00001056void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1057 if( p ) sqlite3ExprDeleteNN(db, p);
1058}
drha2e00042002-01-22 03:13:42 +00001059
drh8e34e402019-06-11 10:43:56 +00001060/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1061** expression.
1062*/
1063void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1064 if( p ){
1065 if( IN_RENAME_OBJECT ){
1066 sqlite3RenameExprUnmap(pParse, p);
1067 }
1068 sqlite3ExprDeleteNN(pParse->db, p);
1069 }
1070}
1071
drhd2687b72005-08-12 22:56:09 +00001072/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001073** Return the number of bytes allocated for the expression structure
1074** passed as the first argument. This is always one of EXPR_FULLSIZE,
1075** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1076*/
1077static int exprStructSize(Expr *p){
1078 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001079 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1080 return EXPR_FULLSIZE;
1081}
1082
1083/*
drh33e619f2009-05-28 01:00:55 +00001084** The dupedExpr*Size() routines each return the number of bytes required
1085** to store a copy of an expression or expression tree. They differ in
1086** how much of the tree is measured.
1087**
1088** dupedExprStructSize() Size of only the Expr structure
1089** dupedExprNodeSize() Size of Expr + space for token
1090** dupedExprSize() Expr + token + subtree components
1091**
1092***************************************************************************
1093**
1094** The dupedExprStructSize() function returns two values OR-ed together:
1095** (1) the space required for a copy of the Expr structure only and
1096** (2) the EP_xxx flags that indicate what the structure size should be.
1097** The return values is always one of:
1098**
1099** EXPR_FULLSIZE
1100** EXPR_REDUCEDSIZE | EP_Reduced
1101** EXPR_TOKENONLYSIZE | EP_TokenOnly
1102**
1103** The size of the structure can be found by masking the return value
1104** of this routine with 0xfff. The flags can be found by masking the
1105** return value with EP_Reduced|EP_TokenOnly.
1106**
1107** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1108** (unreduced) Expr objects as they or originally constructed by the parser.
1109** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001110** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001111** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001112** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001113** to reduce a pristine expression tree from the parser. The implementation
1114** of dupedExprStructSize() contain multiple assert() statements that attempt
1115** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001116*/
1117static int dupedExprStructSize(Expr *p, int flags){
1118 int nSize;
drh33e619f2009-05-28 01:00:55 +00001119 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001120 assert( EXPR_FULLSIZE<=0xfff );
1121 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001122 if( 0==flags || p->op==TK_SELECT_COLUMN
1123#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001124 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001125#endif
1126 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 }else{
drhc5cd1242013-09-12 16:50:49 +00001129 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001130 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001131 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001132 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001133 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001134 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1135 }else{
drhaecd8022013-09-13 18:15:15 +00001136 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001137 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1138 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001139 }
1140 return nSize;
1141}
1142
1143/*
drh33e619f2009-05-28 01:00:55 +00001144** This function returns the space in bytes required to store the copy
1145** of the Expr structure and a copy of the Expr.u.zToken string (if that
1146** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001147*/
1148static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001149 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1150 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001151 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001152 }
danielk1977bc739712009-03-23 04:33:32 +00001153 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001154}
1155
1156/*
1157** Return the number of bytes required to create a duplicate of the
1158** expression passed as the first argument. The second argument is a
1159** mask containing EXPRDUP_XXX flags.
1160**
1161** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001162** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001163**
1164** If the EXPRDUP_REDUCE flag is set, then the return value includes
1165** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1166** and Expr.pRight variables (but not for any structures pointed to or
1167** descended from the Expr.x.pList or Expr.x.pSelect variables).
1168*/
1169static int dupedExprSize(Expr *p, int flags){
1170 int nByte = 0;
1171 if( p ){
1172 nByte = dupedExprNodeSize(p, flags);
1173 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001174 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001175 }
1176 }
1177 return nByte;
1178}
1179
1180/*
1181** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1182** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001183** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001184** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001185** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001186** portion of the buffer copied into by this function.
1187*/
drh3c194692016-04-11 16:43:43 +00001188static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1189 Expr *pNew; /* Value to return */
1190 u8 *zAlloc; /* Memory space from which to build Expr object */
1191 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1192
drh575fad62016-02-05 13:38:36 +00001193 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001194 assert( p );
1195 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1196 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001197
drh3c194692016-04-11 16:43:43 +00001198 /* Figure out where to write the new Expr structure. */
1199 if( pzBuffer ){
1200 zAlloc = *pzBuffer;
1201 staticFlag = EP_Static;
1202 }else{
1203 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1204 staticFlag = 0;
1205 }
1206 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001207
drh3c194692016-04-11 16:43:43 +00001208 if( pNew ){
1209 /* Set nNewSize to the size allocated for the structure pointed to
1210 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1211 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1212 ** by the copy of the p->u.zToken string (if any).
1213 */
1214 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1215 const int nNewSize = nStructSize & 0xfff;
1216 int nToken;
1217 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1218 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001219 }else{
drh3c194692016-04-11 16:43:43 +00001220 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001221 }
drh3c194692016-04-11 16:43:43 +00001222 if( dupFlags ){
1223 assert( ExprHasProperty(p, EP_Reduced)==0 );
1224 memcpy(zAlloc, p, nNewSize);
1225 }else{
1226 u32 nSize = (u32)exprStructSize(p);
1227 memcpy(zAlloc, p, nSize);
1228 if( nSize<EXPR_FULLSIZE ){
1229 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1230 }
1231 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001232
drh3c194692016-04-11 16:43:43 +00001233 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1234 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1235 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1236 pNew->flags |= staticFlag;
1237
1238 /* Copy the p->u.zToken string, if any. */
1239 if( nToken ){
1240 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1241 memcpy(zToken, p->u.zToken, nToken);
1242 }
1243
drh209bc522016-09-23 21:36:24 +00001244 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001245 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1246 if( ExprHasProperty(p, EP_xIsSelect) ){
1247 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001248 }else{
drh3c194692016-04-11 16:43:43 +00001249 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001250 }
drh3c194692016-04-11 16:43:43 +00001251 }
1252
1253 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001254 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001255 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001256 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001257 pNew->pLeft = p->pLeft ?
1258 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1259 pNew->pRight = p->pRight ?
1260 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001261 }
dan67a9b8e2018-06-22 20:51:35 +00001262#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001263 if( ExprHasProperty(p, EP_WinFunc) ){
1264 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1265 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001266 }
dan67a9b8e2018-06-22 20:51:35 +00001267#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001268 if( pzBuffer ){
1269 *pzBuffer = zAlloc;
1270 }
1271 }else{
drh209bc522016-09-23 21:36:24 +00001272 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001273 if( pNew->op==TK_SELECT_COLUMN ){
1274 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001275 assert( p->iColumn==0 || p->pRight==0 );
1276 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001277 }else{
1278 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1279 }
drh3c194692016-04-11 16:43:43 +00001280 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001281 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001282 }
1283 }
1284 return pNew;
1285}
1286
1287/*
danbfe31e72014-01-15 14:17:31 +00001288** Create and return a deep copy of the object passed as the second
1289** argument. If an OOM condition is encountered, NULL is returned
1290** and the db->mallocFailed flag set.
1291*/
daneede6a52014-01-15 19:42:23 +00001292#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001293static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001294 With *pRet = 0;
1295 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001296 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001297 pRet = sqlite3DbMallocZero(db, nByte);
1298 if( pRet ){
1299 int i;
1300 pRet->nCte = p->nCte;
1301 for(i=0; i<p->nCte; i++){
1302 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1303 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1304 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1305 }
1306 }
1307 }
1308 return pRet;
1309}
daneede6a52014-01-15 19:42:23 +00001310#else
1311# define withDup(x,y) 0
1312#endif
dan4e9119d2014-01-13 15:12:23 +00001313
drha8389972018-12-06 22:04:19 +00001314#ifndef SQLITE_OMIT_WINDOWFUNC
1315/*
1316** The gatherSelectWindows() procedure and its helper routine
1317** gatherSelectWindowsCallback() are used to scan all the expressions
1318** an a newly duplicated SELECT statement and gather all of the Window
1319** objects found there, assembling them onto the linked list at Select->pWin.
1320*/
1321static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001322 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001323 Select *pSelect = pWalker->u.pSelect;
1324 Window *pWin = pExpr->y.pWin;
1325 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001326 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001327 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001328 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001329 }
1330 return WRC_Continue;
1331}
drha37b6a52018-12-06 22:12:18 +00001332static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1333 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1334}
drha8389972018-12-06 22:04:19 +00001335static void gatherSelectWindows(Select *p){
1336 Walker w;
1337 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001338 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1339 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001340 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001341 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001342 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001343}
1344#endif
1345
1346
drha76b5df2002-02-23 02:32:10 +00001347/*
drhff78bd22002-02-27 01:47:11 +00001348** The following group of routines make deep copies of expressions,
1349** expression lists, ID lists, and select statements. The copies can
1350** be deleted (by being passed to their respective ...Delete() routines)
1351** without effecting the originals.
1352**
danielk19774adee202004-05-08 08:23:19 +00001353** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1354** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001355** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001356**
drhad3cab52002-05-24 02:04:32 +00001357** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001358**
drhb7916a72009-05-27 10:31:29 +00001359** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001360** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1361** truncated version of the usual Expr structure that will be stored as
1362** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001363*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001364Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001365 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001366 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001367}
danielk19776ab3a2e2009-02-19 14:39:25 +00001368ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001369 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001370 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001371 int i;
drhb1637482017-01-03 00:27:16 +00001372 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001373 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001374 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001375 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001376 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001377 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001378 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001379 pOldItem = p->a;
1380 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001381 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001382 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001383 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001384 if( pOldExpr
1385 && pOldExpr->op==TK_SELECT_COLUMN
1386 && (pNewExpr = pItem->pExpr)!=0
1387 ){
1388 assert( pNewExpr->iColumn==0 || i>0 );
1389 if( pNewExpr->iColumn==0 ){
1390 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001391 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1392 }else{
1393 assert( i>0 );
1394 assert( pItem[-1].pExpr!=0 );
1395 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1396 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1397 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001398 }
1399 }
drh17435752007-08-16 04:30:38 +00001400 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001401 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
dan6e118922019-08-12 16:36:38 +00001402 pItem->sortFlags = pOldItem->sortFlags;
drh3e7bc9c2004-02-21 19:17:17 +00001403 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001404 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001405 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001406 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001407 }
1408 return pNew;
1409}
danielk197793758c82005-01-21 08:13:14 +00001410
1411/*
1412** If cursors, triggers, views and subqueries are all omitted from
1413** the build, then none of the following routines, except for
1414** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1415** called with a NULL argument.
1416*/
danielk19776a67fe82005-02-04 04:07:16 +00001417#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1418 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001419SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001420 SrcList *pNew;
1421 int i;
drh113088e2003-03-20 01:16:58 +00001422 int nByte;
drh575fad62016-02-05 13:38:36 +00001423 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001424 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001425 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001426 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001427 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001428 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001429 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001430 struct SrcList_item *pNewItem = &pNew->a[i];
1431 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001432 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001433 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001434 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1435 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1436 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001437 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001438 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001439 pNewItem->addrFillSub = pOldItem->addrFillSub;
1440 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001441 if( pNewItem->fg.isIndexedBy ){
1442 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1443 }
1444 pNewItem->pIBIndex = pOldItem->pIBIndex;
1445 if( pNewItem->fg.isTabFunc ){
1446 pNewItem->u1.pFuncArg =
1447 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1448 }
drhed8a3bb2005-06-06 21:19:56 +00001449 pTab = pNewItem->pTab = pOldItem->pTab;
1450 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001451 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001452 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001453 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1454 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001455 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001456 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001457 }
1458 return pNew;
1459}
drh17435752007-08-16 04:30:38 +00001460IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001461 IdList *pNew;
1462 int i;
drh575fad62016-02-05 13:38:36 +00001463 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001464 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001465 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001466 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001467 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001468 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001469 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001470 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001471 return 0;
1472 }
drh6c535152012-02-02 03:38:30 +00001473 /* Note that because the size of the allocation for p->a[] is not
1474 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1475 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001476 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001477 struct IdList_item *pNewItem = &pNew->a[i];
1478 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001479 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001480 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001481 }
1482 return pNew;
1483}
dana7466202017-02-03 14:44:52 +00001484Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1485 Select *pRet = 0;
1486 Select *pNext = 0;
1487 Select **pp = &pRet;
1488 Select *p;
1489
drh575fad62016-02-05 13:38:36 +00001490 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001491 for(p=pDup; p; p=p->pPrior){
1492 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1493 if( pNew==0 ) break;
1494 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1495 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1496 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1497 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1498 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1499 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1500 pNew->op = p->op;
1501 pNew->pNext = pNext;
1502 pNew->pPrior = 0;
1503 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001504 pNew->iLimit = 0;
1505 pNew->iOffset = 0;
1506 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1507 pNew->addrOpenEphm[0] = -1;
1508 pNew->addrOpenEphm[1] = -1;
1509 pNew->nSelectRow = p->nSelectRow;
1510 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001511#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001512 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001513 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001514 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001515#endif
drhfef37762018-07-10 19:48:35 +00001516 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001517 *pp = pNew;
1518 pp = &pNew->pPrior;
1519 pNext = pNew;
1520 }
1521
1522 return pRet;
drhff78bd22002-02-27 01:47:11 +00001523}
danielk197793758c82005-01-21 08:13:14 +00001524#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001525Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001526 assert( p==0 );
1527 return 0;
1528}
1529#endif
drhff78bd22002-02-27 01:47:11 +00001530
1531
1532/*
drha76b5df2002-02-23 02:32:10 +00001533** Add a new element to the end of an expression list. If pList is
1534** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001535**
drha19543f2017-09-15 15:17:48 +00001536** The pList argument must be either NULL or a pointer to an ExprList
1537** obtained from a prior call to sqlite3ExprListAppend(). This routine
1538** may not be used with an ExprList obtained from sqlite3ExprListDup().
1539** Reason: This routine assumes that the number of slots in pList->a[]
1540** is a power of two. That is true for sqlite3ExprListAppend() returns
1541** but is not necessarily true from the return value of sqlite3ExprListDup().
1542**
drhb7916a72009-05-27 10:31:29 +00001543** If a memory allocation error occurs, the entire list is freed and
1544** NULL is returned. If non-NULL is returned, then it is guaranteed
1545** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001546*/
drh17435752007-08-16 04:30:38 +00001547ExprList *sqlite3ExprListAppend(
1548 Parse *pParse, /* Parsing context */
1549 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001550 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001551){
drh43606172017-04-05 11:32:13 +00001552 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001553 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001554 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001555 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001556 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001557 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001558 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001559 }
drhc263f7c2016-01-18 13:18:54 +00001560 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001561 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001562 ExprList *pNew;
1563 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001564 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001565 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001566 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001567 }
drh43606172017-04-05 11:32:13 +00001568 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001569 }
drh43606172017-04-05 11:32:13 +00001570 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001571 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1572 assert( offsetof(struct ExprList_item,pExpr)==0 );
1573 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001574 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001575 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001576
1577no_mem:
1578 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001579 sqlite3ExprDelete(db, pExpr);
1580 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001581 return 0;
drha76b5df2002-02-23 02:32:10 +00001582}
1583
1584/*
drh8762ec12016-08-20 01:06:22 +00001585** pColumns and pExpr form a vector assignment which is part of the SET
1586** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001587**
1588** (a,b,c) = (expr1,expr2,expr3)
1589** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1590**
1591** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001592** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001593** TK_SELECT_COLUMN expressions.
1594*/
1595ExprList *sqlite3ExprListAppendVector(
1596 Parse *pParse, /* Parsing context */
1597 ExprList *pList, /* List to which to append. Might be NULL */
1598 IdList *pColumns, /* List of names of LHS of the assignment */
1599 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1600){
1601 sqlite3 *db = pParse->db;
1602 int n;
1603 int i;
drh66860af2016-08-23 18:30:10 +00001604 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001605 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1606 ** exit prior to this routine being invoked */
1607 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001608 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001609
1610 /* If the RHS is a vector, then we can immediately check to see that
1611 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1612 ** wildcards ("*") in the result set of the SELECT must be expanded before
1613 ** we can do the size check, so defer the size check until code generation.
1614 */
1615 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001616 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1617 pColumns->nId, n);
1618 goto vector_append_error;
1619 }
drh966e2912017-01-03 02:58:01 +00001620
1621 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001622 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1623 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1624 if( pList ){
drh66860af2016-08-23 18:30:10 +00001625 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001626 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1627 pColumns->a[i].zName = 0;
1628 }
1629 }
drh966e2912017-01-03 02:58:01 +00001630
drhffe28052017-05-06 18:09:36 +00001631 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001632 Expr *pFirst = pList->a[iFirst].pExpr;
1633 assert( pFirst!=0 );
1634 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001635
drhf4dd26c2017-04-05 11:49:06 +00001636 /* Store the SELECT statement in pRight so it will be deleted when
1637 ** sqlite3ExprListDelete() is called */
1638 pFirst->pRight = pExpr;
1639 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001640
drhf4dd26c2017-04-05 11:49:06 +00001641 /* Remember the size of the LHS in iTable so that we can check that
1642 ** the RHS and LHS sizes match during code generation. */
1643 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001644 }
1645
1646vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001647 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001648 sqlite3IdListDelete(db, pColumns);
1649 return pList;
1650}
1651
1652/*
drhbc622bc2015-08-24 15:39:42 +00001653** Set the sort order for the last element on the given ExprList.
1654*/
dan6e118922019-08-12 16:36:38 +00001655void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001656 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001657 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001658 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001659
1660 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1661 assert( iSortOrder==SQLITE_SO_UNDEFINED
1662 || iSortOrder==SQLITE_SO_ASC
1663 || iSortOrder==SQLITE_SO_DESC
1664 );
1665 assert( eNulls==SQLITE_SO_UNDEFINED
1666 || eNulls==SQLITE_SO_ASC
1667 || eNulls==SQLITE_SO_DESC
1668 );
1669
dan9105fd52019-08-19 17:26:32 +00001670 pItem = &p->a[p->nExpr-1];
1671 assert( pItem->bNulls==0 );
1672 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1673 iSortOrder = SQLITE_SO_ASC;
1674 }
1675 pItem->sortFlags = (u8)iSortOrder;
1676
1677 if( eNulls!=SQLITE_SO_UNDEFINED ){
1678 pItem->bNulls = 1;
1679 if( iSortOrder!=eNulls ){
1680 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1681 }
drhbc622bc2015-08-24 15:39:42 +00001682 }
drhbc622bc2015-08-24 15:39:42 +00001683}
1684
1685/*
drhb7916a72009-05-27 10:31:29 +00001686** Set the ExprList.a[].zName element of the most recently added item
1687** on the expression list.
1688**
1689** pList might be NULL following an OOM error. But pName should never be
1690** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1691** is set.
1692*/
1693void sqlite3ExprListSetName(
1694 Parse *pParse, /* Parsing context */
1695 ExprList *pList, /* List to which to add the span. */
1696 Token *pName, /* Name to be added */
1697 int dequote /* True to cause the name to be dequoted */
1698){
1699 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1700 if( pList ){
1701 struct ExprList_item *pItem;
1702 assert( pList->nExpr>0 );
1703 pItem = &pList->a[pList->nExpr-1];
1704 assert( pItem->zName==0 );
1705 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001706 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001707 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001708 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001709 }
drhb7916a72009-05-27 10:31:29 +00001710 }
1711}
1712
1713/*
1714** Set the ExprList.a[].zSpan element of the most recently added item
1715** on the expression list.
1716**
1717** pList might be NULL following an OOM error. But pSpan should never be
1718** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1719** is set.
1720*/
1721void sqlite3ExprListSetSpan(
1722 Parse *pParse, /* Parsing context */
1723 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001724 const char *zStart, /* Start of the span */
1725 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001726){
1727 sqlite3 *db = pParse->db;
1728 assert( pList!=0 || db->mallocFailed!=0 );
1729 if( pList ){
1730 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1731 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001732 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001733 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001734 }
1735}
1736
1737/*
danielk19777a15a4b2007-05-08 17:54:43 +00001738** If the expression list pEList contains more than iLimit elements,
1739** leave an error message in pParse.
1740*/
1741void sqlite3ExprListCheckLength(
1742 Parse *pParse,
1743 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001744 const char *zObject
1745){
drhb1a6c3c2008-03-20 16:30:17 +00001746 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001747 testcase( pEList && pEList->nExpr==mx );
1748 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001749 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001750 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1751 }
1752}
1753
1754/*
drha76b5df2002-02-23 02:32:10 +00001755** Delete an entire expression list.
1756*/
drhaffa8552016-04-11 18:25:05 +00001757static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001758 int i = pList->nExpr;
1759 struct ExprList_item *pItem = pList->a;
1760 assert( pList->nExpr>0 );
1761 do{
drh633e6d52008-07-28 19:34:53 +00001762 sqlite3ExprDelete(db, pItem->pExpr);
1763 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001764 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001765 pItem++;
1766 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001767 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001768}
drhaffa8552016-04-11 18:25:05 +00001769void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1770 if( pList ) exprListDeleteNN(db, pList);
1771}
drha76b5df2002-02-23 02:32:10 +00001772
1773/*
drh2308ed32015-02-09 16:09:34 +00001774** Return the bitwise-OR of all Expr.flags fields in the given
1775** ExprList.
drh885a5b02015-02-09 15:21:36 +00001776*/
drh2308ed32015-02-09 16:09:34 +00001777u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001778 int i;
drh2308ed32015-02-09 16:09:34 +00001779 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001780 assert( pList!=0 );
1781 for(i=0; i<pList->nExpr; i++){
1782 Expr *pExpr = pList->a[i].pExpr;
1783 assert( pExpr!=0 );
1784 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001785 }
drh2308ed32015-02-09 16:09:34 +00001786 return m;
drh885a5b02015-02-09 15:21:36 +00001787}
1788
1789/*
drh7e6f9802017-09-04 00:33:04 +00001790** This is a SELECT-node callback for the expression walker that
1791** always "fails". By "fail" in this case, we mean set
1792** pWalker->eCode to zero and abort.
1793**
1794** This callback is used by multiple expression walkers.
1795*/
1796int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1797 UNUSED_PARAMETER(NotUsed);
1798 pWalker->eCode = 0;
1799 return WRC_Abort;
1800}
1801
1802/*
drh171d16b2018-02-26 20:15:54 +00001803** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001804** then convert it into an TK_TRUEFALSE term. Return non-zero if
1805** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001806*/
1807int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1808 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001809 if( !ExprHasProperty(pExpr, EP_Quoted)
1810 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1811 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001812 ){
1813 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001814 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001815 return 1;
1816 }
1817 return 0;
1818}
1819
drh43c4ac82018-02-26 21:26:27 +00001820/*
drh96acafb2018-02-27 14:49:25 +00001821** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001822** and 0 if it is FALSE.
1823*/
drh96acafb2018-02-27 14:49:25 +00001824int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001825 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001826 assert( pExpr->op==TK_TRUEFALSE );
1827 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1828 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1829 return pExpr->u.zToken[4]==0;
1830}
1831
drh17180fc2019-04-19 17:26:19 +00001832/*
1833** If pExpr is an AND or OR expression, try to simplify it by eliminating
1834** terms that are always true or false. Return the simplified expression.
1835** Or return the original expression if no simplification is possible.
1836**
1837** Examples:
1838**
1839** (x<10) AND true => (x<10)
1840** (x<10) AND false => false
1841** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1842** (x<10) AND (y=22 OR true) => (x<10)
1843** (y=22) OR true => true
1844*/
1845Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1846 assert( pExpr!=0 );
1847 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1848 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1849 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1850 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1851 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1852 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1853 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1854 }
1855 }
1856 return pExpr;
1857}
1858
drh171d16b2018-02-26 20:15:54 +00001859
1860/*
drh059b2d52014-10-24 19:28:09 +00001861** These routines are Walker callbacks used to check expressions to
1862** see if they are "constant" for some definition of constant. The
1863** Walker.eCode value determines the type of "constant" we are looking
1864** for.
drh73b211a2005-01-18 04:00:42 +00001865**
drh7d10d5a2008-08-20 16:35:10 +00001866** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001867**
drh059b2d52014-10-24 19:28:09 +00001868** sqlite3ExprIsConstant() pWalker->eCode==1
1869** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001870** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001871** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001872**
drh059b2d52014-10-24 19:28:09 +00001873** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1874** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001875**
drhfeada2d2014-09-24 13:20:22 +00001876** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001877** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1878** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001879** parameter raises an error for new statements, but is silently converted
1880** to NULL for existing schemas. This allows sqlite_master tables that
1881** contain a bound parameter because they were generated by older versions
1882** of SQLite to be parsed by newer versions of SQLite without raising a
1883** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001884*/
drh7d10d5a2008-08-20 16:35:10 +00001885static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001886
drh059b2d52014-10-24 19:28:09 +00001887 /* If pWalker->eCode is 2 then any term of the expression that comes from
1888 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001889 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001890 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1891 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001892 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001893 }
1894
drh626a8792005-01-17 22:08:19 +00001895 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001896 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001897 ** and either pWalker->eCode==4 or 5 or the function has the
1898 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001899 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001900 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001901 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001902 }else{
1903 pWalker->eCode = 0;
1904 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001905 }
drh626a8792005-01-17 22:08:19 +00001906 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001907 /* Convert "true" or "false" in a DEFAULT clause into the
1908 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001909 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001910 return WRC_Prune;
1911 }
1912 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001913 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001914 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001915 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001916 testcase( pExpr->op==TK_ID );
1917 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001918 testcase( pExpr->op==TK_AGG_FUNCTION );
1919 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001920 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001921 return WRC_Continue;
1922 }
drh059b2d52014-10-24 19:28:09 +00001923 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1924 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001925 }
drhf43ce0b2017-05-25 00:08:48 +00001926 /* Fall through */
1927 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001928 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001929 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001930 testcase( pExpr->op==TK_IF_NULL_ROW );
1931 pWalker->eCode = 0;
1932 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001933 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001934 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001935 /* Silently convert bound parameters that appear inside of CREATE
1936 ** statements into a NULL when parsing the CREATE statement text out
1937 ** of the sqlite_master table */
1938 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001939 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001940 /* A bound parameter in a CREATE statement that originates from
1941 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001942 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001943 return WRC_Abort;
1944 }
1945 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001946 default:
drh6e341b92018-04-17 18:50:40 +00001947 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1948 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001949 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001950 }
1951}
drh059b2d52014-10-24 19:28:09 +00001952static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001953 Walker w;
drh059b2d52014-10-24 19:28:09 +00001954 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001955 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001956 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001957#ifdef SQLITE_DEBUG
1958 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1959#endif
drh059b2d52014-10-24 19:28:09 +00001960 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001961 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001962 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001963}
drh626a8792005-01-17 22:08:19 +00001964
1965/*
drh059b2d52014-10-24 19:28:09 +00001966** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001967** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001968**
1969** For the purposes of this function, a double-quoted string (ex: "abc")
1970** is considered a variable but a single-quoted string (ex: 'abc') is
1971** a constant.
drhfef52082000-06-06 01:50:43 +00001972*/
danielk19774adee202004-05-08 08:23:19 +00001973int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001974 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001975}
1976
1977/*
drh07aded62018-07-28 16:24:08 +00001978** Walk an expression tree. Return non-zero if
1979**
1980** (1) the expression is constant, and
1981** (2) the expression does originate in the ON or USING clause
1982** of a LEFT JOIN, and
1983** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1984** operands created by the constant propagation optimization.
1985**
1986** When this routine returns true, it indicates that the expression
1987** can be added to the pParse->pConstExpr list and evaluated once when
1988** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001989*/
1990int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001991 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001992}
1993
1994/*
drhfcb9f4f2015-06-01 18:13:16 +00001995** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001996** for any single row of the table with cursor iCur. In other words, the
1997** expression must not refer to any non-deterministic function nor any
1998** table other than iCur.
1999*/
2000int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2001 return exprIsConst(p, 3, iCur);
2002}
2003
danab31a842017-04-29 20:53:09 +00002004
2005/*
2006** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2007*/
2008static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2009 ExprList *pGroupBy = pWalker->u.pGroupBy;
2010 int i;
2011
2012 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2013 ** it constant. */
2014 for(i=0; i<pGroupBy->nExpr; i++){
2015 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002016 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002017 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002018 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002019 return WRC_Prune;
2020 }
2021 }
2022 }
2023
2024 /* Check if pExpr is a sub-select. If so, consider it variable. */
2025 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2026 pWalker->eCode = 0;
2027 return WRC_Abort;
2028 }
2029
2030 return exprNodeIsConstant(pWalker, pExpr);
2031}
2032
2033/*
2034** Walk the expression tree passed as the first argument. Return non-zero
2035** if the expression consists entirely of constants or copies of terms
2036** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002037**
2038** This routine is used to determine if a term of the HAVING clause can
2039** be promoted into the WHERE clause. In order for such a promotion to work,
2040** the value of the HAVING clause term must be the same for all members of
2041** a "group". The requirement that the GROUP BY term must be BINARY
2042** assumes that no other collating sequence will have a finer-grained
2043** grouping than binary. In other words (A=B COLLATE binary) implies
2044** A=B in every other collating sequence. The requirement that the
2045** GROUP BY be BINARY is stricter than necessary. It would also work
2046** to promote HAVING clauses that use the same alternative collating
2047** sequence as the GROUP BY term, but that is much harder to check,
2048** alternative collating sequences are uncommon, and this is only an
2049** optimization, so we take the easy way out and simply require the
2050** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002051*/
2052int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2053 Walker w;
danab31a842017-04-29 20:53:09 +00002054 w.eCode = 1;
2055 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002056 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002057 w.u.pGroupBy = pGroupBy;
2058 w.pParse = pParse;
2059 sqlite3WalkExpr(&w, p);
2060 return w.eCode;
2061}
2062
drh059b2d52014-10-24 19:28:09 +00002063/*
2064** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002065** or a function call with constant arguments. Return and 0 if there
2066** are any variables.
2067**
2068** For the purposes of this function, a double-quoted string (ex: "abc")
2069** is considered a variable but a single-quoted string (ex: 'abc') is
2070** a constant.
2071*/
drhfeada2d2014-09-24 13:20:22 +00002072int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2073 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002074 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002075}
2076
drh5b88bc42013-12-07 23:35:21 +00002077#ifdef SQLITE_ENABLE_CURSOR_HINTS
2078/*
2079** Walk an expression tree. Return 1 if the expression contains a
2080** subquery of some kind. Return 0 if there are no subqueries.
2081*/
2082int sqlite3ExprContainsSubquery(Expr *p){
2083 Walker w;
drhbec24762015-08-13 20:07:13 +00002084 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002085 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002086 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002087#ifdef SQLITE_DEBUG
2088 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2089#endif
drh5b88bc42013-12-07 23:35:21 +00002090 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002091 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002092}
2093#endif
2094
drheb55bd22005-06-30 17:04:21 +00002095/*
drh73b211a2005-01-18 04:00:42 +00002096** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002097** to fit in a 32-bit integer, return 1 and put the value of the integer
2098** in *pValue. If the expression is not an integer or if it is too big
2099** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002100*/
danielk19774adee202004-05-08 08:23:19 +00002101int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002102 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002103 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002104
2105 /* If an expression is an integer literal that fits in a signed 32-bit
2106 ** integer, then the EP_IntValue flag will have already been set */
2107 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2108 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2109
drh92b01d52008-06-24 00:32:35 +00002110 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002111 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002112 return 1;
2113 }
drhe4de1fe2002-06-02 16:09:01 +00002114 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002115 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002116 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002117 break;
drh4b59ab52002-08-24 18:24:51 +00002118 }
drhe4de1fe2002-06-02 16:09:01 +00002119 case TK_UMINUS: {
2120 int v;
danielk19774adee202004-05-08 08:23:19 +00002121 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002122 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002123 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002124 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002125 }
2126 break;
2127 }
2128 default: break;
2129 }
drh92b01d52008-06-24 00:32:35 +00002130 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002131}
2132
2133/*
drh039fc322009-11-17 18:31:47 +00002134** Return FALSE if there is no chance that the expression can be NULL.
2135**
2136** If the expression might be NULL or if the expression is too complex
2137** to tell return TRUE.
2138**
2139** This routine is used as an optimization, to skip OP_IsNull opcodes
2140** when we know that a value cannot be NULL. Hence, a false positive
2141** (returning TRUE when in fact the expression can never be NULL) might
2142** be a small performance hit but is otherwise harmless. On the other
2143** hand, a false negative (returning FALSE when the result could be NULL)
2144** will likely result in an incorrect answer. So when in doubt, return
2145** TRUE.
2146*/
2147int sqlite3ExprCanBeNull(const Expr *p){
2148 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002149 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2150 p = p->pLeft;
2151 }
drh039fc322009-11-17 18:31:47 +00002152 op = p->op;
2153 if( op==TK_REGISTER ) op = p->op2;
2154 switch( op ){
2155 case TK_INTEGER:
2156 case TK_STRING:
2157 case TK_FLOAT:
2158 case TK_BLOB:
2159 return 0;
drh7248a8b2014-08-04 18:50:54 +00002160 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002161 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002162 p->y.pTab==0 || /* Reference to column of index on expression */
2163 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002164 default:
2165 return 1;
2166 }
2167}
2168
2169/*
2170** Return TRUE if the given expression is a constant which would be
2171** unchanged by OP_Affinity with the affinity given in the second
2172** argument.
2173**
2174** This routine is used to determine if the OP_Affinity operation
2175** can be omitted. When in doubt return FALSE. A false negative
2176** is harmless. A false positive, however, can result in the wrong
2177** answer.
2178*/
2179int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2180 u8 op;
drh05883a32015-06-02 15:32:08 +00002181 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002182 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002183 op = p->op;
2184 if( op==TK_REGISTER ) op = p->op2;
2185 switch( op ){
2186 case TK_INTEGER: {
2187 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2188 }
2189 case TK_FLOAT: {
2190 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2191 }
2192 case TK_STRING: {
2193 return aff==SQLITE_AFF_TEXT;
2194 }
2195 case TK_BLOB: {
2196 return 1;
2197 }
drh2f2855b2009-11-18 01:25:26 +00002198 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002199 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2200 return p->iColumn<0
2201 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002202 }
drh039fc322009-11-17 18:31:47 +00002203 default: {
2204 return 0;
2205 }
2206 }
2207}
2208
2209/*
drhc4a3c772001-04-04 11:48:57 +00002210** Return TRUE if the given string is a row-id column name.
2211*/
danielk19774adee202004-05-08 08:23:19 +00002212int sqlite3IsRowid(const char *z){
2213 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2214 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2215 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002216 return 0;
2217}
2218
danielk19779a96b662007-11-29 17:05:18 +00002219/*
drh69c355b2016-03-09 15:34:51 +00002220** pX is the RHS of an IN operator. If pX is a SELECT statement
2221** that can be simplified to a direct table access, then return
2222** a pointer to the SELECT statement. If pX is not a SELECT statement,
2223** or if the SELECT statement needs to be manifested into a transient
2224** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002225*/
2226#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002227static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002228 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002229 SrcList *pSrc;
2230 ExprList *pEList;
2231 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002232 int i;
drh69c355b2016-03-09 15:34:51 +00002233 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2234 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2235 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002236 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002237 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002238 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2239 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2240 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002241 }
drhb74b1012009-05-28 21:04:37 +00002242 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002243 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002244 if( p->pWhere ) return 0; /* Has no WHERE clause */
2245 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002246 assert( pSrc!=0 );
2247 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002248 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002249 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002250 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002251 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002252 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2253 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002254 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002255 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002256 for(i=0; i<pEList->nExpr; i++){
2257 Expr *pRes = pEList->a[i].pExpr;
2258 if( pRes->op!=TK_COLUMN ) return 0;
2259 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002260 }
drh69c355b2016-03-09 15:34:51 +00002261 return p;
drhb287f4b2008-04-25 00:08:38 +00002262}
2263#endif /* SQLITE_OMIT_SUBQUERY */
2264
danf9b2e052016-08-02 17:45:00 +00002265#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002266/*
drh4c259e92014-08-01 21:12:35 +00002267** Generate code that checks the left-most column of index table iCur to see if
2268** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002269** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2270** to be set to NULL if iCur contains one or more NULL values.
2271*/
2272static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002273 int addr1;
drh6be515e2014-08-01 21:00:53 +00002274 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002275 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002276 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2277 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002278 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002279 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002280}
danf9b2e052016-08-02 17:45:00 +00002281#endif
drh6be515e2014-08-01 21:00:53 +00002282
drhbb53ecb2014-08-02 21:03:33 +00002283
2284#ifndef SQLITE_OMIT_SUBQUERY
2285/*
2286** The argument is an IN operator with a list (not a subquery) on the
2287** right-hand side. Return TRUE if that list is constant.
2288*/
2289static int sqlite3InRhsIsConstant(Expr *pIn){
2290 Expr *pLHS;
2291 int res;
2292 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2293 pLHS = pIn->pLeft;
2294 pIn->pLeft = 0;
2295 res = sqlite3ExprIsConstant(pIn);
2296 pIn->pLeft = pLHS;
2297 return res;
2298}
2299#endif
2300
drh6be515e2014-08-01 21:00:53 +00002301/*
danielk19779a96b662007-11-29 17:05:18 +00002302** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002303** The pX parameter is the expression on the RHS of the IN operator, which
2304** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002305**
drhd4305ca2012-09-18 17:08:33 +00002306** The job of this routine is to find or create a b-tree object that can
2307** be used either to test for membership in the RHS set or to iterate through
2308** all members of the RHS set, skipping duplicates.
2309**
drh3a856252014-08-01 14:46:57 +00002310** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002311** and pX->iTable is set to the index of that cursor.
2312**
drhb74b1012009-05-28 21:04:37 +00002313** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002314**
drh1ccce442013-03-12 20:38:51 +00002315** IN_INDEX_ROWID - The cursor was opened on a database table.
2316** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2317** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2318** IN_INDEX_EPH - The cursor was opened on a specially created and
2319** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002320** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2321** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002322**
drhd4305ca2012-09-18 17:08:33 +00002323** An existing b-tree might be used if the RHS expression pX is a simple
2324** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002325**
dan553168c2016-08-01 20:14:31 +00002326** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002327**
drhd4305ca2012-09-18 17:08:33 +00002328** If the RHS of the IN operator is a list or a more complex subquery, then
2329** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002330** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002331** existing table.
drhd4305ca2012-09-18 17:08:33 +00002332**
drh7fc0ba02017-11-17 15:02:00 +00002333** The inFlags parameter must contain, at a minimum, one of the bits
2334** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2335** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2336** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2337** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002338**
2339** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2340** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002341** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002342** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2343** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002344**
drh3a856252014-08-01 14:46:57 +00002345** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2346** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002347** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2348** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002349**
drhbb53ecb2014-08-02 21:03:33 +00002350** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2351** if the RHS of the IN operator is a list (not a subquery) then this
2352** routine might decide that creating an ephemeral b-tree for membership
2353** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2354** calling routine should implement the IN operator using a sequence
2355** of Eq or Ne comparison operations.
2356**
drhb74b1012009-05-28 21:04:37 +00002357** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002358** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002359** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002360** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002361** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002362** to *prRhsHasNull. If there is no chance that the (...) contains a
2363** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002364**
drhe21a6e12014-08-01 18:00:24 +00002365** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002366** the value in that register will be NULL if the b-tree contains one or more
2367** NULL values, and it will be some non-NULL value if the b-tree contains no
2368** NULL values.
dan553168c2016-08-01 20:14:31 +00002369**
2370** If the aiMap parameter is not NULL, it must point to an array containing
2371** one element for each column returned by the SELECT statement on the RHS
2372** of the IN(...) operator. The i'th entry of the array is populated with the
2373** offset of the index column that matches the i'th column returned by the
2374** SELECT. For example, if the expression and selected index are:
2375**
2376** (?,?,?) IN (SELECT a, b, c FROM t1)
2377** CREATE INDEX i1 ON t1(b, c, a);
2378**
2379** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002380*/
danielk1977284f4ac2007-12-10 05:03:46 +00002381#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002382int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002383 Parse *pParse, /* Parsing context */
2384 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2385 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2386 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002387 int *aiMap, /* Mapping from Index fields to RHS fields */
2388 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002389){
drhb74b1012009-05-28 21:04:37 +00002390 Select *p; /* SELECT to the right of IN operator */
2391 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2392 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002393 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002394 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002395
drh1450bc62009-10-30 13:25:56 +00002396 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002397 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002398
dan7b35a772016-07-28 19:47:15 +00002399 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2400 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002401 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002402 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002403 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002404 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2405 int i;
2406 ExprList *pEList = pX->x.pSelect->pEList;
2407 for(i=0; i<pEList->nExpr; i++){
2408 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2409 }
2410 if( i==pEList->nExpr ){
2411 prRhsHasNull = 0;
2412 }
2413 }
2414
drhb74b1012009-05-28 21:04:37 +00002415 /* Check to see if an existing table or index can be used to
2416 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002417 ** ephemeral table. */
2418 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002419 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002420 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002421 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002422 ExprList *pEList = p->pEList;
2423 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002424
drhb07028f2011-10-14 21:49:18 +00002425 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2426 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2427 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2428 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002429
drhb22f7c82014-02-06 23:56:27 +00002430 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002431 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2432 sqlite3CodeVerifySchema(pParse, iDb);
2433 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002434
drha84a2832016-08-26 21:15:35 +00002435 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002436 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002437 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002438 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002439 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002440
2441 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2442 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002443 ExplainQueryPlan((pParse, 0,
2444 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002445 sqlite3VdbeJumpHere(v, iAddr);
2446 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002447 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002448 int affinity_ok = 1;
2449 int i;
2450
2451 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002452 ** comparison is the same as the affinity of each column in table
2453 ** on the RHS of the IN operator. If it not, it is not possible to
2454 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002455 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002456 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002457 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002458 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002459 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002460 testcase( cmpaff==SQLITE_AFF_BLOB );
2461 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002462 switch( cmpaff ){
2463 case SQLITE_AFF_BLOB:
2464 break;
2465 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002466 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2467 ** other has no affinity and the other side is TEXT. Hence,
2468 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2469 ** and for the term on the LHS of the IN to have no affinity. */
2470 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002471 break;
2472 default:
2473 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2474 }
2475 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002476
drha84a2832016-08-26 21:15:35 +00002477 if( affinity_ok ){
2478 /* Search for an existing index that will work for this IN operator */
2479 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2480 Bitmask colUsed; /* Columns of the index used */
2481 Bitmask mCol; /* Mask for the current column */
2482 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002483 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002484 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2485 ** BITMASK(nExpr) without overflowing */
2486 testcase( pIdx->nColumn==BMS-2 );
2487 testcase( pIdx->nColumn==BMS-1 );
2488 if( pIdx->nColumn>=BMS-1 ) continue;
2489 if( mustBeUnique ){
2490 if( pIdx->nKeyCol>nExpr
2491 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2492 ){
2493 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002494 }
danielk19770cdc0222008-06-26 18:04:03 +00002495 }
drha84a2832016-08-26 21:15:35 +00002496
2497 colUsed = 0; /* Columns of index used so far */
2498 for(i=0; i<nExpr; i++){
2499 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2500 Expr *pRhs = pEList->a[i].pExpr;
2501 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2502 int j;
2503
2504 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2505 for(j=0; j<nExpr; j++){
2506 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2507 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002508 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2509 continue;
2510 }
drha84a2832016-08-26 21:15:35 +00002511 break;
2512 }
2513 if( j==nExpr ) break;
2514 mCol = MASKBIT(j);
2515 if( mCol & colUsed ) break; /* Each column used only once */
2516 colUsed |= mCol;
2517 if( aiMap ) aiMap[i] = j;
2518 }
2519
2520 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2521 if( colUsed==(MASKBIT(nExpr)-1) ){
2522 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002523 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002524 ExplainQueryPlan((pParse, 0,
2525 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002526 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2527 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2528 VdbeComment((v, "%s", pIdx->zName));
2529 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2530 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2531
2532 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002533#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002534 i64 mask = (1<<nExpr)-1;
2535 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2536 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002537#endif
2538 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002539 if( nExpr==1 ){
2540 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2541 }
2542 }
2543 sqlite3VdbeJumpHere(v, iAddr);
2544 }
2545 } /* End loop over indexes */
2546 } /* End if( affinity_ok ) */
2547 } /* End if not an rowid index */
2548 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002549
drhbb53ecb2014-08-02 21:03:33 +00002550 /* If no preexisting index is available for the IN clause
2551 ** and IN_INDEX_NOOP is an allowed reply
2552 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002553 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002554 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002555 ** the IN operator so return IN_INDEX_NOOP.
2556 */
2557 if( eType==0
2558 && (inFlags & IN_INDEX_NOOP_OK)
2559 && !ExprHasProperty(pX, EP_xIsSelect)
2560 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2561 ){
2562 eType = IN_INDEX_NOOP;
2563 }
drhbb53ecb2014-08-02 21:03:33 +00002564
danielk19779a96b662007-11-29 17:05:18 +00002565 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002566 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002567 ** We will have to generate an ephemeral table to do the job.
2568 */
drh8e23daf2013-06-11 13:30:04 +00002569 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002570 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002571 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002572 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002573 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002574 }else if( prRhsHasNull ){
2575 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002576 }
drh85bcdce2018-12-23 21:27:29 +00002577 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002578 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002579 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002580 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002581 }
drhcf4d38a2010-07-28 02:53:36 +00002582 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002583 }
danba00e302016-07-23 20:24:06 +00002584
2585 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2586 int i, n;
2587 n = sqlite3ExprVectorSize(pX->pLeft);
2588 for(i=0; i<n; i++) aiMap[i] = i;
2589 }
drh2c041312018-12-24 02:34:49 +00002590 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002591 return eType;
2592}
danielk1977284f4ac2007-12-10 05:03:46 +00002593#endif
drh626a8792005-01-17 22:08:19 +00002594
danf9b2e052016-08-02 17:45:00 +00002595#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002596/*
2597** Argument pExpr is an (?, ?...) IN(...) expression. This
2598** function allocates and returns a nul-terminated string containing
2599** the affinities to be used for each column of the comparison.
2600**
2601** It is the responsibility of the caller to ensure that the returned
2602** string is eventually freed using sqlite3DbFree().
2603*/
dan71c57db2016-07-09 20:23:55 +00002604static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2605 Expr *pLeft = pExpr->pLeft;
2606 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002607 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002608 char *zRet;
2609
dan553168c2016-08-01 20:14:31 +00002610 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002611 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002612 if( zRet ){
2613 int i;
2614 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002615 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002616 char a = sqlite3ExprAffinity(pA);
2617 if( pSelect ){
2618 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2619 }else{
2620 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002621 }
dan71c57db2016-07-09 20:23:55 +00002622 }
2623 zRet[nVal] = '\0';
2624 }
2625 return zRet;
2626}
danf9b2e052016-08-02 17:45:00 +00002627#endif
dan71c57db2016-07-09 20:23:55 +00002628
dan8da209b2016-07-26 18:06:08 +00002629#ifndef SQLITE_OMIT_SUBQUERY
2630/*
2631** Load the Parse object passed as the first argument with an error
2632** message of the form:
2633**
2634** "sub-select returns N columns - expected M"
2635*/
2636void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2637 const char *zFmt = "sub-select returns %d columns - expected %d";
2638 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2639}
2640#endif
2641
drh626a8792005-01-17 22:08:19 +00002642/*
dan44c56042016-12-07 15:38:37 +00002643** Expression pExpr is a vector that has been used in a context where
2644** it is not permitted. If pExpr is a sub-select vector, this routine
2645** loads the Parse object with a message of the form:
2646**
2647** "sub-select returns N columns - expected 1"
2648**
2649** Or, if it is a regular scalar vector:
2650**
2651** "row value misused"
2652*/
2653void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2654#ifndef SQLITE_OMIT_SUBQUERY
2655 if( pExpr->flags & EP_xIsSelect ){
2656 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2657 }else
2658#endif
2659 {
2660 sqlite3ErrorMsg(pParse, "row value misused");
2661 }
2662}
2663
drh85bcdce2018-12-23 21:27:29 +00002664#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002665/*
drh85bcdce2018-12-23 21:27:29 +00002666** Generate code that will construct an ephemeral table containing all terms
2667** in the RHS of an IN operator. The IN operator can be in either of two
2668** forms:
drh626a8792005-01-17 22:08:19 +00002669**
drh9cbe6352005-11-29 03:13:21 +00002670** x IN (4,5,11) -- IN operator with list on right-hand side
2671** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002672**
drh2c041312018-12-24 02:34:49 +00002673** The pExpr parameter is the IN operator. The cursor number for the
2674** constructed ephermeral table is returned. The first time the ephemeral
2675** table is computed, the cursor number is also stored in pExpr->iTable,
2676** however the cursor number returned might not be the same, as it might
2677** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002678**
drh85bcdce2018-12-23 21:27:29 +00002679** If the LHS expression ("x" in the examples) is a column value, or
2680** the SELECT statement returns a column value, then the affinity of that
2681** column is used to build the index keys. If both 'x' and the
2682** SELECT... statement are columns, then numeric affinity is used
2683** if either column has NUMERIC or INTEGER affinity. If neither
2684** 'x' nor the SELECT... statement are columns, then numeric affinity
2685** is used.
drhcce7d172000-05-31 15:34:51 +00002686*/
drh85bcdce2018-12-23 21:27:29 +00002687void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002688 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002689 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002690 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002691){
drh2c041312018-12-24 02:34:49 +00002692 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002693 int addr; /* Address of OP_OpenEphemeral instruction */
2694 Expr *pLeft; /* the LHS of the IN operator */
2695 KeyInfo *pKeyInfo = 0; /* Key information */
2696 int nVal; /* Size of vector pLeft */
2697 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002698
drh2c041312018-12-24 02:34:49 +00002699 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002700 assert( v!=0 );
2701
drh2c041312018-12-24 02:34:49 +00002702 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002703 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002704 **
2705 ** * The right-hand side is a correlated subquery
2706 ** * The right-hand side is an expression list containing variables
2707 ** * We are inside a trigger
2708 **
drh2c041312018-12-24 02:34:49 +00002709 ** If all of the above are false, then we can compute the RHS just once
2710 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002711 */
drhefb699f2018-12-24 11:55:44 +00002712 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002713 /* Reuse of the RHS is allowed */
2714 /* If this routine has already been coded, but the previous code
2715 ** might not have been invoked yet, so invoke it now as a subroutine.
2716 */
2717 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002718 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002719 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2720 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2721 pExpr->x.pSelect->selId));
2722 }
drh2c041312018-12-24 02:34:49 +00002723 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2724 pExpr->y.sub.iAddr);
2725 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002726 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002727 return;
2728 }
2729
2730 /* Begin coding the subroutine */
2731 ExprSetProperty(pExpr, EP_Subrtn);
2732 pExpr->y.sub.regReturn = ++pParse->nMem;
2733 pExpr->y.sub.iAddr =
2734 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2735 VdbeComment((v, "return address"));
2736
2737 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002738 }
2739
drh85bcdce2018-12-23 21:27:29 +00002740 /* Check to see if this is a vector IN operator */
2741 pLeft = pExpr->pLeft;
2742 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002743
drh85bcdce2018-12-23 21:27:29 +00002744 /* Construct the ephemeral table that will contain the content of
2745 ** RHS of the IN operator.
2746 */
drh2c041312018-12-24 02:34:49 +00002747 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002748 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002749#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2750 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2751 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2752 }else{
2753 VdbeComment((v, "RHS of IN operator"));
2754 }
2755#endif
drh50ef6712019-02-22 23:29:56 +00002756 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002757
drh85bcdce2018-12-23 21:27:29 +00002758 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2759 /* Case 1: expr IN (SELECT ...)
2760 **
2761 ** Generate code to write the results of the select into the temporary
2762 ** table allocated and opened above.
2763 */
2764 Select *pSelect = pExpr->x.pSelect;
2765 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002766
drh2c041312018-12-24 02:34:49 +00002767 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2768 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002769 ));
drh85bcdce2018-12-23 21:27:29 +00002770 /* If the LHS and RHS of the IN operator do not match, that
2771 ** error will have been caught long before we reach this point. */
2772 if( ALWAYS(pEList->nExpr==nVal) ){
2773 SelectDest dest;
2774 int i;
drhbd462bc2018-12-24 20:21:06 +00002775 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002776 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2777 pSelect->iLimit = 0;
2778 testcase( pSelect->selFlags & SF_Distinct );
2779 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2780 if( sqlite3Select(pParse, pSelect, &dest) ){
2781 sqlite3DbFree(pParse->db, dest.zAffSdst);
2782 sqlite3KeyInfoUnref(pKeyInfo);
2783 return;
drhfef52082000-06-06 01:50:43 +00002784 }
drh85bcdce2018-12-23 21:27:29 +00002785 sqlite3DbFree(pParse->db, dest.zAffSdst);
2786 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2787 assert( pEList!=0 );
2788 assert( pEList->nExpr>0 );
2789 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2790 for(i=0; i<nVal; i++){
2791 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2792 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2793 pParse, p, pEList->a[i].pExpr
2794 );
danielk197741a05b72008-10-02 13:50:55 +00002795 }
drh85bcdce2018-12-23 21:27:29 +00002796 }
2797 }else if( ALWAYS(pExpr->x.pList!=0) ){
2798 /* Case 2: expr IN (exprlist)
2799 **
2800 ** For each expression, build an index key from the evaluation and
2801 ** store it in the temporary table. If <expr> is a column, then use
2802 ** that columns affinity when building index keys. If <expr> is not
2803 ** a column, use numeric affinity.
2804 */
2805 char affinity; /* Affinity of the LHS of the IN */
2806 int i;
2807 ExprList *pList = pExpr->x.pList;
2808 struct ExprList_item *pItem;
2809 int r1, r2, r3;
2810 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002811 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002812 affinity = SQLITE_AFF_BLOB;
2813 }
2814 if( pKeyInfo ){
2815 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2816 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002817 }
2818
drh85bcdce2018-12-23 21:27:29 +00002819 /* Loop through each expression in <exprlist>. */
2820 r1 = sqlite3GetTempReg(pParse);
2821 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002822 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2823 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002824
2825 /* If the expression is not constant then we will need to
2826 ** disable the test that was generated above that makes sure
2827 ** this code only executes once. Because for a non-constant
2828 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002829 */
drh2c041312018-12-24 02:34:49 +00002830 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2831 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002832 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002833 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002834 }
drh1398ad32005-01-19 23:24:50 +00002835
drh85bcdce2018-12-23 21:27:29 +00002836 /* Evaluate the expression and insert it into the temp table */
drh50ef6712019-02-22 23:29:56 +00002837 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2838 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2839 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drhcce7d172000-05-31 15:34:51 +00002840 }
drh85bcdce2018-12-23 21:27:29 +00002841 sqlite3ReleaseTempReg(pParse, r1);
2842 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002843 }
drh85bcdce2018-12-23 21:27:29 +00002844 if( pKeyInfo ){
2845 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2846 }
drh2c041312018-12-24 02:34:49 +00002847 if( addrOnce ){
2848 sqlite3VdbeJumpHere(v, addrOnce);
2849 /* Subroutine return */
2850 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2851 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002852 }
2853}
2854#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002855
drh85bcdce2018-12-23 21:27:29 +00002856/*
2857** Generate code for scalar subqueries used as a subquery expression
2858** or EXISTS operator:
2859**
2860** (SELECT a FROM b) -- subquery
2861** EXISTS (SELECT a FROM b) -- EXISTS subquery
2862**
2863** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2864**
2865** The register that holds the result. For a multi-column SELECT,
2866** the result is stored in a contiguous array of registers and the
2867** return value is the register of the left-most result column.
2868** Return 0 if an error occurs.
2869*/
2870#ifndef SQLITE_OMIT_SUBQUERY
2871int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002872 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002873 int rReg = 0; /* Register storing resulting */
2874 Select *pSel; /* SELECT statement to encode */
2875 SelectDest dest; /* How to deal with SELECT result */
2876 int nReg; /* Registers to allocate */
2877 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002878
2879 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002880 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002881 testcase( pExpr->op==TK_EXISTS );
2882 testcase( pExpr->op==TK_SELECT );
2883 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2884 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2885 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002886
drh5198ff52018-12-24 12:09:47 +00002887 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002888 ** is encountered if any of the following is true:
2889 **
2890 ** * The right-hand side is a correlated subquery
2891 ** * The right-hand side is an expression list containing variables
2892 ** * We are inside a trigger
2893 **
2894 ** If all of the above are false, then we can run this code just once
2895 ** save the results, and reuse the same result on subsequent invocations.
2896 */
2897 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002898 /* If this routine has already been coded, then invoke it as a
2899 ** subroutine. */
2900 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002901 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002902 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2903 pExpr->y.sub.iAddr);
2904 return pExpr->iTable;
2905 }
2906
2907 /* Begin coding the subroutine */
2908 ExprSetProperty(pExpr, EP_Subrtn);
2909 pExpr->y.sub.regReturn = ++pParse->nMem;
2910 pExpr->y.sub.iAddr =
2911 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2912 VdbeComment((v, "return address"));
2913
drh2c041312018-12-24 02:34:49 +00002914 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002915 }
drh85bcdce2018-12-23 21:27:29 +00002916
2917 /* For a SELECT, generate code to put the values for all columns of
2918 ** the first row into an array of registers and return the index of
2919 ** the first register.
2920 **
2921 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2922 ** into a register and return that register number.
2923 **
2924 ** In both cases, the query is augmented with "LIMIT 1". Any
2925 ** preexisting limit is discarded in place of the new LIMIT 1.
2926 */
drhbd462bc2018-12-24 20:21:06 +00002927 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2928 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002929 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2930 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2931 pParse->nMem += nReg;
2932 if( pExpr->op==TK_SELECT ){
2933 dest.eDest = SRT_Mem;
2934 dest.iSdst = dest.iSDParm;
2935 dest.nSdst = nReg;
2936 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2937 VdbeComment((v, "Init subquery result"));
2938 }else{
2939 dest.eDest = SRT_Exists;
2940 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2941 VdbeComment((v, "Init EXISTS result"));
2942 }
2943 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2944 if( pSel->pLimit ){
2945 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2946 pSel->pLimit->pLeft = pLimit;
2947 }else{
2948 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2949 }
2950 pSel->iLimit = 0;
2951 if( sqlite3Select(pParse, pSel, &dest) ){
2952 return 0;
2953 }
drh2c041312018-12-24 02:34:49 +00002954 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002955 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002956 if( addrOnce ){
2957 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002958
drh5198ff52018-12-24 12:09:47 +00002959 /* Subroutine return */
2960 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2961 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2962 }
drh2c041312018-12-24 02:34:49 +00002963
drh1450bc62009-10-30 13:25:56 +00002964 return rReg;
drhcce7d172000-05-31 15:34:51 +00002965}
drh51522cd2005-01-20 13:36:19 +00002966#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002967
drhe3365e62009-11-12 17:52:24 +00002968#ifndef SQLITE_OMIT_SUBQUERY
2969/*
dan7b35a772016-07-28 19:47:15 +00002970** Expr pIn is an IN(...) expression. This function checks that the
2971** sub-select on the RHS of the IN() operator has the same number of
2972** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2973** a sub-query, that the LHS is a vector of size 1.
2974*/
2975int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2976 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2977 if( (pIn->flags & EP_xIsSelect) ){
2978 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2979 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2980 return 1;
2981 }
2982 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002983 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002984 return 1;
2985 }
2986 return 0;
2987}
2988#endif
2989
2990#ifndef SQLITE_OMIT_SUBQUERY
2991/*
drhe3365e62009-11-12 17:52:24 +00002992** Generate code for an IN expression.
2993**
2994** x IN (SELECT ...)
2995** x IN (value, value, ...)
2996**
drhecb87ac2016-08-25 15:46:25 +00002997** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002998** right-hand side (RHS) is an array of zero or more scalar values, or a
2999** subquery. If the RHS is a subquery, the number of result columns must
3000** match the number of columns in the vector on the LHS. If the RHS is
3001** a list of values, the LHS must be a scalar.
3002**
3003** The IN operator is true if the LHS value is contained within the RHS.
3004** The result is false if the LHS is definitely not in the RHS. The
3005** result is NULL if the presence of the LHS in the RHS cannot be
3006** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003007**
drh6be515e2014-08-01 21:00:53 +00003008** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003009** contained within the RHS. If due to NULLs we cannot determine if the LHS
3010** is contained in the RHS then jump to destIfNull. If the LHS is contained
3011** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003012**
3013** See the separate in-operator.md documentation file in the canonical
3014** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003015*/
3016static void sqlite3ExprCodeIN(
3017 Parse *pParse, /* Parsing and code generating context */
3018 Expr *pExpr, /* The IN expression */
3019 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3020 int destIfNull /* Jump here if the results are unknown due to NULLs */
3021){
3022 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003023 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003024 int rLhs; /* Register(s) holding the LHS values */
3025 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003026 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003027 int *aiMap = 0; /* Map from vector field to index column */
3028 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003029 int nVector; /* Size of vectors for this IN operator */
3030 int iDummy; /* Dummy parameter to exprCodeVector() */
3031 Expr *pLeft; /* The LHS of the IN operator */
3032 int i; /* loop counter */
3033 int destStep2; /* Where to jump when NULLs seen in step 2 */
3034 int destStep6 = 0; /* Start of code for Step 6 */
3035 int addrTruthOp; /* Address of opcode that determines the IN is true */
3036 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3037 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003038 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003039
drhe347d3e2016-08-25 21:14:34 +00003040 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003041 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003042 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003043 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3044 aiMap = (int*)sqlite3DbMallocZero(
3045 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3046 );
drhe347d3e2016-08-25 21:14:34 +00003047 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003048
danba00e302016-07-23 20:24:06 +00003049 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003050 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003051 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3052 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003053 v = pParse->pVdbe;
3054 assert( v!=0 ); /* OOM detected prior to this routine */
3055 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003056 eType = sqlite3FindInIndex(pParse, pExpr,
3057 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003058 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3059 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003060
danba00e302016-07-23 20:24:06 +00003061 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3062 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3063 );
drhecb87ac2016-08-25 15:46:25 +00003064#ifdef SQLITE_DEBUG
3065 /* Confirm that aiMap[] contains nVector integer values between 0 and
3066 ** nVector-1. */
3067 for(i=0; i<nVector; i++){
3068 int j, cnt;
3069 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3070 assert( cnt==1 );
3071 }
3072#endif
drhe3365e62009-11-12 17:52:24 +00003073
danba00e302016-07-23 20:24:06 +00003074 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3075 ** vector, then it is stored in an array of nVector registers starting
3076 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003077 **
3078 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3079 ** so that the fields are in the same order as an existing index. The
3080 ** aiMap[] array contains a mapping from the original LHS field order to
3081 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003082 */
drhe347d3e2016-08-25 21:14:34 +00003083 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3084 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003085 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003086 /* LHS fields are not reordered */
3087 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003088 }else{
3089 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003090 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003091 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003092 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003093 }
danba00e302016-07-23 20:24:06 +00003094 }
drhe3365e62009-11-12 17:52:24 +00003095
drhbb53ecb2014-08-02 21:03:33 +00003096 /* If sqlite3FindInIndex() did not find or create an index that is
3097 ** suitable for evaluating the IN operator, then evaluate using a
3098 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003099 **
3100 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003101 */
drhbb53ecb2014-08-02 21:03:33 +00003102 if( eType==IN_INDEX_NOOP ){
3103 ExprList *pList = pExpr->x.pList;
3104 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003105 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003106 int r2, regToFree;
3107 int regCkNull = 0;
3108 int ii;
3109 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003110 if( destIfNull!=destIfFalse ){
3111 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003112 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003113 }
3114 for(ii=0; ii<pList->nExpr; ii++){
3115 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003116 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003117 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3118 }
3119 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003120 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003121 (void*)pColl, P4_COLLSEQ);
3122 VdbeCoverageIf(v, ii<pList->nExpr-1);
3123 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003124 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003125 }else{
3126 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003127 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003128 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003129 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003130 }
3131 sqlite3ReleaseTempReg(pParse, regToFree);
3132 }
3133 if( regCkNull ){
3134 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003135 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003136 }
3137 sqlite3VdbeResolveLabel(v, labelOk);
3138 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003139 goto sqlite3ExprCodeIN_finished;
3140 }
3141
3142 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3143 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3144 ** We will then skip the binary search of the RHS.
3145 */
3146 if( destIfNull==destIfFalse ){
3147 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003148 }else{
drhec4ccdb2018-12-29 02:26:59 +00003149 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003150 }
3151 for(i=0; i<nVector; i++){
3152 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3153 if( sqlite3ExprCanBeNull(p) ){
3154 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003155 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003156 }
drhe3365e62009-11-12 17:52:24 +00003157 }
drhe347d3e2016-08-25 21:14:34 +00003158
3159 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3160 ** of the RHS using the LHS as a probe. If found, the result is
3161 ** true.
3162 */
3163 if( eType==IN_INDEX_ROWID ){
3164 /* In this case, the RHS is the ROWID of table b-tree and so we also
3165 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3166 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003167 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003168 VdbeCoverage(v);
3169 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3170 }else{
3171 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3172 if( destIfFalse==destIfNull ){
3173 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003174 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003175 rLhs, nVector); VdbeCoverage(v);
3176 goto sqlite3ExprCodeIN_finished;
3177 }
3178 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003179 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003180 rLhs, nVector); VdbeCoverage(v);
3181 }
3182
3183 /* Step 4. If the RHS is known to be non-NULL and we did not find
3184 ** an match on the search above, then the result must be FALSE.
3185 */
3186 if( rRhsHasNull && nVector==1 ){
3187 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3188 VdbeCoverage(v);
3189 }
3190
3191 /* Step 5. If we do not care about the difference between NULL and
3192 ** FALSE, then just return false.
3193 */
3194 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3195
3196 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3197 ** If any comparison is NULL, then the result is NULL. If all
3198 ** comparisons are FALSE then the final result is FALSE.
3199 **
3200 ** For a scalar LHS, it is sufficient to check just the first row
3201 ** of the RHS.
3202 */
3203 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003204 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003205 VdbeCoverage(v);
3206 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003207 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003208 }else{
3209 /* For nVector==1, combine steps 6 and 7 by immediately returning
3210 ** FALSE if the first comparison is not NULL */
3211 destNotNull = destIfFalse;
3212 }
3213 for(i=0; i<nVector; i++){
3214 Expr *p;
3215 CollSeq *pColl;
3216 int r3 = sqlite3GetTempReg(pParse);
3217 p = sqlite3VectorFieldSubexpr(pLeft, i);
3218 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003219 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003220 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3221 (void*)pColl, P4_COLLSEQ);
3222 VdbeCoverage(v);
3223 sqlite3ReleaseTempReg(pParse, r3);
3224 }
3225 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3226 if( nVector>1 ){
3227 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003228 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003229 VdbeCoverage(v);
3230
3231 /* Step 7: If we reach this point, we know that the result must
3232 ** be false. */
3233 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3234 }
3235
3236 /* Jumps here in order to return true. */
3237 sqlite3VdbeJumpHere(v, addrTruthOp);
3238
3239sqlite3ExprCodeIN_finished:
3240 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003241 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003242sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003243 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003244 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003245}
3246#endif /* SQLITE_OMIT_SUBQUERY */
3247
drh13573c72010-01-12 17:04:07 +00003248#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003249/*
3250** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003251** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003252**
3253** The z[] string will probably not be zero-terminated. But the
3254** z[n] character is guaranteed to be something that does not look
3255** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003256*/
drhb7916a72009-05-27 10:31:29 +00003257static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003258 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003259 double value;
drh9339da12010-09-30 00:50:49 +00003260 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003261 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3262 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003263 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003264 }
3265}
drh13573c72010-01-12 17:04:07 +00003266#endif
drh598f1342007-10-23 15:39:45 +00003267
3268
3269/*
drhfec19aa2004-05-19 20:41:03 +00003270** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003271** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003272**
shaneh5f1d6b62010-09-30 16:51:25 +00003273** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003274*/
drh13573c72010-01-12 17:04:07 +00003275static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3276 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003277 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003278 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003279 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003280 if( negFlag ) i = -i;
3281 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003282 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003283 int c;
3284 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003285 const char *z = pExpr->u.zToken;
3286 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003287 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003288 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003289#ifdef SQLITE_OMIT_FLOATING_POINT
3290 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3291#else
drh1b7ddc52014-07-23 14:52:05 +00003292#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003293 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003294 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003295 }else
3296#endif
3297 {
drh9296c182014-07-23 13:40:49 +00003298 codeReal(v, z, negFlag, iMem);
3299 }
drh13573c72010-01-12 17:04:07 +00003300#endif
drh77320ea2016-11-30 14:47:37 +00003301 }else{
drh84d4f1a2017-09-20 10:47:10 +00003302 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003303 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003304 }
drhfec19aa2004-05-19 20:41:03 +00003305 }
3306}
3307
drh5cd79232009-05-25 11:46:29 +00003308
drh1f9ca2c2015-08-25 16:57:52 +00003309/* Generate code that will load into register regOut a value that is
3310** appropriate for the iIdxCol-th column of index pIdx.
3311*/
3312void sqlite3ExprCodeLoadIndexColumn(
3313 Parse *pParse, /* The parsing context */
3314 Index *pIdx, /* The index whose column is to be loaded */
3315 int iTabCur, /* Cursor pointing to a table row */
3316 int iIdxCol, /* The column of the index to be loaded */
3317 int regOut /* Store the index column value in this register */
3318){
3319 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003320 if( iTabCol==XN_EXPR ){
3321 assert( pIdx->aColExpr );
3322 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003323 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003324 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003325 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003326 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003327 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3328 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003329 }
drh1f9ca2c2015-08-25 16:57:52 +00003330}
3331
drh5cd79232009-05-25 11:46:29 +00003332/*
drh5c092e82010-05-14 19:24:02 +00003333** Generate code to extract the value of the iCol-th column of a table.
3334*/
3335void sqlite3ExprCodeGetColumnOfTable(
3336 Vdbe *v, /* The VDBE under construction */
3337 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003338 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003339 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003340 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003341){
drhaca19e12017-04-07 19:41:31 +00003342 if( pTab==0 ){
3343 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3344 return;
3345 }
drh5c092e82010-05-14 19:24:02 +00003346 if( iCol<0 || iCol==pTab->iPKey ){
3347 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3348 }else{
3349 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003350 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003351 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003352 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3353 }
3354 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003355 }
3356 if( iCol>=0 ){
3357 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3358 }
3359}
3360
3361/*
drh945498f2007-02-24 11:52:52 +00003362** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003363** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003364**
3365** There must be an open cursor to pTab in iTable when this routine
3366** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003367*/
drhe55cbd72008-03-31 23:48:03 +00003368int sqlite3ExprCodeGetColumn(
3369 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003370 Table *pTab, /* Description of the table we are reading from */
3371 int iColumn, /* Index of the table column */
3372 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003373 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003374 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003375){
drhe55cbd72008-03-31 23:48:03 +00003376 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003377 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003378 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003379 if( p5 ){
3380 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003381 }
drhe55cbd72008-03-31 23:48:03 +00003382 return iReg;
3383}
drhe55cbd72008-03-31 23:48:03 +00003384
3385/*
drhb21e7c72008-06-22 12:37:57 +00003386** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003387** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003388*/
drhb21e7c72008-06-22 12:37:57 +00003389void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003390 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003391 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003392}
3393
drh652fbf52008-04-01 01:42:41 +00003394/*
drh12abf402016-08-22 14:30:05 +00003395** Convert a scalar expression node to a TK_REGISTER referencing
3396** register iReg. The caller must ensure that iReg already contains
3397** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003398*/
dan069d1b12019-06-16 08:58:14 +00003399static void exprToRegister(Expr *pExpr, int iReg){
3400 Expr *p = sqlite3ExprSkipCollate(pExpr);
drha4c3c872013-09-12 17:29:25 +00003401 p->op2 = p->op;
3402 p->op = TK_REGISTER;
3403 p->iTable = iReg;
3404 ExprClearProperty(p, EP_Skip);
3405}
3406
drh12abf402016-08-22 14:30:05 +00003407/*
3408** Evaluate an expression (either a vector or a scalar expression) and store
3409** the result in continguous temporary registers. Return the index of
3410** the first register used to store the result.
3411**
3412** If the returned result register is a temporary scalar, then also write
3413** that register number into *piFreeable. If the returned result register
3414** is not a temporary or if the expression is a vector set *piFreeable
3415** to 0.
3416*/
3417static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3418 int iResult;
3419 int nResult = sqlite3ExprVectorSize(p);
3420 if( nResult==1 ){
3421 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3422 }else{
3423 *piFreeable = 0;
3424 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003425#if SQLITE_OMIT_SUBQUERY
3426 iResult = 0;
3427#else
drh85bcdce2018-12-23 21:27:29 +00003428 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003429#endif
drh12abf402016-08-22 14:30:05 +00003430 }else{
3431 int i;
3432 iResult = pParse->nMem+1;
3433 pParse->nMem += nResult;
3434 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003435 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003436 }
3437 }
3438 }
3439 return iResult;
3440}
3441
dan71c57db2016-07-09 20:23:55 +00003442
drha4c3c872013-09-12 17:29:25 +00003443/*
drhcce7d172000-05-31 15:34:51 +00003444** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003445** expression. Attempt to store the results in register "target".
3446** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003447**
drh8b213892008-08-29 02:14:02 +00003448** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003449** be stored in target. The result might be stored in some other
3450** register if it is convenient to do so. The calling function
3451** must check the return code and move the results to the desired
3452** register.
drhcce7d172000-05-31 15:34:51 +00003453*/
drh678ccce2008-03-31 18:19:54 +00003454int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003455 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3456 int op; /* The opcode being coded */
3457 int inReg = target; /* Results stored in register inReg */
3458 int regFree1 = 0; /* If non-zero free this temporary register */
3459 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003460 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003461 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003462 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003463
drh9cbf3422008-01-17 16:22:13 +00003464 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003465 if( v==0 ){
3466 assert( pParse->db->mallocFailed );
3467 return 0;
3468 }
drh389a1ad2008-01-03 23:44:53 +00003469
drh1efa8022018-04-28 04:16:43 +00003470expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003471 if( pExpr==0 ){
3472 op = TK_NULL;
3473 }else{
3474 op = pExpr->op;
3475 }
drhf2bc0132004-10-04 13:19:23 +00003476 switch( op ){
drh13449892005-09-07 21:22:45 +00003477 case TK_AGG_COLUMN: {
3478 AggInfo *pAggInfo = pExpr->pAggInfo;
3479 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3480 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003481 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003482 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003483 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003484 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003485 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003486 return target;
drh13449892005-09-07 21:22:45 +00003487 }
3488 /* Otherwise, fall thru into the TK_COLUMN case */
3489 }
drh967e8b72000-06-21 13:59:10 +00003490 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003491 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003492 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003493 /* This COLUMN expression is really a constant due to WHERE clause
3494 ** constraints, and that constant is coded by the pExpr->pLeft
3495 ** expresssion. However, make sure the constant has the correct
3496 ** datatype by applying the Affinity of the table column to the
3497 ** constant.
3498 */
3499 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003500 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00003501 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003502 static const char zAff[] = "B\000C\000D\000E";
3503 assert( SQLITE_AFF_BLOB=='A' );
3504 assert( SQLITE_AFF_TEXT=='B' );
3505 if( iReg!=target ){
3506 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3507 iReg = target;
3508 }
3509 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3510 &zAff[(aff-'B')*2], P4_STATIC);
3511 }
3512 return iReg;
drhefad2e22018-07-27 16:57:11 +00003513 }
drhb2b9d3d2013-08-01 01:14:43 +00003514 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003515 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003516 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003517 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003518 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003519 /* Coding an expression that is part of an index where column names
3520 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003521 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003522 }
drh22827922000-06-06 17:27:05 +00003523 }
drheda079c2018-09-20 19:02:15 +00003524 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003525 pExpr->iColumn, iTab, target,
3526 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003527 }
3528 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003529 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003530 return target;
drhfec19aa2004-05-19 20:41:03 +00003531 }
drh8abed7b2018-02-26 18:49:05 +00003532 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003533 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003534 return target;
3535 }
drh13573c72010-01-12 17:04:07 +00003536#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003537 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003538 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3539 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003540 return target;
drh598f1342007-10-23 15:39:45 +00003541 }
drh13573c72010-01-12 17:04:07 +00003542#endif
drhfec19aa2004-05-19 20:41:03 +00003543 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003544 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003545 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003546 return target;
drhcce7d172000-05-31 15:34:51 +00003547 }
drhf0863fe2005-06-12 21:35:51 +00003548 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003549 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003550 return target;
drhf0863fe2005-06-12 21:35:51 +00003551 }
danielk19775338a5f2005-01-20 13:03:10 +00003552#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003553 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003554 int n;
3555 const char *z;
drhca48c902008-01-18 14:08:24 +00003556 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003557 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3558 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3559 assert( pExpr->u.zToken[1]=='\'' );
3560 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003561 n = sqlite3Strlen30(z) - 1;
3562 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003563 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3564 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003565 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003566 }
danielk19775338a5f2005-01-20 13:03:10 +00003567#endif
drh50457892003-09-06 01:10:47 +00003568 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003569 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3570 assert( pExpr->u.zToken!=0 );
3571 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003572 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3573 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003574 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003575 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003576 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003577 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003578 }
drhc332cc32016-09-19 10:24:19 +00003579 return target;
drh50457892003-09-06 01:10:47 +00003580 }
drh4e0cff62004-11-05 05:10:28 +00003581 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003582 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003583 }
drh487e2622005-06-25 18:42:14 +00003584#ifndef SQLITE_OMIT_CAST
3585 case TK_CAST: {
3586 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003587 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003588 if( inReg!=target ){
3589 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3590 inReg = target;
3591 }
drh4169e432014-08-25 20:11:52 +00003592 sqlite3VdbeAddOp2(v, OP_Cast, target,
3593 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003594 return inReg;
drh487e2622005-06-25 18:42:14 +00003595 }
3596#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003597 case TK_IS:
3598 case TK_ISNOT:
3599 op = (op==TK_IS) ? TK_EQ : TK_NE;
3600 p5 = SQLITE_NULLEQ;
3601 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003602 case TK_LT:
3603 case TK_LE:
3604 case TK_GT:
3605 case TK_GE:
3606 case TK_NE:
3607 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003608 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003609 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003610 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003611 }else{
3612 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3613 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3614 codeCompare(pParse, pLeft, pExpr->pRight, op,
3615 r1, r2, inReg, SQLITE_STOREP2 | p5);
3616 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3617 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3618 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3619 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3620 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3621 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3622 testcase( regFree1==0 );
3623 testcase( regFree2==0 );
3624 }
drh6a2fe092009-09-23 02:29:36 +00003625 break;
3626 }
drhcce7d172000-05-31 15:34:51 +00003627 case TK_AND:
3628 case TK_OR:
3629 case TK_PLUS:
3630 case TK_STAR:
3631 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003632 case TK_REM:
3633 case TK_BITAND:
3634 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003635 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003636 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003637 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003638 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003639 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3640 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3641 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3642 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3643 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3644 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3645 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3646 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3647 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3648 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3649 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003650 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3651 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003652 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003653 testcase( regFree1==0 );
3654 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003655 break;
3656 }
drhcce7d172000-05-31 15:34:51 +00003657 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003658 Expr *pLeft = pExpr->pLeft;
3659 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003660 if( pLeft->op==TK_INTEGER ){
3661 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003662 return target;
drh13573c72010-01-12 17:04:07 +00003663#ifndef SQLITE_OMIT_FLOATING_POINT
3664 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003665 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3666 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003667 return target;
drh13573c72010-01-12 17:04:07 +00003668#endif
drh3c84ddf2008-01-09 02:15:38 +00003669 }else{
drh10d1edf2013-11-15 15:52:39 +00003670 tempX.op = TK_INTEGER;
3671 tempX.flags = EP_IntValue|EP_TokenOnly;
3672 tempX.u.iValue = 0;
3673 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003674 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003675 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003676 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003677 }
drh3c84ddf2008-01-09 02:15:38 +00003678 break;
drh6e142f52000-06-08 13:36:40 +00003679 }
drhbf4133c2001-10-13 02:59:08 +00003680 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003681 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003682 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3683 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003684 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3685 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003686 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003687 break;
3688 }
drh8abed7b2018-02-26 18:49:05 +00003689 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003690 int isTrue; /* IS TRUE or IS NOT TRUE */
3691 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003692 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3693 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003694 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3695 bNormal = pExpr->op2==TK_IS;
3696 testcase( isTrue && bNormal);
3697 testcase( !isTrue && bNormal);
3698 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003699 break;
3700 }
drhcce7d172000-05-31 15:34:51 +00003701 case TK_ISNULL:
3702 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003703 int addr;
drh7d176102014-02-18 03:07:12 +00003704 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3705 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003706 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003707 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003708 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003709 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003710 VdbeCoverageIf(v, op==TK_ISNULL);
3711 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003712 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003713 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003714 break;
drhcce7d172000-05-31 15:34:51 +00003715 }
drh22827922000-06-06 17:27:05 +00003716 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003717 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003718 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003719 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3720 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003721 }else{
drhc332cc32016-09-19 10:24:19 +00003722 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003723 }
drh22827922000-06-06 17:27:05 +00003724 break;
3725 }
drhcce7d172000-05-31 15:34:51 +00003726 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003727 ExprList *pFarg; /* List of function arguments */
3728 int nFarg; /* Number of function arguments */
3729 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003730 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003731 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003732 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003733 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003734 u8 enc = ENC(db); /* The text encoding used by this database */
3735 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003736
dan67a9b8e2018-06-22 20:51:35 +00003737#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003738 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3739 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003740 }
dan67a9b8e2018-06-22 20:51:35 +00003741#endif
dan86fb6e12018-05-16 20:58:07 +00003742
drh1e9b53f2017-01-04 01:07:24 +00003743 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003744 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003745 ** out of the inner loop, even if that means an extra OP_Copy. */
3746 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003747 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003748 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003749 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003750 pFarg = 0;
3751 }else{
3752 pFarg = pExpr->x.pList;
3753 }
3754 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003755 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3756 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003757 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003758#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3759 if( pDef==0 && pParse->explain ){
3760 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3761 }
3762#endif
danb6e9f7a2018-05-19 14:15:29 +00003763 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003764 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003765 break;
3766 }
drhae6bb952009-11-11 00:24:31 +00003767
3768 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003769 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003770 ** arguments past the first non-NULL argument.
3771 */
drhd36e1042013-09-06 13:10:12 +00003772 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003773 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003774 assert( nFarg>=2 );
3775 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3776 for(i=1; i<nFarg; i++){
3777 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003778 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003779 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003780 }
3781 sqlite3VdbeResolveLabel(v, endCoalesce);
3782 break;
3783 }
3784
drhcca9f3d2013-09-06 15:23:29 +00003785 /* The UNLIKELY() function is a no-op. The result is the value
3786 ** of the first argument.
3787 */
3788 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3789 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003790 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003791 }
drhae6bb952009-11-11 00:24:31 +00003792
drh54240752017-01-03 14:39:30 +00003793#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003794 /* The AFFINITY() function evaluates to a string that describes
3795 ** the type affinity of the argument. This is used for testing of
3796 ** the SQLite type logic.
3797 */
3798 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3799 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3800 char aff;
3801 assert( nFarg==1 );
3802 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3803 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003804 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003805 return target;
3806 }
drh54240752017-01-03 14:39:30 +00003807#endif
drha1a523a2016-12-26 00:18:36 +00003808
drhd1a01ed2013-11-21 16:08:52 +00003809 for(i=0; i<nFarg; i++){
3810 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003811 testcase( i==31 );
3812 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003813 }
3814 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3815 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3816 }
3817 }
drh12ffee82009-04-08 13:51:51 +00003818 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003819 if( constMask ){
3820 r1 = pParse->nMem+1;
3821 pParse->nMem += nFarg;
3822 }else{
3823 r1 = sqlite3GetTempRange(pParse, nFarg);
3824 }
drha748fdc2012-03-28 01:34:47 +00003825
3826 /* For length() and typeof() functions with a column argument,
3827 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3828 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3829 ** loading.
3830 */
drhd36e1042013-09-06 13:10:12 +00003831 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003832 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003833 assert( nFarg==1 );
3834 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003835 exprOp = pFarg->a[0].pExpr->op;
3836 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003837 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3838 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003839 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3840 pFarg->a[0].pExpr->op2 =
3841 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003842 }
3843 }
3844
drh5579d592015-08-26 14:01:41 +00003845 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003846 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003847 }else{
drh12ffee82009-04-08 13:51:51 +00003848 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003849 }
drhb7f6f682006-07-08 17:06:43 +00003850#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003851 /* Possibly overload the function if the first argument is
3852 ** a virtual table column.
3853 **
3854 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3855 ** second argument, not the first, as the argument to test to
3856 ** see if it is a column in a virtual table. This is done because
3857 ** the left operand of infix functions (the operand we want to
3858 ** control overloading) ends up as the second argument to the
3859 ** function. The expression "A glob B" is equivalent to
3860 ** "glob(B,A). We want to use the A in "A glob B" to test
3861 ** for function overloading. But we use the B term in "glob(B,A)".
3862 */
drh59155062018-05-26 18:03:48 +00003863 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003864 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3865 }else if( nFarg>0 ){
3866 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003867 }
3868#endif
drhd36e1042013-09-06 13:10:12 +00003869 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003870 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003871 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003872 }
drh092457b2017-12-29 15:04:49 +00003873#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3874 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003875 Expr *pArg = pFarg->a[0].pExpr;
3876 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003877 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003878 }else{
3879 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3880 }
drh092457b2017-12-29 15:04:49 +00003881 }else
3882#endif
3883 {
drh2fc865c2017-12-16 20:20:37 +00003884 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3885 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3886 sqlite3VdbeChangeP5(v, (u8)nFarg);
3887 }
drhd1a01ed2013-11-21 16:08:52 +00003888 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003889 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003890 }
drhc332cc32016-09-19 10:24:19 +00003891 return target;
drhcce7d172000-05-31 15:34:51 +00003892 }
drhfe2093d2005-01-20 22:48:47 +00003893#ifndef SQLITE_OMIT_SUBQUERY
3894 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003895 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003896 int nCol;
drhc5499be2008-04-01 15:06:33 +00003897 testcase( op==TK_EXISTS );
3898 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003899 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3900 sqlite3SubselectError(pParse, nCol, 1);
3901 }else{
drh85bcdce2018-12-23 21:27:29 +00003902 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003903 }
drh19a775c2000-06-05 18:54:46 +00003904 break;
3905 }
drhfc7f27b2016-08-20 00:07:01 +00003906 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003907 int n;
drhfc7f27b2016-08-20 00:07:01 +00003908 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003909 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003910 }
drh966e2912017-01-03 02:58:01 +00003911 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3912 if( pExpr->iTable
3913 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3914 ){
3915 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3916 pExpr->iTable, n);
3917 }
drhc332cc32016-09-19 10:24:19 +00003918 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003919 }
drhfef52082000-06-06 01:50:43 +00003920 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003921 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3922 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003923 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3924 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3925 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3926 sqlite3VdbeResolveLabel(v, destIfFalse);
3927 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3928 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003929 return target;
drhfef52082000-06-06 01:50:43 +00003930 }
drhe3365e62009-11-12 17:52:24 +00003931#endif /* SQLITE_OMIT_SUBQUERY */
3932
3933
drh2dcef112008-01-12 19:03:48 +00003934 /*
3935 ** x BETWEEN y AND z
3936 **
3937 ** This is equivalent to
3938 **
3939 ** x>=y AND x<=z
3940 **
3941 ** X is stored in pExpr->pLeft.
3942 ** Y is stored in pExpr->pList->a[0].pExpr.
3943 ** Z is stored in pExpr->pList->a[1].pExpr.
3944 */
drhfef52082000-06-06 01:50:43 +00003945 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003946 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003947 return target;
drhfef52082000-06-06 01:50:43 +00003948 }
drh94fa9c42016-02-27 21:16:04 +00003949 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003950 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003951 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003952 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003953 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003954 }
drh2dcef112008-01-12 19:03:48 +00003955
dan165921a2009-08-28 18:53:45 +00003956 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003957 /* If the opcode is TK_TRIGGER, then the expression is a reference
3958 ** to a column in the new.* or old.* pseudo-tables available to
3959 ** trigger programs. In this case Expr.iTable is set to 1 for the
3960 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3961 ** is set to the column of the pseudo-table to read, or to -1 to
3962 ** read the rowid field.
3963 **
3964 ** The expression is implemented using an OP_Param opcode. The p1
3965 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3966 ** to reference another column of the old.* pseudo-table, where
3967 ** i is the index of the column. For a new.rowid reference, p1 is
3968 ** set to (n+1), where n is the number of columns in each pseudo-table.
3969 ** For a reference to any other column in the new.* pseudo-table, p1
3970 ** is set to (n+2+i), where n and i are as defined previously. For
3971 ** example, if the table on which triggers are being fired is
3972 ** declared as:
3973 **
3974 ** CREATE TABLE t1(a, b);
3975 **
3976 ** Then p1 is interpreted as follows:
3977 **
3978 ** p1==0 -> old.rowid p1==3 -> new.rowid
3979 ** p1==1 -> old.a p1==4 -> new.a
3980 ** p1==2 -> old.b p1==5 -> new.b
3981 */
drheda079c2018-09-20 19:02:15 +00003982 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003983 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3984
3985 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3986 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3987 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3988 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3989
3990 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003991 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003992 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003993 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003994 ));
dan65a7cd12009-09-01 12:16:01 +00003995
drh44dbca82010-01-13 04:22:20 +00003996#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003997 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003998 ** integer. Use OP_RealAffinity to make sure it is really real.
3999 **
4000 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4001 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004002 if( pExpr->iColumn>=0
4003 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4004 ){
4005 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4006 }
drh44dbca82010-01-13 04:22:20 +00004007#endif
dan165921a2009-08-28 18:53:45 +00004008 break;
4009 }
4010
dan71c57db2016-07-09 20:23:55 +00004011 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004012 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004013 break;
4014 }
4015
drh31d6fd52017-04-14 19:03:10 +00004016 case TK_IF_NULL_ROW: {
4017 int addrINR;
4018 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00004019 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00004020 sqlite3VdbeJumpHere(v, addrINR);
4021 sqlite3VdbeChangeP3(v, addrINR, inReg);
4022 break;
4023 }
4024
drh2dcef112008-01-12 19:03:48 +00004025 /*
4026 ** Form A:
4027 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4028 **
4029 ** Form B:
4030 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4031 **
4032 ** Form A is can be transformed into the equivalent form B as follows:
4033 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4034 ** WHEN x=eN THEN rN ELSE y END
4035 **
4036 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004037 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4038 ** odd. The Y is also optional. If the number of elements in x.pList
4039 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004040 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4041 **
4042 ** The result of the expression is the Ri for the first matching Ei,
4043 ** or if there is no matching Ei, the ELSE term Y, or if there is
4044 ** no ELSE term, NULL.
4045 */
drh33cd4902009-05-30 20:49:20 +00004046 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004047 int endLabel; /* GOTO label for end of CASE stmt */
4048 int nextCase; /* GOTO label for next WHEN clause */
4049 int nExpr; /* 2x number of WHEN terms */
4050 int i; /* Loop counter */
4051 ExprList *pEList; /* List of WHEN terms */
4052 struct ExprList_item *aListelem; /* Array of WHEN terms */
4053 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004054 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004055 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004056 Expr *pDel = 0;
4057 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004058
danielk19776ab3a2e2009-02-19 14:39:25 +00004059 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004060 assert(pExpr->x.pList->nExpr > 0);
4061 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004062 aListelem = pEList->a;
4063 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004064 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004065 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004066 pDel = sqlite3ExprDup(db, pX, 0);
4067 if( db->mallocFailed ){
4068 sqlite3ExprDelete(db, pDel);
4069 break;
4070 }
drh33cd4902009-05-30 20:49:20 +00004071 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004072 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004073 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004074 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004075 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004076 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004077 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004078 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4079 ** The value in regFree1 might get SCopy-ed into the file result.
4080 ** So make sure that the regFree1 register is not reused for other
4081 ** purposes and possibly overwritten. */
4082 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004083 }
drhc5cd1242013-09-12 16:50:49 +00004084 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004085 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004086 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004087 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004088 }else{
drh2dcef112008-01-12 19:03:48 +00004089 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004090 }
drhec4ccdb2018-12-29 02:26:59 +00004091 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004092 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004093 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004094 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004095 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004096 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004097 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004098 }
drhc5cd1242013-09-12 16:50:49 +00004099 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004100 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004101 }else{
drh9de221d2008-01-05 06:51:30 +00004102 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004103 }
dan8b65e592019-07-17 14:34:17 +00004104 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004105 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004106 break;
4107 }
danielk19775338a5f2005-01-20 13:03:10 +00004108#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004109 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004110 assert( pExpr->affExpr==OE_Rollback
4111 || pExpr->affExpr==OE_Abort
4112 || pExpr->affExpr==OE_Fail
4113 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004114 );
dane0af83a2009-09-08 19:15:01 +00004115 if( !pParse->pTriggerTab ){
4116 sqlite3ErrorMsg(pParse,
4117 "RAISE() may only be used within a trigger-program");
4118 return 0;
4119 }
drh11949042019-08-05 18:01:42 +00004120 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004121 sqlite3MayAbort(pParse);
4122 }
dan165921a2009-08-28 18:53:45 +00004123 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004124 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004125 sqlite3VdbeAddOp4(
4126 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004127 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004128 }else{
drh433dccf2013-02-09 15:37:11 +00004129 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004130 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004131 }
4132
drhffe07b22005-11-03 00:41:17 +00004133 break;
drh17a7f8d2002-03-24 13:13:27 +00004134 }
danielk19775338a5f2005-01-20 13:03:10 +00004135#endif
drhffe07b22005-11-03 00:41:17 +00004136 }
drh2dcef112008-01-12 19:03:48 +00004137 sqlite3ReleaseTempReg(pParse, regFree1);
4138 sqlite3ReleaseTempReg(pParse, regFree2);
4139 return inReg;
4140}
4141
4142/*
drhd1a01ed2013-11-21 16:08:52 +00004143** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004144**
drhad879ff2017-01-04 04:10:02 +00004145** If regDest>=0 then the result is always stored in that register and the
4146** result is not reusable. If regDest<0 then this routine is free to
4147** store the value whereever it wants. The register where the expression
4148** is stored is returned. When regDest<0, two identical expressions will
4149** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004150*/
drh1e9b53f2017-01-04 01:07:24 +00004151int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004152 Parse *pParse, /* Parsing context */
4153 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004154 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004155){
drhd1a01ed2013-11-21 16:08:52 +00004156 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004157 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004158 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004159 if( regDest<0 && p ){
4160 struct ExprList_item *pItem;
4161 int i;
4162 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004163 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004164 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004165 }
4166 }
drh1e9b53f2017-01-04 01:07:24 +00004167 }
drhd1a01ed2013-11-21 16:08:52 +00004168 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4169 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004170 if( p ){
4171 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004172 pItem->reusable = regDest<0;
4173 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004174 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004175 }
drhd1a01ed2013-11-21 16:08:52 +00004176 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004177 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004178}
4179
4180/*
drh2dcef112008-01-12 19:03:48 +00004181** Generate code to evaluate an expression and store the results
4182** into a register. Return the register number where the results
4183** are stored.
4184**
4185** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004186** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004187** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004188**
4189** If pExpr is a constant, then this routine might generate this
4190** code to fill the register in the initialization section of the
4191** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004192*/
4193int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004194 int r2;
4195 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004196 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004197 && pExpr->op!=TK_REGISTER
4198 && sqlite3ExprIsConstantNotJoin(pExpr)
4199 ){
drhf30a9692013-11-15 01:10:18 +00004200 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004201 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004202 }else{
drhf30a9692013-11-15 01:10:18 +00004203 int r1 = sqlite3GetTempReg(pParse);
4204 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4205 if( r2==r1 ){
4206 *pReg = r1;
4207 }else{
4208 sqlite3ReleaseTempReg(pParse, r1);
4209 *pReg = 0;
4210 }
drh2dcef112008-01-12 19:03:48 +00004211 }
4212 return r2;
4213}
4214
4215/*
4216** Generate code that will evaluate expression pExpr and store the
4217** results in register target. The results are guaranteed to appear
4218** in register target.
4219*/
drh05a86c52014-02-16 01:55:49 +00004220void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004221 int inReg;
4222
4223 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004224 if( pExpr && pExpr->op==TK_REGISTER ){
4225 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4226 }else{
4227 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004228 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004229 if( inReg!=target && pParse->pVdbe ){
4230 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4231 }
drhcce7d172000-05-31 15:34:51 +00004232 }
drhcce7d172000-05-31 15:34:51 +00004233}
4234
4235/*
drh1c75c9d2015-12-21 15:22:13 +00004236** Make a transient copy of expression pExpr and then code it using
4237** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4238** except that the input expression is guaranteed to be unchanged.
4239*/
4240void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4241 sqlite3 *db = pParse->db;
4242 pExpr = sqlite3ExprDup(db, pExpr, 0);
4243 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4244 sqlite3ExprDelete(db, pExpr);
4245}
4246
4247/*
drh05a86c52014-02-16 01:55:49 +00004248** Generate code that will evaluate expression pExpr and store the
4249** results in register target. The results are guaranteed to appear
4250** in register target. If the expression is constant, then this routine
4251** might choose to code the expression at initialization time.
4252*/
4253void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004254 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004255 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004256 }else{
4257 sqlite3ExprCode(pParse, pExpr, target);
4258 }
drhcce7d172000-05-31 15:34:51 +00004259}
4260
4261/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004262** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004263** in register target.
drh25303782004-12-07 15:41:48 +00004264**
drh2dcef112008-01-12 19:03:48 +00004265** Also make a copy of the expression results into another "cache" register
4266** and modify the expression so that the next time it is evaluated,
4267** the result is a copy of the cache register.
4268**
4269** This routine is used for expressions that are used multiple
4270** times. They are evaluated once and the results of the expression
4271** are reused.
drh25303782004-12-07 15:41:48 +00004272*/
drh05a86c52014-02-16 01:55:49 +00004273void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004274 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004275 int iMem;
4276
drhde4fcfd2008-01-19 23:50:26 +00004277 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004278 assert( pExpr->op!=TK_REGISTER );
4279 sqlite3ExprCode(pParse, pExpr, target);
4280 iMem = ++pParse->nMem;
4281 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4282 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004283}
drh2dcef112008-01-12 19:03:48 +00004284
drh678ccce2008-03-31 18:19:54 +00004285/*
drh268380c2004-02-25 13:47:31 +00004286** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004287** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004288**
drh3df6c3b2017-09-15 15:38:01 +00004289** Return the number of elements evaluated. The number returned will
4290** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4291** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004292**
4293** The SQLITE_ECEL_DUP flag prevents the arguments from being
4294** filled using OP_SCopy. OP_Copy must be used instead.
4295**
4296** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4297** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004298**
4299** The SQLITE_ECEL_REF flag means that expressions in the list with
4300** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4301** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004302** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4303** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004304*/
danielk19774adee202004-05-08 08:23:19 +00004305int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004306 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004307 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004308 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004309 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004310 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004311){
4312 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004313 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004314 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004315 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004316 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004317 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004318 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004319 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004320 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004321 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004322 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004323#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4324 if( pItem->bSorterRef ){
4325 i--;
4326 n--;
4327 }else
4328#endif
dan257c13f2016-11-10 20:14:06 +00004329 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4330 if( flags & SQLITE_ECEL_OMITREF ){
4331 i--;
4332 n--;
4333 }else{
4334 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4335 }
drhb8b06692018-08-04 15:16:20 +00004336 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4337 && sqlite3ExprIsConstantNotJoin(pExpr)
4338 ){
drhad879ff2017-01-04 04:10:02 +00004339 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004340 }else{
4341 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4342 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004343 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004344 if( copyOp==OP_Copy
4345 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4346 && pOp->p1+pOp->p3+1==inReg
4347 && pOp->p2+pOp->p3+1==target+i
4348 ){
4349 pOp->p3++;
4350 }else{
4351 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4352 }
drhd1a01ed2013-11-21 16:08:52 +00004353 }
drhd1766112008-09-17 00:13:12 +00004354 }
drh268380c2004-02-25 13:47:31 +00004355 }
drhf9b596e2004-05-26 16:54:42 +00004356 return n;
drh268380c2004-02-25 13:47:31 +00004357}
4358
4359/*
drh36c563a2009-11-12 13:32:22 +00004360** Generate code for a BETWEEN operator.
4361**
4362** x BETWEEN y AND z
4363**
4364** The above is equivalent to
4365**
4366** x>=y AND x<=z
4367**
4368** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004369** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004370**
4371** The xJumpIf parameter determines details:
4372**
4373** NULL: Store the boolean result in reg[dest]
4374** sqlite3ExprIfTrue: Jump to dest if true
4375** sqlite3ExprIfFalse: Jump to dest if false
4376**
4377** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004378*/
4379static void exprCodeBetween(
4380 Parse *pParse, /* Parsing and code generating context */
4381 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004382 int dest, /* Jump destination or storage location */
4383 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004384 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4385){
dan8b65e592019-07-17 14:34:17 +00004386 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004387 Expr compLeft; /* The x>=y term */
4388 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004389 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004390 Expr *pDel = 0;
4391 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004392
dan71c57db2016-07-09 20:23:55 +00004393 memset(&compLeft, 0, sizeof(Expr));
4394 memset(&compRight, 0, sizeof(Expr));
4395 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004396
4397 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004398 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4399 if( db->mallocFailed==0 ){
4400 exprAnd.op = TK_AND;
4401 exprAnd.pLeft = &compLeft;
4402 exprAnd.pRight = &compRight;
4403 compLeft.op = TK_GE;
4404 compLeft.pLeft = pDel;
4405 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4406 compRight.op = TK_LE;
4407 compRight.pLeft = pDel;
4408 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4409 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4410 if( xJump ){
4411 xJump(pParse, &exprAnd, dest, jumpIfNull);
4412 }else{
4413 /* Mark the expression is being from the ON or USING clause of a join
4414 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4415 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4416 ** for clarity, but we are out of bits in the Expr.flags field so we
4417 ** have to reuse the EP_FromJoin bit. Bummer. */
4418 pDel->flags |= EP_FromJoin;
4419 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4420 }
4421 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004422 }
dan8b65e592019-07-17 14:34:17 +00004423 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004424
4425 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004426 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4427 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4428 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4429 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4430 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4431 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4432 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4433 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004434 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004435}
4436
4437/*
drhcce7d172000-05-31 15:34:51 +00004438** Generate code for a boolean expression such that a jump is made
4439** to the label "dest" if the expression is true but execution
4440** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004441**
4442** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004443** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004444**
4445** This code depends on the fact that certain token values (ex: TK_EQ)
4446** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4447** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4448** the make process cause these values to align. Assert()s in the code
4449** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004450*/
danielk19774adee202004-05-08 08:23:19 +00004451void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004452 Vdbe *v = pParse->pVdbe;
4453 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004454 int regFree1 = 0;
4455 int regFree2 = 0;
4456 int r1, r2;
4457
drh35573352008-01-08 23:54:25 +00004458 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004459 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004460 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004461 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004462 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004463 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004464 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004465 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4466 if( pAlt!=pExpr ){
4467 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4468 }else if( op==TK_AND ){
4469 int d2 = sqlite3VdbeMakeLabel(pParse);
4470 testcase( jumpIfNull==0 );
4471 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4472 jumpIfNull^SQLITE_JUMPIFNULL);
4473 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4474 sqlite3VdbeResolveLabel(v, d2);
4475 }else{
4476 testcase( jumpIfNull==0 );
4477 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4478 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4479 }
drhcce7d172000-05-31 15:34:51 +00004480 break;
4481 }
4482 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004483 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004484 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004485 break;
4486 }
drh8abed7b2018-02-26 18:49:05 +00004487 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004488 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4489 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004490 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004491 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004492 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004493 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004494 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004495 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004496 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4497 isNot ? SQLITE_JUMPIFNULL : 0);
4498 }else{
4499 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4500 isNot ? SQLITE_JUMPIFNULL : 0);
4501 }
drh007c8432018-02-26 03:20:18 +00004502 break;
4503 }
drhde845c22016-03-17 19:07:52 +00004504 case TK_IS:
4505 case TK_ISNOT:
4506 testcase( op==TK_IS );
4507 testcase( op==TK_ISNOT );
4508 op = (op==TK_IS) ? TK_EQ : TK_NE;
4509 jumpIfNull = SQLITE_NULLEQ;
4510 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004511 case TK_LT:
4512 case TK_LE:
4513 case TK_GT:
4514 case TK_GE:
4515 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004516 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004517 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004518 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004519 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4520 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004521 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004522 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004523 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4524 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4525 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4526 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004527 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4528 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4529 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4530 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4531 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4532 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004533 testcase( regFree1==0 );
4534 testcase( regFree2==0 );
4535 break;
4536 }
drhcce7d172000-05-31 15:34:51 +00004537 case TK_ISNULL:
4538 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004539 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4540 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004541 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4542 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004543 VdbeCoverageIf(v, op==TK_ISNULL);
4544 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004545 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004546 break;
4547 }
drhfef52082000-06-06 01:50:43 +00004548 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004549 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004550 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004551 break;
4552 }
drh84e30ca2011-02-10 17:46:14 +00004553#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004554 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004555 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004556 int destIfNull = jumpIfNull ? dest : destIfFalse;
4557 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004558 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004559 sqlite3VdbeResolveLabel(v, destIfFalse);
4560 break;
4561 }
shanehbb201342011-02-09 19:55:20 +00004562#endif
drhcce7d172000-05-31 15:34:51 +00004563 default: {
dan7b35a772016-07-28 19:47:15 +00004564 default_expr:
drhad317272019-04-19 16:21:51 +00004565 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004566 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004567 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004568 /* No-op */
4569 }else{
4570 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4571 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004572 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004573 testcase( regFree1==0 );
4574 testcase( jumpIfNull==0 );
4575 }
drhcce7d172000-05-31 15:34:51 +00004576 break;
4577 }
4578 }
drh2dcef112008-01-12 19:03:48 +00004579 sqlite3ReleaseTempReg(pParse, regFree1);
4580 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004581}
4582
4583/*
drh66b89c82000-11-28 20:47:17 +00004584** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004585** to the label "dest" if the expression is false but execution
4586** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004587**
4588** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004589** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4590** is 0.
drhcce7d172000-05-31 15:34:51 +00004591*/
danielk19774adee202004-05-08 08:23:19 +00004592void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004593 Vdbe *v = pParse->pVdbe;
4594 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004595 int regFree1 = 0;
4596 int regFree2 = 0;
4597 int r1, r2;
4598
drh35573352008-01-08 23:54:25 +00004599 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004600 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004601 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004602
4603 /* The value of pExpr->op and op are related as follows:
4604 **
4605 ** pExpr->op op
4606 ** --------- ----------
4607 ** TK_ISNULL OP_NotNull
4608 ** TK_NOTNULL OP_IsNull
4609 ** TK_NE OP_Eq
4610 ** TK_EQ OP_Ne
4611 ** TK_GT OP_Le
4612 ** TK_LE OP_Gt
4613 ** TK_GE OP_Lt
4614 ** TK_LT OP_Ge
4615 **
4616 ** For other values of pExpr->op, op is undefined and unused.
4617 ** The value of TK_ and OP_ constants are arranged such that we
4618 ** can compute the mapping above using the following expression.
4619 ** Assert()s verify that the computation is correct.
4620 */
4621 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4622
4623 /* Verify correct alignment of TK_ and OP_ constants
4624 */
4625 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4626 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4627 assert( pExpr->op!=TK_NE || op==OP_Eq );
4628 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4629 assert( pExpr->op!=TK_LT || op==OP_Ge );
4630 assert( pExpr->op!=TK_LE || op==OP_Gt );
4631 assert( pExpr->op!=TK_GT || op==OP_Le );
4632 assert( pExpr->op!=TK_GE || op==OP_Lt );
4633
danba00e302016-07-23 20:24:06 +00004634 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004635 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004636 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004637 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4638 if( pAlt!=pExpr ){
4639 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4640 }else if( pExpr->op==TK_AND ){
4641 testcase( jumpIfNull==0 );
4642 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4643 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4644 }else{
4645 int d2 = sqlite3VdbeMakeLabel(pParse);
4646 testcase( jumpIfNull==0 );
4647 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4648 jumpIfNull^SQLITE_JUMPIFNULL);
4649 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4650 sqlite3VdbeResolveLabel(v, d2);
4651 }
drhcce7d172000-05-31 15:34:51 +00004652 break;
4653 }
4654 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004655 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004656 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004657 break;
4658 }
drh8abed7b2018-02-26 18:49:05 +00004659 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004660 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4661 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004662 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004663 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004664 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004665 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004666 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004667 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004668 /* IS TRUE and IS NOT FALSE */
4669 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4670 isNot ? 0 : SQLITE_JUMPIFNULL);
4671
4672 }else{
4673 /* IS FALSE and IS NOT TRUE */
4674 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004675 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004676 }
drh007c8432018-02-26 03:20:18 +00004677 break;
4678 }
drhde845c22016-03-17 19:07:52 +00004679 case TK_IS:
4680 case TK_ISNOT:
4681 testcase( pExpr->op==TK_IS );
4682 testcase( pExpr->op==TK_ISNOT );
4683 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4684 jumpIfNull = SQLITE_NULLEQ;
4685 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004686 case TK_LT:
4687 case TK_LE:
4688 case TK_GT:
4689 case TK_GE:
4690 case TK_NE:
4691 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004692 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004693 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004694 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4695 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004696 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004697 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004698 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4699 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4700 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4701 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004702 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4703 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4704 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4705 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4706 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4707 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004708 testcase( regFree1==0 );
4709 testcase( regFree2==0 );
4710 break;
4711 }
drhcce7d172000-05-31 15:34:51 +00004712 case TK_ISNULL:
4713 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004714 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4715 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004716 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4717 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004718 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004719 break;
4720 }
drhfef52082000-06-06 01:50:43 +00004721 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004722 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004723 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004724 break;
4725 }
drh84e30ca2011-02-10 17:46:14 +00004726#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004727 case TK_IN: {
4728 if( jumpIfNull ){
4729 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4730 }else{
drhec4ccdb2018-12-29 02:26:59 +00004731 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004732 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4733 sqlite3VdbeResolveLabel(v, destIfNull);
4734 }
4735 break;
4736 }
shanehbb201342011-02-09 19:55:20 +00004737#endif
drhcce7d172000-05-31 15:34:51 +00004738 default: {
danba00e302016-07-23 20:24:06 +00004739 default_expr:
drhad317272019-04-19 16:21:51 +00004740 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004741 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004742 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004743 /* no-op */
4744 }else{
4745 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4746 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004747 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004748 testcase( regFree1==0 );
4749 testcase( jumpIfNull==0 );
4750 }
drhcce7d172000-05-31 15:34:51 +00004751 break;
4752 }
4753 }
drh2dcef112008-01-12 19:03:48 +00004754 sqlite3ReleaseTempReg(pParse, regFree1);
4755 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004756}
drh22827922000-06-06 17:27:05 +00004757
4758/*
drh72bc8202015-06-11 13:58:35 +00004759** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4760** code generation, and that copy is deleted after code generation. This
4761** ensures that the original pExpr is unchanged.
4762*/
4763void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4764 sqlite3 *db = pParse->db;
4765 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4766 if( db->mallocFailed==0 ){
4767 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4768 }
4769 sqlite3ExprDelete(db, pCopy);
4770}
4771
dan5aa550c2017-06-24 18:10:29 +00004772/*
4773** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4774** type of expression.
4775**
4776** If pExpr is a simple SQL value - an integer, real, string, blob
4777** or NULL value - then the VDBE currently being prepared is configured
4778** to re-prepare each time a new value is bound to variable pVar.
4779**
4780** Additionally, if pExpr is a simple SQL value and the value is the
4781** same as that currently bound to variable pVar, non-zero is returned.
4782** Otherwise, if the values are not the same or if pExpr is not a simple
4783** SQL value, zero is returned.
4784*/
4785static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4786 int res = 0;
drhc0804222017-06-28 21:47:16 +00004787 int iVar;
4788 sqlite3_value *pL, *pR = 0;
4789
4790 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4791 if( pR ){
4792 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004793 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004794 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004795 if( pL ){
4796 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4797 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4798 }
4799 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004800 }
drhc0804222017-06-28 21:47:16 +00004801 sqlite3ValueFree(pR);
4802 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004803 }
4804
4805 return res;
4806}
drh72bc8202015-06-11 13:58:35 +00004807
4808/*
drh1d9da702010-01-07 15:17:02 +00004809** Do a deep comparison of two expression trees. Return 0 if the two
4810** expressions are completely identical. Return 1 if they differ only
4811** by a COLLATE operator at the top level. Return 2 if there are differences
4812** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004813**
drh619a1302013-08-01 13:04:46 +00004814** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4815** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4816**
drh66518ca2013-08-01 15:09:57 +00004817** The pA side might be using TK_REGISTER. If that is the case and pB is
4818** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4819**
drh1d9da702010-01-07 15:17:02 +00004820** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004821** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004822** identical, we return 2 just to be safe. So if this routine
4823** returns 2, then you do not really know for certain if the two
4824** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004825** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004826** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004827** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004828** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004829**
drhc0804222017-06-28 21:47:16 +00004830** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4831** pParse->pReprepare can be matched against literals in pB. The
4832** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4833** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4834** Argument pParse should normally be NULL. If it is not NULL and pA or
4835** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004836*/
dan5aa550c2017-06-24 18:10:29 +00004837int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004838 u32 combinedFlags;
4839 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004840 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004841 }
dan5aa550c2017-06-24 18:10:29 +00004842 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4843 return 0;
4844 }
drh10d1edf2013-11-15 15:52:39 +00004845 combinedFlags = pA->flags | pB->flags;
4846 if( combinedFlags & EP_IntValue ){
4847 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4848 return 0;
4849 }
drh1d9da702010-01-07 15:17:02 +00004850 return 2;
drh22827922000-06-06 17:27:05 +00004851 }
dan16dd3982018-12-20 15:04:38 +00004852 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004853 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004854 return 1;
4855 }
dan5aa550c2017-06-24 18:10:29 +00004856 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004857 return 1;
4858 }
4859 return 2;
4860 }
drh2edc5fd2015-11-24 02:10:52 +00004861 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00004862 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00004863 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004864#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00004865 assert( pA->op==pB->op );
4866 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4867 return 2;
4868 }
drheda079c2018-09-20 19:02:15 +00004869 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00004870 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
4871 return 2;
4872 }
drheda079c2018-09-20 19:02:15 +00004873 }
4874#endif
drhf20bbc52019-01-17 01:06:00 +00004875 }else if( pA->op==TK_NULL ){
4876 return 0;
drhd5af5422018-04-13 14:27:01 +00004877 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004878 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004879 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004880 return 2;
drh2646da72005-12-09 20:02:05 +00004881 }
drh22827922000-06-06 17:27:05 +00004882 }
drh10d1edf2013-11-15 15:52:39 +00004883 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004884 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004885 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004886 if( (combinedFlags & EP_FixedCol)==0
4887 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004888 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004889 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004890 if( pA->op!=TK_STRING
4891 && pA->op!=TK_TRUEFALSE
4892 && (combinedFlags & EP_Reduced)==0
4893 ){
drh10d1edf2013-11-15 15:52:39 +00004894 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00004895 if( pA->op2!=pB->op2 ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004896 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004897 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004898 }
4899 }
drh1d9da702010-01-07 15:17:02 +00004900 return 0;
drh22827922000-06-06 17:27:05 +00004901}
4902
drh8c6f6662010-04-26 19:17:26 +00004903/*
4904** Compare two ExprList objects. Return 0 if they are identical and
4905** non-zero if they differ in any way.
4906**
drh619a1302013-08-01 13:04:46 +00004907** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4908** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4909**
drh8c6f6662010-04-26 19:17:26 +00004910** This routine might return non-zero for equivalent ExprLists. The
4911** only consequence will be disabled optimizations. But this routine
4912** must never return 0 if the two ExprList objects are different, or
4913** a malfunction will result.
4914**
4915** Two NULL pointers are considered to be the same. But a NULL pointer
4916** always differs from a non-NULL pointer.
4917*/
drh619a1302013-08-01 13:04:46 +00004918int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004919 int i;
4920 if( pA==0 && pB==0 ) return 0;
4921 if( pA==0 || pB==0 ) return 1;
4922 if( pA->nExpr!=pB->nExpr ) return 1;
4923 for(i=0; i<pA->nExpr; i++){
4924 Expr *pExprA = pA->a[i].pExpr;
4925 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00004926 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004927 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004928 }
4929 return 0;
4930}
drh13449892005-09-07 21:22:45 +00004931
drh22827922000-06-06 17:27:05 +00004932/*
drhf9463df2017-02-11 14:59:58 +00004933** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4934** are ignored.
4935*/
4936int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004937 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004938 sqlite3ExprSkipCollate(pA),
4939 sqlite3ExprSkipCollate(pB),
4940 iTab);
4941}
4942
4943/*
drhc51cf862019-05-11 19:36:03 +00004944** Return non-zero if Expr p can only be true if pNN is not NULL.
4945*/
4946static int exprImpliesNotNull(
4947 Parse *pParse, /* Parsing context */
4948 Expr *p, /* The expression to be checked */
4949 Expr *pNN, /* The expression that is NOT NULL */
4950 int iTab, /* Table being evaluated */
4951 int seenNot /* True if p is an operand of NOT */
4952){
4953 assert( p );
4954 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00004955 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
4956 return pNN->op!=TK_NULL;
4957 }
drhc51cf862019-05-11 19:36:03 +00004958 switch( p->op ){
4959 case TK_IN: {
4960 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4961 assert( ExprHasProperty(p,EP_xIsSelect)
4962 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4963 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4964 }
4965 case TK_BETWEEN: {
4966 ExprList *pList = p->x.pList;
4967 assert( pList!=0 );
4968 assert( pList->nExpr==2 );
4969 if( seenNot ) return 0;
4970 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4971 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4972 ){
4973 return 1;
4974 }
4975 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4976 }
4977 case TK_EQ:
4978 case TK_NE:
4979 case TK_LT:
4980 case TK_LE:
4981 case TK_GT:
4982 case TK_GE:
4983 case TK_PLUS:
4984 case TK_MINUS:
4985 case TK_STAR:
4986 case TK_REM:
4987 case TK_BITAND:
4988 case TK_BITOR:
4989 case TK_SLASH:
4990 case TK_LSHIFT:
4991 case TK_RSHIFT:
4992 case TK_CONCAT: {
4993 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
4994 /* Fall thru into the next case */
4995 }
4996 case TK_SPAN:
4997 case TK_COLLATE:
4998 case TK_BITNOT:
4999 case TK_UPLUS:
5000 case TK_UMINUS: {
5001 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5002 }
5003 case TK_TRUTH: {
5004 if( seenNot ) return 0;
5005 if( p->op2!=TK_IS ) return 0;
5006 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5007 }
5008 case TK_NOT: {
5009 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5010 }
5011 }
5012 return 0;
5013}
5014
5015/*
drh4bd5f732013-07-31 23:22:39 +00005016** Return true if we can prove the pE2 will always be true if pE1 is
5017** true. Return false if we cannot complete the proof or if pE2 might
5018** be false. Examples:
5019**
drh619a1302013-08-01 13:04:46 +00005020** pE1: x==5 pE2: x==5 Result: true
5021** pE1: x>0 pE2: x==5 Result: false
5022** pE1: x=21 pE2: x=21 OR y=43 Result: true
5023** pE1: x!=123 pE2: x IS NOT NULL Result: true
5024** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5025** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5026** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005027**
5028** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5029** Expr.iTable<0 then assume a table number given by iTab.
5030**
drhc0804222017-06-28 21:47:16 +00005031** If pParse is not NULL, then the values of bound variables in pE1 are
5032** compared against literal values in pE2 and pParse->pVdbe->expmask is
5033** modified to record which bound variables are referenced. If pParse
5034** is NULL, then false will be returned if pE1 contains any bound variables.
5035**
drh4bd5f732013-07-31 23:22:39 +00005036** When in doubt, return false. Returning true might give a performance
5037** improvement. Returning false might cause a performance reduction, but
5038** it will always give the correct answer and is hence always safe.
5039*/
dan5aa550c2017-06-24 18:10:29 +00005040int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5041 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005042 return 1;
5043 }
5044 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005045 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5046 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005047 ){
5048 return 1;
5049 }
drh664d6d12019-05-04 17:32:07 +00005050 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005051 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005052 ){
drhc51cf862019-05-11 19:36:03 +00005053 return 1;
drh619a1302013-08-01 13:04:46 +00005054 }
5055 return 0;
drh4bd5f732013-07-31 23:22:39 +00005056}
5057
5058/*
drh25897872018-03-20 21:16:15 +00005059** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5060** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005061** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5062**
5063** This routine controls an optimization. False positives (setting
5064** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5065** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005066*/
5067static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005068 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005069 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005070 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5071 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005072 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00005073 case TK_NOT:
drh25897872018-03-20 21:16:15 +00005074 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005075 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005076 case TK_IS:
5077 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005078 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005079 case TK_IN:
drh25897872018-03-20 21:16:15 +00005080 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00005081 testcase( pExpr->op==TK_ISNOT );
5082 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00005083 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005084 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005085 testcase( pExpr->op==TK_IS );
5086 testcase( pExpr->op==TK_OR );
5087 testcase( pExpr->op==TK_CASE );
5088 testcase( pExpr->op==TK_IN );
5089 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005090 return WRC_Prune;
5091 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005092 if( pWalker->u.iCur==pExpr->iTable ){
5093 pWalker->eCode = 1;
5094 return WRC_Abort;
5095 }
5096 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005097
5098 /* Virtual tables are allowed to use constraints like x=NULL. So
5099 ** a term of the form x=y does not prove that y is not null if x
5100 ** is the column of a virtual table */
5101 case TK_EQ:
5102 case TK_NE:
5103 case TK_LT:
5104 case TK_LE:
5105 case TK_GT:
5106 case TK_GE:
5107 testcase( pExpr->op==TK_EQ );
5108 testcase( pExpr->op==TK_NE );
5109 testcase( pExpr->op==TK_LT );
5110 testcase( pExpr->op==TK_LE );
5111 testcase( pExpr->op==TK_GT );
5112 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005113 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5114 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005115 ){
5116 return WRC_Prune;
5117 }
drh25897872018-03-20 21:16:15 +00005118 default:
5119 return WRC_Continue;
5120 }
5121}
5122
5123/*
5124** Return true (non-zero) if expression p can only be true if at least
5125** one column of table iTab is non-null. In other words, return true
5126** if expression p will always be NULL or false if every column of iTab
5127** is NULL.
5128**
drh821b6102018-03-24 18:01:51 +00005129** False negatives are acceptable. In other words, it is ok to return
5130** zero even if expression p will never be true of every column of iTab
5131** is NULL. A false negative is merely a missed optimization opportunity.
5132**
5133** False positives are not allowed, however. A false positive may result
5134** in an incorrect answer.
5135**
drh25897872018-03-20 21:16:15 +00005136** Terms of p that are marked with EP_FromJoin (and hence that come from
5137** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5138**
5139** This routine is used to check if a LEFT JOIN can be converted into
5140** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5141** clause requires that some column of the right table of the LEFT JOIN
5142** be non-NULL, then the LEFT JOIN can be safely converted into an
5143** ordinary join.
5144*/
5145int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5146 Walker w;
drhd6db6592019-04-01 19:42:42 +00005147 p = sqlite3ExprSkipCollate(p);
5148 while( p ){
5149 if( p->op==TK_NOTNULL ){
5150 p = p->pLeft;
5151 }else if( p->op==TK_AND ){
5152 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5153 p = p->pRight;
5154 }else{
5155 break;
5156 }
5157 }
drh25897872018-03-20 21:16:15 +00005158 w.xExprCallback = impliesNotNullRow;
5159 w.xSelectCallback = 0;
5160 w.xSelectCallback2 = 0;
5161 w.eCode = 0;
5162 w.u.iCur = iTab;
5163 sqlite3WalkExpr(&w, p);
5164 return w.eCode;
5165}
5166
5167/*
drh030796d2012-08-23 16:18:10 +00005168** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005169** to determine if an expression can be evaluated by reference to the
5170** index only, without having to do a search for the corresponding
5171** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5172** is the cursor for the table.
5173*/
5174struct IdxCover {
5175 Index *pIdx; /* The index to be tested for coverage */
5176 int iCur; /* Cursor number for the table corresponding to the index */
5177};
5178
5179/*
5180** Check to see if there are references to columns in table
5181** pWalker->u.pIdxCover->iCur can be satisfied using the index
5182** pWalker->u.pIdxCover->pIdx.
5183*/
5184static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5185 if( pExpr->op==TK_COLUMN
5186 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5187 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5188 ){
5189 pWalker->eCode = 1;
5190 return WRC_Abort;
5191 }
5192 return WRC_Continue;
5193}
5194
5195/*
drhe604ec02016-07-27 19:20:58 +00005196** Determine if an index pIdx on table with cursor iCur contains will
5197** the expression pExpr. Return true if the index does cover the
5198** expression and false if the pExpr expression references table columns
5199** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005200**
5201** An index covering an expression means that the expression can be
5202** evaluated using only the index and without having to lookup the
5203** corresponding table entry.
5204*/
5205int sqlite3ExprCoveredByIndex(
5206 Expr *pExpr, /* The index to be tested */
5207 int iCur, /* The cursor number for the corresponding table */
5208 Index *pIdx /* The index that might be used for coverage */
5209){
5210 Walker w;
5211 struct IdxCover xcov;
5212 memset(&w, 0, sizeof(w));
5213 xcov.iCur = iCur;
5214 xcov.pIdx = pIdx;
5215 w.xExprCallback = exprIdxCover;
5216 w.u.pIdxCover = &xcov;
5217 sqlite3WalkExpr(&w, pExpr);
5218 return !w.eCode;
5219}
5220
5221
5222/*
5223** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005224** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005225** aggregate function, in order to implement the
5226** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005227*/
drh030796d2012-08-23 16:18:10 +00005228struct SrcCount {
5229 SrcList *pSrc; /* One particular FROM clause in a nested query */
5230 int nThis; /* Number of references to columns in pSrcList */
5231 int nOther; /* Number of references to columns in other FROM clauses */
5232};
5233
5234/*
5235** Count the number of references to columns.
5236*/
5237static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005238 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5239 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5240 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5241 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5242 ** NEVER() will need to be removed. */
5243 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005244 int i;
drh030796d2012-08-23 16:18:10 +00005245 struct SrcCount *p = pWalker->u.pSrcCount;
5246 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005247 int nSrc = pSrc ? pSrc->nSrc : 0;
5248 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005249 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005250 }
drh655814d2015-01-09 01:27:29 +00005251 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005252 p->nThis++;
5253 }else{
5254 p->nOther++;
5255 }
drh374fdce2012-04-17 16:38:53 +00005256 }
drh030796d2012-08-23 16:18:10 +00005257 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005258}
5259
5260/*
drh030796d2012-08-23 16:18:10 +00005261** Determine if any of the arguments to the pExpr Function reference
5262** pSrcList. Return true if they do. Also return true if the function
5263** has no arguments or has only constant arguments. Return false if pExpr
5264** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005265*/
drh030796d2012-08-23 16:18:10 +00005266int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005267 Walker w;
drh030796d2012-08-23 16:18:10 +00005268 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005269 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005270 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005271 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005272 w.u.pSrcCount = &cnt;
5273 cnt.pSrc = pSrcList;
5274 cnt.nThis = 0;
5275 cnt.nOther = 0;
5276 sqlite3WalkExprList(&w, pExpr->x.pList);
5277 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005278}
5279
5280/*
drh13449892005-09-07 21:22:45 +00005281** Add a new element to the pAggInfo->aCol[] array. Return the index of
5282** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005283*/
drh17435752007-08-16 04:30:38 +00005284static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005285 int i;
drhcf643722007-03-27 13:36:37 +00005286 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005287 db,
drhcf643722007-03-27 13:36:37 +00005288 pInfo->aCol,
5289 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005290 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005291 &i
5292 );
drh13449892005-09-07 21:22:45 +00005293 return i;
5294}
5295
5296/*
5297** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5298** the new element. Return a negative number if malloc fails.
5299*/
drh17435752007-08-16 04:30:38 +00005300static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005301 int i;
drhcf643722007-03-27 13:36:37 +00005302 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005303 db,
drhcf643722007-03-27 13:36:37 +00005304 pInfo->aFunc,
5305 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005306 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005307 &i
5308 );
drh13449892005-09-07 21:22:45 +00005309 return i;
5310}
drh22827922000-06-06 17:27:05 +00005311
5312/*
drh7d10d5a2008-08-20 16:35:10 +00005313** This is the xExprCallback for a tree walker. It is used to
5314** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005315** for additional information.
drh22827922000-06-06 17:27:05 +00005316*/
drh7d10d5a2008-08-20 16:35:10 +00005317static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005318 int i;
drh7d10d5a2008-08-20 16:35:10 +00005319 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005320 Parse *pParse = pNC->pParse;
5321 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005322 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005323
drh25c3b8c2018-04-16 10:34:13 +00005324 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005325 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005326 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005327 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005328 testcase( pExpr->op==TK_AGG_COLUMN );
5329 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005330 /* Check to see if the column is in one of the tables in the FROM
5331 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005332 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005333 struct SrcList_item *pItem = pSrcList->a;
5334 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5335 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005336 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005337 if( pExpr->iTable==pItem->iCursor ){
5338 /* If we reach this point, it means that pExpr refers to a table
5339 ** that is in the FROM clause of the aggregate query.
5340 **
5341 ** Make an entry for the column in pAggInfo->aCol[] if there
5342 ** is not an entry there already.
5343 */
drh7f906d62007-03-12 23:48:52 +00005344 int k;
drh13449892005-09-07 21:22:45 +00005345 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005346 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005347 if( pCol->iTable==pExpr->iTable &&
5348 pCol->iColumn==pExpr->iColumn ){
5349 break;
5350 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005351 }
danielk19771e536952007-08-16 10:09:01 +00005352 if( (k>=pAggInfo->nColumn)
5353 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5354 ){
drh7f906d62007-03-12 23:48:52 +00005355 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005356 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005357 pCol->iTable = pExpr->iTable;
5358 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005359 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005360 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005361 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005362 if( pAggInfo->pGroupBy ){
5363 int j, n;
5364 ExprList *pGB = pAggInfo->pGroupBy;
5365 struct ExprList_item *pTerm = pGB->a;
5366 n = pGB->nExpr;
5367 for(j=0; j<n; j++, pTerm++){
5368 Expr *pE = pTerm->pExpr;
5369 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5370 pE->iColumn==pExpr->iColumn ){
5371 pCol->iSorterColumn = j;
5372 break;
5373 }
5374 }
5375 }
5376 if( pCol->iSorterColumn<0 ){
5377 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5378 }
5379 }
5380 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5381 ** because it was there before or because we just created it).
5382 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5383 ** pAggInfo->aCol[] entry.
5384 */
drhebb6a652013-09-12 23:42:22 +00005385 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005386 pExpr->pAggInfo = pAggInfo;
5387 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005388 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005389 break;
5390 } /* endif pExpr->iTable==pItem->iCursor */
5391 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005392 }
drh7d10d5a2008-08-20 16:35:10 +00005393 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005394 }
5395 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005396 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005397 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005398 ){
drh13449892005-09-07 21:22:45 +00005399 /* Check to see if pExpr is a duplicate of another aggregate
5400 ** function that is already in the pAggInfo structure
5401 */
5402 struct AggInfo_func *pItem = pAggInfo->aFunc;
5403 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005404 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005405 break;
5406 }
drh22827922000-06-06 17:27:05 +00005407 }
drh13449892005-09-07 21:22:45 +00005408 if( i>=pAggInfo->nFunc ){
5409 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5410 */
danielk197714db2662006-01-09 16:12:04 +00005411 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005412 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005413 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005414 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005415 pItem = &pAggInfo->aFunc[i];
5416 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005417 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005418 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005419 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005420 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005421 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005422 if( pExpr->flags & EP_Distinct ){
5423 pItem->iDistinct = pParse->nTab++;
5424 }else{
5425 pItem->iDistinct = -1;
5426 }
drh13449892005-09-07 21:22:45 +00005427 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005428 }
drh13449892005-09-07 21:22:45 +00005429 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5430 */
drhc5cd1242013-09-12 16:50:49 +00005431 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005432 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005433 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005434 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005435 return WRC_Prune;
5436 }else{
5437 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005438 }
drh22827922000-06-06 17:27:05 +00005439 }
5440 }
drh7d10d5a2008-08-20 16:35:10 +00005441 return WRC_Continue;
5442}
5443static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005444 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005445 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005446 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005447}
drh979dd1b2017-05-29 14:26:07 +00005448static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5449 UNUSED_PARAMETER(pSelect);
5450 pWalker->walkerDepth--;
5451}
drh626a8792005-01-17 22:08:19 +00005452
5453/*
drhe8abb4c2012-11-02 18:24:57 +00005454** Analyze the pExpr expression looking for aggregate functions and
5455** for variables that need to be added to AggInfo object that pNC->pAggInfo
5456** points to. Additional entries are made on the AggInfo object as
5457** necessary.
drh626a8792005-01-17 22:08:19 +00005458**
5459** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005460** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005461*/
drhd2b3e232008-01-23 14:51:49 +00005462void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005463 Walker w;
5464 w.xExprCallback = analyzeAggregate;
5465 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005466 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5467 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005468 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005469 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005470 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005471 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005472}
drh5d9a4af2005-08-30 00:54:01 +00005473
5474/*
5475** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5476** expression list. Return the number of errors.
5477**
5478** If an error is found, the analysis is cut short.
5479*/
drhd2b3e232008-01-23 14:51:49 +00005480void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005481 struct ExprList_item *pItem;
5482 int i;
drh5d9a4af2005-08-30 00:54:01 +00005483 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005484 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5485 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005486 }
5487 }
drh5d9a4af2005-08-30 00:54:01 +00005488}
drh892d3172008-01-10 03:46:36 +00005489
5490/*
drhceea3322009-04-23 13:22:42 +00005491** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005492*/
5493int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005494 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005495 return ++pParse->nMem;
5496 }
danielk19772f425f62008-07-04 09:41:39 +00005497 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005498}
drhceea3322009-04-23 13:22:42 +00005499
5500/*
5501** Deallocate a register, making available for reuse for some other
5502** purpose.
drhceea3322009-04-23 13:22:42 +00005503*/
drh892d3172008-01-10 03:46:36 +00005504void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005505 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005506 pParse->aTempReg[pParse->nTempReg++] = iReg;
5507 }
5508}
5509
5510/*
drhed24da42016-09-06 14:37:05 +00005511** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005512*/
5513int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005514 int i, n;
drhed24da42016-09-06 14:37:05 +00005515 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005516 i = pParse->iRangeReg;
5517 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005518 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005519 pParse->iRangeReg += nReg;
5520 pParse->nRangeReg -= nReg;
5521 }else{
5522 i = pParse->nMem+1;
5523 pParse->nMem += nReg;
5524 }
5525 return i;
5526}
5527void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005528 if( nReg==1 ){
5529 sqlite3ReleaseTempReg(pParse, iReg);
5530 return;
5531 }
drh892d3172008-01-10 03:46:36 +00005532 if( nReg>pParse->nRangeReg ){
5533 pParse->nRangeReg = nReg;
5534 pParse->iRangeReg = iReg;
5535 }
5536}
drhcdc69552011-12-06 13:24:59 +00005537
5538/*
5539** Mark all temporary registers as being unavailable for reuse.
5540*/
5541void sqlite3ClearTempRegCache(Parse *pParse){
5542 pParse->nTempReg = 0;
5543 pParse->nRangeReg = 0;
5544}
drhbb9b5f22016-03-19 00:35:02 +00005545
5546/*
5547** Validate that no temporary register falls within the range of
5548** iFirst..iLast, inclusive. This routine is only call from within assert()
5549** statements.
5550*/
5551#ifdef SQLITE_DEBUG
5552int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5553 int i;
5554 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005555 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5556 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005557 ){
5558 return 0;
5559 }
5560 for(i=0; i<pParse->nTempReg; i++){
5561 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5562 return 0;
5563 }
5564 }
5565 return 1;
5566}
5567#endif /* SQLITE_DEBUG */