blob: ed53fc7f98f0458f4f049b40c56b3e7e74977227 [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;
47 pExpr = sqlite3ExprSkipCollate(pExpr);
mistachkin9bec6fb2014-06-26 21:28:21 +000048 if( pExpr->flags & EP_Generic ) return 0;
drh580c8c12012-12-08 03:34:04 +000049 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000050 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000051 assert( pExpr->flags&EP_xIsSelect );
52 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000053 }
drhdb45bd52016-08-22 00:48:58 +000054 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000055#ifndef SQLITE_OMIT_CAST
56 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000057 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000058 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000059 }
60#endif
drheda079c2018-09-20 19:02:15 +000061 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000063 }
dan80aa5452016-09-03 19:52:12 +000064 if( op==TK_SELECT_COLUMN ){
65 assert( pExpr->pLeft->flags&EP_xIsSelect );
66 return sqlite3ExprAffinity(
67 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
68 );
69 }
danielk1977a37cdde2004-05-16 11:15:36 +000070 return pExpr->affinity;
71}
72
drh53db1452004-05-20 13:54:53 +000073/*
drh8b4c40d2007-02-01 23:02:45 +000074** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000075** sequence named by pToken. Return a pointer to a new Expr node that
76** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000077**
78** If a memory allocation error occurs, that fact is recorded in pParse->db
79** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000080*/
drh4ef7efa2014-03-20 15:14:08 +000081Expr *sqlite3ExprAddCollateToken(
82 Parse *pParse, /* Parsing context */
83 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000084 const Token *pCollName, /* Name of collating sequence */
85 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000086){
drh0a8a4062012-12-07 18:38:16 +000087 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000088 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000089 if( pNew ){
90 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000091 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000092 pExpr = pNew;
93 }
drhae80dde2012-12-06 21:16:43 +000094 }
drh0a8a4062012-12-07 18:38:16 +000095 return pExpr;
96}
97Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +000098 Token s;
99 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000100 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000101 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000102}
103
104/*
drh0b8d2552015-09-05 22:36:07 +0000105** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000106** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000107*/
108Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +0000109 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000111 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000113 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000114 pExpr = pExpr->x.pList->a[0].pExpr;
115 }else{
drh0b8d2552015-09-05 22:36:07 +0000116 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000117 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000118 }
drha4c3c872013-09-12 17:29:25 +0000119 }
drh0a8a4062012-12-07 18:38:16 +0000120 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000121}
122
123/*
drhae80dde2012-12-06 21:16:43 +0000124** Return the collation sequence for the expression pExpr. If
125** there is no defined collating sequence, return NULL.
126**
drh70efa842017-09-28 01:58:23 +0000127** See also: sqlite3ExprNNCollSeq()
128**
129** The sqlite3ExprNNCollSeq() works the same exact that it returns the
130** default collation if pExpr has no defined collation.
131**
drhae80dde2012-12-06 21:16:43 +0000132** The collating sequence might be determined by a COLLATE operator
133** or by the presence of a column with a defined collating sequence.
134** COLLATE operators take first precedence. Left operands take
135** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000136*/
danielk19777cedc8d2004-06-10 10:50:08 +0000137CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000138 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000139 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000140 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000141 while( p ){
drhae80dde2012-12-06 21:16:43 +0000142 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000143 if( p->flags & EP_Generic ) break;
drhcb0e04f2018-12-12 21:34:17 +0000144 if( op==TK_REGISTER ) op = p->op2;
145 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000146 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000147 ){
drheda079c2018-09-20 19:02:15 +0000148 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000149 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000150 int j = p->iColumn;
151 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000152 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000153 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000154 }
155 break;
danielk19770202b292004-06-09 09:55:16 +0000156 }
drhe081d732018-07-27 18:19:12 +0000157 if( op==TK_CAST || op==TK_UPLUS ){
158 p = p->pLeft;
159 continue;
160 }
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000162 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163 break;
164 }
drhae80dde2012-12-06 21:16:43 +0000165 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000166 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000167 p = p->pLeft;
168 }else{
drh2308ed32015-02-09 16:09:34 +0000169 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000170 /* The Expr.x union is never used at the same time as Expr.pRight */
171 assert( p->x.pList==0 || p->pRight==0 );
172 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
173 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
174 ** least one EP_Collate. Thus the following two ALWAYS. */
175 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000176 int i;
drh6728cd92015-02-09 18:28:03 +0000177 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000178 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
179 pNext = p->x.pList->a[i].pExpr;
180 break;
181 }
182 }
183 }
184 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000185 }
186 }else{
drh7d10d5a2008-08-20 16:35:10 +0000187 break;
188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
danielk19777cedc8d2004-06-10 10:50:08 +0000190 if( sqlite3CheckCollSeq(pParse, pColl) ){
191 pColl = 0;
192 }
193 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000194}
195
196/*
drh70efa842017-09-28 01:58:23 +0000197** Return the collation sequence for the expression pExpr. If
198** there is no defined collating sequence, return a pointer to the
199** defautl collation sequence.
200**
201** See also: sqlite3ExprCollSeq()
202**
203** The sqlite3ExprCollSeq() routine works the same except that it
204** returns NULL if there is no defined collation.
205*/
206CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
207 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
208 if( p==0 ) p = pParse->db->pDfltColl;
209 assert( p!=0 );
210 return p;
211}
212
213/*
214** Return TRUE if the two expressions have equivalent collating sequences.
215*/
216int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
217 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
218 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
219 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
220}
221
222/*
drh626a8792005-01-17 22:08:19 +0000223** pExpr is an operand of a comparison operator. aff2 is the
224** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000225** type affinity that should be used for the comparison operator.
226*/
danielk1977e014a832004-05-17 10:48:57 +0000227char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000228 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000229 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000230 /* Both sides of the comparison are columns. If one has numeric
231 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000232 */
drh8a512562005-11-14 22:29:05 +0000233 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000234 return SQLITE_AFF_NUMERIC;
235 }else{
drh05883a32015-06-02 15:32:08 +0000236 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000237 }
238 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000239 /* Neither side of the comparison is a column. Compare the
240 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000241 */
drh05883a32015-06-02 15:32:08 +0000242 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000243 }else{
244 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000245 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000246 return (aff1 + aff2);
247 }
248}
249
drh53db1452004-05-20 13:54:53 +0000250/*
251** pExpr is a comparison operator. Return the type affinity that should
252** be applied to both operands prior to doing the comparison.
253*/
danielk1977e014a832004-05-17 10:48:57 +0000254static char comparisonAffinity(Expr *pExpr){
255 char aff;
256 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000258 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000259 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000260 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000261 if( pExpr->pRight ){
262 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000263 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
264 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000265 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000266 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000267 }
268 return aff;
269}
270
271/*
272** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273** idx_affinity is the affinity of an indexed column. Return true
274** if the index with affinity idx_affinity may be used to implement
275** the comparison in pExpr.
276*/
277int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000279 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000280 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000281 return 1;
282 case SQLITE_AFF_TEXT:
283 return idx_affinity==SQLITE_AFF_TEXT;
284 default:
285 return sqlite3IsNumericAffinity(idx_affinity);
286 }
danielk1977e014a832004-05-17 10:48:57 +0000287}
288
danielk1977a37cdde2004-05-16 11:15:36 +0000289/*
drh35573352008-01-08 23:54:25 +0000290** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000291** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000292*/
drh35573352008-01-08 23:54:25 +0000293static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
294 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000295 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000296 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000297}
298
drha2e00042002-01-22 03:13:42 +0000299/*
danielk19770202b292004-06-09 09:55:16 +0000300** Return a pointer to the collation sequence that should be used by
301** a binary comparison operator comparing pLeft and pRight.
302**
303** If the left hand expression has a collating sequence type, then it is
304** used. Otherwise the collation sequence for the right hand expression
305** is used, or the default (BINARY) if neither expression has a collating
306** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000307**
308** Argument pRight (but not pLeft) may be a null pointer. In this case,
309** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000310*/
drh0a0e1312007-08-07 17:04:59 +0000311CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000312 Parse *pParse,
313 Expr *pLeft,
314 Expr *pRight
315){
drhec41dda2007-02-07 13:09:45 +0000316 CollSeq *pColl;
317 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000318 if( pLeft->flags & EP_Collate ){
319 pColl = sqlite3ExprCollSeq(pParse, pLeft);
320 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000322 }else{
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 if( !pColl ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
326 }
danielk19770202b292004-06-09 09:55:16 +0000327 }
328 return pColl;
329}
330
331/*
drhbe5c89a2004-07-26 00:31:09 +0000332** Generate code for a comparison operator.
333*/
334static int codeCompare(
335 Parse *pParse, /* The parsing (and code generating) context */
336 Expr *pLeft, /* The left operand */
337 Expr *pRight, /* The right operand */
338 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000339 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000340 int dest, /* Jump here if true. */
341 int jumpIfNull /* If true, jump if either operand is NULL */
342){
drh35573352008-01-08 23:54:25 +0000343 int p5;
344 int addr;
345 CollSeq *p4;
346
347 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
348 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
349 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
350 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000351 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000352 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000353}
354
dancfbb5e82016-07-13 19:48:13 +0000355/*
dan870a0702016-08-01 16:37:43 +0000356** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000357**
358** A vector is defined as any expression that results in two or more
359** columns of result. Every TK_VECTOR node is an vector because the
360** parser will not generate a TK_VECTOR with fewer than two entries.
361** But a TK_SELECT might be either a vector or a scalar. It is only
362** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000363*/
364int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000365 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000366}
367
368/*
dancfbb5e82016-07-13 19:48:13 +0000369** If the expression passed as the only argument is of type TK_VECTOR
370** return the number of expressions in the vector. Or, if the expression
371** is a sub-select, return the number of columns in the sub-select. For
372** any other type of expression, return 1.
373*/
dan71c57db2016-07-09 20:23:55 +0000374int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000375 u8 op = pExpr->op;
376 if( op==TK_REGISTER ) op = pExpr->op2;
377 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000378 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000379 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000380 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000381 }else{
382 return 1;
dan71c57db2016-07-09 20:23:55 +0000383 }
dan71c57db2016-07-09 20:23:55 +0000384}
385
danba00e302016-07-23 20:24:06 +0000386/*
drhfc7f27b2016-08-20 00:07:01 +0000387** Return a pointer to a subexpression of pVector that is the i-th
388** column of the vector (numbered starting with 0). The caller must
389** ensure that i is within range.
390**
drh76dbe7a2016-08-20 21:02:38 +0000391** If pVector is really a scalar (and "scalar" here includes subqueries
392** that return a single column!) then return pVector unmodified.
393**
drhfc7f27b2016-08-20 00:07:01 +0000394** pVector retains ownership of the returned subexpression.
395**
396** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000397** just the expression for the i-th term of the result set, and may
398** not be ready for evaluation because the table cursor has not yet
399** been positioned.
danba00e302016-07-23 20:24:06 +0000400*/
drhfc7f27b2016-08-20 00:07:01 +0000401Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000402 assert( i<sqlite3ExprVectorSize(pVector) );
403 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000404 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
405 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000406 return pVector->x.pSelect->pEList->a[i].pExpr;
407 }else{
408 return pVector->x.pList->a[i].pExpr;
409 }
dan71c57db2016-07-09 20:23:55 +0000410 }
dan870a0702016-08-01 16:37:43 +0000411 return pVector;
dan71c57db2016-07-09 20:23:55 +0000412}
drhfc7f27b2016-08-20 00:07:01 +0000413
drhfc7f27b2016-08-20 00:07:01 +0000414/*
415** Compute and return a new Expr object which when passed to
416** sqlite3ExprCode() will generate all necessary code to compute
417** the iField-th column of the vector expression pVector.
418**
drh8762ec12016-08-20 01:06:22 +0000419** It is ok for pVector to be a scalar (as long as iField==0).
420** In that case, this routine works like sqlite3ExprDup().
421**
drhfc7f27b2016-08-20 00:07:01 +0000422** The caller owns the returned Expr object and is responsible for
423** ensuring that the returned value eventually gets freed.
424**
drh8762ec12016-08-20 01:06:22 +0000425** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000426** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000427** valid for the life of the returned object. If pVector is a TK_VECTOR
428** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000429** returns.
drh8762ec12016-08-20 01:06:22 +0000430**
431** A trick to cause a TK_SELECT pVector to be deleted together with
432** the returned Expr object is to attach the pVector to the pRight field
433** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000434*/
435Expr *sqlite3ExprForVectorField(
436 Parse *pParse, /* Parsing context */
437 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000438 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000439){
440 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000441 if( pVector->op==TK_SELECT ){
442 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000443 /* The TK_SELECT_COLUMN Expr node:
444 **
drh966e2912017-01-03 02:58:01 +0000445 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000446 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000447 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000448 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000449 ** pLeft->iTable: First in an array of register holding result, or 0
450 ** if the result is not yet computed.
451 **
452 ** sqlite3ExprDelete() specifically skips the recursive delete of
453 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000454 ** can be attached to pRight to cause this node to take ownership of
455 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
456 ** with the same pLeft pointer to the pVector, but only one of them
457 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000458 */
drhabfd35e2016-12-06 22:47:23 +0000459 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000460 if( pRet ){
461 pRet->iColumn = iField;
462 pRet->pLeft = pVector;
463 }
drhfc7f27b2016-08-20 00:07:01 +0000464 assert( pRet==0 || pRet->iTable==0 );
465 }else{
drha1251bc2016-08-20 00:51:37 +0000466 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000468 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000469 }
470 return pRet;
471}
dan71c57db2016-07-09 20:23:55 +0000472
dan5c288b92016-07-30 21:02:33 +0000473/*
474** If expression pExpr is of type TK_SELECT, generate code to evaluate
475** it. Return the register in which the result is stored (or, if the
476** sub-select returns more than one column, the first in an array
477** of registers in which the result is stored).
478**
479** If pExpr is not a TK_SELECT expression, return 0.
480*/
481static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000482 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000483#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000484 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000485 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000486 }
danf9b2e052016-08-02 17:45:00 +0000487#endif
dan8da209b2016-07-26 18:06:08 +0000488 return reg;
489}
490
dan5c288b92016-07-30 21:02:33 +0000491/*
492** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000493** or TK_SELECT that returns more than one column. This function returns
494** the register number of a register that contains the value of
495** element iField of the vector.
496**
497** If pVector is a TK_SELECT expression, then code for it must have
498** already been generated using the exprCodeSubselect() routine. In this
499** case parameter regSelect should be the first in an array of registers
500** containing the results of the sub-select.
501**
502** If pVector is of type TK_VECTOR, then code for the requested field
503** is generated. In this case (*pRegFree) may be set to the number of
504** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000505**
506** Before returning, output parameter (*ppExpr) is set to point to the
507** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000508*/
509static int exprVectorRegister(
510 Parse *pParse, /* Parse context */
511 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000512 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000513 int regSelect, /* First in array of registers */
514 Expr **ppExpr, /* OUT: Expression element */
515 int *pRegFree /* OUT: Temp register to free */
516){
drh12abf402016-08-22 14:30:05 +0000517 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000518 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000519 if( op==TK_REGISTER ){
520 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
521 return pVector->iTable+iField;
522 }
523 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000524 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
525 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000526 }
dan870a0702016-08-01 16:37:43 +0000527 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000528 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
529}
530
531/*
532** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000533** the result of the comparison (1, 0, or NULL) and write that
534** result into register dest.
535**
536** The caller must satisfy the following preconditions:
537**
538** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
539** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
540** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000541*/
drh79752b62016-08-13 10:02:17 +0000542static void codeVectorCompare(
543 Parse *pParse, /* Code generator context */
544 Expr *pExpr, /* The comparison operation */
545 int dest, /* Write results into this register */
546 u8 op, /* Comparison operator */
547 u8 p5 /* SQLITE_NULLEQ or zero */
548){
dan71c57db2016-07-09 20:23:55 +0000549 Vdbe *v = pParse->pVdbe;
550 Expr *pLeft = pExpr->pLeft;
551 Expr *pRight = pExpr->pRight;
552 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000553 int i;
554 int regLeft = 0;
555 int regRight = 0;
556 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000557 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000558
drh245ce622017-01-01 12:44:07 +0000559 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
560 sqlite3ErrorMsg(pParse, "row value misused");
561 return;
562 }
drhb29e60c2016-09-05 12:02:34 +0000563 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
564 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
565 || pExpr->op==TK_LT || pExpr->op==TK_GT
566 || pExpr->op==TK_LE || pExpr->op==TK_GE
567 );
568 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
569 || (pExpr->op==TK_ISNOT && op==TK_NE) );
570 assert( p5==0 || pExpr->op!=op );
571 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000572
drhb29e60c2016-09-05 12:02:34 +0000573 p5 |= SQLITE_STOREP2;
574 if( opx==TK_LE ) opx = TK_LT;
575 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000576
drhb29e60c2016-09-05 12:02:34 +0000577 regLeft = exprCodeSubselect(pParse, pLeft);
578 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000579
drhb29e60c2016-09-05 12:02:34 +0000580 for(i=0; 1 /*Loop exits by "break"*/; i++){
581 int regFree1 = 0, regFree2 = 0;
582 Expr *pL, *pR;
583 int r1, r2;
584 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000585 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
586 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
587 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
588 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
589 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
590 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
591 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
592 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
593 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
594 sqlite3ReleaseTempReg(pParse, regFree1);
595 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000596 if( i==nLeft-1 ){
597 break;
dan71c57db2016-07-09 20:23:55 +0000598 }
drhb29e60c2016-09-05 12:02:34 +0000599 if( opx==TK_EQ ){
600 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
601 p5 |= SQLITE_KEEPNULL;
602 }else if( opx==TK_NE ){
603 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
604 p5 |= SQLITE_KEEPNULL;
605 }else{
606 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
607 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
608 VdbeCoverageIf(v, op==TK_LT);
609 VdbeCoverageIf(v, op==TK_GT);
610 VdbeCoverageIf(v, op==TK_LE);
611 VdbeCoverageIf(v, op==TK_GE);
612 if( i==nLeft-2 ) opx = op;
613 }
dan71c57db2016-07-09 20:23:55 +0000614 }
drhb29e60c2016-09-05 12:02:34 +0000615 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000616}
617
danielk19774b5255a2008-06-05 16:47:39 +0000618#if SQLITE_MAX_EXPR_DEPTH>0
619/*
620** Check that argument nHeight is less than or equal to the maximum
621** expression depth allowed. If it is not, leave an error message in
622** pParse.
623*/
drh7d10d5a2008-08-20 16:35:10 +0000624int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000625 int rc = SQLITE_OK;
626 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
627 if( nHeight>mxHeight ){
628 sqlite3ErrorMsg(pParse,
629 "Expression tree is too large (maximum depth %d)", mxHeight
630 );
631 rc = SQLITE_ERROR;
632 }
633 return rc;
634}
635
636/* The following three functions, heightOfExpr(), heightOfExprList()
637** and heightOfSelect(), are used to determine the maximum height
638** of any expression tree referenced by the structure passed as the
639** first argument.
640**
641** If this maximum height is greater than the current value pointed
642** to by pnHeight, the second parameter, then set *pnHeight to that
643** value.
644*/
645static void heightOfExpr(Expr *p, int *pnHeight){
646 if( p ){
647 if( p->nHeight>*pnHeight ){
648 *pnHeight = p->nHeight;
649 }
650 }
651}
652static void heightOfExprList(ExprList *p, int *pnHeight){
653 if( p ){
654 int i;
655 for(i=0; i<p->nExpr; i++){
656 heightOfExpr(p->a[i].pExpr, pnHeight);
657 }
658 }
659}
dan1a3a3082018-01-18 19:00:54 +0000660static void heightOfSelect(Select *pSelect, int *pnHeight){
661 Select *p;
662 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000663 heightOfExpr(p->pWhere, pnHeight);
664 heightOfExpr(p->pHaving, pnHeight);
665 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000666 heightOfExprList(p->pEList, pnHeight);
667 heightOfExprList(p->pGroupBy, pnHeight);
668 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000669 }
670}
671
672/*
673** Set the Expr.nHeight variable in the structure passed as an
674** argument. An expression with no children, Expr.pList or
675** Expr.pSelect member has a height of 1. Any other expression
676** has a height equal to the maximum height of any other
677** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000678**
679** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
680** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000681*/
682static void exprSetHeight(Expr *p){
683 int nHeight = 0;
684 heightOfExpr(p->pLeft, &nHeight);
685 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000686 if( ExprHasProperty(p, EP_xIsSelect) ){
687 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000688 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000689 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000690 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000691 }
danielk19774b5255a2008-06-05 16:47:39 +0000692 p->nHeight = nHeight + 1;
693}
694
695/*
696** Set the Expr.nHeight variable using the exprSetHeight() function. If
697** the height is greater than the maximum allowed expression depth,
698** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000699**
700** Also propagate all EP_Propagate flags from the Expr.x.pList into
701** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000702*/
drh2308ed32015-02-09 16:09:34 +0000703void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000704 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000705 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000706 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000707}
708
709/*
710** Return the maximum height of any expression tree referenced
711** by the select statement passed as an argument.
712*/
713int sqlite3SelectExprHeight(Select *p){
714 int nHeight = 0;
715 heightOfSelect(p, &nHeight);
716 return nHeight;
717}
drh2308ed32015-02-09 16:09:34 +0000718#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
719/*
720** Propagate all EP_Propagate flags from the Expr.x.pList into
721** Expr.flags.
722*/
723void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
724 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
725 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
726 }
727}
728#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000729#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
730
drhbe5c89a2004-07-26 00:31:09 +0000731/*
drhb7916a72009-05-27 10:31:29 +0000732** This routine is the core allocator for Expr nodes.
733**
drha76b5df2002-02-23 02:32:10 +0000734** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000735** for this node and for the pToken argument is a single allocation
736** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000737** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000738**
739** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000740** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000741** parameter is ignored if pToken is NULL or if the token does not
742** appear to be quoted. If the quotes were of the form "..." (double-quotes)
743** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000744**
745** Special case: If op==TK_INTEGER and pToken points to a string that
746** can be translated into a 32-bit integer, then the token is not
747** stored in u.zToken. Instead, the integer values is written
748** into u.iValue and the EP_IntValue flag is set. No extra storage
749** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000750*/
drhb7916a72009-05-27 10:31:29 +0000751Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000752 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000753 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000754 const Token *pToken, /* Token argument. Might be NULL */
755 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000756){
drha76b5df2002-02-23 02:32:10 +0000757 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000758 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000759 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000760
drh575fad62016-02-05 13:38:36 +0000761 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000762 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000763 if( op!=TK_INTEGER || pToken->z==0
764 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
765 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000766 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000767 }
drhb7916a72009-05-27 10:31:29 +0000768 }
drh575fad62016-02-05 13:38:36 +0000769 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000770 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000771 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000772 pNew->op = (u8)op;
773 pNew->iAgg = -1;
774 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000775 if( nExtra==0 ){
drhb98a2e32017-07-07 12:43:57 +0000776 pNew->flags |= EP_IntValue|EP_Leaf;
drh33e619f2009-05-28 01:00:55 +0000777 pNew->u.iValue = iValue;
778 }else{
drh33e619f2009-05-28 01:00:55 +0000779 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000780 assert( pToken->z!=0 || pToken->n==0 );
781 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000782 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000783 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000784 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000785 }
drhb7916a72009-05-27 10:31:29 +0000786 }
787 }
788#if SQLITE_MAX_EXPR_DEPTH>0
789 pNew->nHeight = 1;
790#endif
791 }
drha76b5df2002-02-23 02:32:10 +0000792 return pNew;
793}
794
795/*
drhb7916a72009-05-27 10:31:29 +0000796** Allocate a new expression node from a zero-terminated token that has
797** already been dequoted.
798*/
799Expr *sqlite3Expr(
800 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
801 int op, /* Expression opcode */
802 const char *zToken /* Token argument. Might be NULL */
803){
804 Token x;
805 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000806 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000807 return sqlite3ExprAlloc(db, op, &x, 0);
808}
809
810/*
811** Attach subtrees pLeft and pRight to the Expr node pRoot.
812**
813** If pRoot==NULL that means that a memory allocation error has occurred.
814** In that case, delete the subtrees pLeft and pRight.
815*/
816void sqlite3ExprAttachSubtrees(
817 sqlite3 *db,
818 Expr *pRoot,
819 Expr *pLeft,
820 Expr *pRight
821){
822 if( pRoot==0 ){
823 assert( db->mallocFailed );
824 sqlite3ExprDelete(db, pLeft);
825 sqlite3ExprDelete(db, pRight);
826 }else{
827 if( pRight ){
828 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000829 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000830 }
831 if( pLeft ){
832 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 exprSetHeight(pRoot);
836 }
837}
838
839/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000840** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000841**
drhbf664462009-06-19 18:32:54 +0000842** One or both of the subtrees can be NULL. Return a pointer to the new
843** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
844** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000845*/
drh17435752007-08-16 04:30:38 +0000846Expr *sqlite3PExpr(
847 Parse *pParse, /* Parsing context */
848 int op, /* Expression opcode */
849 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000850 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000851){
drh5fb52ca2012-03-31 02:34:35 +0000852 Expr *p;
drh1167d322015-10-28 20:01:45 +0000853 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000854 /* Take advantage of short-circuit false optimization for AND */
855 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
856 }else{
drhabfd35e2016-12-06 22:47:23 +0000857 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858 if( p ){
859 memset(p, 0, sizeof(Expr));
860 p->op = op & TKFLG_MASK;
861 p->iAgg = -1;
862 }
drh5fb52ca2012-03-31 02:34:35 +0000863 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
864 }
dan2b359bd2010-10-28 11:31:23 +0000865 if( p ) {
866 sqlite3ExprCheckHeight(pParse, p->nHeight);
867 }
drh4e0cff62004-11-05 05:10:28 +0000868 return p;
869}
870
871/*
drh08de4f72016-04-11 01:06:47 +0000872** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
873** do a memory allocation failure) then delete the pSelect object.
874*/
875void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
876 if( pExpr ){
877 pExpr->x.pSelect = pSelect;
878 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
879 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
880 }else{
881 assert( pParse->db->mallocFailed );
882 sqlite3SelectDelete(pParse->db, pSelect);
883 }
884}
885
886
887/*
drh991a1982014-01-02 17:57:16 +0000888** If the expression is always either TRUE or FALSE (respectively),
889** then return 1. If one cannot determine the truth value of the
890** expression at compile-time return 0.
891**
892** This is an optimization. If is OK to return 0 here even if
893** the expression really is always false or false (a false negative).
894** But it is a bug to return 1 if the expression might have different
895** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000896**
897** Note that if the expression is part of conditional for a
898** LEFT JOIN, then we cannot determine at compile-time whether or not
899** is it true or false, so always return 0.
900*/
drh991a1982014-01-02 17:57:16 +0000901static int exprAlwaysTrue(Expr *p){
902 int v = 0;
903 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
904 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
905 return v!=0;
906}
drh5fb52ca2012-03-31 02:34:35 +0000907static int exprAlwaysFalse(Expr *p){
908 int v = 0;
909 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
910 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
911 return v==0;
912}
913
914/*
drh91bb0ee2004-09-01 03:06:34 +0000915** Join two expressions using an AND operator. If either expression is
916** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000917**
918** If one side or the other of the AND is known to be false, then instead
919** of returning an AND expression, just return a constant expression with
920** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000921*/
danielk19771e536952007-08-16 10:09:01 +0000922Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000923 if( pLeft==0 ){
924 return pRight;
925 }else if( pRight==0 ){
926 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000927 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
928 sqlite3ExprDelete(db, pLeft);
929 sqlite3ExprDelete(db, pRight);
930 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000931 }else{
drhb7916a72009-05-27 10:31:29 +0000932 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
933 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
934 return pNew;
drha76b5df2002-02-23 02:32:10 +0000935 }
936}
937
938/*
939** Construct a new expression node for a function with multiple
940** arguments.
941*/
drh954733b2018-07-27 23:33:16 +0000942Expr *sqlite3ExprFunction(
943 Parse *pParse, /* Parsing context */
944 ExprList *pList, /* Argument list */
945 Token *pToken, /* Name of the function */
946 int eDistinct /* SF_Distinct or SF_ALL or 0 */
947){
drha76b5df2002-02-23 02:32:10 +0000948 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000949 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000950 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000951 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000952 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000953 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000954 return 0;
955 }
drh954733b2018-07-27 23:33:16 +0000956 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
957 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
958 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000959 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000960 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000961 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000962 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000963 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000964 return pNew;
965}
966
967/*
drhfa6bc002004-09-07 16:19:52 +0000968** Assign a variable number to an expression that encodes a wildcard
969** in the original SQL statement.
970**
971** Wildcards consisting of a single "?" are assigned the next sequential
972** variable number.
973**
974** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000975** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000976** the SQL statement comes from an external source.
977**
drh51f49f12009-05-21 20:41:32 +0000978** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000979** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000980** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000981** assigned.
982*/
drhde25a882016-10-03 15:28:24 +0000983void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000984 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000985 const char *z;
drhf326d662016-12-23 13:30:53 +0000986 ynVar x;
drh17435752007-08-16 04:30:38 +0000987
drhfa6bc002004-09-07 16:19:52 +0000988 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000989 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000990 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000991 assert( z!=0 );
992 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000993 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000994 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000995 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000996 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000997 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000998 }else{
drhf326d662016-12-23 13:30:53 +0000999 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001000 if( z[0]=='?' ){
1001 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1002 ** use it as the variable number */
1003 i64 i;
drh18814df2017-01-31 03:52:34 +00001004 int bOk;
1005 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1006 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1007 bOk = 1;
1008 }else{
1009 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1010 }
drh124c0b42011-06-01 18:15:55 +00001011 testcase( i==0 );
1012 testcase( i==1 );
1013 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1014 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1015 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1017 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001018 return;
drhfa6bc002004-09-07 16:19:52 +00001019 }
drh8e74e7b2017-01-31 12:41:48 +00001020 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001021 if( x>pParse->nVar ){
1022 pParse->nVar = (int)x;
1023 doAdd = 1;
1024 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1025 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001026 }
1027 }else{
1028 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1029 ** number as the prior appearance of the same name, or if the name
1030 ** has never appeared before, reuse the same variable number
1031 */
drh9bf755c2016-12-23 03:59:31 +00001032 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1033 if( x==0 ){
1034 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001035 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001036 }
drhfa6bc002004-09-07 16:19:52 +00001037 }
drhf326d662016-12-23 13:30:53 +00001038 if( doAdd ){
1039 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1040 }
1041 }
1042 pExpr->iColumn = x;
1043 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001044 sqlite3ErrorMsg(pParse, "too many SQL variables");
1045 }
drhfa6bc002004-09-07 16:19:52 +00001046}
1047
1048/*
danf6963f92009-11-23 14:39:14 +00001049** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001050*/
drh4f0010b2016-04-11 14:49:39 +00001051static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1052 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001053 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1054 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001055
1056 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1057 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1058 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001059#ifdef SQLITE_DEBUG
1060 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1061 assert( p->pLeft==0 );
1062 assert( p->pRight==0 );
1063 assert( p->x.pSelect==0 );
1064 }
1065#endif
1066 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001067 /* The Expr.x union is never used at the same time as Expr.pRight */
1068 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001069 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001070 if( p->pRight ){
1071 sqlite3ExprDeleteNN(db, p->pRight);
1072 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001073 sqlite3SelectDelete(db, p->x.pSelect);
1074 }else{
1075 sqlite3ExprListDelete(db, p->x.pList);
1076 }
drheda079c2018-09-20 19:02:15 +00001077 if( ExprHasProperty(p, EP_WinFunc) ){
1078 assert( p->op==TK_FUNCTION );
1079 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001080 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001081 }
drh209bc522016-09-23 21:36:24 +00001082 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001083 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001084 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001085 }
drha2e00042002-01-22 03:13:42 +00001086}
drh4f0010b2016-04-11 14:49:39 +00001087void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1088 if( p ) sqlite3ExprDeleteNN(db, p);
1089}
drha2e00042002-01-22 03:13:42 +00001090
drhd2687b72005-08-12 22:56:09 +00001091/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001092** Return the number of bytes allocated for the expression structure
1093** passed as the first argument. This is always one of EXPR_FULLSIZE,
1094** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1095*/
1096static int exprStructSize(Expr *p){
1097 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001098 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1099 return EXPR_FULLSIZE;
1100}
1101
1102/*
drha8e05762019-01-05 21:56:12 +00001103** Copy the complete content of an Expr node, taking care not to read
1104** past the end of the structure for a reduced-size version of the source
1105** Expr.
1106*/
1107static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1108 memset(pDest, 0, sizeof(Expr));
1109 memcpy(pDest, pSrc, exprStructSize(pSrc));
1110}
1111
1112/*
drh33e619f2009-05-28 01:00:55 +00001113** The dupedExpr*Size() routines each return the number of bytes required
1114** to store a copy of an expression or expression tree. They differ in
1115** how much of the tree is measured.
1116**
1117** dupedExprStructSize() Size of only the Expr structure
1118** dupedExprNodeSize() Size of Expr + space for token
1119** dupedExprSize() Expr + token + subtree components
1120**
1121***************************************************************************
1122**
1123** The dupedExprStructSize() function returns two values OR-ed together:
1124** (1) the space required for a copy of the Expr structure only and
1125** (2) the EP_xxx flags that indicate what the structure size should be.
1126** The return values is always one of:
1127**
1128** EXPR_FULLSIZE
1129** EXPR_REDUCEDSIZE | EP_Reduced
1130** EXPR_TOKENONLYSIZE | EP_TokenOnly
1131**
1132** The size of the structure can be found by masking the return value
1133** of this routine with 0xfff. The flags can be found by masking the
1134** return value with EP_Reduced|EP_TokenOnly.
1135**
1136** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1137** (unreduced) Expr objects as they or originally constructed by the parser.
1138** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001139** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001140** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001141** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001142** to reduce a pristine expression tree from the parser. The implementation
1143** of dupedExprStructSize() contain multiple assert() statements that attempt
1144** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001145*/
1146static int dupedExprStructSize(Expr *p, int flags){
1147 int nSize;
drh33e619f2009-05-28 01:00:55 +00001148 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001149 assert( EXPR_FULLSIZE<=0xfff );
1150 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001151 if( 0==flags || p->op==TK_SELECT_COLUMN
1152#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001153 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001154#endif
1155 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001156 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001157 }else{
drhc5cd1242013-09-12 16:50:49 +00001158 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001159 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001160 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001161 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001162 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001163 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1164 }else{
drhaecd8022013-09-13 18:15:15 +00001165 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001166 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1167 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001168 }
1169 return nSize;
1170}
1171
1172/*
drh33e619f2009-05-28 01:00:55 +00001173** This function returns the space in bytes required to store the copy
1174** of the Expr structure and a copy of the Expr.u.zToken string (if that
1175** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001176*/
1177static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001178 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1179 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001180 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001181 }
danielk1977bc739712009-03-23 04:33:32 +00001182 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001183}
1184
1185/*
1186** Return the number of bytes required to create a duplicate of the
1187** expression passed as the first argument. The second argument is a
1188** mask containing EXPRDUP_XXX flags.
1189**
1190** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001191** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001192**
1193** If the EXPRDUP_REDUCE flag is set, then the return value includes
1194** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1195** and Expr.pRight variables (but not for any structures pointed to or
1196** descended from the Expr.x.pList or Expr.x.pSelect variables).
1197*/
1198static int dupedExprSize(Expr *p, int flags){
1199 int nByte = 0;
1200 if( p ){
1201 nByte = dupedExprNodeSize(p, flags);
1202 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001203 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001204 }
1205 }
1206 return nByte;
1207}
1208
1209/*
1210** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1211** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001212** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001213** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001214** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001215** portion of the buffer copied into by this function.
1216*/
drh3c194692016-04-11 16:43:43 +00001217static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1218 Expr *pNew; /* Value to return */
1219 u8 *zAlloc; /* Memory space from which to build Expr object */
1220 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1221
drh575fad62016-02-05 13:38:36 +00001222 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001223 assert( p );
1224 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1225 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001226
drh3c194692016-04-11 16:43:43 +00001227 /* Figure out where to write the new Expr structure. */
1228 if( pzBuffer ){
1229 zAlloc = *pzBuffer;
1230 staticFlag = EP_Static;
1231 }else{
1232 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1233 staticFlag = 0;
1234 }
1235 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001236
drh3c194692016-04-11 16:43:43 +00001237 if( pNew ){
1238 /* Set nNewSize to the size allocated for the structure pointed to
1239 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1240 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1241 ** by the copy of the p->u.zToken string (if any).
1242 */
1243 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1244 const int nNewSize = nStructSize & 0xfff;
1245 int nToken;
1246 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1247 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001248 }else{
drh3c194692016-04-11 16:43:43 +00001249 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001250 }
drh3c194692016-04-11 16:43:43 +00001251 if( dupFlags ){
1252 assert( ExprHasProperty(p, EP_Reduced)==0 );
1253 memcpy(zAlloc, p, nNewSize);
1254 }else{
1255 u32 nSize = (u32)exprStructSize(p);
1256 memcpy(zAlloc, p, nSize);
1257 if( nSize<EXPR_FULLSIZE ){
1258 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1259 }
1260 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001261
drh3c194692016-04-11 16:43:43 +00001262 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1263 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1264 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1265 pNew->flags |= staticFlag;
1266
1267 /* Copy the p->u.zToken string, if any. */
1268 if( nToken ){
1269 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1270 memcpy(zToken, p->u.zToken, nToken);
1271 }
1272
drh209bc522016-09-23 21:36:24 +00001273 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001274 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1275 if( ExprHasProperty(p, EP_xIsSelect) ){
1276 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001277 }else{
drh3c194692016-04-11 16:43:43 +00001278 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001279 }
drh3c194692016-04-11 16:43:43 +00001280 }
1281
1282 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001283 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1284 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001285 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001286 pNew->pLeft = p->pLeft ?
1287 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1288 pNew->pRight = p->pRight ?
1289 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001290 }
dan67a9b8e2018-06-22 20:51:35 +00001291#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001292 if( ExprHasProperty(p, EP_WinFunc) ){
1293 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1294 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001295 }
dan67a9b8e2018-06-22 20:51:35 +00001296#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001297 if( pzBuffer ){
1298 *pzBuffer = zAlloc;
1299 }
1300 }else{
drh209bc522016-09-23 21:36:24 +00001301 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001302 if( pNew->op==TK_SELECT_COLUMN ){
1303 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001304 assert( p->iColumn==0 || p->pRight==0 );
1305 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001306 }else{
1307 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1308 }
drh3c194692016-04-11 16:43:43 +00001309 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001310 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001311 }
1312 }
1313 return pNew;
1314}
1315
1316/*
danbfe31e72014-01-15 14:17:31 +00001317** Create and return a deep copy of the object passed as the second
1318** argument. If an OOM condition is encountered, NULL is returned
1319** and the db->mallocFailed flag set.
1320*/
daneede6a52014-01-15 19:42:23 +00001321#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001322static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001323 With *pRet = 0;
1324 if( p ){
1325 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
1326 pRet = sqlite3DbMallocZero(db, nByte);
1327 if( pRet ){
1328 int i;
1329 pRet->nCte = p->nCte;
1330 for(i=0; i<p->nCte; i++){
1331 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1332 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1333 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1334 }
1335 }
1336 }
1337 return pRet;
1338}
daneede6a52014-01-15 19:42:23 +00001339#else
1340# define withDup(x,y) 0
1341#endif
dan4e9119d2014-01-13 15:12:23 +00001342
drha8389972018-12-06 22:04:19 +00001343#ifndef SQLITE_OMIT_WINDOWFUNC
1344/*
1345** The gatherSelectWindows() procedure and its helper routine
1346** gatherSelectWindowsCallback() are used to scan all the expressions
1347** an a newly duplicated SELECT statement and gather all of the Window
1348** objects found there, assembling them onto the linked list at Select->pWin.
1349*/
1350static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1351 if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1352 assert( ExprHasProperty(pExpr, EP_WinFunc) );
1353 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1354 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1355 }
1356 return WRC_Continue;
1357}
drha37b6a52018-12-06 22:12:18 +00001358static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1359 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1360}
drha8389972018-12-06 22:04:19 +00001361static void gatherSelectWindows(Select *p){
1362 Walker w;
1363 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001364 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1365 w.xSelectCallback2 = 0;
drha8389972018-12-06 22:04:19 +00001366 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001367 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001368}
1369#endif
1370
1371
drha76b5df2002-02-23 02:32:10 +00001372/*
drhff78bd22002-02-27 01:47:11 +00001373** The following group of routines make deep copies of expressions,
1374** expression lists, ID lists, and select statements. The copies can
1375** be deleted (by being passed to their respective ...Delete() routines)
1376** without effecting the originals.
1377**
danielk19774adee202004-05-08 08:23:19 +00001378** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1379** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001380** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001381**
drhad3cab52002-05-24 02:04:32 +00001382** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001383**
drhb7916a72009-05-27 10:31:29 +00001384** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001385** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1386** truncated version of the usual Expr structure that will be stored as
1387** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001388*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001389Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001390 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001391 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001392}
danielk19776ab3a2e2009-02-19 14:39:25 +00001393ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001394 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001395 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001396 int i;
drhb1637482017-01-03 00:27:16 +00001397 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001398 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001399 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001400 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001401 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001402 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001403 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001404 pOldItem = p->a;
1405 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001406 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001407 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001408 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001409 if( pOldExpr
1410 && pOldExpr->op==TK_SELECT_COLUMN
1411 && (pNewExpr = pItem->pExpr)!=0
1412 ){
1413 assert( pNewExpr->iColumn==0 || i>0 );
1414 if( pNewExpr->iColumn==0 ){
1415 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001416 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1417 }else{
1418 assert( i>0 );
1419 assert( pItem[-1].pExpr!=0 );
1420 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1421 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1422 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001423 }
1424 }
drh17435752007-08-16 04:30:38 +00001425 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001426 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001427 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001428 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001429 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001430 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001431 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001432 }
1433 return pNew;
1434}
danielk197793758c82005-01-21 08:13:14 +00001435
1436/*
1437** If cursors, triggers, views and subqueries are all omitted from
1438** the build, then none of the following routines, except for
1439** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1440** called with a NULL argument.
1441*/
danielk19776a67fe82005-02-04 04:07:16 +00001442#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1443 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001444SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001445 SrcList *pNew;
1446 int i;
drh113088e2003-03-20 01:16:58 +00001447 int nByte;
drh575fad62016-02-05 13:38:36 +00001448 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001449 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001450 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001451 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001452 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001453 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001454 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001455 struct SrcList_item *pNewItem = &pNew->a[i];
1456 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001457 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001458 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001459 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1460 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1461 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001462 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001463 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001464 pNewItem->addrFillSub = pOldItem->addrFillSub;
1465 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001466 if( pNewItem->fg.isIndexedBy ){
1467 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1468 }
1469 pNewItem->pIBIndex = pOldItem->pIBIndex;
1470 if( pNewItem->fg.isTabFunc ){
1471 pNewItem->u1.pFuncArg =
1472 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1473 }
drhed8a3bb2005-06-06 21:19:56 +00001474 pTab = pNewItem->pTab = pOldItem->pTab;
1475 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001476 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001477 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001478 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1479 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001480 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001481 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001482 }
1483 return pNew;
1484}
drh17435752007-08-16 04:30:38 +00001485IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001486 IdList *pNew;
1487 int i;
drh575fad62016-02-05 13:38:36 +00001488 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001489 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001490 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001491 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001492 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001493 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001494 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001495 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001496 return 0;
1497 }
drh6c535152012-02-02 03:38:30 +00001498 /* Note that because the size of the allocation for p->a[] is not
1499 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1500 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001501 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001502 struct IdList_item *pNewItem = &pNew->a[i];
1503 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001504 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001505 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001506 }
1507 return pNew;
1508}
dana7466202017-02-03 14:44:52 +00001509Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1510 Select *pRet = 0;
1511 Select *pNext = 0;
1512 Select **pp = &pRet;
1513 Select *p;
1514
drh575fad62016-02-05 13:38:36 +00001515 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001516 for(p=pDup; p; p=p->pPrior){
1517 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1518 if( pNew==0 ) break;
1519 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1520 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1521 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1522 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1523 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1524 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1525 pNew->op = p->op;
1526 pNew->pNext = pNext;
1527 pNew->pPrior = 0;
1528 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001529 pNew->iLimit = 0;
1530 pNew->iOffset = 0;
1531 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1532 pNew->addrOpenEphm[0] = -1;
1533 pNew->addrOpenEphm[1] = -1;
1534 pNew->nSelectRow = p->nSelectRow;
1535 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001536#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001537 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001538 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001539 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001540#endif
drhfef37762018-07-10 19:48:35 +00001541 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001542 *pp = pNew;
1543 pp = &pNew->pPrior;
1544 pNext = pNew;
1545 }
1546
1547 return pRet;
drhff78bd22002-02-27 01:47:11 +00001548}
danielk197793758c82005-01-21 08:13:14 +00001549#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001550Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001551 assert( p==0 );
1552 return 0;
1553}
1554#endif
drhff78bd22002-02-27 01:47:11 +00001555
1556
1557/*
drha76b5df2002-02-23 02:32:10 +00001558** Add a new element to the end of an expression list. If pList is
1559** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001560**
drha19543f2017-09-15 15:17:48 +00001561** The pList argument must be either NULL or a pointer to an ExprList
1562** obtained from a prior call to sqlite3ExprListAppend(). This routine
1563** may not be used with an ExprList obtained from sqlite3ExprListDup().
1564** Reason: This routine assumes that the number of slots in pList->a[]
1565** is a power of two. That is true for sqlite3ExprListAppend() returns
1566** but is not necessarily true from the return value of sqlite3ExprListDup().
1567**
drhb7916a72009-05-27 10:31:29 +00001568** If a memory allocation error occurs, the entire list is freed and
1569** NULL is returned. If non-NULL is returned, then it is guaranteed
1570** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001571*/
drh17435752007-08-16 04:30:38 +00001572ExprList *sqlite3ExprListAppend(
1573 Parse *pParse, /* Parsing context */
1574 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001575 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001576){
drh43606172017-04-05 11:32:13 +00001577 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001578 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001579 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001580 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001581 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001582 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001583 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001584 }
drhc263f7c2016-01-18 13:18:54 +00001585 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001586 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001587 ExprList *pNew;
1588 pNew = sqlite3DbRealloc(db, pList,
drha19543f2017-09-15 15:17:48 +00001589 sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001590 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001591 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001592 }
drh43606172017-04-05 11:32:13 +00001593 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001594 }
drh43606172017-04-05 11:32:13 +00001595 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001596 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1597 assert( offsetof(struct ExprList_item,pExpr)==0 );
1598 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001599 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001600 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001601
1602no_mem:
1603 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001604 sqlite3ExprDelete(db, pExpr);
1605 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001606 return 0;
drha76b5df2002-02-23 02:32:10 +00001607}
1608
1609/*
drh8762ec12016-08-20 01:06:22 +00001610** pColumns and pExpr form a vector assignment which is part of the SET
1611** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001612**
1613** (a,b,c) = (expr1,expr2,expr3)
1614** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1615**
1616** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001617** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001618** TK_SELECT_COLUMN expressions.
1619*/
1620ExprList *sqlite3ExprListAppendVector(
1621 Parse *pParse, /* Parsing context */
1622 ExprList *pList, /* List to which to append. Might be NULL */
1623 IdList *pColumns, /* List of names of LHS of the assignment */
1624 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1625){
1626 sqlite3 *db = pParse->db;
1627 int n;
1628 int i;
drh66860af2016-08-23 18:30:10 +00001629 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001630 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1631 ** exit prior to this routine being invoked */
1632 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001633 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001634
1635 /* If the RHS is a vector, then we can immediately check to see that
1636 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1637 ** wildcards ("*") in the result set of the SELECT must be expanded before
1638 ** we can do the size check, so defer the size check until code generation.
1639 */
1640 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001641 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1642 pColumns->nId, n);
1643 goto vector_append_error;
1644 }
drh966e2912017-01-03 02:58:01 +00001645
1646 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001647 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1648 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1649 if( pList ){
drh66860af2016-08-23 18:30:10 +00001650 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001651 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1652 pColumns->a[i].zName = 0;
1653 }
1654 }
drh966e2912017-01-03 02:58:01 +00001655
drhffe28052017-05-06 18:09:36 +00001656 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001657 Expr *pFirst = pList->a[iFirst].pExpr;
1658 assert( pFirst!=0 );
1659 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001660
drhf4dd26c2017-04-05 11:49:06 +00001661 /* Store the SELECT statement in pRight so it will be deleted when
1662 ** sqlite3ExprListDelete() is called */
1663 pFirst->pRight = pExpr;
1664 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001665
drhf4dd26c2017-04-05 11:49:06 +00001666 /* Remember the size of the LHS in iTable so that we can check that
1667 ** the RHS and LHS sizes match during code generation. */
1668 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001669 }
1670
1671vector_append_error:
dandfb5c962019-01-15 20:51:35 +00001672 if( IN_RENAME_OBJECT ){
1673 sqlite3RenameExprUnmap(pParse, pExpr);
1674 }
drha1251bc2016-08-20 00:51:37 +00001675 sqlite3ExprDelete(db, pExpr);
1676 sqlite3IdListDelete(db, pColumns);
1677 return pList;
1678}
1679
1680/*
drhbc622bc2015-08-24 15:39:42 +00001681** Set the sort order for the last element on the given ExprList.
1682*/
1683void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1684 if( p==0 ) return;
1685 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1686 assert( p->nExpr>0 );
1687 if( iSortOrder<0 ){
1688 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1689 return;
1690 }
1691 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001692}
1693
1694/*
drhb7916a72009-05-27 10:31:29 +00001695** Set the ExprList.a[].zName element of the most recently added item
1696** on the expression list.
1697**
1698** pList might be NULL following an OOM error. But pName should never be
1699** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1700** is set.
1701*/
1702void sqlite3ExprListSetName(
1703 Parse *pParse, /* Parsing context */
1704 ExprList *pList, /* List to which to add the span. */
1705 Token *pName, /* Name to be added */
1706 int dequote /* True to cause the name to be dequoted */
1707){
1708 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1709 if( pList ){
1710 struct ExprList_item *pItem;
1711 assert( pList->nExpr>0 );
1712 pItem = &pList->a[pList->nExpr-1];
1713 assert( pItem->zName==0 );
1714 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001715 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001716 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001717 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001718 }
drhb7916a72009-05-27 10:31:29 +00001719 }
1720}
1721
1722/*
1723** Set the ExprList.a[].zSpan element of the most recently added item
1724** on the expression list.
1725**
1726** pList might be NULL following an OOM error. But pSpan should never be
1727** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1728** is set.
1729*/
1730void sqlite3ExprListSetSpan(
1731 Parse *pParse, /* Parsing context */
1732 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001733 const char *zStart, /* Start of the span */
1734 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001735){
1736 sqlite3 *db = pParse->db;
1737 assert( pList!=0 || db->mallocFailed!=0 );
1738 if( pList ){
1739 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1740 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001741 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001742 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001743 }
1744}
1745
1746/*
danielk19777a15a4b2007-05-08 17:54:43 +00001747** If the expression list pEList contains more than iLimit elements,
1748** leave an error message in pParse.
1749*/
1750void sqlite3ExprListCheckLength(
1751 Parse *pParse,
1752 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001753 const char *zObject
1754){
drhb1a6c3c2008-03-20 16:30:17 +00001755 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001756 testcase( pEList && pEList->nExpr==mx );
1757 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001758 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001759 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1760 }
1761}
1762
1763/*
drha76b5df2002-02-23 02:32:10 +00001764** Delete an entire expression list.
1765*/
drhaffa8552016-04-11 18:25:05 +00001766static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001767 int i = pList->nExpr;
1768 struct ExprList_item *pItem = pList->a;
1769 assert( pList->nExpr>0 );
1770 do{
drh633e6d52008-07-28 19:34:53 +00001771 sqlite3ExprDelete(db, pItem->pExpr);
1772 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001773 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001774 pItem++;
1775 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001776 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001777}
drhaffa8552016-04-11 18:25:05 +00001778void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1779 if( pList ) exprListDeleteNN(db, pList);
1780}
drha76b5df2002-02-23 02:32:10 +00001781
1782/*
drh2308ed32015-02-09 16:09:34 +00001783** Return the bitwise-OR of all Expr.flags fields in the given
1784** ExprList.
drh885a5b02015-02-09 15:21:36 +00001785*/
drh2308ed32015-02-09 16:09:34 +00001786u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001787 int i;
drh2308ed32015-02-09 16:09:34 +00001788 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001789 assert( pList!=0 );
1790 for(i=0; i<pList->nExpr; i++){
1791 Expr *pExpr = pList->a[i].pExpr;
1792 assert( pExpr!=0 );
1793 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001794 }
drh2308ed32015-02-09 16:09:34 +00001795 return m;
drh885a5b02015-02-09 15:21:36 +00001796}
1797
1798/*
drh7e6f9802017-09-04 00:33:04 +00001799** This is a SELECT-node callback for the expression walker that
1800** always "fails". By "fail" in this case, we mean set
1801** pWalker->eCode to zero and abort.
1802**
1803** This callback is used by multiple expression walkers.
1804*/
1805int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1806 UNUSED_PARAMETER(NotUsed);
1807 pWalker->eCode = 0;
1808 return WRC_Abort;
1809}
1810
1811/*
drh171d16b2018-02-26 20:15:54 +00001812** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001813** then convert it into an TK_TRUEFALSE term. Return non-zero if
1814** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001815*/
1816int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1817 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001818 if( !ExprHasProperty(pExpr, EP_Quoted)
1819 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1820 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001821 ){
1822 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001823 return 1;
1824 }
1825 return 0;
1826}
1827
drh43c4ac82018-02-26 21:26:27 +00001828/*
drh96acafb2018-02-27 14:49:25 +00001829** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001830** and 0 if it is FALSE.
1831*/
drh96acafb2018-02-27 14:49:25 +00001832int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001833 assert( pExpr->op==TK_TRUEFALSE );
1834 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1835 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1836 return pExpr->u.zToken[4]==0;
1837}
1838
drh171d16b2018-02-26 20:15:54 +00001839
1840/*
drh059b2d52014-10-24 19:28:09 +00001841** These routines are Walker callbacks used to check expressions to
1842** see if they are "constant" for some definition of constant. The
1843** Walker.eCode value determines the type of "constant" we are looking
1844** for.
drh73b211a2005-01-18 04:00:42 +00001845**
drh7d10d5a2008-08-20 16:35:10 +00001846** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001847**
drh059b2d52014-10-24 19:28:09 +00001848** sqlite3ExprIsConstant() pWalker->eCode==1
1849** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001850** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001851** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001852**
drh059b2d52014-10-24 19:28:09 +00001853** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1854** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001855**
drhfeada2d2014-09-24 13:20:22 +00001856** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001857** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1858** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001859** parameter raises an error for new statements, but is silently converted
1860** to NULL for existing schemas. This allows sqlite_master tables that
1861** contain a bound parameter because they were generated by older versions
1862** of SQLite to be parsed by newer versions of SQLite without raising a
1863** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001864*/
drh7d10d5a2008-08-20 16:35:10 +00001865static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001866
drh059b2d52014-10-24 19:28:09 +00001867 /* If pWalker->eCode is 2 then any term of the expression that comes from
1868 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001869 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001870 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1871 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001872 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001873 }
1874
drh626a8792005-01-17 22:08:19 +00001875 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001876 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001877 ** and either pWalker->eCode==4 or 5 or the function has the
1878 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001879 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001880 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001881 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001882 }else{
1883 pWalker->eCode = 0;
1884 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001885 }
drh626a8792005-01-17 22:08:19 +00001886 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001887 /* Convert "true" or "false" in a DEFAULT clause into the
1888 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001889 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001890 return WRC_Prune;
1891 }
1892 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001893 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001894 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001895 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001896 testcase( pExpr->op==TK_ID );
1897 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001898 testcase( pExpr->op==TK_AGG_FUNCTION );
1899 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001900 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001901 return WRC_Continue;
1902 }
drh059b2d52014-10-24 19:28:09 +00001903 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1904 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001905 }
drhf43ce0b2017-05-25 00:08:48 +00001906 /* Fall through */
1907 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001908 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001909 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001910 testcase( pExpr->op==TK_IF_NULL_ROW );
1911 pWalker->eCode = 0;
1912 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001913 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001914 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001915 /* Silently convert bound parameters that appear inside of CREATE
1916 ** statements into a NULL when parsing the CREATE statement text out
1917 ** of the sqlite_master table */
1918 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001919 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001920 /* A bound parameter in a CREATE statement that originates from
1921 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001922 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001923 return WRC_Abort;
1924 }
1925 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001926 default:
drh6e341b92018-04-17 18:50:40 +00001927 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1928 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001929 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001930 }
1931}
drh059b2d52014-10-24 19:28:09 +00001932static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001933 Walker w;
drh059b2d52014-10-24 19:28:09 +00001934 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001935 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001936 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001937#ifdef SQLITE_DEBUG
1938 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1939#endif
drh059b2d52014-10-24 19:28:09 +00001940 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001941 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001942 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001943}
drh626a8792005-01-17 22:08:19 +00001944
1945/*
drh059b2d52014-10-24 19:28:09 +00001946** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001947** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001948**
1949** For the purposes of this function, a double-quoted string (ex: "abc")
1950** is considered a variable but a single-quoted string (ex: 'abc') is
1951** a constant.
drhfef52082000-06-06 01:50:43 +00001952*/
danielk19774adee202004-05-08 08:23:19 +00001953int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001954 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001955}
1956
1957/*
drh07aded62018-07-28 16:24:08 +00001958** Walk an expression tree. Return non-zero if
1959**
1960** (1) the expression is constant, and
1961** (2) the expression does originate in the ON or USING clause
1962** of a LEFT JOIN, and
1963** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1964** operands created by the constant propagation optimization.
1965**
1966** When this routine returns true, it indicates that the expression
1967** can be added to the pParse->pConstExpr list and evaluated once when
1968** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001969*/
1970int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001971 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001972}
1973
1974/*
drhfcb9f4f2015-06-01 18:13:16 +00001975** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001976** for any single row of the table with cursor iCur. In other words, the
1977** expression must not refer to any non-deterministic function nor any
1978** table other than iCur.
1979*/
1980int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1981 return exprIsConst(p, 3, iCur);
1982}
1983
danab31a842017-04-29 20:53:09 +00001984
1985/*
1986** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1987*/
1988static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1989 ExprList *pGroupBy = pWalker->u.pGroupBy;
1990 int i;
1991
1992 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1993 ** it constant. */
1994 for(i=0; i<pGroupBy->nExpr; i++){
1995 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001996 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001997 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001998 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001999 return WRC_Prune;
2000 }
2001 }
2002 }
2003
2004 /* Check if pExpr is a sub-select. If so, consider it variable. */
2005 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2006 pWalker->eCode = 0;
2007 return WRC_Abort;
2008 }
2009
2010 return exprNodeIsConstant(pWalker, pExpr);
2011}
2012
2013/*
2014** Walk the expression tree passed as the first argument. Return non-zero
2015** if the expression consists entirely of constants or copies of terms
2016** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002017**
2018** This routine is used to determine if a term of the HAVING clause can
2019** be promoted into the WHERE clause. In order for such a promotion to work,
2020** the value of the HAVING clause term must be the same for all members of
2021** a "group". The requirement that the GROUP BY term must be BINARY
2022** assumes that no other collating sequence will have a finer-grained
2023** grouping than binary. In other words (A=B COLLATE binary) implies
2024** A=B in every other collating sequence. The requirement that the
2025** GROUP BY be BINARY is stricter than necessary. It would also work
2026** to promote HAVING clauses that use the same alternative collating
2027** sequence as the GROUP BY term, but that is much harder to check,
2028** alternative collating sequences are uncommon, and this is only an
2029** optimization, so we take the easy way out and simply require the
2030** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002031*/
2032int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2033 Walker w;
danab31a842017-04-29 20:53:09 +00002034 w.eCode = 1;
2035 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002036 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002037 w.u.pGroupBy = pGroupBy;
2038 w.pParse = pParse;
2039 sqlite3WalkExpr(&w, p);
2040 return w.eCode;
2041}
2042
drh059b2d52014-10-24 19:28:09 +00002043/*
2044** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002045** or a function call with constant arguments. Return and 0 if there
2046** are any variables.
2047**
2048** For the purposes of this function, a double-quoted string (ex: "abc")
2049** is considered a variable but a single-quoted string (ex: 'abc') is
2050** a constant.
2051*/
drhfeada2d2014-09-24 13:20:22 +00002052int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2053 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002054 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002055}
2056
drh5b88bc42013-12-07 23:35:21 +00002057#ifdef SQLITE_ENABLE_CURSOR_HINTS
2058/*
2059** Walk an expression tree. Return 1 if the expression contains a
2060** subquery of some kind. Return 0 if there are no subqueries.
2061*/
2062int sqlite3ExprContainsSubquery(Expr *p){
2063 Walker w;
drhbec24762015-08-13 20:07:13 +00002064 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002065 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002066 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002067#ifdef SQLITE_DEBUG
2068 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2069#endif
drh5b88bc42013-12-07 23:35:21 +00002070 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002071 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002072}
2073#endif
2074
drheb55bd22005-06-30 17:04:21 +00002075/*
drh73b211a2005-01-18 04:00:42 +00002076** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002077** to fit in a 32-bit integer, return 1 and put the value of the integer
2078** in *pValue. If the expression is not an integer or if it is too big
2079** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002080*/
danielk19774adee202004-05-08 08:23:19 +00002081int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002082 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002083 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002084
2085 /* If an expression is an integer literal that fits in a signed 32-bit
2086 ** integer, then the EP_IntValue flag will have already been set */
2087 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2088 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2089
drh92b01d52008-06-24 00:32:35 +00002090 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002091 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002092 return 1;
2093 }
drhe4de1fe2002-06-02 16:09:01 +00002094 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002095 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002096 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002097 break;
drh4b59ab52002-08-24 18:24:51 +00002098 }
drhe4de1fe2002-06-02 16:09:01 +00002099 case TK_UMINUS: {
2100 int v;
danielk19774adee202004-05-08 08:23:19 +00002101 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002102 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002103 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002104 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002105 }
2106 break;
2107 }
2108 default: break;
2109 }
drh92b01d52008-06-24 00:32:35 +00002110 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002111}
2112
2113/*
drh039fc322009-11-17 18:31:47 +00002114** Return FALSE if there is no chance that the expression can be NULL.
2115**
2116** If the expression might be NULL or if the expression is too complex
2117** to tell return TRUE.
2118**
2119** This routine is used as an optimization, to skip OP_IsNull opcodes
2120** when we know that a value cannot be NULL. Hence, a false positive
2121** (returning TRUE when in fact the expression can never be NULL) might
2122** be a small performance hit but is otherwise harmless. On the other
2123** hand, a false negative (returning FALSE when the result could be NULL)
2124** will likely result in an incorrect answer. So when in doubt, return
2125** TRUE.
2126*/
2127int sqlite3ExprCanBeNull(const Expr *p){
2128 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002129 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2130 p = p->pLeft;
2131 }
drh039fc322009-11-17 18:31:47 +00002132 op = p->op;
2133 if( op==TK_REGISTER ) op = p->op2;
2134 switch( op ){
2135 case TK_INTEGER:
2136 case TK_STRING:
2137 case TK_FLOAT:
2138 case TK_BLOB:
2139 return 0;
drh7248a8b2014-08-04 18:50:54 +00002140 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002141 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002142 p->y.pTab==0 || /* Reference to column of index on expression */
2143 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002144 default:
2145 return 1;
2146 }
2147}
2148
2149/*
2150** Return TRUE if the given expression is a constant which would be
2151** unchanged by OP_Affinity with the affinity given in the second
2152** argument.
2153**
2154** This routine is used to determine if the OP_Affinity operation
2155** can be omitted. When in doubt return FALSE. A false negative
2156** is harmless. A false positive, however, can result in the wrong
2157** answer.
2158*/
2159int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2160 u8 op;
drh05883a32015-06-02 15:32:08 +00002161 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002162 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002163 op = p->op;
2164 if( op==TK_REGISTER ) op = p->op2;
2165 switch( op ){
2166 case TK_INTEGER: {
2167 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2168 }
2169 case TK_FLOAT: {
2170 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2171 }
2172 case TK_STRING: {
2173 return aff==SQLITE_AFF_TEXT;
2174 }
2175 case TK_BLOB: {
2176 return 1;
2177 }
drh2f2855b2009-11-18 01:25:26 +00002178 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002179 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2180 return p->iColumn<0
2181 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002182 }
drh039fc322009-11-17 18:31:47 +00002183 default: {
2184 return 0;
2185 }
2186 }
2187}
2188
2189/*
drhc4a3c772001-04-04 11:48:57 +00002190** Return TRUE if the given string is a row-id column name.
2191*/
danielk19774adee202004-05-08 08:23:19 +00002192int sqlite3IsRowid(const char *z){
2193 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2194 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2195 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002196 return 0;
2197}
2198
danielk19779a96b662007-11-29 17:05:18 +00002199/*
drh69c355b2016-03-09 15:34:51 +00002200** pX is the RHS of an IN operator. If pX is a SELECT statement
2201** that can be simplified to a direct table access, then return
2202** a pointer to the SELECT statement. If pX is not a SELECT statement,
2203** or if the SELECT statement needs to be manifested into a transient
2204** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002205*/
2206#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002207static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002208 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002209 SrcList *pSrc;
2210 ExprList *pEList;
2211 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002212 int i;
drh69c355b2016-03-09 15:34:51 +00002213 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2214 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2215 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002216 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002217 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002218 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2219 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2220 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002221 }
drhb74b1012009-05-28 21:04:37 +00002222 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002223 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002224 if( p->pWhere ) return 0; /* Has no WHERE clause */
2225 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002226 assert( pSrc!=0 );
2227 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002228 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002229 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002230 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002231 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002232 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2233 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002234 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002235 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002236 for(i=0; i<pEList->nExpr; i++){
2237 Expr *pRes = pEList->a[i].pExpr;
2238 if( pRes->op!=TK_COLUMN ) return 0;
2239 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002240 }
drh69c355b2016-03-09 15:34:51 +00002241 return p;
drhb287f4b2008-04-25 00:08:38 +00002242}
2243#endif /* SQLITE_OMIT_SUBQUERY */
2244
danf9b2e052016-08-02 17:45:00 +00002245#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002246/*
drh4c259e92014-08-01 21:12:35 +00002247** Generate code that checks the left-most column of index table iCur to see if
2248** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002249** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2250** to be set to NULL if iCur contains one or more NULL values.
2251*/
2252static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002253 int addr1;
drh6be515e2014-08-01 21:00:53 +00002254 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002255 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002256 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2257 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002258 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002259 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002260}
danf9b2e052016-08-02 17:45:00 +00002261#endif
drh6be515e2014-08-01 21:00:53 +00002262
drhbb53ecb2014-08-02 21:03:33 +00002263
2264#ifndef SQLITE_OMIT_SUBQUERY
2265/*
2266** The argument is an IN operator with a list (not a subquery) on the
2267** right-hand side. Return TRUE if that list is constant.
2268*/
2269static int sqlite3InRhsIsConstant(Expr *pIn){
2270 Expr *pLHS;
2271 int res;
2272 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2273 pLHS = pIn->pLeft;
2274 pIn->pLeft = 0;
2275 res = sqlite3ExprIsConstant(pIn);
2276 pIn->pLeft = pLHS;
2277 return res;
2278}
2279#endif
2280
drh6be515e2014-08-01 21:00:53 +00002281/*
danielk19779a96b662007-11-29 17:05:18 +00002282** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002283** The pX parameter is the expression on the RHS of the IN operator, which
2284** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002285**
drhd4305ca2012-09-18 17:08:33 +00002286** The job of this routine is to find or create a b-tree object that can
2287** be used either to test for membership in the RHS set or to iterate through
2288** all members of the RHS set, skipping duplicates.
2289**
drh3a856252014-08-01 14:46:57 +00002290** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002291** and pX->iTable is set to the index of that cursor.
2292**
drhb74b1012009-05-28 21:04:37 +00002293** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002294**
drh1ccce442013-03-12 20:38:51 +00002295** IN_INDEX_ROWID - The cursor was opened on a database table.
2296** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2297** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2298** IN_INDEX_EPH - The cursor was opened on a specially created and
2299** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002300** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2301** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002302**
drhd4305ca2012-09-18 17:08:33 +00002303** An existing b-tree might be used if the RHS expression pX is a simple
2304** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002305**
dan553168c2016-08-01 20:14:31 +00002306** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002307**
drhd4305ca2012-09-18 17:08:33 +00002308** If the RHS of the IN operator is a list or a more complex subquery, then
2309** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002310** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002311** existing table.
drhd4305ca2012-09-18 17:08:33 +00002312**
drh7fc0ba02017-11-17 15:02:00 +00002313** The inFlags parameter must contain, at a minimum, one of the bits
2314** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2315** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2316** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2317** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002318**
2319** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2320** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002321** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002322** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2323** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002324**
drh3a856252014-08-01 14:46:57 +00002325** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2326** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002327** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2328** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002329**
drhbb53ecb2014-08-02 21:03:33 +00002330** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2331** if the RHS of the IN operator is a list (not a subquery) then this
2332** routine might decide that creating an ephemeral b-tree for membership
2333** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2334** calling routine should implement the IN operator using a sequence
2335** of Eq or Ne comparison operations.
2336**
drhb74b1012009-05-28 21:04:37 +00002337** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002338** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002339** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002340** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002341** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002342** to *prRhsHasNull. If there is no chance that the (...) contains a
2343** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002344**
drhe21a6e12014-08-01 18:00:24 +00002345** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002346** the value in that register will be NULL if the b-tree contains one or more
2347** NULL values, and it will be some non-NULL value if the b-tree contains no
2348** NULL values.
dan553168c2016-08-01 20:14:31 +00002349**
2350** If the aiMap parameter is not NULL, it must point to an array containing
2351** one element for each column returned by the SELECT statement on the RHS
2352** of the IN(...) operator. The i'th entry of the array is populated with the
2353** offset of the index column that matches the i'th column returned by the
2354** SELECT. For example, if the expression and selected index are:
2355**
2356** (?,?,?) IN (SELECT a, b, c FROM t1)
2357** CREATE INDEX i1 ON t1(b, c, a);
2358**
2359** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002360*/
danielk1977284f4ac2007-12-10 05:03:46 +00002361#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002362int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002363 Parse *pParse, /* Parsing context */
2364 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2365 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2366 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002367 int *aiMap, /* Mapping from Index fields to RHS fields */
2368 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002369){
drhb74b1012009-05-28 21:04:37 +00002370 Select *p; /* SELECT to the right of IN operator */
2371 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2372 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002373 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002374 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002375
drh1450bc62009-10-30 13:25:56 +00002376 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002377 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002378
dan7b35a772016-07-28 19:47:15 +00002379 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2380 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002381 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002382 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002383 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002384 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2385 int i;
2386 ExprList *pEList = pX->x.pSelect->pEList;
2387 for(i=0; i<pEList->nExpr; i++){
2388 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2389 }
2390 if( i==pEList->nExpr ){
2391 prRhsHasNull = 0;
2392 }
2393 }
2394
drhb74b1012009-05-28 21:04:37 +00002395 /* Check to see if an existing table or index can be used to
2396 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002397 ** ephemeral table. */
2398 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002399 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002400 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002401 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002402 ExprList *pEList = p->pEList;
2403 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002404
drhb07028f2011-10-14 21:49:18 +00002405 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2406 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2407 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2408 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002409
drhb22f7c82014-02-06 23:56:27 +00002410 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002411 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2412 sqlite3CodeVerifySchema(pParse, iDb);
2413 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002414
drha84a2832016-08-26 21:15:35 +00002415 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002416 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002417 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002418 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002419 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002420
2421 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2422 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002423 ExplainQueryPlan((pParse, 0,
2424 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002425 sqlite3VdbeJumpHere(v, iAddr);
2426 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002427 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002428 int affinity_ok = 1;
2429 int i;
2430
2431 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002432 ** comparison is the same as the affinity of each column in table
2433 ** on the RHS of the IN operator. If it not, it is not possible to
2434 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002435 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002436 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002437 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002438 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002439 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002440 testcase( cmpaff==SQLITE_AFF_BLOB );
2441 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002442 switch( cmpaff ){
2443 case SQLITE_AFF_BLOB:
2444 break;
2445 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002446 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2447 ** other has no affinity and the other side is TEXT. Hence,
2448 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2449 ** and for the term on the LHS of the IN to have no affinity. */
2450 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002451 break;
2452 default:
2453 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2454 }
2455 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002456
drha84a2832016-08-26 21:15:35 +00002457 if( affinity_ok ){
2458 /* Search for an existing index that will work for this IN operator */
2459 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2460 Bitmask colUsed; /* Columns of the index used */
2461 Bitmask mCol; /* Mask for the current column */
2462 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002463 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002464 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2465 ** BITMASK(nExpr) without overflowing */
2466 testcase( pIdx->nColumn==BMS-2 );
2467 testcase( pIdx->nColumn==BMS-1 );
2468 if( pIdx->nColumn>=BMS-1 ) continue;
2469 if( mustBeUnique ){
2470 if( pIdx->nKeyCol>nExpr
2471 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2472 ){
2473 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002474 }
danielk19770cdc0222008-06-26 18:04:03 +00002475 }
drha84a2832016-08-26 21:15:35 +00002476
2477 colUsed = 0; /* Columns of index used so far */
2478 for(i=0; i<nExpr; i++){
2479 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2480 Expr *pRhs = pEList->a[i].pExpr;
2481 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2482 int j;
2483
2484 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2485 for(j=0; j<nExpr; j++){
2486 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2487 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002488 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2489 continue;
2490 }
drha84a2832016-08-26 21:15:35 +00002491 break;
2492 }
2493 if( j==nExpr ) break;
2494 mCol = MASKBIT(j);
2495 if( mCol & colUsed ) break; /* Each column used only once */
2496 colUsed |= mCol;
2497 if( aiMap ) aiMap[i] = j;
2498 }
2499
2500 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2501 if( colUsed==(MASKBIT(nExpr)-1) ){
2502 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002503 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002504 ExplainQueryPlan((pParse, 0,
2505 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002506 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2507 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2508 VdbeComment((v, "%s", pIdx->zName));
2509 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2510 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2511
2512 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002513#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002514 i64 mask = (1<<nExpr)-1;
2515 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2516 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002517#endif
2518 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002519 if( nExpr==1 ){
2520 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2521 }
2522 }
2523 sqlite3VdbeJumpHere(v, iAddr);
2524 }
2525 } /* End loop over indexes */
2526 } /* End if( affinity_ok ) */
2527 } /* End if not an rowid index */
2528 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002529
drhbb53ecb2014-08-02 21:03:33 +00002530 /* If no preexisting index is available for the IN clause
2531 ** and IN_INDEX_NOOP is an allowed reply
2532 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002533 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002534 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002535 ** the IN operator so return IN_INDEX_NOOP.
2536 */
2537 if( eType==0
2538 && (inFlags & IN_INDEX_NOOP_OK)
2539 && !ExprHasProperty(pX, EP_xIsSelect)
2540 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2541 ){
2542 eType = IN_INDEX_NOOP;
2543 }
drhbb53ecb2014-08-02 21:03:33 +00002544
danielk19779a96b662007-11-29 17:05:18 +00002545 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002546 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002547 ** We will have to generate an ephemeral table to do the job.
2548 */
drh8e23daf2013-06-11 13:30:04 +00002549 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002550 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002551 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002552 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002553 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00002554 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00002555 eType = IN_INDEX_ROWID;
2556 }
drhe21a6e12014-08-01 18:00:24 +00002557 }else if( prRhsHasNull ){
2558 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002559 }
drh85bcdce2018-12-23 21:27:29 +00002560 assert( pX->op==TK_IN );
drh2c041312018-12-24 02:34:49 +00002561 sqlite3CodeRhsOfIN(pParse, pX, iTab, eType==IN_INDEX_ROWID);
drh85bcdce2018-12-23 21:27:29 +00002562 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002563 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002564 }
drhcf4d38a2010-07-28 02:53:36 +00002565 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002566 }
danba00e302016-07-23 20:24:06 +00002567
2568 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2569 int i, n;
2570 n = sqlite3ExprVectorSize(pX->pLeft);
2571 for(i=0; i<n; i++) aiMap[i] = i;
2572 }
drh2c041312018-12-24 02:34:49 +00002573 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002574 return eType;
2575}
danielk1977284f4ac2007-12-10 05:03:46 +00002576#endif
drh626a8792005-01-17 22:08:19 +00002577
danf9b2e052016-08-02 17:45:00 +00002578#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002579/*
2580** Argument pExpr is an (?, ?...) IN(...) expression. This
2581** function allocates and returns a nul-terminated string containing
2582** the affinities to be used for each column of the comparison.
2583**
2584** It is the responsibility of the caller to ensure that the returned
2585** string is eventually freed using sqlite3DbFree().
2586*/
dan71c57db2016-07-09 20:23:55 +00002587static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2588 Expr *pLeft = pExpr->pLeft;
2589 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002590 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002591 char *zRet;
2592
dan553168c2016-08-01 20:14:31 +00002593 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002594 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002595 if( zRet ){
2596 int i;
2597 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002598 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002599 char a = sqlite3ExprAffinity(pA);
2600 if( pSelect ){
2601 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2602 }else{
2603 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002604 }
dan71c57db2016-07-09 20:23:55 +00002605 }
2606 zRet[nVal] = '\0';
2607 }
2608 return zRet;
2609}
danf9b2e052016-08-02 17:45:00 +00002610#endif
dan71c57db2016-07-09 20:23:55 +00002611
dan8da209b2016-07-26 18:06:08 +00002612#ifndef SQLITE_OMIT_SUBQUERY
2613/*
2614** Load the Parse object passed as the first argument with an error
2615** message of the form:
2616**
2617** "sub-select returns N columns - expected M"
2618*/
2619void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2620 const char *zFmt = "sub-select returns %d columns - expected %d";
2621 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2622}
2623#endif
2624
drh626a8792005-01-17 22:08:19 +00002625/*
dan44c56042016-12-07 15:38:37 +00002626** Expression pExpr is a vector that has been used in a context where
2627** it is not permitted. If pExpr is a sub-select vector, this routine
2628** loads the Parse object with a message of the form:
2629**
2630** "sub-select returns N columns - expected 1"
2631**
2632** Or, if it is a regular scalar vector:
2633**
2634** "row value misused"
2635*/
2636void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2637#ifndef SQLITE_OMIT_SUBQUERY
2638 if( pExpr->flags & EP_xIsSelect ){
2639 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2640 }else
2641#endif
2642 {
2643 sqlite3ErrorMsg(pParse, "row value misused");
2644 }
2645}
2646
drh85bcdce2018-12-23 21:27:29 +00002647#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002648/*
drh85bcdce2018-12-23 21:27:29 +00002649** Generate code that will construct an ephemeral table containing all terms
2650** in the RHS of an IN operator. The IN operator can be in either of two
2651** forms:
drh626a8792005-01-17 22:08:19 +00002652**
drh9cbe6352005-11-29 03:13:21 +00002653** x IN (4,5,11) -- IN operator with list on right-hand side
2654** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002655**
drh2c041312018-12-24 02:34:49 +00002656** The pExpr parameter is the IN operator. The cursor number for the
2657** constructed ephermeral table is returned. The first time the ephemeral
2658** table is computed, the cursor number is also stored in pExpr->iTable,
2659** however the cursor number returned might not be the same, as it might
2660** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002661**
drh85bcdce2018-12-23 21:27:29 +00002662** If parameter isRowid is non-zero, then LHS of the IN operator is guaranteed
2663** to be a non-null integer. In this case, the ephemeral table can be an
2664** table B-Tree that keyed by only integers. The more general cases uses
2665** an index B-Tree which can have arbitrary keys, but is slower to both
2666** read and write.
drhfd773cf2009-05-29 14:39:07 +00002667**
drh85bcdce2018-12-23 21:27:29 +00002668** If the LHS expression ("x" in the examples) is a column value, or
2669** the SELECT statement returns a column value, then the affinity of that
2670** column is used to build the index keys. If both 'x' and the
2671** SELECT... statement are columns, then numeric affinity is used
2672** if either column has NUMERIC or INTEGER affinity. If neither
2673** 'x' nor the SELECT... statement are columns, then numeric affinity
2674** is used.
drhcce7d172000-05-31 15:34:51 +00002675*/
drh85bcdce2018-12-23 21:27:29 +00002676void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002677 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002678 Expr *pExpr, /* The IN operator */
drh2c041312018-12-24 02:34:49 +00002679 int iTab, /* Use this cursor number */
drh85bcdce2018-12-23 21:27:29 +00002680 int isRowid /* If true, LHS is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00002681){
drh2c041312018-12-24 02:34:49 +00002682 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002683 int addr; /* Address of OP_OpenEphemeral instruction */
2684 Expr *pLeft; /* the LHS of the IN operator */
2685 KeyInfo *pKeyInfo = 0; /* Key information */
2686 int nVal; /* Size of vector pLeft */
2687 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002688
drh2c041312018-12-24 02:34:49 +00002689 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002690 assert( v!=0 );
2691
drh2c041312018-12-24 02:34:49 +00002692 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002693 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002694 **
2695 ** * The right-hand side is a correlated subquery
2696 ** * The right-hand side is an expression list containing variables
2697 ** * We are inside a trigger
2698 **
drh2c041312018-12-24 02:34:49 +00002699 ** If all of the above are false, then we can compute the RHS just once
2700 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002701 */
drhefb699f2018-12-24 11:55:44 +00002702 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002703 /* Reuse of the RHS is allowed */
2704 /* If this routine has already been coded, but the previous code
2705 ** might not have been invoked yet, so invoke it now as a subroutine.
2706 */
2707 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002708 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002709 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2710 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2711 pExpr->x.pSelect->selId));
2712 }
drh2c041312018-12-24 02:34:49 +00002713 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2714 pExpr->y.sub.iAddr);
2715 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002716 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002717 return;
2718 }
2719
2720 /* Begin coding the subroutine */
2721 ExprSetProperty(pExpr, EP_Subrtn);
2722 pExpr->y.sub.regReturn = ++pParse->nMem;
2723 pExpr->y.sub.iAddr =
2724 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2725 VdbeComment((v, "return address"));
2726
2727 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002728 }
2729
drh85bcdce2018-12-23 21:27:29 +00002730 /* Check to see if this is a vector IN operator */
2731 pLeft = pExpr->pLeft;
2732 nVal = sqlite3ExprVectorSize(pLeft);
2733 assert( !isRowid || nVal==1 );
danielk1977e014a832004-05-17 10:48:57 +00002734
drh85bcdce2018-12-23 21:27:29 +00002735 /* Construct the ephemeral table that will contain the content of
2736 ** RHS of the IN operator.
2737 */
drh2c041312018-12-24 02:34:49 +00002738 pExpr->iTable = iTab;
drh85bcdce2018-12-23 21:27:29 +00002739 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
2740 pExpr->iTable, (isRowid?0:nVal));
drh2c041312018-12-24 02:34:49 +00002741#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2742 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2743 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2744 }else{
2745 VdbeComment((v, "RHS of IN operator"));
2746 }
2747#endif
drh85bcdce2018-12-23 21:27:29 +00002748 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002749
drh85bcdce2018-12-23 21:27:29 +00002750 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2751 /* Case 1: expr IN (SELECT ...)
2752 **
2753 ** Generate code to write the results of the select into the temporary
2754 ** table allocated and opened above.
2755 */
2756 Select *pSelect = pExpr->x.pSelect;
2757 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002758
drh2c041312018-12-24 02:34:49 +00002759 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2760 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002761 ));
2762 assert( !isRowid );
2763 /* If the LHS and RHS of the IN operator do not match, that
2764 ** error will have been caught long before we reach this point. */
2765 if( ALWAYS(pEList->nExpr==nVal) ){
2766 SelectDest dest;
2767 int i;
drhbd462bc2018-12-24 20:21:06 +00002768 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002769 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2770 pSelect->iLimit = 0;
2771 testcase( pSelect->selFlags & SF_Distinct );
2772 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2773 if( sqlite3Select(pParse, pSelect, &dest) ){
2774 sqlite3DbFree(pParse->db, dest.zAffSdst);
2775 sqlite3KeyInfoUnref(pKeyInfo);
2776 return;
drhfef52082000-06-06 01:50:43 +00002777 }
drh85bcdce2018-12-23 21:27:29 +00002778 sqlite3DbFree(pParse->db, dest.zAffSdst);
2779 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2780 assert( pEList!=0 );
2781 assert( pEList->nExpr>0 );
2782 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2783 for(i=0; i<nVal; i++){
2784 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2785 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2786 pParse, p, pEList->a[i].pExpr
2787 );
danielk197741a05b72008-10-02 13:50:55 +00002788 }
drh85bcdce2018-12-23 21:27:29 +00002789 }
2790 }else if( ALWAYS(pExpr->x.pList!=0) ){
2791 /* Case 2: expr IN (exprlist)
2792 **
2793 ** For each expression, build an index key from the evaluation and
2794 ** store it in the temporary table. If <expr> is a column, then use
2795 ** that columns affinity when building index keys. If <expr> is not
2796 ** a column, use numeric affinity.
2797 */
2798 char affinity; /* Affinity of the LHS of the IN */
2799 int i;
2800 ExprList *pList = pExpr->x.pList;
2801 struct ExprList_item *pItem;
2802 int r1, r2, r3;
2803 affinity = sqlite3ExprAffinity(pLeft);
2804 if( !affinity ){
2805 affinity = SQLITE_AFF_BLOB;
2806 }
2807 if( pKeyInfo ){
2808 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2809 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002810 }
2811
drh85bcdce2018-12-23 21:27:29 +00002812 /* Loop through each expression in <exprlist>. */
2813 r1 = sqlite3GetTempReg(pParse);
2814 r2 = sqlite3GetTempReg(pParse);
2815 if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
2816 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2817 Expr *pE2 = pItem->pExpr;
2818 int iValToIns;
2819
2820 /* If the expression is not constant then we will need to
2821 ** disable the test that was generated above that makes sure
2822 ** this code only executes once. Because for a non-constant
2823 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002824 */
drh2c041312018-12-24 02:34:49 +00002825 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2826 sqlite3VdbeChangeToNoop(v, addrOnce);
2827 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002828 }
drh1398ad32005-01-19 23:24:50 +00002829
drh85bcdce2018-12-23 21:27:29 +00002830 /* Evaluate the expression and insert it into the temp table */
2831 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
drhbd462bc2018-12-24 20:21:06 +00002832 sqlite3VdbeAddOp3(v, OP_InsertInt, iTab, r2, iValToIns);
drh51522cd2005-01-20 13:36:19 +00002833 }else{
drh85bcdce2018-12-23 21:27:29 +00002834 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2835 if( isRowid ){
2836 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2837 sqlite3VdbeCurrentAddr(v)+2);
2838 VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002839 sqlite3VdbeAddOp3(v, OP_Insert, iTab, r2, r3);
drh85bcdce2018-12-23 21:27:29 +00002840 }else{
2841 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
drhbd462bc2018-12-24 20:21:06 +00002842 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drh85bcdce2018-12-23 21:27:29 +00002843 }
drh51522cd2005-01-20 13:36:19 +00002844 }
drhcce7d172000-05-31 15:34:51 +00002845 }
drh85bcdce2018-12-23 21:27:29 +00002846 sqlite3ReleaseTempReg(pParse, r1);
2847 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002848 }
drh85bcdce2018-12-23 21:27:29 +00002849 if( pKeyInfo ){
2850 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2851 }
drh2c041312018-12-24 02:34:49 +00002852 if( addrOnce ){
2853 sqlite3VdbeJumpHere(v, addrOnce);
2854 /* Subroutine return */
2855 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2856 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002857 }
2858}
2859#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002860
drh85bcdce2018-12-23 21:27:29 +00002861/*
2862** Generate code for scalar subqueries used as a subquery expression
2863** or EXISTS operator:
2864**
2865** (SELECT a FROM b) -- subquery
2866** EXISTS (SELECT a FROM b) -- EXISTS subquery
2867**
2868** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2869**
2870** The register that holds the result. For a multi-column SELECT,
2871** the result is stored in a contiguous array of registers and the
2872** return value is the register of the left-most result column.
2873** Return 0 if an error occurs.
2874*/
2875#ifndef SQLITE_OMIT_SUBQUERY
2876int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002877 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002878 int rReg = 0; /* Register storing resulting */
2879 Select *pSel; /* SELECT statement to encode */
2880 SelectDest dest; /* How to deal with SELECT result */
2881 int nReg; /* Registers to allocate */
2882 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002883
2884 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002885 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002886 testcase( pExpr->op==TK_EXISTS );
2887 testcase( pExpr->op==TK_SELECT );
2888 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2889 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2890 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002891
drh5198ff52018-12-24 12:09:47 +00002892 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002893 ** is encountered if any of the following is true:
2894 **
2895 ** * The right-hand side is a correlated subquery
2896 ** * The right-hand side is an expression list containing variables
2897 ** * We are inside a trigger
2898 **
2899 ** If all of the above are false, then we can run this code just once
2900 ** save the results, and reuse the same result on subsequent invocations.
2901 */
2902 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002903 /* If this routine has already been coded, then invoke it as a
2904 ** subroutine. */
2905 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002906 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002907 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2908 pExpr->y.sub.iAddr);
2909 return pExpr->iTable;
2910 }
2911
2912 /* Begin coding the subroutine */
2913 ExprSetProperty(pExpr, EP_Subrtn);
2914 pExpr->y.sub.regReturn = ++pParse->nMem;
2915 pExpr->y.sub.iAddr =
2916 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2917 VdbeComment((v, "return address"));
2918
drh2c041312018-12-24 02:34:49 +00002919 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002920 }
drh85bcdce2018-12-23 21:27:29 +00002921
2922 /* For a SELECT, generate code to put the values for all columns of
2923 ** the first row into an array of registers and return the index of
2924 ** the first register.
2925 **
2926 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2927 ** into a register and return that register number.
2928 **
2929 ** In both cases, the query is augmented with "LIMIT 1". Any
2930 ** preexisting limit is discarded in place of the new LIMIT 1.
2931 */
drhbd462bc2018-12-24 20:21:06 +00002932 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2933 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002934 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2935 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2936 pParse->nMem += nReg;
2937 if( pExpr->op==TK_SELECT ){
2938 dest.eDest = SRT_Mem;
2939 dest.iSdst = dest.iSDParm;
2940 dest.nSdst = nReg;
2941 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2942 VdbeComment((v, "Init subquery result"));
2943 }else{
2944 dest.eDest = SRT_Exists;
2945 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2946 VdbeComment((v, "Init EXISTS result"));
2947 }
2948 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2949 if( pSel->pLimit ){
2950 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2951 pSel->pLimit->pLeft = pLimit;
2952 }else{
2953 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2954 }
2955 pSel->iLimit = 0;
2956 if( sqlite3Select(pParse, pSel, &dest) ){
2957 return 0;
2958 }
drh2c041312018-12-24 02:34:49 +00002959 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002960 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002961 if( addrOnce ){
2962 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002963
drh5198ff52018-12-24 12:09:47 +00002964 /* Subroutine return */
2965 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2966 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2967 }
drh2c041312018-12-24 02:34:49 +00002968
drh1450bc62009-10-30 13:25:56 +00002969 return rReg;
drhcce7d172000-05-31 15:34:51 +00002970}
drh51522cd2005-01-20 13:36:19 +00002971#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002972
drhe3365e62009-11-12 17:52:24 +00002973#ifndef SQLITE_OMIT_SUBQUERY
2974/*
dan7b35a772016-07-28 19:47:15 +00002975** Expr pIn is an IN(...) expression. This function checks that the
2976** sub-select on the RHS of the IN() operator has the same number of
2977** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2978** a sub-query, that the LHS is a vector of size 1.
2979*/
2980int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2981 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2982 if( (pIn->flags & EP_xIsSelect) ){
2983 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2984 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2985 return 1;
2986 }
2987 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002988 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002989 return 1;
2990 }
2991 return 0;
2992}
2993#endif
2994
2995#ifndef SQLITE_OMIT_SUBQUERY
2996/*
drhe3365e62009-11-12 17:52:24 +00002997** Generate code for an IN expression.
2998**
2999** x IN (SELECT ...)
3000** x IN (value, value, ...)
3001**
drhecb87ac2016-08-25 15:46:25 +00003002** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003003** right-hand side (RHS) is an array of zero or more scalar values, or a
3004** subquery. If the RHS is a subquery, the number of result columns must
3005** match the number of columns in the vector on the LHS. If the RHS is
3006** a list of values, the LHS must be a scalar.
3007**
3008** The IN operator is true if the LHS value is contained within the RHS.
3009** The result is false if the LHS is definitely not in the RHS. The
3010** result is NULL if the presence of the LHS in the RHS cannot be
3011** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003012**
drh6be515e2014-08-01 21:00:53 +00003013** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003014** contained within the RHS. If due to NULLs we cannot determine if the LHS
3015** is contained in the RHS then jump to destIfNull. If the LHS is contained
3016** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003017**
3018** See the separate in-operator.md documentation file in the canonical
3019** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003020*/
3021static void sqlite3ExprCodeIN(
3022 Parse *pParse, /* Parsing and code generating context */
3023 Expr *pExpr, /* The IN expression */
3024 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3025 int destIfNull /* Jump here if the results are unknown due to NULLs */
3026){
3027 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003028 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003029 int rLhs; /* Register(s) holding the LHS values */
3030 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003031 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003032 int *aiMap = 0; /* Map from vector field to index column */
3033 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003034 int nVector; /* Size of vectors for this IN operator */
3035 int iDummy; /* Dummy parameter to exprCodeVector() */
3036 Expr *pLeft; /* The LHS of the IN operator */
3037 int i; /* loop counter */
3038 int destStep2; /* Where to jump when NULLs seen in step 2 */
3039 int destStep6 = 0; /* Start of code for Step 6 */
3040 int addrTruthOp; /* Address of opcode that determines the IN is true */
3041 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3042 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003043 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003044
drhe347d3e2016-08-25 21:14:34 +00003045 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003046 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003047 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003048 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3049 aiMap = (int*)sqlite3DbMallocZero(
3050 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3051 );
drhe347d3e2016-08-25 21:14:34 +00003052 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003053
danba00e302016-07-23 20:24:06 +00003054 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003055 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003056 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3057 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003058 v = pParse->pVdbe;
3059 assert( v!=0 ); /* OOM detected prior to this routine */
3060 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003061 eType = sqlite3FindInIndex(pParse, pExpr,
3062 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003063 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3064 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003065
danba00e302016-07-23 20:24:06 +00003066 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3067 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3068 );
drhecb87ac2016-08-25 15:46:25 +00003069#ifdef SQLITE_DEBUG
3070 /* Confirm that aiMap[] contains nVector integer values between 0 and
3071 ** nVector-1. */
3072 for(i=0; i<nVector; i++){
3073 int j, cnt;
3074 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3075 assert( cnt==1 );
3076 }
3077#endif
drhe3365e62009-11-12 17:52:24 +00003078
danba00e302016-07-23 20:24:06 +00003079 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3080 ** vector, then it is stored in an array of nVector registers starting
3081 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003082 **
3083 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3084 ** so that the fields are in the same order as an existing index. The
3085 ** aiMap[] array contains a mapping from the original LHS field order to
3086 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003087 */
drhe347d3e2016-08-25 21:14:34 +00003088 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3089 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003090 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003091 /* LHS fields are not reordered */
3092 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003093 }else{
3094 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003095 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003096 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003097 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003098 }
danba00e302016-07-23 20:24:06 +00003099 }
drhe3365e62009-11-12 17:52:24 +00003100
drhbb53ecb2014-08-02 21:03:33 +00003101 /* If sqlite3FindInIndex() did not find or create an index that is
3102 ** suitable for evaluating the IN operator, then evaluate using a
3103 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003104 **
3105 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003106 */
drhbb53ecb2014-08-02 21:03:33 +00003107 if( eType==IN_INDEX_NOOP ){
3108 ExprList *pList = pExpr->x.pList;
3109 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003110 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003111 int r2, regToFree;
3112 int regCkNull = 0;
3113 int ii;
3114 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003115 if( destIfNull!=destIfFalse ){
3116 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003117 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003118 }
3119 for(ii=0; ii<pList->nExpr; ii++){
3120 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003121 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003122 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3123 }
3124 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003125 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003126 (void*)pColl, P4_COLLSEQ);
3127 VdbeCoverageIf(v, ii<pList->nExpr-1);
3128 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003129 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003130 }else{
3131 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003132 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003133 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003134 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003135 }
3136 sqlite3ReleaseTempReg(pParse, regToFree);
3137 }
3138 if( regCkNull ){
3139 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003140 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003141 }
3142 sqlite3VdbeResolveLabel(v, labelOk);
3143 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003144 goto sqlite3ExprCodeIN_finished;
3145 }
3146
3147 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3148 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3149 ** We will then skip the binary search of the RHS.
3150 */
3151 if( destIfNull==destIfFalse ){
3152 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003153 }else{
drhec4ccdb2018-12-29 02:26:59 +00003154 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003155 }
3156 for(i=0; i<nVector; i++){
3157 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3158 if( sqlite3ExprCanBeNull(p) ){
3159 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003160 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003161 }
drhe3365e62009-11-12 17:52:24 +00003162 }
drhe347d3e2016-08-25 21:14:34 +00003163
3164 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3165 ** of the RHS using the LHS as a probe. If found, the result is
3166 ** true.
3167 */
3168 if( eType==IN_INDEX_ROWID ){
3169 /* In this case, the RHS is the ROWID of table b-tree and so we also
3170 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3171 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003172 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003173 VdbeCoverage(v);
3174 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3175 }else{
3176 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3177 if( destIfFalse==destIfNull ){
3178 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003179 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003180 rLhs, nVector); VdbeCoverage(v);
3181 goto sqlite3ExprCodeIN_finished;
3182 }
3183 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003184 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003185 rLhs, nVector); VdbeCoverage(v);
3186 }
3187
3188 /* Step 4. If the RHS is known to be non-NULL and we did not find
3189 ** an match on the search above, then the result must be FALSE.
3190 */
3191 if( rRhsHasNull && nVector==1 ){
3192 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3193 VdbeCoverage(v);
3194 }
3195
3196 /* Step 5. If we do not care about the difference between NULL and
3197 ** FALSE, then just return false.
3198 */
3199 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3200
3201 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3202 ** If any comparison is NULL, then the result is NULL. If all
3203 ** comparisons are FALSE then the final result is FALSE.
3204 **
3205 ** For a scalar LHS, it is sufficient to check just the first row
3206 ** of the RHS.
3207 */
3208 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003209 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003210 VdbeCoverage(v);
3211 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003212 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003213 }else{
3214 /* For nVector==1, combine steps 6 and 7 by immediately returning
3215 ** FALSE if the first comparison is not NULL */
3216 destNotNull = destIfFalse;
3217 }
3218 for(i=0; i<nVector; i++){
3219 Expr *p;
3220 CollSeq *pColl;
3221 int r3 = sqlite3GetTempReg(pParse);
3222 p = sqlite3VectorFieldSubexpr(pLeft, i);
3223 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003224 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003225 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3226 (void*)pColl, P4_COLLSEQ);
3227 VdbeCoverage(v);
3228 sqlite3ReleaseTempReg(pParse, r3);
3229 }
3230 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3231 if( nVector>1 ){
3232 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003233 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003234 VdbeCoverage(v);
3235
3236 /* Step 7: If we reach this point, we know that the result must
3237 ** be false. */
3238 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3239 }
3240
3241 /* Jumps here in order to return true. */
3242 sqlite3VdbeJumpHere(v, addrTruthOp);
3243
3244sqlite3ExprCodeIN_finished:
3245 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003246 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003247sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003248 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003249 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003250}
3251#endif /* SQLITE_OMIT_SUBQUERY */
3252
drh13573c72010-01-12 17:04:07 +00003253#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003254/*
3255** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003256** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003257**
3258** The z[] string will probably not be zero-terminated. But the
3259** z[n] character is guaranteed to be something that does not look
3260** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003261*/
drhb7916a72009-05-27 10:31:29 +00003262static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003263 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003264 double value;
drh9339da12010-09-30 00:50:49 +00003265 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003266 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3267 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003268 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003269 }
3270}
drh13573c72010-01-12 17:04:07 +00003271#endif
drh598f1342007-10-23 15:39:45 +00003272
3273
3274/*
drhfec19aa2004-05-19 20:41:03 +00003275** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003276** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003277**
shaneh5f1d6b62010-09-30 16:51:25 +00003278** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003279*/
drh13573c72010-01-12 17:04:07 +00003280static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3281 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003282 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003283 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003284 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003285 if( negFlag ) i = -i;
3286 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003287 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003288 int c;
3289 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003290 const char *z = pExpr->u.zToken;
3291 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003292 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003293 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003294#ifdef SQLITE_OMIT_FLOATING_POINT
3295 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3296#else
drh1b7ddc52014-07-23 14:52:05 +00003297#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003298 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003299 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003300 }else
3301#endif
3302 {
drh9296c182014-07-23 13:40:49 +00003303 codeReal(v, z, negFlag, iMem);
3304 }
drh13573c72010-01-12 17:04:07 +00003305#endif
drh77320ea2016-11-30 14:47:37 +00003306 }else{
drh84d4f1a2017-09-20 10:47:10 +00003307 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003308 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003309 }
drhfec19aa2004-05-19 20:41:03 +00003310 }
3311}
3312
drh5cd79232009-05-25 11:46:29 +00003313
drh1f9ca2c2015-08-25 16:57:52 +00003314/* Generate code that will load into register regOut a value that is
3315** appropriate for the iIdxCol-th column of index pIdx.
3316*/
3317void sqlite3ExprCodeLoadIndexColumn(
3318 Parse *pParse, /* The parsing context */
3319 Index *pIdx, /* The index whose column is to be loaded */
3320 int iTabCur, /* Cursor pointing to a table row */
3321 int iIdxCol, /* The column of the index to be loaded */
3322 int regOut /* Store the index column value in this register */
3323){
3324 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003325 if( iTabCol==XN_EXPR ){
3326 assert( pIdx->aColExpr );
3327 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003328 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003329 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003330 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003331 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003332 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3333 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003334 }
drh1f9ca2c2015-08-25 16:57:52 +00003335}
3336
drh5cd79232009-05-25 11:46:29 +00003337/*
drh5c092e82010-05-14 19:24:02 +00003338** Generate code to extract the value of the iCol-th column of a table.
3339*/
3340void sqlite3ExprCodeGetColumnOfTable(
3341 Vdbe *v, /* The VDBE under construction */
3342 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003343 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003344 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003345 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003346){
drhaca19e12017-04-07 19:41:31 +00003347 if( pTab==0 ){
3348 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3349 return;
3350 }
drh5c092e82010-05-14 19:24:02 +00003351 if( iCol<0 || iCol==pTab->iPKey ){
3352 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3353 }else{
3354 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003355 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003356 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003357 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3358 }
3359 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003360 }
3361 if( iCol>=0 ){
3362 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3363 }
3364}
3365
3366/*
drh945498f2007-02-24 11:52:52 +00003367** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003368** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003369**
3370** There must be an open cursor to pTab in iTable when this routine
3371** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003372*/
drhe55cbd72008-03-31 23:48:03 +00003373int sqlite3ExprCodeGetColumn(
3374 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003375 Table *pTab, /* Description of the table we are reading from */
3376 int iColumn, /* Index of the table column */
3377 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003378 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003379 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003380){
drhe55cbd72008-03-31 23:48:03 +00003381 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003382 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003383 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003384 if( p5 ){
3385 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003386 }
drhe55cbd72008-03-31 23:48:03 +00003387 return iReg;
3388}
drhe55cbd72008-03-31 23:48:03 +00003389
3390/*
drhb21e7c72008-06-22 12:37:57 +00003391** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003392** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003393*/
drhb21e7c72008-06-22 12:37:57 +00003394void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003395 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003396 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003397}
3398
drh652fbf52008-04-01 01:42:41 +00003399/*
drh12abf402016-08-22 14:30:05 +00003400** Convert a scalar expression node to a TK_REGISTER referencing
3401** register iReg. The caller must ensure that iReg already contains
3402** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003403*/
3404static void exprToRegister(Expr *p, int iReg){
3405 p->op2 = p->op;
3406 p->op = TK_REGISTER;
3407 p->iTable = iReg;
3408 ExprClearProperty(p, EP_Skip);
3409}
3410
drh12abf402016-08-22 14:30:05 +00003411/*
3412** Evaluate an expression (either a vector or a scalar expression) and store
3413** the result in continguous temporary registers. Return the index of
3414** the first register used to store the result.
3415**
3416** If the returned result register is a temporary scalar, then also write
3417** that register number into *piFreeable. If the returned result register
3418** is not a temporary or if the expression is a vector set *piFreeable
3419** to 0.
3420*/
3421static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3422 int iResult;
3423 int nResult = sqlite3ExprVectorSize(p);
3424 if( nResult==1 ){
3425 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3426 }else{
3427 *piFreeable = 0;
3428 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003429#if SQLITE_OMIT_SUBQUERY
3430 iResult = 0;
3431#else
drh85bcdce2018-12-23 21:27:29 +00003432 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003433#endif
drh12abf402016-08-22 14:30:05 +00003434 }else{
3435 int i;
3436 iResult = pParse->nMem+1;
3437 pParse->nMem += nResult;
3438 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003439 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003440 }
3441 }
3442 }
3443 return iResult;
3444}
3445
dan71c57db2016-07-09 20:23:55 +00003446
drha4c3c872013-09-12 17:29:25 +00003447/*
drhcce7d172000-05-31 15:34:51 +00003448** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003449** expression. Attempt to store the results in register "target".
3450** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003451**
drh8b213892008-08-29 02:14:02 +00003452** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003453** be stored in target. The result might be stored in some other
3454** register if it is convenient to do so. The calling function
3455** must check the return code and move the results to the desired
3456** register.
drhcce7d172000-05-31 15:34:51 +00003457*/
drh678ccce2008-03-31 18:19:54 +00003458int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003459 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3460 int op; /* The opcode being coded */
3461 int inReg = target; /* Results stored in register inReg */
3462 int regFree1 = 0; /* If non-zero free this temporary register */
3463 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003464 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003465 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003466 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003467
drh9cbf3422008-01-17 16:22:13 +00003468 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003469 if( v==0 ){
3470 assert( pParse->db->mallocFailed );
3471 return 0;
3472 }
drh389a1ad2008-01-03 23:44:53 +00003473
drh1efa8022018-04-28 04:16:43 +00003474expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003475 if( pExpr==0 ){
3476 op = TK_NULL;
3477 }else{
3478 op = pExpr->op;
3479 }
drhf2bc0132004-10-04 13:19:23 +00003480 switch( op ){
drh13449892005-09-07 21:22:45 +00003481 case TK_AGG_COLUMN: {
3482 AggInfo *pAggInfo = pExpr->pAggInfo;
3483 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3484 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003485 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003486 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003487 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003488 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003489 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003490 return target;
drh13449892005-09-07 21:22:45 +00003491 }
3492 /* Otherwise, fall thru into the TK_COLUMN case */
3493 }
drh967e8b72000-06-21 13:59:10 +00003494 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003495 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003496 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003497 /* This COLUMN expression is really a constant due to WHERE clause
3498 ** constraints, and that constant is coded by the pExpr->pLeft
3499 ** expresssion. However, make sure the constant has the correct
3500 ** datatype by applying the Affinity of the table column to the
3501 ** constant.
3502 */
3503 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003504 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003505 if( aff!=SQLITE_AFF_BLOB ){
3506 static const char zAff[] = "B\000C\000D\000E";
3507 assert( SQLITE_AFF_BLOB=='A' );
3508 assert( SQLITE_AFF_TEXT=='B' );
3509 if( iReg!=target ){
3510 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3511 iReg = target;
3512 }
3513 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3514 &zAff[(aff-'B')*2], P4_STATIC);
3515 }
3516 return iReg;
drhefad2e22018-07-27 16:57:11 +00003517 }
drhb2b9d3d2013-08-01 01:14:43 +00003518 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003519 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003520 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003521 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003522 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003523 /* Coding an expression that is part of an index where column names
3524 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003525 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003526 }
drh22827922000-06-06 17:27:05 +00003527 }
drheda079c2018-09-20 19:02:15 +00003528 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003529 pExpr->iColumn, iTab, target,
3530 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003531 }
3532 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003533 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003534 return target;
drhfec19aa2004-05-19 20:41:03 +00003535 }
drh8abed7b2018-02-26 18:49:05 +00003536 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003537 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003538 return target;
3539 }
drh13573c72010-01-12 17:04:07 +00003540#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003541 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003542 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3543 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003544 return target;
drh598f1342007-10-23 15:39:45 +00003545 }
drh13573c72010-01-12 17:04:07 +00003546#endif
drhfec19aa2004-05-19 20:41:03 +00003547 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003548 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003549 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003550 return target;
drhcce7d172000-05-31 15:34:51 +00003551 }
drhf0863fe2005-06-12 21:35:51 +00003552 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003553 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003554 return target;
drhf0863fe2005-06-12 21:35:51 +00003555 }
danielk19775338a5f2005-01-20 13:03:10 +00003556#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003557 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003558 int n;
3559 const char *z;
drhca48c902008-01-18 14:08:24 +00003560 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003561 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3562 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3563 assert( pExpr->u.zToken[1]=='\'' );
3564 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003565 n = sqlite3Strlen30(z) - 1;
3566 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003567 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3568 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003569 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003570 }
danielk19775338a5f2005-01-20 13:03:10 +00003571#endif
drh50457892003-09-06 01:10:47 +00003572 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003573 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3574 assert( pExpr->u.zToken!=0 );
3575 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003576 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3577 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003578 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003579 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003580 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003581 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003582 }
drhc332cc32016-09-19 10:24:19 +00003583 return target;
drh50457892003-09-06 01:10:47 +00003584 }
drh4e0cff62004-11-05 05:10:28 +00003585 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003586 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003587 }
drh487e2622005-06-25 18:42:14 +00003588#ifndef SQLITE_OMIT_CAST
3589 case TK_CAST: {
3590 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003591 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003592 if( inReg!=target ){
3593 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3594 inReg = target;
3595 }
drh4169e432014-08-25 20:11:52 +00003596 sqlite3VdbeAddOp2(v, OP_Cast, target,
3597 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003598 return inReg;
drh487e2622005-06-25 18:42:14 +00003599 }
3600#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003601 case TK_IS:
3602 case TK_ISNOT:
3603 op = (op==TK_IS) ? TK_EQ : TK_NE;
3604 p5 = SQLITE_NULLEQ;
3605 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003606 case TK_LT:
3607 case TK_LE:
3608 case TK_GT:
3609 case TK_GE:
3610 case TK_NE:
3611 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003612 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003613 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003614 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003615 }else{
3616 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3617 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3618 codeCompare(pParse, pLeft, pExpr->pRight, op,
3619 r1, r2, inReg, SQLITE_STOREP2 | p5);
3620 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3621 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3622 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3623 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3624 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3625 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3626 testcase( regFree1==0 );
3627 testcase( regFree2==0 );
3628 }
drh6a2fe092009-09-23 02:29:36 +00003629 break;
3630 }
drhcce7d172000-05-31 15:34:51 +00003631 case TK_AND:
3632 case TK_OR:
3633 case TK_PLUS:
3634 case TK_STAR:
3635 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003636 case TK_REM:
3637 case TK_BITAND:
3638 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003639 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003640 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003641 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003642 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003643 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3644 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3645 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3646 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3647 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3648 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3649 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3650 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3651 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3652 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3653 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003654 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3655 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003656 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003657 testcase( regFree1==0 );
3658 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003659 break;
3660 }
drhcce7d172000-05-31 15:34:51 +00003661 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003662 Expr *pLeft = pExpr->pLeft;
3663 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003664 if( pLeft->op==TK_INTEGER ){
3665 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003666 return target;
drh13573c72010-01-12 17:04:07 +00003667#ifndef SQLITE_OMIT_FLOATING_POINT
3668 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003669 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3670 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003671 return target;
drh13573c72010-01-12 17:04:07 +00003672#endif
drh3c84ddf2008-01-09 02:15:38 +00003673 }else{
drh10d1edf2013-11-15 15:52:39 +00003674 tempX.op = TK_INTEGER;
3675 tempX.flags = EP_IntValue|EP_TokenOnly;
3676 tempX.u.iValue = 0;
3677 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003678 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003679 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003680 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003681 }
drh3c84ddf2008-01-09 02:15:38 +00003682 break;
drh6e142f52000-06-08 13:36:40 +00003683 }
drhbf4133c2001-10-13 02:59:08 +00003684 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003685 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003686 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3687 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003688 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3689 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003690 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003691 break;
3692 }
drh8abed7b2018-02-26 18:49:05 +00003693 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003694 int isTrue; /* IS TRUE or IS NOT TRUE */
3695 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003696 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3697 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003698 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3699 bNormal = pExpr->op2==TK_IS;
3700 testcase( isTrue && bNormal);
3701 testcase( !isTrue && bNormal);
3702 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003703 break;
3704 }
drhcce7d172000-05-31 15:34:51 +00003705 case TK_ISNULL:
3706 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003707 int addr;
drh7d176102014-02-18 03:07:12 +00003708 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3709 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003710 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003711 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003712 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003713 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003714 VdbeCoverageIf(v, op==TK_ISNULL);
3715 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003716 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003717 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003718 break;
drhcce7d172000-05-31 15:34:51 +00003719 }
drh22827922000-06-06 17:27:05 +00003720 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003721 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003722 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003723 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3724 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003725 }else{
drhc332cc32016-09-19 10:24:19 +00003726 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003727 }
drh22827922000-06-06 17:27:05 +00003728 break;
3729 }
drhcce7d172000-05-31 15:34:51 +00003730 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003731 ExprList *pFarg; /* List of function arguments */
3732 int nFarg; /* Number of function arguments */
3733 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003734 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003735 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003736 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003737 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003738 u8 enc = ENC(db); /* The text encoding used by this database */
3739 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003740
dan67a9b8e2018-06-22 20:51:35 +00003741#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003742 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3743 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003744 }
dan67a9b8e2018-06-22 20:51:35 +00003745#endif
dan86fb6e12018-05-16 20:58:07 +00003746
drh1e9b53f2017-01-04 01:07:24 +00003747 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003748 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003749 ** out of the inner loop, even if that means an extra OP_Copy. */
3750 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003751 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003752 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003753 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003754 pFarg = 0;
3755 }else{
3756 pFarg = pExpr->x.pList;
3757 }
3758 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003759 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3760 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003761 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003762#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3763 if( pDef==0 && pParse->explain ){
3764 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3765 }
3766#endif
danb6e9f7a2018-05-19 14:15:29 +00003767 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003768 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003769 break;
3770 }
drhae6bb952009-11-11 00:24:31 +00003771
3772 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003773 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003774 ** arguments past the first non-NULL argument.
3775 */
drhd36e1042013-09-06 13:10:12 +00003776 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003777 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003778 assert( nFarg>=2 );
3779 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3780 for(i=1; i<nFarg; i++){
3781 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003782 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003783 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003784 }
3785 sqlite3VdbeResolveLabel(v, endCoalesce);
3786 break;
3787 }
3788
drhcca9f3d2013-09-06 15:23:29 +00003789 /* The UNLIKELY() function is a no-op. The result is the value
3790 ** of the first argument.
3791 */
3792 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3793 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003794 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003795 }
drhae6bb952009-11-11 00:24:31 +00003796
drh54240752017-01-03 14:39:30 +00003797#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003798 /* The AFFINITY() function evaluates to a string that describes
3799 ** the type affinity of the argument. This is used for testing of
3800 ** the SQLite type logic.
3801 */
3802 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3803 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3804 char aff;
3805 assert( nFarg==1 );
3806 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3807 sqlite3VdbeLoadString(v, target,
3808 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3809 return target;
3810 }
drh54240752017-01-03 14:39:30 +00003811#endif
drha1a523a2016-12-26 00:18:36 +00003812
drhd1a01ed2013-11-21 16:08:52 +00003813 for(i=0; i<nFarg; i++){
3814 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003815 testcase( i==31 );
3816 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003817 }
3818 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3819 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3820 }
3821 }
drh12ffee82009-04-08 13:51:51 +00003822 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003823 if( constMask ){
3824 r1 = pParse->nMem+1;
3825 pParse->nMem += nFarg;
3826 }else{
3827 r1 = sqlite3GetTempRange(pParse, nFarg);
3828 }
drha748fdc2012-03-28 01:34:47 +00003829
3830 /* For length() and typeof() functions with a column argument,
3831 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3832 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3833 ** loading.
3834 */
drhd36e1042013-09-06 13:10:12 +00003835 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003836 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003837 assert( nFarg==1 );
3838 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003839 exprOp = pFarg->a[0].pExpr->op;
3840 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003841 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3842 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003843 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3844 pFarg->a[0].pExpr->op2 =
3845 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003846 }
3847 }
3848
drh5579d592015-08-26 14:01:41 +00003849 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003850 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003851 }else{
drh12ffee82009-04-08 13:51:51 +00003852 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003853 }
drhb7f6f682006-07-08 17:06:43 +00003854#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003855 /* Possibly overload the function if the first argument is
3856 ** a virtual table column.
3857 **
3858 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3859 ** second argument, not the first, as the argument to test to
3860 ** see if it is a column in a virtual table. This is done because
3861 ** the left operand of infix functions (the operand we want to
3862 ** control overloading) ends up as the second argument to the
3863 ** function. The expression "A glob B" is equivalent to
3864 ** "glob(B,A). We want to use the A in "A glob B" to test
3865 ** for function overloading. But we use the B term in "glob(B,A)".
3866 */
drh59155062018-05-26 18:03:48 +00003867 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003868 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3869 }else if( nFarg>0 ){
3870 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003871 }
3872#endif
drhd36e1042013-09-06 13:10:12 +00003873 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003874 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003875 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003876 }
drh092457b2017-12-29 15:04:49 +00003877#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3878 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003879 Expr *pArg = pFarg->a[0].pExpr;
3880 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003881 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003882 }else{
3883 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3884 }
drh092457b2017-12-29 15:04:49 +00003885 }else
3886#endif
3887 {
drh2fc865c2017-12-16 20:20:37 +00003888 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3889 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3890 sqlite3VdbeChangeP5(v, (u8)nFarg);
3891 }
drhd1a01ed2013-11-21 16:08:52 +00003892 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003893 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003894 }
drhc332cc32016-09-19 10:24:19 +00003895 return target;
drhcce7d172000-05-31 15:34:51 +00003896 }
drhfe2093d2005-01-20 22:48:47 +00003897#ifndef SQLITE_OMIT_SUBQUERY
3898 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003899 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003900 int nCol;
drhc5499be2008-04-01 15:06:33 +00003901 testcase( op==TK_EXISTS );
3902 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003903 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3904 sqlite3SubselectError(pParse, nCol, 1);
3905 }else{
drh85bcdce2018-12-23 21:27:29 +00003906 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003907 }
drh19a775c2000-06-05 18:54:46 +00003908 break;
3909 }
drhfc7f27b2016-08-20 00:07:01 +00003910 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003911 int n;
drhfc7f27b2016-08-20 00:07:01 +00003912 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003913 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003914 }
drh966e2912017-01-03 02:58:01 +00003915 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3916 if( pExpr->iTable
3917 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3918 ){
3919 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3920 pExpr->iTable, n);
3921 }
drhc332cc32016-09-19 10:24:19 +00003922 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003923 }
drhfef52082000-06-06 01:50:43 +00003924 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003925 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3926 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003927 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3928 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3929 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3930 sqlite3VdbeResolveLabel(v, destIfFalse);
3931 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3932 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003933 return target;
drhfef52082000-06-06 01:50:43 +00003934 }
drhe3365e62009-11-12 17:52:24 +00003935#endif /* SQLITE_OMIT_SUBQUERY */
3936
3937
drh2dcef112008-01-12 19:03:48 +00003938 /*
3939 ** x BETWEEN y AND z
3940 **
3941 ** This is equivalent to
3942 **
3943 ** x>=y AND x<=z
3944 **
3945 ** X is stored in pExpr->pLeft.
3946 ** Y is stored in pExpr->pList->a[0].pExpr.
3947 ** Z is stored in pExpr->pList->a[1].pExpr.
3948 */
drhfef52082000-06-06 01:50:43 +00003949 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003950 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003951 return target;
drhfef52082000-06-06 01:50:43 +00003952 }
drh94fa9c42016-02-27 21:16:04 +00003953 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003954 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003955 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003956 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003957 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003958 }
drh2dcef112008-01-12 19:03:48 +00003959
dan165921a2009-08-28 18:53:45 +00003960 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003961 /* If the opcode is TK_TRIGGER, then the expression is a reference
3962 ** to a column in the new.* or old.* pseudo-tables available to
3963 ** trigger programs. In this case Expr.iTable is set to 1 for the
3964 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3965 ** is set to the column of the pseudo-table to read, or to -1 to
3966 ** read the rowid field.
3967 **
3968 ** The expression is implemented using an OP_Param opcode. The p1
3969 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3970 ** to reference another column of the old.* pseudo-table, where
3971 ** i is the index of the column. For a new.rowid reference, p1 is
3972 ** set to (n+1), where n is the number of columns in each pseudo-table.
3973 ** For a reference to any other column in the new.* pseudo-table, p1
3974 ** is set to (n+2+i), where n and i are as defined previously. For
3975 ** example, if the table on which triggers are being fired is
3976 ** declared as:
3977 **
3978 ** CREATE TABLE t1(a, b);
3979 **
3980 ** Then p1 is interpreted as follows:
3981 **
3982 ** p1==0 -> old.rowid p1==3 -> new.rowid
3983 ** p1==1 -> old.a p1==4 -> new.a
3984 ** p1==2 -> old.b p1==5 -> new.b
3985 */
drheda079c2018-09-20 19:02:15 +00003986 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003987 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3988
3989 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3990 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3991 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3992 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3993
3994 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003995 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003996 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003997 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003998 ));
dan65a7cd12009-09-01 12:16:01 +00003999
drh44dbca82010-01-13 04:22:20 +00004000#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004001 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004002 ** integer. Use OP_RealAffinity to make sure it is really real.
4003 **
4004 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4005 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004006 if( pExpr->iColumn>=0
4007 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4008 ){
4009 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4010 }
drh44dbca82010-01-13 04:22:20 +00004011#endif
dan165921a2009-08-28 18:53:45 +00004012 break;
4013 }
4014
dan71c57db2016-07-09 20:23:55 +00004015 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004016 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004017 break;
4018 }
4019
drh31d6fd52017-04-14 19:03:10 +00004020 case TK_IF_NULL_ROW: {
4021 int addrINR;
4022 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00004023 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00004024 sqlite3VdbeJumpHere(v, addrINR);
4025 sqlite3VdbeChangeP3(v, addrINR, inReg);
4026 break;
4027 }
4028
drh2dcef112008-01-12 19:03:48 +00004029 /*
4030 ** Form A:
4031 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4032 **
4033 ** Form B:
4034 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4035 **
4036 ** Form A is can be transformed into the equivalent form B as follows:
4037 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4038 ** WHEN x=eN THEN rN ELSE y END
4039 **
4040 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004041 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4042 ** odd. The Y is also optional. If the number of elements in x.pList
4043 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004044 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4045 **
4046 ** The result of the expression is the Ri for the first matching Ei,
4047 ** or if there is no matching Ei, the ELSE term Y, or if there is
4048 ** no ELSE term, NULL.
4049 */
drh33cd4902009-05-30 20:49:20 +00004050 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004051 int endLabel; /* GOTO label for end of CASE stmt */
4052 int nextCase; /* GOTO label for next WHEN clause */
4053 int nExpr; /* 2x number of WHEN terms */
4054 int i; /* Loop counter */
4055 ExprList *pEList; /* List of WHEN terms */
4056 struct ExprList_item *aListelem; /* Array of WHEN terms */
4057 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004058 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004059 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00004060
danielk19776ab3a2e2009-02-19 14:39:25 +00004061 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004062 assert(pExpr->x.pList->nExpr > 0);
4063 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004064 aListelem = pEList->a;
4065 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004066 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004067 if( (pX = pExpr->pLeft)!=0 ){
drha8e05762019-01-05 21:56:12 +00004068 exprNodeCopy(&tempX, pX);
drh33cd4902009-05-30 20:49:20 +00004069 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004070 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004071 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004072 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004073 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004074 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004075 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004076 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4077 ** The value in regFree1 might get SCopy-ed into the file result.
4078 ** So make sure that the regFree1 register is not reused for other
4079 ** purposes and possibly overwritten. */
4080 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004081 }
drhc5cd1242013-09-12 16:50:49 +00004082 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004083 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004084 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004085 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004086 }else{
drh2dcef112008-01-12 19:03:48 +00004087 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004088 }
drhec4ccdb2018-12-29 02:26:59 +00004089 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004090 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004091 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004092 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004093 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004094 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004095 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004096 }
drhc5cd1242013-09-12 16:50:49 +00004097 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004098 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004099 }else{
drh9de221d2008-01-05 06:51:30 +00004100 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004101 }
drh2dcef112008-01-12 19:03:48 +00004102 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004103 break;
4104 }
danielk19775338a5f2005-01-20 13:03:10 +00004105#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004106 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004107 assert( pExpr->affinity==OE_Rollback
4108 || pExpr->affinity==OE_Abort
4109 || pExpr->affinity==OE_Fail
4110 || pExpr->affinity==OE_Ignore
4111 );
dane0af83a2009-09-08 19:15:01 +00004112 if( !pParse->pTriggerTab ){
4113 sqlite3ErrorMsg(pParse,
4114 "RAISE() may only be used within a trigger-program");
4115 return 0;
4116 }
4117 if( pExpr->affinity==OE_Abort ){
4118 sqlite3MayAbort(pParse);
4119 }
dan165921a2009-08-28 18:53:45 +00004120 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004121 if( pExpr->affinity==OE_Ignore ){
4122 sqlite3VdbeAddOp4(
4123 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004124 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004125 }else{
drh433dccf2013-02-09 15:37:11 +00004126 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004127 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004128 }
4129
drhffe07b22005-11-03 00:41:17 +00004130 break;
drh17a7f8d2002-03-24 13:13:27 +00004131 }
danielk19775338a5f2005-01-20 13:03:10 +00004132#endif
drhffe07b22005-11-03 00:41:17 +00004133 }
drh2dcef112008-01-12 19:03:48 +00004134 sqlite3ReleaseTempReg(pParse, regFree1);
4135 sqlite3ReleaseTempReg(pParse, regFree2);
4136 return inReg;
4137}
4138
4139/*
drhd1a01ed2013-11-21 16:08:52 +00004140** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004141**
drhad879ff2017-01-04 04:10:02 +00004142** If regDest>=0 then the result is always stored in that register and the
4143** result is not reusable. If regDest<0 then this routine is free to
4144** store the value whereever it wants. The register where the expression
4145** is stored is returned. When regDest<0, two identical expressions will
4146** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004147*/
drh1e9b53f2017-01-04 01:07:24 +00004148int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004149 Parse *pParse, /* Parsing context */
4150 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004151 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004152){
drhd1a01ed2013-11-21 16:08:52 +00004153 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004154 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004155 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004156 if( regDest<0 && p ){
4157 struct ExprList_item *pItem;
4158 int i;
4159 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004160 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004161 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004162 }
4163 }
drh1e9b53f2017-01-04 01:07:24 +00004164 }
drhd1a01ed2013-11-21 16:08:52 +00004165 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4166 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004167 if( p ){
4168 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004169 pItem->reusable = regDest<0;
4170 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004171 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004172 }
drhd1a01ed2013-11-21 16:08:52 +00004173 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004174 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004175}
4176
4177/*
drh2dcef112008-01-12 19:03:48 +00004178** Generate code to evaluate an expression and store the results
4179** into a register. Return the register number where the results
4180** are stored.
4181**
4182** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004183** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004184** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004185**
4186** If pExpr is a constant, then this routine might generate this
4187** code to fill the register in the initialization section of the
4188** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004189*/
4190int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004191 int r2;
4192 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004193 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004194 && pExpr->op!=TK_REGISTER
4195 && sqlite3ExprIsConstantNotJoin(pExpr)
4196 ){
drhf30a9692013-11-15 01:10:18 +00004197 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004198 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004199 }else{
drhf30a9692013-11-15 01:10:18 +00004200 int r1 = sqlite3GetTempReg(pParse);
4201 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4202 if( r2==r1 ){
4203 *pReg = r1;
4204 }else{
4205 sqlite3ReleaseTempReg(pParse, r1);
4206 *pReg = 0;
4207 }
drh2dcef112008-01-12 19:03:48 +00004208 }
4209 return r2;
4210}
4211
4212/*
4213** Generate code that will evaluate expression pExpr and store the
4214** results in register target. The results are guaranteed to appear
4215** in register target.
4216*/
drh05a86c52014-02-16 01:55:49 +00004217void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004218 int inReg;
4219
4220 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004221 if( pExpr && pExpr->op==TK_REGISTER ){
4222 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4223 }else{
4224 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004225 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004226 if( inReg!=target && pParse->pVdbe ){
4227 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4228 }
drhcce7d172000-05-31 15:34:51 +00004229 }
drhcce7d172000-05-31 15:34:51 +00004230}
4231
4232/*
drh1c75c9d2015-12-21 15:22:13 +00004233** Make a transient copy of expression pExpr and then code it using
4234** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4235** except that the input expression is guaranteed to be unchanged.
4236*/
4237void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4238 sqlite3 *db = pParse->db;
4239 pExpr = sqlite3ExprDup(db, pExpr, 0);
4240 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4241 sqlite3ExprDelete(db, pExpr);
4242}
4243
4244/*
drh05a86c52014-02-16 01:55:49 +00004245** Generate code that will evaluate expression pExpr and store the
4246** results in register target. The results are guaranteed to appear
4247** in register target. If the expression is constant, then this routine
4248** might choose to code the expression at initialization time.
4249*/
4250void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004251 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004252 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004253 }else{
4254 sqlite3ExprCode(pParse, pExpr, target);
4255 }
drhcce7d172000-05-31 15:34:51 +00004256}
4257
4258/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004259** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004260** in register target.
drh25303782004-12-07 15:41:48 +00004261**
drh2dcef112008-01-12 19:03:48 +00004262** Also make a copy of the expression results into another "cache" register
4263** and modify the expression so that the next time it is evaluated,
4264** the result is a copy of the cache register.
4265**
4266** This routine is used for expressions that are used multiple
4267** times. They are evaluated once and the results of the expression
4268** are reused.
drh25303782004-12-07 15:41:48 +00004269*/
drh05a86c52014-02-16 01:55:49 +00004270void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004271 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004272 int iMem;
4273
drhde4fcfd2008-01-19 23:50:26 +00004274 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004275 assert( pExpr->op!=TK_REGISTER );
4276 sqlite3ExprCode(pParse, pExpr, target);
4277 iMem = ++pParse->nMem;
4278 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4279 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004280}
drh2dcef112008-01-12 19:03:48 +00004281
drh678ccce2008-03-31 18:19:54 +00004282/*
drh268380c2004-02-25 13:47:31 +00004283** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004284** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004285**
drh3df6c3b2017-09-15 15:38:01 +00004286** Return the number of elements evaluated. The number returned will
4287** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4288** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004289**
4290** The SQLITE_ECEL_DUP flag prevents the arguments from being
4291** filled using OP_SCopy. OP_Copy must be used instead.
4292**
4293** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4294** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004295**
4296** The SQLITE_ECEL_REF flag means that expressions in the list with
4297** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4298** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004299** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4300** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004301*/
danielk19774adee202004-05-08 08:23:19 +00004302int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004303 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004304 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004305 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004306 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004307 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004308){
4309 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004310 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004311 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004312 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004313 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004314 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004315 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004316 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004317 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004318 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004319 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004320#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4321 if( pItem->bSorterRef ){
4322 i--;
4323 n--;
4324 }else
4325#endif
dan257c13f2016-11-10 20:14:06 +00004326 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4327 if( flags & SQLITE_ECEL_OMITREF ){
4328 i--;
4329 n--;
4330 }else{
4331 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4332 }
drhb8b06692018-08-04 15:16:20 +00004333 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4334 && sqlite3ExprIsConstantNotJoin(pExpr)
4335 ){
drhad879ff2017-01-04 04:10:02 +00004336 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004337 }else{
4338 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4339 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004340 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004341 if( copyOp==OP_Copy
4342 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4343 && pOp->p1+pOp->p3+1==inReg
4344 && pOp->p2+pOp->p3+1==target+i
4345 ){
4346 pOp->p3++;
4347 }else{
4348 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4349 }
drhd1a01ed2013-11-21 16:08:52 +00004350 }
drhd1766112008-09-17 00:13:12 +00004351 }
drh268380c2004-02-25 13:47:31 +00004352 }
drhf9b596e2004-05-26 16:54:42 +00004353 return n;
drh268380c2004-02-25 13:47:31 +00004354}
4355
4356/*
drh36c563a2009-11-12 13:32:22 +00004357** Generate code for a BETWEEN operator.
4358**
4359** x BETWEEN y AND z
4360**
4361** The above is equivalent to
4362**
4363** x>=y AND x<=z
4364**
4365** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004366** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004367**
4368** The xJumpIf parameter determines details:
4369**
4370** NULL: Store the boolean result in reg[dest]
4371** sqlite3ExprIfTrue: Jump to dest if true
4372** sqlite3ExprIfFalse: Jump to dest if false
4373**
4374** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004375*/
4376static void exprCodeBetween(
4377 Parse *pParse, /* Parsing and code generating context */
4378 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004379 int dest, /* Jump destination or storage location */
4380 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004381 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4382){
drhdb45bd52016-08-22 00:48:58 +00004383 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004384 Expr compLeft; /* The x>=y term */
4385 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004386 Expr exprX; /* The x subexpression */
4387 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004388
dan71c57db2016-07-09 20:23:55 +00004389 memset(&compLeft, 0, sizeof(Expr));
4390 memset(&compRight, 0, sizeof(Expr));
4391 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004392
4393 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drha8e05762019-01-05 21:56:12 +00004394 exprNodeCopy(&exprX, pExpr->pLeft);
drh36c563a2009-11-12 13:32:22 +00004395 exprAnd.op = TK_AND;
4396 exprAnd.pLeft = &compLeft;
4397 exprAnd.pRight = &compRight;
4398 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004399 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004400 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4401 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004402 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004403 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004404 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004405 if( xJump ){
4406 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004407 }else{
drh36fd41e2016-11-25 14:30:42 +00004408 /* Mark the expression is being from the ON or USING clause of a join
4409 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4410 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4411 ** for clarity, but we are out of bits in the Expr.flags field so we
4412 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004413 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004414 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004415 }
drhdb45bd52016-08-22 00:48:58 +00004416 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004417
4418 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004419 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4420 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4421 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4422 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4423 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4424 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4425 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4426 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004427 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004428}
4429
4430/*
drhcce7d172000-05-31 15:34:51 +00004431** Generate code for a boolean expression such that a jump is made
4432** to the label "dest" if the expression is true but execution
4433** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004434**
4435** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004436** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004437**
4438** This code depends on the fact that certain token values (ex: TK_EQ)
4439** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4440** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4441** the make process cause these values to align. Assert()s in the code
4442** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004443*/
danielk19774adee202004-05-08 08:23:19 +00004444void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004445 Vdbe *v = pParse->pVdbe;
4446 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004447 int regFree1 = 0;
4448 int regFree2 = 0;
4449 int r1, r2;
4450
drh35573352008-01-08 23:54:25 +00004451 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004452 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004453 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004454 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004455 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004456 case TK_AND: {
drhec4ccdb2018-12-29 02:26:59 +00004457 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004458 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004459 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004460 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4461 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004462 break;
4463 }
4464 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004465 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004466 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4467 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004468 break;
4469 }
4470 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004471 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004472 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004473 break;
4474 }
drh8abed7b2018-02-26 18:49:05 +00004475 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004476 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4477 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004478 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004479 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004480 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004481 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004482 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004483 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004484 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4485 isNot ? SQLITE_JUMPIFNULL : 0);
4486 }else{
4487 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4488 isNot ? SQLITE_JUMPIFNULL : 0);
4489 }
drh007c8432018-02-26 03:20:18 +00004490 break;
4491 }
drhde845c22016-03-17 19:07:52 +00004492 case TK_IS:
4493 case TK_ISNOT:
4494 testcase( op==TK_IS );
4495 testcase( op==TK_ISNOT );
4496 op = (op==TK_IS) ? TK_EQ : TK_NE;
4497 jumpIfNull = SQLITE_NULLEQ;
4498 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004499 case TK_LT:
4500 case TK_LE:
4501 case TK_GT:
4502 case TK_GE:
4503 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004504 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004505 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004506 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004507 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4508 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004509 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004510 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004511 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4512 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4513 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4514 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004515 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4516 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4517 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4518 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4519 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4520 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004521 testcase( regFree1==0 );
4522 testcase( regFree2==0 );
4523 break;
4524 }
drhcce7d172000-05-31 15:34:51 +00004525 case TK_ISNULL:
4526 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004527 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4528 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004529 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4530 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004531 VdbeCoverageIf(v, op==TK_ISNULL);
4532 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004533 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004534 break;
4535 }
drhfef52082000-06-06 01:50:43 +00004536 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004537 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004538 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004539 break;
4540 }
drh84e30ca2011-02-10 17:46:14 +00004541#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004542 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004543 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004544 int destIfNull = jumpIfNull ? dest : destIfFalse;
4545 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004546 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004547 sqlite3VdbeResolveLabel(v, destIfFalse);
4548 break;
4549 }
shanehbb201342011-02-09 19:55:20 +00004550#endif
drhcce7d172000-05-31 15:34:51 +00004551 default: {
dan7b35a772016-07-28 19:47:15 +00004552 default_expr:
drh991a1982014-01-02 17:57:16 +00004553 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004554 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004555 }else if( exprAlwaysFalse(pExpr) ){
4556 /* No-op */
4557 }else{
4558 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4559 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004560 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004561 testcase( regFree1==0 );
4562 testcase( jumpIfNull==0 );
4563 }
drhcce7d172000-05-31 15:34:51 +00004564 break;
4565 }
4566 }
drh2dcef112008-01-12 19:03:48 +00004567 sqlite3ReleaseTempReg(pParse, regFree1);
4568 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004569}
4570
4571/*
drh66b89c82000-11-28 20:47:17 +00004572** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004573** to the label "dest" if the expression is false but execution
4574** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004575**
4576** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004577** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4578** is 0.
drhcce7d172000-05-31 15:34:51 +00004579*/
danielk19774adee202004-05-08 08:23:19 +00004580void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004581 Vdbe *v = pParse->pVdbe;
4582 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004583 int regFree1 = 0;
4584 int regFree2 = 0;
4585 int r1, r2;
4586
drh35573352008-01-08 23:54:25 +00004587 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004588 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004589 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004590
4591 /* The value of pExpr->op and op are related as follows:
4592 **
4593 ** pExpr->op op
4594 ** --------- ----------
4595 ** TK_ISNULL OP_NotNull
4596 ** TK_NOTNULL OP_IsNull
4597 ** TK_NE OP_Eq
4598 ** TK_EQ OP_Ne
4599 ** TK_GT OP_Le
4600 ** TK_LE OP_Gt
4601 ** TK_GE OP_Lt
4602 ** TK_LT OP_Ge
4603 **
4604 ** For other values of pExpr->op, op is undefined and unused.
4605 ** The value of TK_ and OP_ constants are arranged such that we
4606 ** can compute the mapping above using the following expression.
4607 ** Assert()s verify that the computation is correct.
4608 */
4609 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4610
4611 /* Verify correct alignment of TK_ and OP_ constants
4612 */
4613 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4614 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4615 assert( pExpr->op!=TK_NE || op==OP_Eq );
4616 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4617 assert( pExpr->op!=TK_LT || op==OP_Ge );
4618 assert( pExpr->op!=TK_LE || op==OP_Gt );
4619 assert( pExpr->op!=TK_GT || op==OP_Le );
4620 assert( pExpr->op!=TK_GE || op==OP_Lt );
4621
danba00e302016-07-23 20:24:06 +00004622 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004623 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004624 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004625 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4626 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004627 break;
4628 }
4629 case TK_OR: {
drhec4ccdb2018-12-29 02:26:59 +00004630 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004631 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004632 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004633 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4634 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004635 break;
4636 }
4637 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004638 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004639 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004640 break;
4641 }
drh8abed7b2018-02-26 18:49:05 +00004642 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004643 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4644 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004645 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004646 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004647 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004648 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004649 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004650 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004651 /* IS TRUE and IS NOT FALSE */
4652 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4653 isNot ? 0 : SQLITE_JUMPIFNULL);
4654
4655 }else{
4656 /* IS FALSE and IS NOT TRUE */
4657 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004658 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004659 }
drh007c8432018-02-26 03:20:18 +00004660 break;
4661 }
drhde845c22016-03-17 19:07:52 +00004662 case TK_IS:
4663 case TK_ISNOT:
4664 testcase( pExpr->op==TK_IS );
4665 testcase( pExpr->op==TK_ISNOT );
4666 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4667 jumpIfNull = SQLITE_NULLEQ;
4668 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004669 case TK_LT:
4670 case TK_LE:
4671 case TK_GT:
4672 case TK_GE:
4673 case TK_NE:
4674 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004675 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004676 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004677 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4678 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004679 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004680 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004681 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4682 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4683 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4684 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004685 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4686 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4687 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4688 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4689 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4690 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004691 testcase( regFree1==0 );
4692 testcase( regFree2==0 );
4693 break;
4694 }
drhcce7d172000-05-31 15:34:51 +00004695 case TK_ISNULL:
4696 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004697 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4698 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004699 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4700 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004701 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004702 break;
4703 }
drhfef52082000-06-06 01:50:43 +00004704 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004705 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004706 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004707 break;
4708 }
drh84e30ca2011-02-10 17:46:14 +00004709#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004710 case TK_IN: {
4711 if( jumpIfNull ){
4712 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4713 }else{
drhec4ccdb2018-12-29 02:26:59 +00004714 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004715 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4716 sqlite3VdbeResolveLabel(v, destIfNull);
4717 }
4718 break;
4719 }
shanehbb201342011-02-09 19:55:20 +00004720#endif
drhcce7d172000-05-31 15:34:51 +00004721 default: {
danba00e302016-07-23 20:24:06 +00004722 default_expr:
drh991a1982014-01-02 17:57:16 +00004723 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004724 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004725 }else if( exprAlwaysTrue(pExpr) ){
4726 /* no-op */
4727 }else{
4728 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4729 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004730 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004731 testcase( regFree1==0 );
4732 testcase( jumpIfNull==0 );
4733 }
drhcce7d172000-05-31 15:34:51 +00004734 break;
4735 }
4736 }
drh2dcef112008-01-12 19:03:48 +00004737 sqlite3ReleaseTempReg(pParse, regFree1);
4738 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004739}
drh22827922000-06-06 17:27:05 +00004740
4741/*
drh72bc8202015-06-11 13:58:35 +00004742** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4743** code generation, and that copy is deleted after code generation. This
4744** ensures that the original pExpr is unchanged.
4745*/
4746void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4747 sqlite3 *db = pParse->db;
4748 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4749 if( db->mallocFailed==0 ){
4750 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4751 }
4752 sqlite3ExprDelete(db, pCopy);
4753}
4754
dan5aa550c2017-06-24 18:10:29 +00004755/*
4756** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4757** type of expression.
4758**
4759** If pExpr is a simple SQL value - an integer, real, string, blob
4760** or NULL value - then the VDBE currently being prepared is configured
4761** to re-prepare each time a new value is bound to variable pVar.
4762**
4763** Additionally, if pExpr is a simple SQL value and the value is the
4764** same as that currently bound to variable pVar, non-zero is returned.
4765** Otherwise, if the values are not the same or if pExpr is not a simple
4766** SQL value, zero is returned.
4767*/
4768static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4769 int res = 0;
drhc0804222017-06-28 21:47:16 +00004770 int iVar;
4771 sqlite3_value *pL, *pR = 0;
4772
4773 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4774 if( pR ){
4775 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004776 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004777 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004778 if( pL ){
4779 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4780 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4781 }
4782 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004783 }
drhc0804222017-06-28 21:47:16 +00004784 sqlite3ValueFree(pR);
4785 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004786 }
4787
4788 return res;
4789}
drh72bc8202015-06-11 13:58:35 +00004790
4791/*
drh1d9da702010-01-07 15:17:02 +00004792** Do a deep comparison of two expression trees. Return 0 if the two
4793** expressions are completely identical. Return 1 if they differ only
4794** by a COLLATE operator at the top level. Return 2 if there are differences
4795** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004796**
drh619a1302013-08-01 13:04:46 +00004797** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4798** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4799**
drh66518ca2013-08-01 15:09:57 +00004800** The pA side might be using TK_REGISTER. If that is the case and pB is
4801** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4802**
drh1d9da702010-01-07 15:17:02 +00004803** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004804** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004805** identical, we return 2 just to be safe. So if this routine
4806** returns 2, then you do not really know for certain if the two
4807** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004808** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004809** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004810** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004811** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004812**
drhc0804222017-06-28 21:47:16 +00004813** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4814** pParse->pReprepare can be matched against literals in pB. The
4815** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4816** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4817** Argument pParse should normally be NULL. If it is not NULL and pA or
4818** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004819*/
dan5aa550c2017-06-24 18:10:29 +00004820int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004821 u32 combinedFlags;
4822 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004823 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004824 }
dan5aa550c2017-06-24 18:10:29 +00004825 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4826 return 0;
4827 }
drh10d1edf2013-11-15 15:52:39 +00004828 combinedFlags = pA->flags | pB->flags;
4829 if( combinedFlags & EP_IntValue ){
4830 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4831 return 0;
4832 }
drh1d9da702010-01-07 15:17:02 +00004833 return 2;
drh22827922000-06-06 17:27:05 +00004834 }
dan16dd3982018-12-20 15:04:38 +00004835 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004836 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004837 return 1;
4838 }
dan5aa550c2017-06-24 18:10:29 +00004839 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004840 return 1;
4841 }
4842 return 2;
4843 }
drh2edc5fd2015-11-24 02:10:52 +00004844 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004845 if( pA->op==TK_FUNCTION ){
4846 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004847#ifndef SQLITE_OMIT_WINDOWFUNC
4848 /* Justification for the assert():
4849 ** window functions have p->op==TK_FUNCTION but aggregate functions
4850 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4851 ** function and a window function should have failed before reaching
4852 ** this point. And, it is not possible to have a window function and
4853 ** a scalar function with the same name and number of arguments. So
4854 ** if we reach this point, either A and B both window functions or
4855 ** neither are a window functions. */
4856 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4857 if( ExprHasProperty(pA,EP_WinFunc) ){
4858 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4859 }
4860#endif
drhf20bbc52019-01-17 01:06:00 +00004861 }else if( pA->op==TK_NULL ){
4862 return 0;
drhd5af5422018-04-13 14:27:01 +00004863 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004864 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004865 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004866 return 2;
drh2646da72005-12-09 20:02:05 +00004867 }
drh22827922000-06-06 17:27:05 +00004868 }
drh10d1edf2013-11-15 15:52:39 +00004869 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004870 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004871 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004872 if( (combinedFlags & EP_FixedCol)==0
4873 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004874 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004875 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004876 if( pA->op!=TK_STRING
4877 && pA->op!=TK_TRUEFALSE
4878 && (combinedFlags & EP_Reduced)==0
4879 ){
drh10d1edf2013-11-15 15:52:39 +00004880 if( pA->iColumn!=pB->iColumn ) return 2;
4881 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004882 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004883 }
4884 }
drh1d9da702010-01-07 15:17:02 +00004885 return 0;
drh22827922000-06-06 17:27:05 +00004886}
4887
drh8c6f6662010-04-26 19:17:26 +00004888/*
4889** Compare two ExprList objects. Return 0 if they are identical and
4890** non-zero if they differ in any way.
4891**
drh619a1302013-08-01 13:04:46 +00004892** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4893** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4894**
drh8c6f6662010-04-26 19:17:26 +00004895** This routine might return non-zero for equivalent ExprLists. The
4896** only consequence will be disabled optimizations. But this routine
4897** must never return 0 if the two ExprList objects are different, or
4898** a malfunction will result.
4899**
4900** Two NULL pointers are considered to be the same. But a NULL pointer
4901** always differs from a non-NULL pointer.
4902*/
drh619a1302013-08-01 13:04:46 +00004903int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004904 int i;
4905 if( pA==0 && pB==0 ) return 0;
4906 if( pA==0 || pB==0 ) return 1;
4907 if( pA->nExpr!=pB->nExpr ) return 1;
4908 for(i=0; i<pA->nExpr; i++){
4909 Expr *pExprA = pA->a[i].pExpr;
4910 Expr *pExprB = pB->a[i].pExpr;
4911 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004912 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004913 }
4914 return 0;
4915}
drh13449892005-09-07 21:22:45 +00004916
drh22827922000-06-06 17:27:05 +00004917/*
drhf9463df2017-02-11 14:59:58 +00004918** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4919** are ignored.
4920*/
4921int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004922 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004923 sqlite3ExprSkipCollate(pA),
4924 sqlite3ExprSkipCollate(pB),
4925 iTab);
4926}
4927
4928/*
drh4bd5f732013-07-31 23:22:39 +00004929** Return true if we can prove the pE2 will always be true if pE1 is
4930** true. Return false if we cannot complete the proof or if pE2 might
4931** be false. Examples:
4932**
drh619a1302013-08-01 13:04:46 +00004933** pE1: x==5 pE2: x==5 Result: true
4934** pE1: x>0 pE2: x==5 Result: false
4935** pE1: x=21 pE2: x=21 OR y=43 Result: true
4936** pE1: x!=123 pE2: x IS NOT NULL Result: true
4937** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4938** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4939** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004940**
4941** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4942** Expr.iTable<0 then assume a table number given by iTab.
4943**
drhc0804222017-06-28 21:47:16 +00004944** If pParse is not NULL, then the values of bound variables in pE1 are
4945** compared against literal values in pE2 and pParse->pVdbe->expmask is
4946** modified to record which bound variables are referenced. If pParse
4947** is NULL, then false will be returned if pE1 contains any bound variables.
4948**
drh4bd5f732013-07-31 23:22:39 +00004949** When in doubt, return false. Returning true might give a performance
4950** improvement. Returning false might cause a performance reduction, but
4951** it will always give the correct answer and is hence always safe.
4952*/
dan5aa550c2017-06-24 18:10:29 +00004953int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4954 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004955 return 1;
4956 }
4957 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004958 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4959 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004960 ){
4961 return 1;
4962 }
drh1ad93a02016-11-02 02:17:52 +00004963 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4964 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4965 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004966 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004967 }
4968 return 0;
drh4bd5f732013-07-31 23:22:39 +00004969}
4970
4971/*
drh25897872018-03-20 21:16:15 +00004972** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4973** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004974** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4975**
4976** This routine controls an optimization. False positives (setting
4977** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4978** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004979*/
4980static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004981 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004982 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004983 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4984 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004985 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004986 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004987 case TK_ISNULL:
4988 case TK_IS:
4989 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004990 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004991 case TK_IN:
drh25897872018-03-20 21:16:15 +00004992 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004993 testcase( pExpr->op==TK_ISNOT );
4994 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004995 testcase( pExpr->op==TK_ISNULL );
4996 testcase( pExpr->op==TK_IS );
4997 testcase( pExpr->op==TK_OR );
4998 testcase( pExpr->op==TK_CASE );
4999 testcase( pExpr->op==TK_IN );
5000 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005001 return WRC_Prune;
5002 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005003 if( pWalker->u.iCur==pExpr->iTable ){
5004 pWalker->eCode = 1;
5005 return WRC_Abort;
5006 }
5007 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005008
5009 /* Virtual tables are allowed to use constraints like x=NULL. So
5010 ** a term of the form x=y does not prove that y is not null if x
5011 ** is the column of a virtual table */
5012 case TK_EQ:
5013 case TK_NE:
5014 case TK_LT:
5015 case TK_LE:
5016 case TK_GT:
5017 case TK_GE:
5018 testcase( pExpr->op==TK_EQ );
5019 testcase( pExpr->op==TK_NE );
5020 testcase( pExpr->op==TK_LT );
5021 testcase( pExpr->op==TK_LE );
5022 testcase( pExpr->op==TK_GT );
5023 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005024 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5025 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005026 ){
5027 return WRC_Prune;
5028 }
drh25897872018-03-20 21:16:15 +00005029 default:
5030 return WRC_Continue;
5031 }
5032}
5033
5034/*
5035** Return true (non-zero) if expression p can only be true if at least
5036** one column of table iTab is non-null. In other words, return true
5037** if expression p will always be NULL or false if every column of iTab
5038** is NULL.
5039**
drh821b6102018-03-24 18:01:51 +00005040** False negatives are acceptable. In other words, it is ok to return
5041** zero even if expression p will never be true of every column of iTab
5042** is NULL. A false negative is merely a missed optimization opportunity.
5043**
5044** False positives are not allowed, however. A false positive may result
5045** in an incorrect answer.
5046**
drh25897872018-03-20 21:16:15 +00005047** Terms of p that are marked with EP_FromJoin (and hence that come from
5048** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5049**
5050** This routine is used to check if a LEFT JOIN can be converted into
5051** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5052** clause requires that some column of the right table of the LEFT JOIN
5053** be non-NULL, then the LEFT JOIN can be safely converted into an
5054** ordinary join.
5055*/
5056int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5057 Walker w;
5058 w.xExprCallback = impliesNotNullRow;
5059 w.xSelectCallback = 0;
5060 w.xSelectCallback2 = 0;
5061 w.eCode = 0;
5062 w.u.iCur = iTab;
5063 sqlite3WalkExpr(&w, p);
5064 return w.eCode;
5065}
5066
5067/*
drh030796d2012-08-23 16:18:10 +00005068** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005069** to determine if an expression can be evaluated by reference to the
5070** index only, without having to do a search for the corresponding
5071** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5072** is the cursor for the table.
5073*/
5074struct IdxCover {
5075 Index *pIdx; /* The index to be tested for coverage */
5076 int iCur; /* Cursor number for the table corresponding to the index */
5077};
5078
5079/*
5080** Check to see if there are references to columns in table
5081** pWalker->u.pIdxCover->iCur can be satisfied using the index
5082** pWalker->u.pIdxCover->pIdx.
5083*/
5084static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5085 if( pExpr->op==TK_COLUMN
5086 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5087 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5088 ){
5089 pWalker->eCode = 1;
5090 return WRC_Abort;
5091 }
5092 return WRC_Continue;
5093}
5094
5095/*
drhe604ec02016-07-27 19:20:58 +00005096** Determine if an index pIdx on table with cursor iCur contains will
5097** the expression pExpr. Return true if the index does cover the
5098** expression and false if the pExpr expression references table columns
5099** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005100**
5101** An index covering an expression means that the expression can be
5102** evaluated using only the index and without having to lookup the
5103** corresponding table entry.
5104*/
5105int sqlite3ExprCoveredByIndex(
5106 Expr *pExpr, /* The index to be tested */
5107 int iCur, /* The cursor number for the corresponding table */
5108 Index *pIdx /* The index that might be used for coverage */
5109){
5110 Walker w;
5111 struct IdxCover xcov;
5112 memset(&w, 0, sizeof(w));
5113 xcov.iCur = iCur;
5114 xcov.pIdx = pIdx;
5115 w.xExprCallback = exprIdxCover;
5116 w.u.pIdxCover = &xcov;
5117 sqlite3WalkExpr(&w, pExpr);
5118 return !w.eCode;
5119}
5120
5121
5122/*
5123** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005124** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005125** aggregate function, in order to implement the
5126** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005127*/
drh030796d2012-08-23 16:18:10 +00005128struct SrcCount {
5129 SrcList *pSrc; /* One particular FROM clause in a nested query */
5130 int nThis; /* Number of references to columns in pSrcList */
5131 int nOther; /* Number of references to columns in other FROM clauses */
5132};
5133
5134/*
5135** Count the number of references to columns.
5136*/
5137static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005138 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5139 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5140 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5141 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5142 ** NEVER() will need to be removed. */
5143 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005144 int i;
drh030796d2012-08-23 16:18:10 +00005145 struct SrcCount *p = pWalker->u.pSrcCount;
5146 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005147 int nSrc = pSrc ? pSrc->nSrc : 0;
5148 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005149 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005150 }
drh655814d2015-01-09 01:27:29 +00005151 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005152 p->nThis++;
5153 }else{
5154 p->nOther++;
5155 }
drh374fdce2012-04-17 16:38:53 +00005156 }
drh030796d2012-08-23 16:18:10 +00005157 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005158}
5159
5160/*
drh030796d2012-08-23 16:18:10 +00005161** Determine if any of the arguments to the pExpr Function reference
5162** pSrcList. Return true if they do. Also return true if the function
5163** has no arguments or has only constant arguments. Return false if pExpr
5164** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005165*/
drh030796d2012-08-23 16:18:10 +00005166int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005167 Walker w;
drh030796d2012-08-23 16:18:10 +00005168 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005169 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005170 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005171 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005172 w.u.pSrcCount = &cnt;
5173 cnt.pSrc = pSrcList;
5174 cnt.nThis = 0;
5175 cnt.nOther = 0;
5176 sqlite3WalkExprList(&w, pExpr->x.pList);
5177 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005178}
5179
5180/*
drh13449892005-09-07 21:22:45 +00005181** Add a new element to the pAggInfo->aCol[] array. Return the index of
5182** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005183*/
drh17435752007-08-16 04:30:38 +00005184static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005185 int i;
drhcf643722007-03-27 13:36:37 +00005186 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005187 db,
drhcf643722007-03-27 13:36:37 +00005188 pInfo->aCol,
5189 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005190 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005191 &i
5192 );
drh13449892005-09-07 21:22:45 +00005193 return i;
5194}
5195
5196/*
5197** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5198** the new element. Return a negative number if malloc fails.
5199*/
drh17435752007-08-16 04:30:38 +00005200static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005201 int i;
drhcf643722007-03-27 13:36:37 +00005202 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005203 db,
drhcf643722007-03-27 13:36:37 +00005204 pInfo->aFunc,
5205 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005206 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005207 &i
5208 );
drh13449892005-09-07 21:22:45 +00005209 return i;
5210}
drh22827922000-06-06 17:27:05 +00005211
5212/*
drh7d10d5a2008-08-20 16:35:10 +00005213** This is the xExprCallback for a tree walker. It is used to
5214** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005215** for additional information.
drh22827922000-06-06 17:27:05 +00005216*/
drh7d10d5a2008-08-20 16:35:10 +00005217static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005218 int i;
drh7d10d5a2008-08-20 16:35:10 +00005219 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005220 Parse *pParse = pNC->pParse;
5221 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005222 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005223
drh25c3b8c2018-04-16 10:34:13 +00005224 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005225 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005226 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005227 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005228 testcase( pExpr->op==TK_AGG_COLUMN );
5229 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005230 /* Check to see if the column is in one of the tables in the FROM
5231 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005232 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005233 struct SrcList_item *pItem = pSrcList->a;
5234 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5235 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005236 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005237 if( pExpr->iTable==pItem->iCursor ){
5238 /* If we reach this point, it means that pExpr refers to a table
5239 ** that is in the FROM clause of the aggregate query.
5240 **
5241 ** Make an entry for the column in pAggInfo->aCol[] if there
5242 ** is not an entry there already.
5243 */
drh7f906d62007-03-12 23:48:52 +00005244 int k;
drh13449892005-09-07 21:22:45 +00005245 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005246 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005247 if( pCol->iTable==pExpr->iTable &&
5248 pCol->iColumn==pExpr->iColumn ){
5249 break;
5250 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005251 }
danielk19771e536952007-08-16 10:09:01 +00005252 if( (k>=pAggInfo->nColumn)
5253 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5254 ){
drh7f906d62007-03-12 23:48:52 +00005255 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005256 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005257 pCol->iTable = pExpr->iTable;
5258 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005259 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005260 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005261 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005262 if( pAggInfo->pGroupBy ){
5263 int j, n;
5264 ExprList *pGB = pAggInfo->pGroupBy;
5265 struct ExprList_item *pTerm = pGB->a;
5266 n = pGB->nExpr;
5267 for(j=0; j<n; j++, pTerm++){
5268 Expr *pE = pTerm->pExpr;
5269 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5270 pE->iColumn==pExpr->iColumn ){
5271 pCol->iSorterColumn = j;
5272 break;
5273 }
5274 }
5275 }
5276 if( pCol->iSorterColumn<0 ){
5277 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5278 }
5279 }
5280 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5281 ** because it was there before or because we just created it).
5282 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5283 ** pAggInfo->aCol[] entry.
5284 */
drhebb6a652013-09-12 23:42:22 +00005285 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005286 pExpr->pAggInfo = pAggInfo;
5287 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005288 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005289 break;
5290 } /* endif pExpr->iTable==pItem->iCursor */
5291 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005292 }
drh7d10d5a2008-08-20 16:35:10 +00005293 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005294 }
5295 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005296 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005297 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005298 ){
drh13449892005-09-07 21:22:45 +00005299 /* Check to see if pExpr is a duplicate of another aggregate
5300 ** function that is already in the pAggInfo structure
5301 */
5302 struct AggInfo_func *pItem = pAggInfo->aFunc;
5303 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005304 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005305 break;
5306 }
drh22827922000-06-06 17:27:05 +00005307 }
drh13449892005-09-07 21:22:45 +00005308 if( i>=pAggInfo->nFunc ){
5309 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5310 */
danielk197714db2662006-01-09 16:12:04 +00005311 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005312 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005313 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005314 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005315 pItem = &pAggInfo->aFunc[i];
5316 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005317 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005318 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005319 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005320 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005321 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005322 if( pExpr->flags & EP_Distinct ){
5323 pItem->iDistinct = pParse->nTab++;
5324 }else{
5325 pItem->iDistinct = -1;
5326 }
drh13449892005-09-07 21:22:45 +00005327 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005328 }
drh13449892005-09-07 21:22:45 +00005329 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5330 */
drhc5cd1242013-09-12 16:50:49 +00005331 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005332 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005333 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005334 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005335 return WRC_Prune;
5336 }else{
5337 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005338 }
drh22827922000-06-06 17:27:05 +00005339 }
5340 }
drh7d10d5a2008-08-20 16:35:10 +00005341 return WRC_Continue;
5342}
5343static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005344 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005345 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005346 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005347}
drh979dd1b2017-05-29 14:26:07 +00005348static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5349 UNUSED_PARAMETER(pSelect);
5350 pWalker->walkerDepth--;
5351}
drh626a8792005-01-17 22:08:19 +00005352
5353/*
drhe8abb4c2012-11-02 18:24:57 +00005354** Analyze the pExpr expression looking for aggregate functions and
5355** for variables that need to be added to AggInfo object that pNC->pAggInfo
5356** points to. Additional entries are made on the AggInfo object as
5357** necessary.
drh626a8792005-01-17 22:08:19 +00005358**
5359** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005360** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005361*/
drhd2b3e232008-01-23 14:51:49 +00005362void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005363 Walker w;
5364 w.xExprCallback = analyzeAggregate;
5365 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005366 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5367 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005368 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00005369 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005370 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005371}
drh5d9a4af2005-08-30 00:54:01 +00005372
5373/*
5374** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5375** expression list. Return the number of errors.
5376**
5377** If an error is found, the analysis is cut short.
5378*/
drhd2b3e232008-01-23 14:51:49 +00005379void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005380 struct ExprList_item *pItem;
5381 int i;
drh5d9a4af2005-08-30 00:54:01 +00005382 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005383 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5384 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005385 }
5386 }
drh5d9a4af2005-08-30 00:54:01 +00005387}
drh892d3172008-01-10 03:46:36 +00005388
5389/*
drhceea3322009-04-23 13:22:42 +00005390** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005391*/
5392int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005393 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005394 return ++pParse->nMem;
5395 }
danielk19772f425f62008-07-04 09:41:39 +00005396 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005397}
drhceea3322009-04-23 13:22:42 +00005398
5399/*
5400** Deallocate a register, making available for reuse for some other
5401** purpose.
drhceea3322009-04-23 13:22:42 +00005402*/
drh892d3172008-01-10 03:46:36 +00005403void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005404 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005405 pParse->aTempReg[pParse->nTempReg++] = iReg;
5406 }
5407}
5408
5409/*
drhed24da42016-09-06 14:37:05 +00005410** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005411*/
5412int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005413 int i, n;
drhed24da42016-09-06 14:37:05 +00005414 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005415 i = pParse->iRangeReg;
5416 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005417 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005418 pParse->iRangeReg += nReg;
5419 pParse->nRangeReg -= nReg;
5420 }else{
5421 i = pParse->nMem+1;
5422 pParse->nMem += nReg;
5423 }
5424 return i;
5425}
5426void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005427 if( nReg==1 ){
5428 sqlite3ReleaseTempReg(pParse, iReg);
5429 return;
5430 }
drh892d3172008-01-10 03:46:36 +00005431 if( nReg>pParse->nRangeReg ){
5432 pParse->nRangeReg = nReg;
5433 pParse->iRangeReg = iReg;
5434 }
5435}
drhcdc69552011-12-06 13:24:59 +00005436
5437/*
5438** Mark all temporary registers as being unavailable for reuse.
5439*/
5440void sqlite3ClearTempRegCache(Parse *pParse){
5441 pParse->nTempReg = 0;
5442 pParse->nRangeReg = 0;
5443}
drhbb9b5f22016-03-19 00:35:02 +00005444
5445/*
5446** Validate that no temporary register falls within the range of
5447** iFirst..iLast, inclusive. This routine is only call from within assert()
5448** statements.
5449*/
5450#ifdef SQLITE_DEBUG
5451int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5452 int i;
5453 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005454 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5455 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005456 ){
5457 return 0;
5458 }
5459 for(i=0; i<pParse->nTempReg; i++){
5460 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5461 return 0;
5462 }
5463 }
5464 return 1;
5465}
5466#endif /* SQLITE_DEBUG */