blob: c03caa6c6b59f10c2524ae3847d503e6ed042a73 [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);
drhfc7f27b2016-08-20 00:07:01 +0000468 }
469 return pRet;
470}
dan71c57db2016-07-09 20:23:55 +0000471
dan5c288b92016-07-30 21:02:33 +0000472/*
473** If expression pExpr is of type TK_SELECT, generate code to evaluate
474** it. Return the register in which the result is stored (or, if the
475** sub-select returns more than one column, the first in an array
476** of registers in which the result is stored).
477**
478** If pExpr is not a TK_SELECT expression, return 0.
479*/
480static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000481 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000482#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000483 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000484 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000485 }
danf9b2e052016-08-02 17:45:00 +0000486#endif
dan8da209b2016-07-26 18:06:08 +0000487 return reg;
488}
489
dan5c288b92016-07-30 21:02:33 +0000490/*
491** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000492** or TK_SELECT that returns more than one column. This function returns
493** the register number of a register that contains the value of
494** element iField of the vector.
495**
496** If pVector is a TK_SELECT expression, then code for it must have
497** already been generated using the exprCodeSubselect() routine. In this
498** case parameter regSelect should be the first in an array of registers
499** containing the results of the sub-select.
500**
501** If pVector is of type TK_VECTOR, then code for the requested field
502** is generated. In this case (*pRegFree) may be set to the number of
503** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000504**
505** Before returning, output parameter (*ppExpr) is set to point to the
506** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000507*/
508static int exprVectorRegister(
509 Parse *pParse, /* Parse context */
510 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000511 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000512 int regSelect, /* First in array of registers */
513 Expr **ppExpr, /* OUT: Expression element */
514 int *pRegFree /* OUT: Temp register to free */
515){
drh12abf402016-08-22 14:30:05 +0000516 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000517 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000518 if( op==TK_REGISTER ){
519 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
520 return pVector->iTable+iField;
521 }
522 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000523 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
524 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000525 }
dan870a0702016-08-01 16:37:43 +0000526 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000527 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
528}
529
530/*
531** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000532** the result of the comparison (1, 0, or NULL) and write that
533** result into register dest.
534**
535** The caller must satisfy the following preconditions:
536**
537** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
538** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
539** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000540*/
drh79752b62016-08-13 10:02:17 +0000541static void codeVectorCompare(
542 Parse *pParse, /* Code generator context */
543 Expr *pExpr, /* The comparison operation */
544 int dest, /* Write results into this register */
545 u8 op, /* Comparison operator */
546 u8 p5 /* SQLITE_NULLEQ or zero */
547){
dan71c57db2016-07-09 20:23:55 +0000548 Vdbe *v = pParse->pVdbe;
549 Expr *pLeft = pExpr->pLeft;
550 Expr *pRight = pExpr->pRight;
551 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000552 int i;
553 int regLeft = 0;
554 int regRight = 0;
555 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000556 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000557
drh245ce622017-01-01 12:44:07 +0000558 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
559 sqlite3ErrorMsg(pParse, "row value misused");
560 return;
561 }
drhb29e60c2016-09-05 12:02:34 +0000562 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
563 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
564 || pExpr->op==TK_LT || pExpr->op==TK_GT
565 || pExpr->op==TK_LE || pExpr->op==TK_GE
566 );
567 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
568 || (pExpr->op==TK_ISNOT && op==TK_NE) );
569 assert( p5==0 || pExpr->op!=op );
570 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000571
drhb29e60c2016-09-05 12:02:34 +0000572 p5 |= SQLITE_STOREP2;
573 if( opx==TK_LE ) opx = TK_LT;
574 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000575
drhb29e60c2016-09-05 12:02:34 +0000576 regLeft = exprCodeSubselect(pParse, pLeft);
577 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000578
drhb29e60c2016-09-05 12:02:34 +0000579 for(i=0; 1 /*Loop exits by "break"*/; i++){
580 int regFree1 = 0, regFree2 = 0;
581 Expr *pL, *pR;
582 int r1, r2;
583 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000584 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
585 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
586 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
587 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
588 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
589 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
590 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
591 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
592 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
593 sqlite3ReleaseTempReg(pParse, regFree1);
594 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000595 if( i==nLeft-1 ){
596 break;
dan71c57db2016-07-09 20:23:55 +0000597 }
drhb29e60c2016-09-05 12:02:34 +0000598 if( opx==TK_EQ ){
599 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
600 p5 |= SQLITE_KEEPNULL;
601 }else if( opx==TK_NE ){
602 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
603 p5 |= SQLITE_KEEPNULL;
604 }else{
605 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
606 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
607 VdbeCoverageIf(v, op==TK_LT);
608 VdbeCoverageIf(v, op==TK_GT);
609 VdbeCoverageIf(v, op==TK_LE);
610 VdbeCoverageIf(v, op==TK_GE);
611 if( i==nLeft-2 ) opx = op;
612 }
dan71c57db2016-07-09 20:23:55 +0000613 }
drhb29e60c2016-09-05 12:02:34 +0000614 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000615}
616
danielk19774b5255a2008-06-05 16:47:39 +0000617#if SQLITE_MAX_EXPR_DEPTH>0
618/*
619** Check that argument nHeight is less than or equal to the maximum
620** expression depth allowed. If it is not, leave an error message in
621** pParse.
622*/
drh7d10d5a2008-08-20 16:35:10 +0000623int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000624 int rc = SQLITE_OK;
625 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
626 if( nHeight>mxHeight ){
627 sqlite3ErrorMsg(pParse,
628 "Expression tree is too large (maximum depth %d)", mxHeight
629 );
630 rc = SQLITE_ERROR;
631 }
632 return rc;
633}
634
635/* The following three functions, heightOfExpr(), heightOfExprList()
636** and heightOfSelect(), are used to determine the maximum height
637** of any expression tree referenced by the structure passed as the
638** first argument.
639**
640** If this maximum height is greater than the current value pointed
641** to by pnHeight, the second parameter, then set *pnHeight to that
642** value.
643*/
644static void heightOfExpr(Expr *p, int *pnHeight){
645 if( p ){
646 if( p->nHeight>*pnHeight ){
647 *pnHeight = p->nHeight;
648 }
649 }
650}
651static void heightOfExprList(ExprList *p, int *pnHeight){
652 if( p ){
653 int i;
654 for(i=0; i<p->nExpr; i++){
655 heightOfExpr(p->a[i].pExpr, pnHeight);
656 }
657 }
658}
dan1a3a3082018-01-18 19:00:54 +0000659static void heightOfSelect(Select *pSelect, int *pnHeight){
660 Select *p;
661 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000662 heightOfExpr(p->pWhere, pnHeight);
663 heightOfExpr(p->pHaving, pnHeight);
664 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000665 heightOfExprList(p->pEList, pnHeight);
666 heightOfExprList(p->pGroupBy, pnHeight);
667 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000668 }
669}
670
671/*
672** Set the Expr.nHeight variable in the structure passed as an
673** argument. An expression with no children, Expr.pList or
674** Expr.pSelect member has a height of 1. Any other expression
675** has a height equal to the maximum height of any other
676** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000677**
678** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
679** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000680*/
681static void exprSetHeight(Expr *p){
682 int nHeight = 0;
683 heightOfExpr(p->pLeft, &nHeight);
684 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000685 if( ExprHasProperty(p, EP_xIsSelect) ){
686 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000687 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000688 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000689 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000690 }
danielk19774b5255a2008-06-05 16:47:39 +0000691 p->nHeight = nHeight + 1;
692}
693
694/*
695** Set the Expr.nHeight variable using the exprSetHeight() function. If
696** the height is greater than the maximum allowed expression depth,
697** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000698**
699** Also propagate all EP_Propagate flags from the Expr.x.pList into
700** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000701*/
drh2308ed32015-02-09 16:09:34 +0000702void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000703 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000704 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000705 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000706}
707
708/*
709** Return the maximum height of any expression tree referenced
710** by the select statement passed as an argument.
711*/
712int sqlite3SelectExprHeight(Select *p){
713 int nHeight = 0;
714 heightOfSelect(p, &nHeight);
715 return nHeight;
716}
drh2308ed32015-02-09 16:09:34 +0000717#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
718/*
719** Propagate all EP_Propagate flags from the Expr.x.pList into
720** Expr.flags.
721*/
722void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
723 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
724 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
725 }
726}
727#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000728#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
729
drhbe5c89a2004-07-26 00:31:09 +0000730/*
drhb7916a72009-05-27 10:31:29 +0000731** This routine is the core allocator for Expr nodes.
732**
drha76b5df2002-02-23 02:32:10 +0000733** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000734** for this node and for the pToken argument is a single allocation
735** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000736** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000737**
738** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000739** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000740** parameter is ignored if pToken is NULL or if the token does not
741** appear to be quoted. If the quotes were of the form "..." (double-quotes)
742** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000743**
744** Special case: If op==TK_INTEGER and pToken points to a string that
745** can be translated into a 32-bit integer, then the token is not
746** stored in u.zToken. Instead, the integer values is written
747** into u.iValue and the EP_IntValue flag is set. No extra storage
748** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000749*/
drhb7916a72009-05-27 10:31:29 +0000750Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000751 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000752 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000753 const Token *pToken, /* Token argument. Might be NULL */
754 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000755){
drha76b5df2002-02-23 02:32:10 +0000756 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000757 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000758 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000759
drh575fad62016-02-05 13:38:36 +0000760 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000761 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000762 if( op!=TK_INTEGER || pToken->z==0
763 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
764 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000765 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000766 }
drhb7916a72009-05-27 10:31:29 +0000767 }
drh575fad62016-02-05 13:38:36 +0000768 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000769 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000770 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000771 pNew->op = (u8)op;
772 pNew->iAgg = -1;
773 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000774 if( nExtra==0 ){
drhb98a2e32017-07-07 12:43:57 +0000775 pNew->flags |= EP_IntValue|EP_Leaf;
drh33e619f2009-05-28 01:00:55 +0000776 pNew->u.iValue = iValue;
777 }else{
drh33e619f2009-05-28 01:00:55 +0000778 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000779 assert( pToken->z!=0 || pToken->n==0 );
780 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000781 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000782 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000783 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000784 }
drhb7916a72009-05-27 10:31:29 +0000785 }
786 }
787#if SQLITE_MAX_EXPR_DEPTH>0
788 pNew->nHeight = 1;
789#endif
790 }
drha76b5df2002-02-23 02:32:10 +0000791 return pNew;
792}
793
794/*
drhb7916a72009-05-27 10:31:29 +0000795** Allocate a new expression node from a zero-terminated token that has
796** already been dequoted.
797*/
798Expr *sqlite3Expr(
799 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
800 int op, /* Expression opcode */
801 const char *zToken /* Token argument. Might be NULL */
802){
803 Token x;
804 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000805 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000806 return sqlite3ExprAlloc(db, op, &x, 0);
807}
808
809/*
810** Attach subtrees pLeft and pRight to the Expr node pRoot.
811**
812** If pRoot==NULL that means that a memory allocation error has occurred.
813** In that case, delete the subtrees pLeft and pRight.
814*/
815void sqlite3ExprAttachSubtrees(
816 sqlite3 *db,
817 Expr *pRoot,
818 Expr *pLeft,
819 Expr *pRight
820){
821 if( pRoot==0 ){
822 assert( db->mallocFailed );
823 sqlite3ExprDelete(db, pLeft);
824 sqlite3ExprDelete(db, pRight);
825 }else{
826 if( pRight ){
827 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000828 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000829 }
830 if( pLeft ){
831 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000832 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000833 }
834 exprSetHeight(pRoot);
835 }
836}
837
838/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000839** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000840**
drhbf664462009-06-19 18:32:54 +0000841** One or both of the subtrees can be NULL. Return a pointer to the new
842** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
843** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000844*/
drh17435752007-08-16 04:30:38 +0000845Expr *sqlite3PExpr(
846 Parse *pParse, /* Parsing context */
847 int op, /* Expression opcode */
848 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000849 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000850){
drh5fb52ca2012-03-31 02:34:35 +0000851 Expr *p;
drh1167d322015-10-28 20:01:45 +0000852 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000853 /* Take advantage of short-circuit false optimization for AND */
854 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
855 }else{
drhabfd35e2016-12-06 22:47:23 +0000856 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
857 if( p ){
858 memset(p, 0, sizeof(Expr));
859 p->op = op & TKFLG_MASK;
860 p->iAgg = -1;
861 }
drh5fb52ca2012-03-31 02:34:35 +0000862 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
863 }
dan2b359bd2010-10-28 11:31:23 +0000864 if( p ) {
865 sqlite3ExprCheckHeight(pParse, p->nHeight);
866 }
drh4e0cff62004-11-05 05:10:28 +0000867 return p;
868}
869
870/*
drh08de4f72016-04-11 01:06:47 +0000871** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
872** do a memory allocation failure) then delete the pSelect object.
873*/
874void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
875 if( pExpr ){
876 pExpr->x.pSelect = pSelect;
877 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
878 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
879 }else{
880 assert( pParse->db->mallocFailed );
881 sqlite3SelectDelete(pParse->db, pSelect);
882 }
883}
884
885
886/*
drh991a1982014-01-02 17:57:16 +0000887** If the expression is always either TRUE or FALSE (respectively),
888** then return 1. If one cannot determine the truth value of the
889** expression at compile-time return 0.
890**
891** This is an optimization. If is OK to return 0 here even if
892** the expression really is always false or false (a false negative).
893** But it is a bug to return 1 if the expression might have different
894** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000895**
896** Note that if the expression is part of conditional for a
897** LEFT JOIN, then we cannot determine at compile-time whether or not
898** is it true or false, so always return 0.
899*/
drh991a1982014-01-02 17:57:16 +0000900static int exprAlwaysTrue(Expr *p){
901 int v = 0;
902 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
903 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
904 return v!=0;
905}
drh5fb52ca2012-03-31 02:34:35 +0000906static int exprAlwaysFalse(Expr *p){
907 int v = 0;
908 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
909 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
910 return v==0;
911}
912
913/*
drh91bb0ee2004-09-01 03:06:34 +0000914** Join two expressions using an AND operator. If either expression is
915** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000916**
917** If one side or the other of the AND is known to be false, then instead
918** of returning an AND expression, just return a constant expression with
919** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000920*/
danielk19771e536952007-08-16 10:09:01 +0000921Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000922 if( pLeft==0 ){
923 return pRight;
924 }else if( pRight==0 ){
925 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000926 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
927 sqlite3ExprDelete(db, pLeft);
928 sqlite3ExprDelete(db, pRight);
929 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000930 }else{
drhb7916a72009-05-27 10:31:29 +0000931 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
932 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
933 return pNew;
drha76b5df2002-02-23 02:32:10 +0000934 }
935}
936
937/*
938** Construct a new expression node for a function with multiple
939** arguments.
940*/
drh954733b2018-07-27 23:33:16 +0000941Expr *sqlite3ExprFunction(
942 Parse *pParse, /* Parsing context */
943 ExprList *pList, /* Argument list */
944 Token *pToken, /* Name of the function */
945 int eDistinct /* SF_Distinct or SF_ALL or 0 */
946){
drha76b5df2002-02-23 02:32:10 +0000947 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000948 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000949 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000950 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000951 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000952 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000953 return 0;
954 }
drh954733b2018-07-27 23:33:16 +0000955 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
956 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
957 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000958 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000959 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000960 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000961 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000962 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000963 return pNew;
964}
965
966/*
drhfa6bc002004-09-07 16:19:52 +0000967** Assign a variable number to an expression that encodes a wildcard
968** in the original SQL statement.
969**
970** Wildcards consisting of a single "?" are assigned the next sequential
971** variable number.
972**
973** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000974** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000975** the SQL statement comes from an external source.
976**
drh51f49f12009-05-21 20:41:32 +0000977** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000978** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000979** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000980** assigned.
981*/
drhde25a882016-10-03 15:28:24 +0000982void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000983 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000984 const char *z;
drhf326d662016-12-23 13:30:53 +0000985 ynVar x;
drh17435752007-08-16 04:30:38 +0000986
drhfa6bc002004-09-07 16:19:52 +0000987 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000988 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000989 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000990 assert( z!=0 );
991 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000992 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000993 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000994 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000995 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000996 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000997 }else{
drhf326d662016-12-23 13:30:53 +0000998 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000999 if( z[0]=='?' ){
1000 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1001 ** use it as the variable number */
1002 i64 i;
drh18814df2017-01-31 03:52:34 +00001003 int bOk;
1004 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1005 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1006 bOk = 1;
1007 }else{
1008 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1009 }
drh124c0b42011-06-01 18:15:55 +00001010 testcase( i==0 );
1011 testcase( i==1 );
1012 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1013 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1014 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1015 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1016 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001017 return;
drhfa6bc002004-09-07 16:19:52 +00001018 }
drh8e74e7b2017-01-31 12:41:48 +00001019 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001020 if( x>pParse->nVar ){
1021 pParse->nVar = (int)x;
1022 doAdd = 1;
1023 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1024 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001025 }
1026 }else{
1027 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1028 ** number as the prior appearance of the same name, or if the name
1029 ** has never appeared before, reuse the same variable number
1030 */
drh9bf755c2016-12-23 03:59:31 +00001031 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1032 if( x==0 ){
1033 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001034 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001035 }
drhfa6bc002004-09-07 16:19:52 +00001036 }
drhf326d662016-12-23 13:30:53 +00001037 if( doAdd ){
1038 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1039 }
1040 }
1041 pExpr->iColumn = x;
1042 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001043 sqlite3ErrorMsg(pParse, "too many SQL variables");
1044 }
drhfa6bc002004-09-07 16:19:52 +00001045}
1046
1047/*
danf6963f92009-11-23 14:39:14 +00001048** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001049*/
drh4f0010b2016-04-11 14:49:39 +00001050static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1051 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001052 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1053 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001054
1055 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1056 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1057 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001058#ifdef SQLITE_DEBUG
1059 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1060 assert( p->pLeft==0 );
1061 assert( p->pRight==0 );
1062 assert( p->x.pSelect==0 );
1063 }
1064#endif
1065 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001066 /* The Expr.x union is never used at the same time as Expr.pRight */
1067 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001068 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001069 if( p->pRight ){
1070 sqlite3ExprDeleteNN(db, p->pRight);
1071 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001072 sqlite3SelectDelete(db, p->x.pSelect);
1073 }else{
1074 sqlite3ExprListDelete(db, p->x.pList);
1075 }
drheda079c2018-09-20 19:02:15 +00001076 if( ExprHasProperty(p, EP_WinFunc) ){
1077 assert( p->op==TK_FUNCTION );
1078 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001079 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001080 }
drh209bc522016-09-23 21:36:24 +00001081 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001082 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001083 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001084 }
drha2e00042002-01-22 03:13:42 +00001085}
drh4f0010b2016-04-11 14:49:39 +00001086void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1087 if( p ) sqlite3ExprDeleteNN(db, p);
1088}
drha2e00042002-01-22 03:13:42 +00001089
drhd2687b72005-08-12 22:56:09 +00001090/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001091** Return the number of bytes allocated for the expression structure
1092** passed as the first argument. This is always one of EXPR_FULLSIZE,
1093** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1094*/
1095static int exprStructSize(Expr *p){
1096 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001097 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1098 return EXPR_FULLSIZE;
1099}
1100
1101/*
drha8e05762019-01-05 21:56:12 +00001102** Copy the complete content of an Expr node, taking care not to read
1103** past the end of the structure for a reduced-size version of the source
1104** Expr.
1105*/
1106static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1107 memset(pDest, 0, sizeof(Expr));
1108 memcpy(pDest, pSrc, exprStructSize(pSrc));
1109}
1110
1111/*
drh33e619f2009-05-28 01:00:55 +00001112** The dupedExpr*Size() routines each return the number of bytes required
1113** to store a copy of an expression or expression tree. They differ in
1114** how much of the tree is measured.
1115**
1116** dupedExprStructSize() Size of only the Expr structure
1117** dupedExprNodeSize() Size of Expr + space for token
1118** dupedExprSize() Expr + token + subtree components
1119**
1120***************************************************************************
1121**
1122** The dupedExprStructSize() function returns two values OR-ed together:
1123** (1) the space required for a copy of the Expr structure only and
1124** (2) the EP_xxx flags that indicate what the structure size should be.
1125** The return values is always one of:
1126**
1127** EXPR_FULLSIZE
1128** EXPR_REDUCEDSIZE | EP_Reduced
1129** EXPR_TOKENONLYSIZE | EP_TokenOnly
1130**
1131** The size of the structure can be found by masking the return value
1132** of this routine with 0xfff. The flags can be found by masking the
1133** return value with EP_Reduced|EP_TokenOnly.
1134**
1135** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1136** (unreduced) Expr objects as they or originally constructed by the parser.
1137** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001138** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001139** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001140** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001141** to reduce a pristine expression tree from the parser. The implementation
1142** of dupedExprStructSize() contain multiple assert() statements that attempt
1143** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001144*/
1145static int dupedExprStructSize(Expr *p, int flags){
1146 int nSize;
drh33e619f2009-05-28 01:00:55 +00001147 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001148 assert( EXPR_FULLSIZE<=0xfff );
1149 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001150 if( 0==flags || p->op==TK_SELECT_COLUMN
1151#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001152 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001153#endif
1154 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001155 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001156 }else{
drhc5cd1242013-09-12 16:50:49 +00001157 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001158 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001159 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001160 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001161 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001162 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1163 }else{
drhaecd8022013-09-13 18:15:15 +00001164 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001165 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1166 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001167 }
1168 return nSize;
1169}
1170
1171/*
drh33e619f2009-05-28 01:00:55 +00001172** This function returns the space in bytes required to store the copy
1173** of the Expr structure and a copy of the Expr.u.zToken string (if that
1174** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001175*/
1176static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001177 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1178 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001179 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001180 }
danielk1977bc739712009-03-23 04:33:32 +00001181 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001182}
1183
1184/*
1185** Return the number of bytes required to create a duplicate of the
1186** expression passed as the first argument. The second argument is a
1187** mask containing EXPRDUP_XXX flags.
1188**
1189** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001190** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001191**
1192** If the EXPRDUP_REDUCE flag is set, then the return value includes
1193** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1194** and Expr.pRight variables (but not for any structures pointed to or
1195** descended from the Expr.x.pList or Expr.x.pSelect variables).
1196*/
1197static int dupedExprSize(Expr *p, int flags){
1198 int nByte = 0;
1199 if( p ){
1200 nByte = dupedExprNodeSize(p, flags);
1201 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001202 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001203 }
1204 }
1205 return nByte;
1206}
1207
1208/*
1209** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1210** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001211** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001212** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001213** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001214** portion of the buffer copied into by this function.
1215*/
drh3c194692016-04-11 16:43:43 +00001216static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1217 Expr *pNew; /* Value to return */
1218 u8 *zAlloc; /* Memory space from which to build Expr object */
1219 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1220
drh575fad62016-02-05 13:38:36 +00001221 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001222 assert( p );
1223 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1224 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001225
drh3c194692016-04-11 16:43:43 +00001226 /* Figure out where to write the new Expr structure. */
1227 if( pzBuffer ){
1228 zAlloc = *pzBuffer;
1229 staticFlag = EP_Static;
1230 }else{
1231 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1232 staticFlag = 0;
1233 }
1234 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001235
drh3c194692016-04-11 16:43:43 +00001236 if( pNew ){
1237 /* Set nNewSize to the size allocated for the structure pointed to
1238 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1239 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1240 ** by the copy of the p->u.zToken string (if any).
1241 */
1242 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1243 const int nNewSize = nStructSize & 0xfff;
1244 int nToken;
1245 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1246 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001247 }else{
drh3c194692016-04-11 16:43:43 +00001248 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001249 }
drh3c194692016-04-11 16:43:43 +00001250 if( dupFlags ){
1251 assert( ExprHasProperty(p, EP_Reduced)==0 );
1252 memcpy(zAlloc, p, nNewSize);
1253 }else{
1254 u32 nSize = (u32)exprStructSize(p);
1255 memcpy(zAlloc, p, nSize);
1256 if( nSize<EXPR_FULLSIZE ){
1257 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1258 }
1259 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001260
drh3c194692016-04-11 16:43:43 +00001261 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1262 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1263 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1264 pNew->flags |= staticFlag;
1265
1266 /* Copy the p->u.zToken string, if any. */
1267 if( nToken ){
1268 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1269 memcpy(zToken, p->u.zToken, nToken);
1270 }
1271
drh209bc522016-09-23 21:36:24 +00001272 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001273 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1274 if( ExprHasProperty(p, EP_xIsSelect) ){
1275 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001276 }else{
drh3c194692016-04-11 16:43:43 +00001277 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001278 }
drh3c194692016-04-11 16:43:43 +00001279 }
1280
1281 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001282 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1283 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001284 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001285 pNew->pLeft = p->pLeft ?
1286 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1287 pNew->pRight = p->pRight ?
1288 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001289 }
dan67a9b8e2018-06-22 20:51:35 +00001290#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001291 if( ExprHasProperty(p, EP_WinFunc) ){
1292 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1293 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001294 }
dan67a9b8e2018-06-22 20:51:35 +00001295#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001296 if( pzBuffer ){
1297 *pzBuffer = zAlloc;
1298 }
1299 }else{
drh209bc522016-09-23 21:36:24 +00001300 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001301 if( pNew->op==TK_SELECT_COLUMN ){
1302 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001303 assert( p->iColumn==0 || p->pRight==0 );
1304 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001305 }else{
1306 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1307 }
drh3c194692016-04-11 16:43:43 +00001308 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001309 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001310 }
1311 }
1312 return pNew;
1313}
1314
1315/*
danbfe31e72014-01-15 14:17:31 +00001316** Create and return a deep copy of the object passed as the second
1317** argument. If an OOM condition is encountered, NULL is returned
1318** and the db->mallocFailed flag set.
1319*/
daneede6a52014-01-15 19:42:23 +00001320#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001321static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001322 With *pRet = 0;
1323 if( p ){
1324 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
1325 pRet = sqlite3DbMallocZero(db, nByte);
1326 if( pRet ){
1327 int i;
1328 pRet->nCte = p->nCte;
1329 for(i=0; i<p->nCte; i++){
1330 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1331 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1332 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1333 }
1334 }
1335 }
1336 return pRet;
1337}
daneede6a52014-01-15 19:42:23 +00001338#else
1339# define withDup(x,y) 0
1340#endif
dan4e9119d2014-01-13 15:12:23 +00001341
drha8389972018-12-06 22:04:19 +00001342#ifndef SQLITE_OMIT_WINDOWFUNC
1343/*
1344** The gatherSelectWindows() procedure and its helper routine
1345** gatherSelectWindowsCallback() are used to scan all the expressions
1346** an a newly duplicated SELECT statement and gather all of the Window
1347** objects found there, assembling them onto the linked list at Select->pWin.
1348*/
1349static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1350 if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1351 assert( ExprHasProperty(pExpr, EP_WinFunc) );
1352 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1353 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1354 }
1355 return WRC_Continue;
1356}
drha37b6a52018-12-06 22:12:18 +00001357static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1358 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1359}
drha8389972018-12-06 22:04:19 +00001360static void gatherSelectWindows(Select *p){
1361 Walker w;
1362 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001363 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1364 w.xSelectCallback2 = 0;
drha8389972018-12-06 22:04:19 +00001365 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001366 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001367}
1368#endif
1369
1370
drha76b5df2002-02-23 02:32:10 +00001371/*
drhff78bd22002-02-27 01:47:11 +00001372** The following group of routines make deep copies of expressions,
1373** expression lists, ID lists, and select statements. The copies can
1374** be deleted (by being passed to their respective ...Delete() routines)
1375** without effecting the originals.
1376**
danielk19774adee202004-05-08 08:23:19 +00001377** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1378** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001379** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001380**
drhad3cab52002-05-24 02:04:32 +00001381** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001382**
drhb7916a72009-05-27 10:31:29 +00001383** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001384** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1385** truncated version of the usual Expr structure that will be stored as
1386** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001387*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001388Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001389 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001390 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001391}
danielk19776ab3a2e2009-02-19 14:39:25 +00001392ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001393 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001394 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001395 int i;
drhb1637482017-01-03 00:27:16 +00001396 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001397 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001398 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001399 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001400 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001401 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001402 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001403 pOldItem = p->a;
1404 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001405 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001406 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001407 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001408 if( pOldExpr
1409 && pOldExpr->op==TK_SELECT_COLUMN
1410 && (pNewExpr = pItem->pExpr)!=0
1411 ){
1412 assert( pNewExpr->iColumn==0 || i>0 );
1413 if( pNewExpr->iColumn==0 ){
1414 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001415 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1416 }else{
1417 assert( i>0 );
1418 assert( pItem[-1].pExpr!=0 );
1419 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1420 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1421 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001422 }
1423 }
drh17435752007-08-16 04:30:38 +00001424 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001425 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001426 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001427 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001428 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001429 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001430 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001431 }
1432 return pNew;
1433}
danielk197793758c82005-01-21 08:13:14 +00001434
1435/*
1436** If cursors, triggers, views and subqueries are all omitted from
1437** the build, then none of the following routines, except for
1438** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1439** called with a NULL argument.
1440*/
danielk19776a67fe82005-02-04 04:07:16 +00001441#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1442 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001443SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001444 SrcList *pNew;
1445 int i;
drh113088e2003-03-20 01:16:58 +00001446 int nByte;
drh575fad62016-02-05 13:38:36 +00001447 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001448 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001449 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001450 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001451 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001452 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001453 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001454 struct SrcList_item *pNewItem = &pNew->a[i];
1455 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001456 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001457 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001458 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1459 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1460 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001461 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001462 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001463 pNewItem->addrFillSub = pOldItem->addrFillSub;
1464 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001465 if( pNewItem->fg.isIndexedBy ){
1466 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1467 }
1468 pNewItem->pIBIndex = pOldItem->pIBIndex;
1469 if( pNewItem->fg.isTabFunc ){
1470 pNewItem->u1.pFuncArg =
1471 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1472 }
drhed8a3bb2005-06-06 21:19:56 +00001473 pTab = pNewItem->pTab = pOldItem->pTab;
1474 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001475 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001476 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001477 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1478 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001479 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001480 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001481 }
1482 return pNew;
1483}
drh17435752007-08-16 04:30:38 +00001484IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001485 IdList *pNew;
1486 int i;
drh575fad62016-02-05 13:38:36 +00001487 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001488 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001489 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001490 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001491 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001492 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001493 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001494 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001495 return 0;
1496 }
drh6c535152012-02-02 03:38:30 +00001497 /* Note that because the size of the allocation for p->a[] is not
1498 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1499 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001500 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001501 struct IdList_item *pNewItem = &pNew->a[i];
1502 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001503 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001504 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001505 }
1506 return pNew;
1507}
dana7466202017-02-03 14:44:52 +00001508Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1509 Select *pRet = 0;
1510 Select *pNext = 0;
1511 Select **pp = &pRet;
1512 Select *p;
1513
drh575fad62016-02-05 13:38:36 +00001514 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001515 for(p=pDup; p; p=p->pPrior){
1516 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1517 if( pNew==0 ) break;
1518 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1519 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1520 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1521 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1522 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1523 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1524 pNew->op = p->op;
1525 pNew->pNext = pNext;
1526 pNew->pPrior = 0;
1527 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001528 pNew->iLimit = 0;
1529 pNew->iOffset = 0;
1530 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1531 pNew->addrOpenEphm[0] = -1;
1532 pNew->addrOpenEphm[1] = -1;
1533 pNew->nSelectRow = p->nSelectRow;
1534 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001535#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001536 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001537 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001538 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001539#endif
drhfef37762018-07-10 19:48:35 +00001540 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001541 *pp = pNew;
1542 pp = &pNew->pPrior;
1543 pNext = pNew;
1544 }
1545
1546 return pRet;
drhff78bd22002-02-27 01:47:11 +00001547}
danielk197793758c82005-01-21 08:13:14 +00001548#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001549Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001550 assert( p==0 );
1551 return 0;
1552}
1553#endif
drhff78bd22002-02-27 01:47:11 +00001554
1555
1556/*
drha76b5df2002-02-23 02:32:10 +00001557** Add a new element to the end of an expression list. If pList is
1558** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001559**
drha19543f2017-09-15 15:17:48 +00001560** The pList argument must be either NULL or a pointer to an ExprList
1561** obtained from a prior call to sqlite3ExprListAppend(). This routine
1562** may not be used with an ExprList obtained from sqlite3ExprListDup().
1563** Reason: This routine assumes that the number of slots in pList->a[]
1564** is a power of two. That is true for sqlite3ExprListAppend() returns
1565** but is not necessarily true from the return value of sqlite3ExprListDup().
1566**
drhb7916a72009-05-27 10:31:29 +00001567** If a memory allocation error occurs, the entire list is freed and
1568** NULL is returned. If non-NULL is returned, then it is guaranteed
1569** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001570*/
drh17435752007-08-16 04:30:38 +00001571ExprList *sqlite3ExprListAppend(
1572 Parse *pParse, /* Parsing context */
1573 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001574 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001575){
drh43606172017-04-05 11:32:13 +00001576 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001577 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001578 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001579 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001580 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001581 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001582 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001583 }
drhc263f7c2016-01-18 13:18:54 +00001584 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001585 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001586 ExprList *pNew;
1587 pNew = sqlite3DbRealloc(db, pList,
drha19543f2017-09-15 15:17:48 +00001588 sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001589 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001590 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001591 }
drh43606172017-04-05 11:32:13 +00001592 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001593 }
drh43606172017-04-05 11:32:13 +00001594 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001595 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1596 assert( offsetof(struct ExprList_item,pExpr)==0 );
1597 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001598 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001599 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001600
1601no_mem:
1602 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001603 sqlite3ExprDelete(db, pExpr);
1604 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001605 return 0;
drha76b5df2002-02-23 02:32:10 +00001606}
1607
1608/*
drh8762ec12016-08-20 01:06:22 +00001609** pColumns and pExpr form a vector assignment which is part of the SET
1610** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001611**
1612** (a,b,c) = (expr1,expr2,expr3)
1613** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1614**
1615** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001616** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001617** TK_SELECT_COLUMN expressions.
1618*/
1619ExprList *sqlite3ExprListAppendVector(
1620 Parse *pParse, /* Parsing context */
1621 ExprList *pList, /* List to which to append. Might be NULL */
1622 IdList *pColumns, /* List of names of LHS of the assignment */
1623 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1624){
1625 sqlite3 *db = pParse->db;
1626 int n;
1627 int i;
drh66860af2016-08-23 18:30:10 +00001628 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001629 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1630 ** exit prior to this routine being invoked */
1631 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001632 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001633
1634 /* If the RHS is a vector, then we can immediately check to see that
1635 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1636 ** wildcards ("*") in the result set of the SELECT must be expanded before
1637 ** we can do the size check, so defer the size check until code generation.
1638 */
1639 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001640 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1641 pColumns->nId, n);
1642 goto vector_append_error;
1643 }
drh966e2912017-01-03 02:58:01 +00001644
1645 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001646 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1647 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1648 if( pList ){
drh66860af2016-08-23 18:30:10 +00001649 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001650 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1651 pColumns->a[i].zName = 0;
1652 }
1653 }
drh966e2912017-01-03 02:58:01 +00001654
drhffe28052017-05-06 18:09:36 +00001655 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001656 Expr *pFirst = pList->a[iFirst].pExpr;
1657 assert( pFirst!=0 );
1658 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001659
drhf4dd26c2017-04-05 11:49:06 +00001660 /* Store the SELECT statement in pRight so it will be deleted when
1661 ** sqlite3ExprListDelete() is called */
1662 pFirst->pRight = pExpr;
1663 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001664
drhf4dd26c2017-04-05 11:49:06 +00001665 /* Remember the size of the LHS in iTable so that we can check that
1666 ** the RHS and LHS sizes match during code generation. */
1667 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001668 }
1669
1670vector_append_error:
1671 sqlite3ExprDelete(db, pExpr);
1672 sqlite3IdListDelete(db, pColumns);
1673 return pList;
1674}
1675
1676/*
drhbc622bc2015-08-24 15:39:42 +00001677** Set the sort order for the last element on the given ExprList.
1678*/
1679void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1680 if( p==0 ) return;
1681 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1682 assert( p->nExpr>0 );
1683 if( iSortOrder<0 ){
1684 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1685 return;
1686 }
1687 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001688}
1689
1690/*
drhb7916a72009-05-27 10:31:29 +00001691** Set the ExprList.a[].zName element of the most recently added item
1692** on the expression list.
1693**
1694** pList might be NULL following an OOM error. But pName should never be
1695** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1696** is set.
1697*/
1698void sqlite3ExprListSetName(
1699 Parse *pParse, /* Parsing context */
1700 ExprList *pList, /* List to which to add the span. */
1701 Token *pName, /* Name to be added */
1702 int dequote /* True to cause the name to be dequoted */
1703){
1704 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1705 if( pList ){
1706 struct ExprList_item *pItem;
1707 assert( pList->nExpr>0 );
1708 pItem = &pList->a[pList->nExpr-1];
1709 assert( pItem->zName==0 );
1710 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001711 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001712 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001713 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001714 }
drhb7916a72009-05-27 10:31:29 +00001715 }
1716}
1717
1718/*
1719** Set the ExprList.a[].zSpan element of the most recently added item
1720** on the expression list.
1721**
1722** pList might be NULL following an OOM error. But pSpan should never be
1723** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1724** is set.
1725*/
1726void sqlite3ExprListSetSpan(
1727 Parse *pParse, /* Parsing context */
1728 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001729 const char *zStart, /* Start of the span */
1730 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001731){
1732 sqlite3 *db = pParse->db;
1733 assert( pList!=0 || db->mallocFailed!=0 );
1734 if( pList ){
1735 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1736 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001737 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001738 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001739 }
1740}
1741
1742/*
danielk19777a15a4b2007-05-08 17:54:43 +00001743** If the expression list pEList contains more than iLimit elements,
1744** leave an error message in pParse.
1745*/
1746void sqlite3ExprListCheckLength(
1747 Parse *pParse,
1748 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001749 const char *zObject
1750){
drhb1a6c3c2008-03-20 16:30:17 +00001751 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001752 testcase( pEList && pEList->nExpr==mx );
1753 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001754 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001755 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1756 }
1757}
1758
1759/*
drha76b5df2002-02-23 02:32:10 +00001760** Delete an entire expression list.
1761*/
drhaffa8552016-04-11 18:25:05 +00001762static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001763 int i = pList->nExpr;
1764 struct ExprList_item *pItem = pList->a;
1765 assert( pList->nExpr>0 );
1766 do{
drh633e6d52008-07-28 19:34:53 +00001767 sqlite3ExprDelete(db, pItem->pExpr);
1768 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001769 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001770 pItem++;
1771 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001772 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001773}
drhaffa8552016-04-11 18:25:05 +00001774void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1775 if( pList ) exprListDeleteNN(db, pList);
1776}
drha76b5df2002-02-23 02:32:10 +00001777
1778/*
drh2308ed32015-02-09 16:09:34 +00001779** Return the bitwise-OR of all Expr.flags fields in the given
1780** ExprList.
drh885a5b02015-02-09 15:21:36 +00001781*/
drh2308ed32015-02-09 16:09:34 +00001782u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001783 int i;
drh2308ed32015-02-09 16:09:34 +00001784 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001785 assert( pList!=0 );
1786 for(i=0; i<pList->nExpr; i++){
1787 Expr *pExpr = pList->a[i].pExpr;
1788 assert( pExpr!=0 );
1789 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001790 }
drh2308ed32015-02-09 16:09:34 +00001791 return m;
drh885a5b02015-02-09 15:21:36 +00001792}
1793
1794/*
drh7e6f9802017-09-04 00:33:04 +00001795** This is a SELECT-node callback for the expression walker that
1796** always "fails". By "fail" in this case, we mean set
1797** pWalker->eCode to zero and abort.
1798**
1799** This callback is used by multiple expression walkers.
1800*/
1801int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1802 UNUSED_PARAMETER(NotUsed);
1803 pWalker->eCode = 0;
1804 return WRC_Abort;
1805}
1806
1807/*
drh171d16b2018-02-26 20:15:54 +00001808** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001809** then convert it into an TK_TRUEFALSE term. Return non-zero if
1810** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001811*/
1812int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1813 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001814 if( !ExprHasProperty(pExpr, EP_Quoted)
1815 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1816 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001817 ){
1818 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001819 return 1;
1820 }
1821 return 0;
1822}
1823
drh43c4ac82018-02-26 21:26:27 +00001824/*
drh96acafb2018-02-27 14:49:25 +00001825** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001826** and 0 if it is FALSE.
1827*/
drh96acafb2018-02-27 14:49:25 +00001828int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001829 assert( pExpr->op==TK_TRUEFALSE );
1830 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1831 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1832 return pExpr->u.zToken[4]==0;
1833}
1834
drh171d16b2018-02-26 20:15:54 +00001835
1836/*
drh059b2d52014-10-24 19:28:09 +00001837** These routines are Walker callbacks used to check expressions to
1838** see if they are "constant" for some definition of constant. The
1839** Walker.eCode value determines the type of "constant" we are looking
1840** for.
drh73b211a2005-01-18 04:00:42 +00001841**
drh7d10d5a2008-08-20 16:35:10 +00001842** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001843**
drh059b2d52014-10-24 19:28:09 +00001844** sqlite3ExprIsConstant() pWalker->eCode==1
1845** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001846** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001847** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001848**
drh059b2d52014-10-24 19:28:09 +00001849** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1850** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001851**
drhfeada2d2014-09-24 13:20:22 +00001852** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001853** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1854** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001855** parameter raises an error for new statements, but is silently converted
1856** to NULL for existing schemas. This allows sqlite_master tables that
1857** contain a bound parameter because they were generated by older versions
1858** of SQLite to be parsed by newer versions of SQLite without raising a
1859** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001860*/
drh7d10d5a2008-08-20 16:35:10 +00001861static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001862
drh059b2d52014-10-24 19:28:09 +00001863 /* If pWalker->eCode is 2 then any term of the expression that comes from
1864 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001865 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001866 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1867 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001868 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001869 }
1870
drh626a8792005-01-17 22:08:19 +00001871 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001872 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001873 ** and either pWalker->eCode==4 or 5 or the function has the
1874 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001875 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001876 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001877 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001878 }else{
1879 pWalker->eCode = 0;
1880 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001881 }
drh626a8792005-01-17 22:08:19 +00001882 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001883 /* Convert "true" or "false" in a DEFAULT clause into the
1884 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001885 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001886 return WRC_Prune;
1887 }
1888 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001889 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001890 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001891 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001892 testcase( pExpr->op==TK_ID );
1893 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001894 testcase( pExpr->op==TK_AGG_FUNCTION );
1895 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001896 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001897 return WRC_Continue;
1898 }
drh059b2d52014-10-24 19:28:09 +00001899 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1900 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001901 }
drhf43ce0b2017-05-25 00:08:48 +00001902 /* Fall through */
1903 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001904 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001905 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001906 testcase( pExpr->op==TK_IF_NULL_ROW );
1907 pWalker->eCode = 0;
1908 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001909 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001910 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001911 /* Silently convert bound parameters that appear inside of CREATE
1912 ** statements into a NULL when parsing the CREATE statement text out
1913 ** of the sqlite_master table */
1914 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001915 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001916 /* A bound parameter in a CREATE statement that originates from
1917 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001918 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001919 return WRC_Abort;
1920 }
1921 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001922 default:
drh6e341b92018-04-17 18:50:40 +00001923 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1924 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001925 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001926 }
1927}
drh059b2d52014-10-24 19:28:09 +00001928static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001929 Walker w;
drh059b2d52014-10-24 19:28:09 +00001930 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001931 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001932 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001933#ifdef SQLITE_DEBUG
1934 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1935#endif
drh059b2d52014-10-24 19:28:09 +00001936 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001937 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001938 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001939}
drh626a8792005-01-17 22:08:19 +00001940
1941/*
drh059b2d52014-10-24 19:28:09 +00001942** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001943** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001944**
1945** For the purposes of this function, a double-quoted string (ex: "abc")
1946** is considered a variable but a single-quoted string (ex: 'abc') is
1947** a constant.
drhfef52082000-06-06 01:50:43 +00001948*/
danielk19774adee202004-05-08 08:23:19 +00001949int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001950 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001951}
1952
1953/*
drh07aded62018-07-28 16:24:08 +00001954** Walk an expression tree. Return non-zero if
1955**
1956** (1) the expression is constant, and
1957** (2) the expression does originate in the ON or USING clause
1958** of a LEFT JOIN, and
1959** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1960** operands created by the constant propagation optimization.
1961**
1962** When this routine returns true, it indicates that the expression
1963** can be added to the pParse->pConstExpr list and evaluated once when
1964** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001965*/
1966int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001967 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001968}
1969
1970/*
drhfcb9f4f2015-06-01 18:13:16 +00001971** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001972** for any single row of the table with cursor iCur. In other words, the
1973** expression must not refer to any non-deterministic function nor any
1974** table other than iCur.
1975*/
1976int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1977 return exprIsConst(p, 3, iCur);
1978}
1979
danab31a842017-04-29 20:53:09 +00001980
1981/*
1982** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1983*/
1984static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1985 ExprList *pGroupBy = pWalker->u.pGroupBy;
1986 int i;
1987
1988 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1989 ** it constant. */
1990 for(i=0; i<pGroupBy->nExpr; i++){
1991 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001992 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001993 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001994 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001995 return WRC_Prune;
1996 }
1997 }
1998 }
1999
2000 /* Check if pExpr is a sub-select. If so, consider it variable. */
2001 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2002 pWalker->eCode = 0;
2003 return WRC_Abort;
2004 }
2005
2006 return exprNodeIsConstant(pWalker, pExpr);
2007}
2008
2009/*
2010** Walk the expression tree passed as the first argument. Return non-zero
2011** if the expression consists entirely of constants or copies of terms
2012** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002013**
2014** This routine is used to determine if a term of the HAVING clause can
2015** be promoted into the WHERE clause. In order for such a promotion to work,
2016** the value of the HAVING clause term must be the same for all members of
2017** a "group". The requirement that the GROUP BY term must be BINARY
2018** assumes that no other collating sequence will have a finer-grained
2019** grouping than binary. In other words (A=B COLLATE binary) implies
2020** A=B in every other collating sequence. The requirement that the
2021** GROUP BY be BINARY is stricter than necessary. It would also work
2022** to promote HAVING clauses that use the same alternative collating
2023** sequence as the GROUP BY term, but that is much harder to check,
2024** alternative collating sequences are uncommon, and this is only an
2025** optimization, so we take the easy way out and simply require the
2026** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002027*/
2028int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2029 Walker w;
danab31a842017-04-29 20:53:09 +00002030 w.eCode = 1;
2031 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002032 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002033 w.u.pGroupBy = pGroupBy;
2034 w.pParse = pParse;
2035 sqlite3WalkExpr(&w, p);
2036 return w.eCode;
2037}
2038
drh059b2d52014-10-24 19:28:09 +00002039/*
2040** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002041** or a function call with constant arguments. Return and 0 if there
2042** are any variables.
2043**
2044** For the purposes of this function, a double-quoted string (ex: "abc")
2045** is considered a variable but a single-quoted string (ex: 'abc') is
2046** a constant.
2047*/
drhfeada2d2014-09-24 13:20:22 +00002048int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2049 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002050 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002051}
2052
drh5b88bc42013-12-07 23:35:21 +00002053#ifdef SQLITE_ENABLE_CURSOR_HINTS
2054/*
2055** Walk an expression tree. Return 1 if the expression contains a
2056** subquery of some kind. Return 0 if there are no subqueries.
2057*/
2058int sqlite3ExprContainsSubquery(Expr *p){
2059 Walker w;
drhbec24762015-08-13 20:07:13 +00002060 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002061 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002062 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002063#ifdef SQLITE_DEBUG
2064 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2065#endif
drh5b88bc42013-12-07 23:35:21 +00002066 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002067 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002068}
2069#endif
2070
drheb55bd22005-06-30 17:04:21 +00002071/*
drh73b211a2005-01-18 04:00:42 +00002072** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002073** to fit in a 32-bit integer, return 1 and put the value of the integer
2074** in *pValue. If the expression is not an integer or if it is too big
2075** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002076*/
danielk19774adee202004-05-08 08:23:19 +00002077int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002078 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002079 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002080
2081 /* If an expression is an integer literal that fits in a signed 32-bit
2082 ** integer, then the EP_IntValue flag will have already been set */
2083 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2084 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2085
drh92b01d52008-06-24 00:32:35 +00002086 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002087 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002088 return 1;
2089 }
drhe4de1fe2002-06-02 16:09:01 +00002090 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002091 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002092 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002093 break;
drh4b59ab52002-08-24 18:24:51 +00002094 }
drhe4de1fe2002-06-02 16:09:01 +00002095 case TK_UMINUS: {
2096 int v;
danielk19774adee202004-05-08 08:23:19 +00002097 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002098 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002099 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002100 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002101 }
2102 break;
2103 }
2104 default: break;
2105 }
drh92b01d52008-06-24 00:32:35 +00002106 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002107}
2108
2109/*
drh039fc322009-11-17 18:31:47 +00002110** Return FALSE if there is no chance that the expression can be NULL.
2111**
2112** If the expression might be NULL or if the expression is too complex
2113** to tell return TRUE.
2114**
2115** This routine is used as an optimization, to skip OP_IsNull opcodes
2116** when we know that a value cannot be NULL. Hence, a false positive
2117** (returning TRUE when in fact the expression can never be NULL) might
2118** be a small performance hit but is otherwise harmless. On the other
2119** hand, a false negative (returning FALSE when the result could be NULL)
2120** will likely result in an incorrect answer. So when in doubt, return
2121** TRUE.
2122*/
2123int sqlite3ExprCanBeNull(const Expr *p){
2124 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002125 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2126 p = p->pLeft;
2127 }
drh039fc322009-11-17 18:31:47 +00002128 op = p->op;
2129 if( op==TK_REGISTER ) op = p->op2;
2130 switch( op ){
2131 case TK_INTEGER:
2132 case TK_STRING:
2133 case TK_FLOAT:
2134 case TK_BLOB:
2135 return 0;
drh7248a8b2014-08-04 18:50:54 +00002136 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002137 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002138 p->y.pTab==0 || /* Reference to column of index on expression */
2139 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002140 default:
2141 return 1;
2142 }
2143}
2144
2145/*
2146** Return TRUE if the given expression is a constant which would be
2147** unchanged by OP_Affinity with the affinity given in the second
2148** argument.
2149**
2150** This routine is used to determine if the OP_Affinity operation
2151** can be omitted. When in doubt return FALSE. A false negative
2152** is harmless. A false positive, however, can result in the wrong
2153** answer.
2154*/
2155int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2156 u8 op;
drh05883a32015-06-02 15:32:08 +00002157 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002158 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002159 op = p->op;
2160 if( op==TK_REGISTER ) op = p->op2;
2161 switch( op ){
2162 case TK_INTEGER: {
2163 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2164 }
2165 case TK_FLOAT: {
2166 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2167 }
2168 case TK_STRING: {
2169 return aff==SQLITE_AFF_TEXT;
2170 }
2171 case TK_BLOB: {
2172 return 1;
2173 }
drh2f2855b2009-11-18 01:25:26 +00002174 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002175 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2176 return p->iColumn<0
2177 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002178 }
drh039fc322009-11-17 18:31:47 +00002179 default: {
2180 return 0;
2181 }
2182 }
2183}
2184
2185/*
drhc4a3c772001-04-04 11:48:57 +00002186** Return TRUE if the given string is a row-id column name.
2187*/
danielk19774adee202004-05-08 08:23:19 +00002188int sqlite3IsRowid(const char *z){
2189 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2190 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2191 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002192 return 0;
2193}
2194
danielk19779a96b662007-11-29 17:05:18 +00002195/*
drh69c355b2016-03-09 15:34:51 +00002196** pX is the RHS of an IN operator. If pX is a SELECT statement
2197** that can be simplified to a direct table access, then return
2198** a pointer to the SELECT statement. If pX is not a SELECT statement,
2199** or if the SELECT statement needs to be manifested into a transient
2200** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002201*/
2202#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002203static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002204 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002205 SrcList *pSrc;
2206 ExprList *pEList;
2207 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002208 int i;
drh69c355b2016-03-09 15:34:51 +00002209 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2210 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2211 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002212 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002213 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002214 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2215 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2216 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002217 }
drhb74b1012009-05-28 21:04:37 +00002218 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002219 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002220 if( p->pWhere ) return 0; /* Has no WHERE clause */
2221 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002222 assert( pSrc!=0 );
2223 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002224 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002225 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002226 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002227 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002228 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2229 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002230 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002231 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002232 for(i=0; i<pEList->nExpr; i++){
2233 Expr *pRes = pEList->a[i].pExpr;
2234 if( pRes->op!=TK_COLUMN ) return 0;
2235 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002236 }
drh69c355b2016-03-09 15:34:51 +00002237 return p;
drhb287f4b2008-04-25 00:08:38 +00002238}
2239#endif /* SQLITE_OMIT_SUBQUERY */
2240
danf9b2e052016-08-02 17:45:00 +00002241#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002242/*
drh4c259e92014-08-01 21:12:35 +00002243** Generate code that checks the left-most column of index table iCur to see if
2244** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002245** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2246** to be set to NULL if iCur contains one or more NULL values.
2247*/
2248static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002249 int addr1;
drh6be515e2014-08-01 21:00:53 +00002250 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002251 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002252 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2253 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002254 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002255 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002256}
danf9b2e052016-08-02 17:45:00 +00002257#endif
drh6be515e2014-08-01 21:00:53 +00002258
drhbb53ecb2014-08-02 21:03:33 +00002259
2260#ifndef SQLITE_OMIT_SUBQUERY
2261/*
2262** The argument is an IN operator with a list (not a subquery) on the
2263** right-hand side. Return TRUE if that list is constant.
2264*/
2265static int sqlite3InRhsIsConstant(Expr *pIn){
2266 Expr *pLHS;
2267 int res;
2268 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2269 pLHS = pIn->pLeft;
2270 pIn->pLeft = 0;
2271 res = sqlite3ExprIsConstant(pIn);
2272 pIn->pLeft = pLHS;
2273 return res;
2274}
2275#endif
2276
drh6be515e2014-08-01 21:00:53 +00002277/*
danielk19779a96b662007-11-29 17:05:18 +00002278** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002279** The pX parameter is the expression on the RHS of the IN operator, which
2280** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002281**
drhd4305ca2012-09-18 17:08:33 +00002282** The job of this routine is to find or create a b-tree object that can
2283** be used either to test for membership in the RHS set or to iterate through
2284** all members of the RHS set, skipping duplicates.
2285**
drh3a856252014-08-01 14:46:57 +00002286** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002287** and pX->iTable is set to the index of that cursor.
2288**
drhb74b1012009-05-28 21:04:37 +00002289** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002290**
drh1ccce442013-03-12 20:38:51 +00002291** IN_INDEX_ROWID - The cursor was opened on a database table.
2292** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2293** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2294** IN_INDEX_EPH - The cursor was opened on a specially created and
2295** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002296** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2297** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002298**
drhd4305ca2012-09-18 17:08:33 +00002299** An existing b-tree might be used if the RHS expression pX is a simple
2300** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002301**
dan553168c2016-08-01 20:14:31 +00002302** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002303**
drhd4305ca2012-09-18 17:08:33 +00002304** If the RHS of the IN operator is a list or a more complex subquery, then
2305** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002306** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002307** existing table.
drhd4305ca2012-09-18 17:08:33 +00002308**
drh7fc0ba02017-11-17 15:02:00 +00002309** The inFlags parameter must contain, at a minimum, one of the bits
2310** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2311** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2312** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2313** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002314**
2315** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2316** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002317** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002318** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2319** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002320**
drh3a856252014-08-01 14:46:57 +00002321** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2322** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002323** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2324** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002325**
drhbb53ecb2014-08-02 21:03:33 +00002326** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2327** if the RHS of the IN operator is a list (not a subquery) then this
2328** routine might decide that creating an ephemeral b-tree for membership
2329** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2330** calling routine should implement the IN operator using a sequence
2331** of Eq or Ne comparison operations.
2332**
drhb74b1012009-05-28 21:04:37 +00002333** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002334** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002335** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002336** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002337** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002338** to *prRhsHasNull. If there is no chance that the (...) contains a
2339** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002340**
drhe21a6e12014-08-01 18:00:24 +00002341** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002342** the value in that register will be NULL if the b-tree contains one or more
2343** NULL values, and it will be some non-NULL value if the b-tree contains no
2344** NULL values.
dan553168c2016-08-01 20:14:31 +00002345**
2346** If the aiMap parameter is not NULL, it must point to an array containing
2347** one element for each column returned by the SELECT statement on the RHS
2348** of the IN(...) operator. The i'th entry of the array is populated with the
2349** offset of the index column that matches the i'th column returned by the
2350** SELECT. For example, if the expression and selected index are:
2351**
2352** (?,?,?) IN (SELECT a, b, c FROM t1)
2353** CREATE INDEX i1 ON t1(b, c, a);
2354**
2355** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002356*/
danielk1977284f4ac2007-12-10 05:03:46 +00002357#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002358int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002359 Parse *pParse, /* Parsing context */
2360 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2361 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2362 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002363 int *aiMap, /* Mapping from Index fields to RHS fields */
2364 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002365){
drhb74b1012009-05-28 21:04:37 +00002366 Select *p; /* SELECT to the right of IN operator */
2367 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2368 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002369 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002370 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002371
drh1450bc62009-10-30 13:25:56 +00002372 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002373 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002374
dan7b35a772016-07-28 19:47:15 +00002375 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2376 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002377 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002378 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002379 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002380 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2381 int i;
2382 ExprList *pEList = pX->x.pSelect->pEList;
2383 for(i=0; i<pEList->nExpr; i++){
2384 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2385 }
2386 if( i==pEList->nExpr ){
2387 prRhsHasNull = 0;
2388 }
2389 }
2390
drhb74b1012009-05-28 21:04:37 +00002391 /* Check to see if an existing table or index can be used to
2392 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002393 ** ephemeral table. */
2394 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002395 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002396 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002397 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002398 ExprList *pEList = p->pEList;
2399 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002400
drhb07028f2011-10-14 21:49:18 +00002401 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2402 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2403 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2404 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002405
drhb22f7c82014-02-06 23:56:27 +00002406 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002407 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2408 sqlite3CodeVerifySchema(pParse, iDb);
2409 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002410
drha84a2832016-08-26 21:15:35 +00002411 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002412 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002413 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002414 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002415 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002416
2417 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2418 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002419 ExplainQueryPlan((pParse, 0,
2420 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002421 sqlite3VdbeJumpHere(v, iAddr);
2422 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002423 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002424 int affinity_ok = 1;
2425 int i;
2426
2427 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002428 ** comparison is the same as the affinity of each column in table
2429 ** on the RHS of the IN operator. If it not, it is not possible to
2430 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002431 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002432 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002433 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002434 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002435 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002436 testcase( cmpaff==SQLITE_AFF_BLOB );
2437 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002438 switch( cmpaff ){
2439 case SQLITE_AFF_BLOB:
2440 break;
2441 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002442 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2443 ** other has no affinity and the other side is TEXT. Hence,
2444 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2445 ** and for the term on the LHS of the IN to have no affinity. */
2446 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002447 break;
2448 default:
2449 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2450 }
2451 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002452
drha84a2832016-08-26 21:15:35 +00002453 if( affinity_ok ){
2454 /* Search for an existing index that will work for this IN operator */
2455 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2456 Bitmask colUsed; /* Columns of the index used */
2457 Bitmask mCol; /* Mask for the current column */
2458 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002459 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002460 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2461 ** BITMASK(nExpr) without overflowing */
2462 testcase( pIdx->nColumn==BMS-2 );
2463 testcase( pIdx->nColumn==BMS-1 );
2464 if( pIdx->nColumn>=BMS-1 ) continue;
2465 if( mustBeUnique ){
2466 if( pIdx->nKeyCol>nExpr
2467 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2468 ){
2469 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002470 }
danielk19770cdc0222008-06-26 18:04:03 +00002471 }
drha84a2832016-08-26 21:15:35 +00002472
2473 colUsed = 0; /* Columns of index used so far */
2474 for(i=0; i<nExpr; i++){
2475 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2476 Expr *pRhs = pEList->a[i].pExpr;
2477 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2478 int j;
2479
2480 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2481 for(j=0; j<nExpr; j++){
2482 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2483 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002484 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2485 continue;
2486 }
drha84a2832016-08-26 21:15:35 +00002487 break;
2488 }
2489 if( j==nExpr ) break;
2490 mCol = MASKBIT(j);
2491 if( mCol & colUsed ) break; /* Each column used only once */
2492 colUsed |= mCol;
2493 if( aiMap ) aiMap[i] = j;
2494 }
2495
2496 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2497 if( colUsed==(MASKBIT(nExpr)-1) ){
2498 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002499 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002500 ExplainQueryPlan((pParse, 0,
2501 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002502 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2503 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2504 VdbeComment((v, "%s", pIdx->zName));
2505 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2506 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2507
2508 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002509#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002510 i64 mask = (1<<nExpr)-1;
2511 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2512 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002513#endif
2514 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002515 if( nExpr==1 ){
2516 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2517 }
2518 }
2519 sqlite3VdbeJumpHere(v, iAddr);
2520 }
2521 } /* End loop over indexes */
2522 } /* End if( affinity_ok ) */
2523 } /* End if not an rowid index */
2524 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002525
drhbb53ecb2014-08-02 21:03:33 +00002526 /* If no preexisting index is available for the IN clause
2527 ** and IN_INDEX_NOOP is an allowed reply
2528 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002529 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002530 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002531 ** the IN operator so return IN_INDEX_NOOP.
2532 */
2533 if( eType==0
2534 && (inFlags & IN_INDEX_NOOP_OK)
2535 && !ExprHasProperty(pX, EP_xIsSelect)
2536 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2537 ){
2538 eType = IN_INDEX_NOOP;
2539 }
drhbb53ecb2014-08-02 21:03:33 +00002540
danielk19779a96b662007-11-29 17:05:18 +00002541 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002542 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002543 ** We will have to generate an ephemeral table to do the job.
2544 */
drh8e23daf2013-06-11 13:30:04 +00002545 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002546 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002547 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002548 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002549 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00002550 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00002551 eType = IN_INDEX_ROWID;
2552 }
drhe21a6e12014-08-01 18:00:24 +00002553 }else if( prRhsHasNull ){
2554 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002555 }
drh85bcdce2018-12-23 21:27:29 +00002556 assert( pX->op==TK_IN );
drh2c041312018-12-24 02:34:49 +00002557 sqlite3CodeRhsOfIN(pParse, pX, iTab, eType==IN_INDEX_ROWID);
drh85bcdce2018-12-23 21:27:29 +00002558 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002559 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002560 }
drhcf4d38a2010-07-28 02:53:36 +00002561 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002562 }
danba00e302016-07-23 20:24:06 +00002563
2564 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2565 int i, n;
2566 n = sqlite3ExprVectorSize(pX->pLeft);
2567 for(i=0; i<n; i++) aiMap[i] = i;
2568 }
drh2c041312018-12-24 02:34:49 +00002569 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002570 return eType;
2571}
danielk1977284f4ac2007-12-10 05:03:46 +00002572#endif
drh626a8792005-01-17 22:08:19 +00002573
danf9b2e052016-08-02 17:45:00 +00002574#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002575/*
2576** Argument pExpr is an (?, ?...) IN(...) expression. This
2577** function allocates and returns a nul-terminated string containing
2578** the affinities to be used for each column of the comparison.
2579**
2580** It is the responsibility of the caller to ensure that the returned
2581** string is eventually freed using sqlite3DbFree().
2582*/
dan71c57db2016-07-09 20:23:55 +00002583static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2584 Expr *pLeft = pExpr->pLeft;
2585 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002586 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002587 char *zRet;
2588
dan553168c2016-08-01 20:14:31 +00002589 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002590 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002591 if( zRet ){
2592 int i;
2593 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002594 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002595 char a = sqlite3ExprAffinity(pA);
2596 if( pSelect ){
2597 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2598 }else{
2599 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002600 }
dan71c57db2016-07-09 20:23:55 +00002601 }
2602 zRet[nVal] = '\0';
2603 }
2604 return zRet;
2605}
danf9b2e052016-08-02 17:45:00 +00002606#endif
dan71c57db2016-07-09 20:23:55 +00002607
dan8da209b2016-07-26 18:06:08 +00002608#ifndef SQLITE_OMIT_SUBQUERY
2609/*
2610** Load the Parse object passed as the first argument with an error
2611** message of the form:
2612**
2613** "sub-select returns N columns - expected M"
2614*/
2615void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2616 const char *zFmt = "sub-select returns %d columns - expected %d";
2617 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2618}
2619#endif
2620
drh626a8792005-01-17 22:08:19 +00002621/*
dan44c56042016-12-07 15:38:37 +00002622** Expression pExpr is a vector that has been used in a context where
2623** it is not permitted. If pExpr is a sub-select vector, this routine
2624** loads the Parse object with a message of the form:
2625**
2626** "sub-select returns N columns - expected 1"
2627**
2628** Or, if it is a regular scalar vector:
2629**
2630** "row value misused"
2631*/
2632void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2633#ifndef SQLITE_OMIT_SUBQUERY
2634 if( pExpr->flags & EP_xIsSelect ){
2635 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2636 }else
2637#endif
2638 {
2639 sqlite3ErrorMsg(pParse, "row value misused");
2640 }
2641}
2642
drh85bcdce2018-12-23 21:27:29 +00002643#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002644/*
drh85bcdce2018-12-23 21:27:29 +00002645** Generate code that will construct an ephemeral table containing all terms
2646** in the RHS of an IN operator. The IN operator can be in either of two
2647** forms:
drh626a8792005-01-17 22:08:19 +00002648**
drh9cbe6352005-11-29 03:13:21 +00002649** x IN (4,5,11) -- IN operator with list on right-hand side
2650** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002651**
drh2c041312018-12-24 02:34:49 +00002652** The pExpr parameter is the IN operator. The cursor number for the
2653** constructed ephermeral table is returned. The first time the ephemeral
2654** table is computed, the cursor number is also stored in pExpr->iTable,
2655** however the cursor number returned might not be the same, as it might
2656** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002657**
drh85bcdce2018-12-23 21:27:29 +00002658** If parameter isRowid is non-zero, then LHS of the IN operator is guaranteed
2659** to be a non-null integer. In this case, the ephemeral table can be an
2660** table B-Tree that keyed by only integers. The more general cases uses
2661** an index B-Tree which can have arbitrary keys, but is slower to both
2662** read and write.
drhfd773cf2009-05-29 14:39:07 +00002663**
drh85bcdce2018-12-23 21:27:29 +00002664** If the LHS expression ("x" in the examples) is a column value, or
2665** the SELECT statement returns a column value, then the affinity of that
2666** column is used to build the index keys. If both 'x' and the
2667** SELECT... statement are columns, then numeric affinity is used
2668** if either column has NUMERIC or INTEGER affinity. If neither
2669** 'x' nor the SELECT... statement are columns, then numeric affinity
2670** is used.
drhcce7d172000-05-31 15:34:51 +00002671*/
drh85bcdce2018-12-23 21:27:29 +00002672void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002673 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002674 Expr *pExpr, /* The IN operator */
drh2c041312018-12-24 02:34:49 +00002675 int iTab, /* Use this cursor number */
drh85bcdce2018-12-23 21:27:29 +00002676 int isRowid /* If true, LHS is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00002677){
drh2c041312018-12-24 02:34:49 +00002678 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002679 int addr; /* Address of OP_OpenEphemeral instruction */
2680 Expr *pLeft; /* the LHS of the IN operator */
2681 KeyInfo *pKeyInfo = 0; /* Key information */
2682 int nVal; /* Size of vector pLeft */
2683 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002684
drh2c041312018-12-24 02:34:49 +00002685 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002686 assert( v!=0 );
2687
drh2c041312018-12-24 02:34:49 +00002688 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002689 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002690 **
2691 ** * The right-hand side is a correlated subquery
2692 ** * The right-hand side is an expression list containing variables
2693 ** * We are inside a trigger
2694 **
drh2c041312018-12-24 02:34:49 +00002695 ** If all of the above are false, then we can compute the RHS just once
2696 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002697 */
drhefb699f2018-12-24 11:55:44 +00002698 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002699 /* Reuse of the RHS is allowed */
2700 /* If this routine has already been coded, but the previous code
2701 ** might not have been invoked yet, so invoke it now as a subroutine.
2702 */
2703 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002704 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002705 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2706 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2707 pExpr->x.pSelect->selId));
2708 }
drh2c041312018-12-24 02:34:49 +00002709 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2710 pExpr->y.sub.iAddr);
2711 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002712 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002713 return;
2714 }
2715
2716 /* Begin coding the subroutine */
2717 ExprSetProperty(pExpr, EP_Subrtn);
2718 pExpr->y.sub.regReturn = ++pParse->nMem;
2719 pExpr->y.sub.iAddr =
2720 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2721 VdbeComment((v, "return address"));
2722
2723 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002724 }
2725
drh85bcdce2018-12-23 21:27:29 +00002726 /* Check to see if this is a vector IN operator */
2727 pLeft = pExpr->pLeft;
2728 nVal = sqlite3ExprVectorSize(pLeft);
2729 assert( !isRowid || nVal==1 );
danielk1977e014a832004-05-17 10:48:57 +00002730
drh85bcdce2018-12-23 21:27:29 +00002731 /* Construct the ephemeral table that will contain the content of
2732 ** RHS of the IN operator.
2733 */
drh2c041312018-12-24 02:34:49 +00002734 pExpr->iTable = iTab;
drh85bcdce2018-12-23 21:27:29 +00002735 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
2736 pExpr->iTable, (isRowid?0:nVal));
drh2c041312018-12-24 02:34:49 +00002737#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2738 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2739 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2740 }else{
2741 VdbeComment((v, "RHS of IN operator"));
2742 }
2743#endif
drh85bcdce2018-12-23 21:27:29 +00002744 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002745
drh85bcdce2018-12-23 21:27:29 +00002746 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2747 /* Case 1: expr IN (SELECT ...)
2748 **
2749 ** Generate code to write the results of the select into the temporary
2750 ** table allocated and opened above.
2751 */
2752 Select *pSelect = pExpr->x.pSelect;
2753 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002754
drh2c041312018-12-24 02:34:49 +00002755 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2756 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002757 ));
2758 assert( !isRowid );
2759 /* If the LHS and RHS of the IN operator do not match, that
2760 ** error will have been caught long before we reach this point. */
2761 if( ALWAYS(pEList->nExpr==nVal) ){
2762 SelectDest dest;
2763 int i;
drhbd462bc2018-12-24 20:21:06 +00002764 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002765 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2766 pSelect->iLimit = 0;
2767 testcase( pSelect->selFlags & SF_Distinct );
2768 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2769 if( sqlite3Select(pParse, pSelect, &dest) ){
2770 sqlite3DbFree(pParse->db, dest.zAffSdst);
2771 sqlite3KeyInfoUnref(pKeyInfo);
2772 return;
drhfef52082000-06-06 01:50:43 +00002773 }
drh85bcdce2018-12-23 21:27:29 +00002774 sqlite3DbFree(pParse->db, dest.zAffSdst);
2775 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2776 assert( pEList!=0 );
2777 assert( pEList->nExpr>0 );
2778 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2779 for(i=0; i<nVal; i++){
2780 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2781 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2782 pParse, p, pEList->a[i].pExpr
2783 );
danielk197741a05b72008-10-02 13:50:55 +00002784 }
drh85bcdce2018-12-23 21:27:29 +00002785 }
2786 }else if( ALWAYS(pExpr->x.pList!=0) ){
2787 /* Case 2: expr IN (exprlist)
2788 **
2789 ** For each expression, build an index key from the evaluation and
2790 ** store it in the temporary table. If <expr> is a column, then use
2791 ** that columns affinity when building index keys. If <expr> is not
2792 ** a column, use numeric affinity.
2793 */
2794 char affinity; /* Affinity of the LHS of the IN */
2795 int i;
2796 ExprList *pList = pExpr->x.pList;
2797 struct ExprList_item *pItem;
2798 int r1, r2, r3;
2799 affinity = sqlite3ExprAffinity(pLeft);
2800 if( !affinity ){
2801 affinity = SQLITE_AFF_BLOB;
2802 }
2803 if( pKeyInfo ){
2804 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2805 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002806 }
2807
drh85bcdce2018-12-23 21:27:29 +00002808 /* Loop through each expression in <exprlist>. */
2809 r1 = sqlite3GetTempReg(pParse);
2810 r2 = sqlite3GetTempReg(pParse);
2811 if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
2812 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2813 Expr *pE2 = pItem->pExpr;
2814 int iValToIns;
2815
2816 /* If the expression is not constant then we will need to
2817 ** disable the test that was generated above that makes sure
2818 ** this code only executes once. Because for a non-constant
2819 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002820 */
drh2c041312018-12-24 02:34:49 +00002821 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2822 sqlite3VdbeChangeToNoop(v, addrOnce);
2823 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002824 }
drh1398ad32005-01-19 23:24:50 +00002825
drh85bcdce2018-12-23 21:27:29 +00002826 /* Evaluate the expression and insert it into the temp table */
2827 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
drhbd462bc2018-12-24 20:21:06 +00002828 sqlite3VdbeAddOp3(v, OP_InsertInt, iTab, r2, iValToIns);
drh51522cd2005-01-20 13:36:19 +00002829 }else{
drh85bcdce2018-12-23 21:27:29 +00002830 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2831 if( isRowid ){
2832 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2833 sqlite3VdbeCurrentAddr(v)+2);
2834 VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002835 sqlite3VdbeAddOp3(v, OP_Insert, iTab, r2, r3);
drh85bcdce2018-12-23 21:27:29 +00002836 }else{
2837 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
drhbd462bc2018-12-24 20:21:06 +00002838 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drh85bcdce2018-12-23 21:27:29 +00002839 }
drh51522cd2005-01-20 13:36:19 +00002840 }
drhcce7d172000-05-31 15:34:51 +00002841 }
drh85bcdce2018-12-23 21:27:29 +00002842 sqlite3ReleaseTempReg(pParse, r1);
2843 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002844 }
drh85bcdce2018-12-23 21:27:29 +00002845 if( pKeyInfo ){
2846 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2847 }
drh2c041312018-12-24 02:34:49 +00002848 if( addrOnce ){
2849 sqlite3VdbeJumpHere(v, addrOnce);
2850 /* Subroutine return */
2851 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2852 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002853 }
2854}
2855#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002856
drh85bcdce2018-12-23 21:27:29 +00002857/*
2858** Generate code for scalar subqueries used as a subquery expression
2859** or EXISTS operator:
2860**
2861** (SELECT a FROM b) -- subquery
2862** EXISTS (SELECT a FROM b) -- EXISTS subquery
2863**
2864** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2865**
2866** The register that holds the result. For a multi-column SELECT,
2867** the result is stored in a contiguous array of registers and the
2868** return value is the register of the left-most result column.
2869** Return 0 if an error occurs.
2870*/
2871#ifndef SQLITE_OMIT_SUBQUERY
2872int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002873 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002874 int rReg = 0; /* Register storing resulting */
2875 Select *pSel; /* SELECT statement to encode */
2876 SelectDest dest; /* How to deal with SELECT result */
2877 int nReg; /* Registers to allocate */
2878 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002879
2880 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002881 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002882 testcase( pExpr->op==TK_EXISTS );
2883 testcase( pExpr->op==TK_SELECT );
2884 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2885 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2886 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002887
drh5198ff52018-12-24 12:09:47 +00002888 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002889 ** is encountered if any of the following is true:
2890 **
2891 ** * The right-hand side is a correlated subquery
2892 ** * The right-hand side is an expression list containing variables
2893 ** * We are inside a trigger
2894 **
2895 ** If all of the above are false, then we can run this code just once
2896 ** save the results, and reuse the same result on subsequent invocations.
2897 */
2898 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002899 /* If this routine has already been coded, then invoke it as a
2900 ** subroutine. */
2901 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002902 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002903 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2904 pExpr->y.sub.iAddr);
2905 return pExpr->iTable;
2906 }
2907
2908 /* Begin coding the subroutine */
2909 ExprSetProperty(pExpr, EP_Subrtn);
2910 pExpr->y.sub.regReturn = ++pParse->nMem;
2911 pExpr->y.sub.iAddr =
2912 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2913 VdbeComment((v, "return address"));
2914
drh2c041312018-12-24 02:34:49 +00002915 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002916 }
drh85bcdce2018-12-23 21:27:29 +00002917
2918 /* For a SELECT, generate code to put the values for all columns of
2919 ** the first row into an array of registers and return the index of
2920 ** the first register.
2921 **
2922 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2923 ** into a register and return that register number.
2924 **
2925 ** In both cases, the query is augmented with "LIMIT 1". Any
2926 ** preexisting limit is discarded in place of the new LIMIT 1.
2927 */
drhbd462bc2018-12-24 20:21:06 +00002928 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2929 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002930 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2931 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2932 pParse->nMem += nReg;
2933 if( pExpr->op==TK_SELECT ){
2934 dest.eDest = SRT_Mem;
2935 dest.iSdst = dest.iSDParm;
2936 dest.nSdst = nReg;
2937 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2938 VdbeComment((v, "Init subquery result"));
2939 }else{
2940 dest.eDest = SRT_Exists;
2941 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2942 VdbeComment((v, "Init EXISTS result"));
2943 }
2944 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2945 if( pSel->pLimit ){
2946 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2947 pSel->pLimit->pLeft = pLimit;
2948 }else{
2949 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2950 }
2951 pSel->iLimit = 0;
2952 if( sqlite3Select(pParse, pSel, &dest) ){
2953 return 0;
2954 }
drh2c041312018-12-24 02:34:49 +00002955 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002956 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002957 if( addrOnce ){
2958 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002959
drh5198ff52018-12-24 12:09:47 +00002960 /* Subroutine return */
2961 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2962 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2963 }
drh2c041312018-12-24 02:34:49 +00002964
drh1450bc62009-10-30 13:25:56 +00002965 return rReg;
drhcce7d172000-05-31 15:34:51 +00002966}
drh51522cd2005-01-20 13:36:19 +00002967#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002968
drhe3365e62009-11-12 17:52:24 +00002969#ifndef SQLITE_OMIT_SUBQUERY
2970/*
dan7b35a772016-07-28 19:47:15 +00002971** Expr pIn is an IN(...) expression. This function checks that the
2972** sub-select on the RHS of the IN() operator has the same number of
2973** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2974** a sub-query, that the LHS is a vector of size 1.
2975*/
2976int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2977 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2978 if( (pIn->flags & EP_xIsSelect) ){
2979 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2980 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2981 return 1;
2982 }
2983 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002984 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002985 return 1;
2986 }
2987 return 0;
2988}
2989#endif
2990
2991#ifndef SQLITE_OMIT_SUBQUERY
2992/*
drhe3365e62009-11-12 17:52:24 +00002993** Generate code for an IN expression.
2994**
2995** x IN (SELECT ...)
2996** x IN (value, value, ...)
2997**
drhecb87ac2016-08-25 15:46:25 +00002998** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002999** right-hand side (RHS) is an array of zero or more scalar values, or a
3000** subquery. If the RHS is a subquery, the number of result columns must
3001** match the number of columns in the vector on the LHS. If the RHS is
3002** a list of values, the LHS must be a scalar.
3003**
3004** The IN operator is true if the LHS value is contained within the RHS.
3005** The result is false if the LHS is definitely not in the RHS. The
3006** result is NULL if the presence of the LHS in the RHS cannot be
3007** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003008**
drh6be515e2014-08-01 21:00:53 +00003009** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003010** contained within the RHS. If due to NULLs we cannot determine if the LHS
3011** is contained in the RHS then jump to destIfNull. If the LHS is contained
3012** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003013**
3014** See the separate in-operator.md documentation file in the canonical
3015** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003016*/
3017static void sqlite3ExprCodeIN(
3018 Parse *pParse, /* Parsing and code generating context */
3019 Expr *pExpr, /* The IN expression */
3020 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3021 int destIfNull /* Jump here if the results are unknown due to NULLs */
3022){
3023 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003024 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003025 int rLhs; /* Register(s) holding the LHS values */
3026 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003027 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003028 int *aiMap = 0; /* Map from vector field to index column */
3029 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003030 int nVector; /* Size of vectors for this IN operator */
3031 int iDummy; /* Dummy parameter to exprCodeVector() */
3032 Expr *pLeft; /* The LHS of the IN operator */
3033 int i; /* loop counter */
3034 int destStep2; /* Where to jump when NULLs seen in step 2 */
3035 int destStep6 = 0; /* Start of code for Step 6 */
3036 int addrTruthOp; /* Address of opcode that determines the IN is true */
3037 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3038 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003039 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003040
drhe347d3e2016-08-25 21:14:34 +00003041 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003042 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003043 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003044 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3045 aiMap = (int*)sqlite3DbMallocZero(
3046 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3047 );
drhe347d3e2016-08-25 21:14:34 +00003048 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003049
danba00e302016-07-23 20:24:06 +00003050 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003051 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003052 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3053 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003054 v = pParse->pVdbe;
3055 assert( v!=0 ); /* OOM detected prior to this routine */
3056 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003057 eType = sqlite3FindInIndex(pParse, pExpr,
3058 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003059 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3060 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003061
danba00e302016-07-23 20:24:06 +00003062 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3063 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3064 );
drhecb87ac2016-08-25 15:46:25 +00003065#ifdef SQLITE_DEBUG
3066 /* Confirm that aiMap[] contains nVector integer values between 0 and
3067 ** nVector-1. */
3068 for(i=0; i<nVector; i++){
3069 int j, cnt;
3070 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3071 assert( cnt==1 );
3072 }
3073#endif
drhe3365e62009-11-12 17:52:24 +00003074
danba00e302016-07-23 20:24:06 +00003075 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3076 ** vector, then it is stored in an array of nVector registers starting
3077 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003078 **
3079 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3080 ** so that the fields are in the same order as an existing index. The
3081 ** aiMap[] array contains a mapping from the original LHS field order to
3082 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003083 */
drhe347d3e2016-08-25 21:14:34 +00003084 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3085 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003086 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003087 /* LHS fields are not reordered */
3088 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003089 }else{
3090 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003091 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003092 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003093 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003094 }
danba00e302016-07-23 20:24:06 +00003095 }
drhe3365e62009-11-12 17:52:24 +00003096
drhbb53ecb2014-08-02 21:03:33 +00003097 /* If sqlite3FindInIndex() did not find or create an index that is
3098 ** suitable for evaluating the IN operator, then evaluate using a
3099 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003100 **
3101 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003102 */
drhbb53ecb2014-08-02 21:03:33 +00003103 if( eType==IN_INDEX_NOOP ){
3104 ExprList *pList = pExpr->x.pList;
3105 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003106 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003107 int r2, regToFree;
3108 int regCkNull = 0;
3109 int ii;
3110 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003111 if( destIfNull!=destIfFalse ){
3112 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003113 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003114 }
3115 for(ii=0; ii<pList->nExpr; ii++){
3116 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003117 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003118 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3119 }
3120 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003121 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003122 (void*)pColl, P4_COLLSEQ);
3123 VdbeCoverageIf(v, ii<pList->nExpr-1);
3124 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003125 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003126 }else{
3127 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003128 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003129 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003130 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003131 }
3132 sqlite3ReleaseTempReg(pParse, regToFree);
3133 }
3134 if( regCkNull ){
3135 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003136 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003137 }
3138 sqlite3VdbeResolveLabel(v, labelOk);
3139 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003140 goto sqlite3ExprCodeIN_finished;
3141 }
3142
3143 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3144 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3145 ** We will then skip the binary search of the RHS.
3146 */
3147 if( destIfNull==destIfFalse ){
3148 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003149 }else{
drhec4ccdb2018-12-29 02:26:59 +00003150 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003151 }
3152 for(i=0; i<nVector; i++){
3153 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3154 if( sqlite3ExprCanBeNull(p) ){
3155 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003156 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003157 }
drhe3365e62009-11-12 17:52:24 +00003158 }
drhe347d3e2016-08-25 21:14:34 +00003159
3160 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3161 ** of the RHS using the LHS as a probe. If found, the result is
3162 ** true.
3163 */
3164 if( eType==IN_INDEX_ROWID ){
3165 /* In this case, the RHS is the ROWID of table b-tree and so we also
3166 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3167 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003168 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003169 VdbeCoverage(v);
3170 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3171 }else{
3172 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3173 if( destIfFalse==destIfNull ){
3174 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003175 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003176 rLhs, nVector); VdbeCoverage(v);
3177 goto sqlite3ExprCodeIN_finished;
3178 }
3179 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003180 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003181 rLhs, nVector); VdbeCoverage(v);
3182 }
3183
3184 /* Step 4. If the RHS is known to be non-NULL and we did not find
3185 ** an match on the search above, then the result must be FALSE.
3186 */
3187 if( rRhsHasNull && nVector==1 ){
3188 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3189 VdbeCoverage(v);
3190 }
3191
3192 /* Step 5. If we do not care about the difference between NULL and
3193 ** FALSE, then just return false.
3194 */
3195 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3196
3197 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3198 ** If any comparison is NULL, then the result is NULL. If all
3199 ** comparisons are FALSE then the final result is FALSE.
3200 **
3201 ** For a scalar LHS, it is sufficient to check just the first row
3202 ** of the RHS.
3203 */
3204 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003205 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003206 VdbeCoverage(v);
3207 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003208 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003209 }else{
3210 /* For nVector==1, combine steps 6 and 7 by immediately returning
3211 ** FALSE if the first comparison is not NULL */
3212 destNotNull = destIfFalse;
3213 }
3214 for(i=0; i<nVector; i++){
3215 Expr *p;
3216 CollSeq *pColl;
3217 int r3 = sqlite3GetTempReg(pParse);
3218 p = sqlite3VectorFieldSubexpr(pLeft, i);
3219 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003220 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003221 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3222 (void*)pColl, P4_COLLSEQ);
3223 VdbeCoverage(v);
3224 sqlite3ReleaseTempReg(pParse, r3);
3225 }
3226 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3227 if( nVector>1 ){
3228 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003229 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003230 VdbeCoverage(v);
3231
3232 /* Step 7: If we reach this point, we know that the result must
3233 ** be false. */
3234 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3235 }
3236
3237 /* Jumps here in order to return true. */
3238 sqlite3VdbeJumpHere(v, addrTruthOp);
3239
3240sqlite3ExprCodeIN_finished:
3241 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003242 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003243sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003244 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003245 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003246}
3247#endif /* SQLITE_OMIT_SUBQUERY */
3248
drh13573c72010-01-12 17:04:07 +00003249#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003250/*
3251** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003252** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003253**
3254** The z[] string will probably not be zero-terminated. But the
3255** z[n] character is guaranteed to be something that does not look
3256** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003257*/
drhb7916a72009-05-27 10:31:29 +00003258static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003259 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003260 double value;
drh9339da12010-09-30 00:50:49 +00003261 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003262 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3263 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003264 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003265 }
3266}
drh13573c72010-01-12 17:04:07 +00003267#endif
drh598f1342007-10-23 15:39:45 +00003268
3269
3270/*
drhfec19aa2004-05-19 20:41:03 +00003271** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003272** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003273**
shaneh5f1d6b62010-09-30 16:51:25 +00003274** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003275*/
drh13573c72010-01-12 17:04:07 +00003276static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3277 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003278 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003279 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003280 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003281 if( negFlag ) i = -i;
3282 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003283 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003284 int c;
3285 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003286 const char *z = pExpr->u.zToken;
3287 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003288 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003289 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003290#ifdef SQLITE_OMIT_FLOATING_POINT
3291 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3292#else
drh1b7ddc52014-07-23 14:52:05 +00003293#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003294 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003295 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003296 }else
3297#endif
3298 {
drh9296c182014-07-23 13:40:49 +00003299 codeReal(v, z, negFlag, iMem);
3300 }
drh13573c72010-01-12 17:04:07 +00003301#endif
drh77320ea2016-11-30 14:47:37 +00003302 }else{
drh84d4f1a2017-09-20 10:47:10 +00003303 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003304 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003305 }
drhfec19aa2004-05-19 20:41:03 +00003306 }
3307}
3308
drh5cd79232009-05-25 11:46:29 +00003309
drh1f9ca2c2015-08-25 16:57:52 +00003310/* Generate code that will load into register regOut a value that is
3311** appropriate for the iIdxCol-th column of index pIdx.
3312*/
3313void sqlite3ExprCodeLoadIndexColumn(
3314 Parse *pParse, /* The parsing context */
3315 Index *pIdx, /* The index whose column is to be loaded */
3316 int iTabCur, /* Cursor pointing to a table row */
3317 int iIdxCol, /* The column of the index to be loaded */
3318 int regOut /* Store the index column value in this register */
3319){
3320 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003321 if( iTabCol==XN_EXPR ){
3322 assert( pIdx->aColExpr );
3323 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003324 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003325 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003326 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003327 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003328 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3329 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003330 }
drh1f9ca2c2015-08-25 16:57:52 +00003331}
3332
drh5cd79232009-05-25 11:46:29 +00003333/*
drh5c092e82010-05-14 19:24:02 +00003334** Generate code to extract the value of the iCol-th column of a table.
3335*/
3336void sqlite3ExprCodeGetColumnOfTable(
3337 Vdbe *v, /* The VDBE under construction */
3338 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003339 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003340 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003341 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003342){
drhaca19e12017-04-07 19:41:31 +00003343 if( pTab==0 ){
3344 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3345 return;
3346 }
drh5c092e82010-05-14 19:24:02 +00003347 if( iCol<0 || iCol==pTab->iPKey ){
3348 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3349 }else{
3350 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003351 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003352 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003353 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3354 }
3355 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003356 }
3357 if( iCol>=0 ){
3358 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3359 }
3360}
3361
3362/*
drh945498f2007-02-24 11:52:52 +00003363** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003364** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003365**
3366** There must be an open cursor to pTab in iTable when this routine
3367** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003368*/
drhe55cbd72008-03-31 23:48:03 +00003369int sqlite3ExprCodeGetColumn(
3370 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003371 Table *pTab, /* Description of the table we are reading from */
3372 int iColumn, /* Index of the table column */
3373 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003374 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003375 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003376){
drhe55cbd72008-03-31 23:48:03 +00003377 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003378 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003379 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003380 if( p5 ){
3381 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003382 }
drhe55cbd72008-03-31 23:48:03 +00003383 return iReg;
3384}
drhe55cbd72008-03-31 23:48:03 +00003385
3386/*
drhb21e7c72008-06-22 12:37:57 +00003387** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003388** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003389*/
drhb21e7c72008-06-22 12:37:57 +00003390void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003391 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003392 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003393}
3394
drh652fbf52008-04-01 01:42:41 +00003395/*
drh12abf402016-08-22 14:30:05 +00003396** Convert a scalar expression node to a TK_REGISTER referencing
3397** register iReg. The caller must ensure that iReg already contains
3398** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003399*/
3400static void exprToRegister(Expr *p, int iReg){
3401 p->op2 = p->op;
3402 p->op = TK_REGISTER;
3403 p->iTable = iReg;
3404 ExprClearProperty(p, EP_Skip);
3405}
3406
drh12abf402016-08-22 14:30:05 +00003407/*
3408** Evaluate an expression (either a vector or a scalar expression) and store
3409** the result in continguous temporary registers. Return the index of
3410** the first register used to store the result.
3411**
3412** If the returned result register is a temporary scalar, then also write
3413** that register number into *piFreeable. If the returned result register
3414** is not a temporary or if the expression is a vector set *piFreeable
3415** to 0.
3416*/
3417static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3418 int iResult;
3419 int nResult = sqlite3ExprVectorSize(p);
3420 if( nResult==1 ){
3421 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3422 }else{
3423 *piFreeable = 0;
3424 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003425#if SQLITE_OMIT_SUBQUERY
3426 iResult = 0;
3427#else
drh85bcdce2018-12-23 21:27:29 +00003428 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003429#endif
drh12abf402016-08-22 14:30:05 +00003430 }else{
3431 int i;
3432 iResult = pParse->nMem+1;
3433 pParse->nMem += nResult;
3434 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003435 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003436 }
3437 }
3438 }
3439 return iResult;
3440}
3441
dan71c57db2016-07-09 20:23:55 +00003442
drha4c3c872013-09-12 17:29:25 +00003443/*
drhcce7d172000-05-31 15:34:51 +00003444** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003445** expression. Attempt to store the results in register "target".
3446** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003447**
drh8b213892008-08-29 02:14:02 +00003448** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003449** be stored in target. The result might be stored in some other
3450** register if it is convenient to do so. The calling function
3451** must check the return code and move the results to the desired
3452** register.
drhcce7d172000-05-31 15:34:51 +00003453*/
drh678ccce2008-03-31 18:19:54 +00003454int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003455 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3456 int op; /* The opcode being coded */
3457 int inReg = target; /* Results stored in register inReg */
3458 int regFree1 = 0; /* If non-zero free this temporary register */
3459 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003460 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003461 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003462 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003463
drh9cbf3422008-01-17 16:22:13 +00003464 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003465 if( v==0 ){
3466 assert( pParse->db->mallocFailed );
3467 return 0;
3468 }
drh389a1ad2008-01-03 23:44:53 +00003469
drh1efa8022018-04-28 04:16:43 +00003470expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003471 if( pExpr==0 ){
3472 op = TK_NULL;
3473 }else{
3474 op = pExpr->op;
3475 }
drhf2bc0132004-10-04 13:19:23 +00003476 switch( op ){
drh13449892005-09-07 21:22:45 +00003477 case TK_AGG_COLUMN: {
3478 AggInfo *pAggInfo = pExpr->pAggInfo;
3479 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3480 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003481 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003482 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003483 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003484 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003485 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003486 return target;
drh13449892005-09-07 21:22:45 +00003487 }
3488 /* Otherwise, fall thru into the TK_COLUMN case */
3489 }
drh967e8b72000-06-21 13:59:10 +00003490 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003491 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003492 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003493 /* This COLUMN expression is really a constant due to WHERE clause
3494 ** constraints, and that constant is coded by the pExpr->pLeft
3495 ** expresssion. However, make sure the constant has the correct
3496 ** datatype by applying the Affinity of the table column to the
3497 ** constant.
3498 */
3499 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003500 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003501 if( aff!=SQLITE_AFF_BLOB ){
3502 static const char zAff[] = "B\000C\000D\000E";
3503 assert( SQLITE_AFF_BLOB=='A' );
3504 assert( SQLITE_AFF_TEXT=='B' );
3505 if( iReg!=target ){
3506 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3507 iReg = target;
3508 }
3509 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3510 &zAff[(aff-'B')*2], P4_STATIC);
3511 }
3512 return iReg;
drhefad2e22018-07-27 16:57:11 +00003513 }
drhb2b9d3d2013-08-01 01:14:43 +00003514 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003515 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003516 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003517 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003518 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003519 /* Coding an expression that is part of an index where column names
3520 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003521 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003522 }
drh22827922000-06-06 17:27:05 +00003523 }
drheda079c2018-09-20 19:02:15 +00003524 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003525 pExpr->iColumn, iTab, target,
3526 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003527 }
3528 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003529 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003530 return target;
drhfec19aa2004-05-19 20:41:03 +00003531 }
drh8abed7b2018-02-26 18:49:05 +00003532 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003533 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003534 return target;
3535 }
drh13573c72010-01-12 17:04:07 +00003536#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003537 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003538 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3539 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003540 return target;
drh598f1342007-10-23 15:39:45 +00003541 }
drh13573c72010-01-12 17:04:07 +00003542#endif
drhfec19aa2004-05-19 20:41:03 +00003543 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003544 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003545 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003546 return target;
drhcce7d172000-05-31 15:34:51 +00003547 }
drhf0863fe2005-06-12 21:35:51 +00003548 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003549 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003550 return target;
drhf0863fe2005-06-12 21:35:51 +00003551 }
danielk19775338a5f2005-01-20 13:03:10 +00003552#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003553 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003554 int n;
3555 const char *z;
drhca48c902008-01-18 14:08:24 +00003556 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003557 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3558 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3559 assert( pExpr->u.zToken[1]=='\'' );
3560 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003561 n = sqlite3Strlen30(z) - 1;
3562 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003563 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3564 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003565 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003566 }
danielk19775338a5f2005-01-20 13:03:10 +00003567#endif
drh50457892003-09-06 01:10:47 +00003568 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003569 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3570 assert( pExpr->u.zToken!=0 );
3571 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003572 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3573 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003574 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003575 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003576 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003577 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003578 }
drhc332cc32016-09-19 10:24:19 +00003579 return target;
drh50457892003-09-06 01:10:47 +00003580 }
drh4e0cff62004-11-05 05:10:28 +00003581 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003582 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003583 }
drh487e2622005-06-25 18:42:14 +00003584#ifndef SQLITE_OMIT_CAST
3585 case TK_CAST: {
3586 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003587 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003588 if( inReg!=target ){
3589 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3590 inReg = target;
3591 }
drh4169e432014-08-25 20:11:52 +00003592 sqlite3VdbeAddOp2(v, OP_Cast, target,
3593 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003594 return inReg;
drh487e2622005-06-25 18:42:14 +00003595 }
3596#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003597 case TK_IS:
3598 case TK_ISNOT:
3599 op = (op==TK_IS) ? TK_EQ : TK_NE;
3600 p5 = SQLITE_NULLEQ;
3601 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003602 case TK_LT:
3603 case TK_LE:
3604 case TK_GT:
3605 case TK_GE:
3606 case TK_NE:
3607 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003608 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003609 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003610 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003611 }else{
3612 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3613 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3614 codeCompare(pParse, pLeft, pExpr->pRight, op,
3615 r1, r2, inReg, SQLITE_STOREP2 | p5);
3616 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3617 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3618 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3619 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3620 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3621 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3622 testcase( regFree1==0 );
3623 testcase( regFree2==0 );
3624 }
drh6a2fe092009-09-23 02:29:36 +00003625 break;
3626 }
drhcce7d172000-05-31 15:34:51 +00003627 case TK_AND:
3628 case TK_OR:
3629 case TK_PLUS:
3630 case TK_STAR:
3631 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003632 case TK_REM:
3633 case TK_BITAND:
3634 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003635 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003636 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003637 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003638 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003639 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3640 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3641 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3642 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3643 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3644 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3645 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3646 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3647 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3648 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3649 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003650 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3651 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003652 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003653 testcase( regFree1==0 );
3654 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003655 break;
3656 }
drhcce7d172000-05-31 15:34:51 +00003657 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003658 Expr *pLeft = pExpr->pLeft;
3659 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003660 if( pLeft->op==TK_INTEGER ){
3661 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003662 return target;
drh13573c72010-01-12 17:04:07 +00003663#ifndef SQLITE_OMIT_FLOATING_POINT
3664 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003665 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3666 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003667 return target;
drh13573c72010-01-12 17:04:07 +00003668#endif
drh3c84ddf2008-01-09 02:15:38 +00003669 }else{
drh10d1edf2013-11-15 15:52:39 +00003670 tempX.op = TK_INTEGER;
3671 tempX.flags = EP_IntValue|EP_TokenOnly;
3672 tempX.u.iValue = 0;
3673 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003674 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003675 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003676 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003677 }
drh3c84ddf2008-01-09 02:15:38 +00003678 break;
drh6e142f52000-06-08 13:36:40 +00003679 }
drhbf4133c2001-10-13 02:59:08 +00003680 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003681 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003682 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3683 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003684 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3685 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003686 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003687 break;
3688 }
drh8abed7b2018-02-26 18:49:05 +00003689 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003690 int isTrue; /* IS TRUE or IS NOT TRUE */
3691 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003692 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3693 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003694 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3695 bNormal = pExpr->op2==TK_IS;
3696 testcase( isTrue && bNormal);
3697 testcase( !isTrue && bNormal);
3698 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003699 break;
3700 }
drhcce7d172000-05-31 15:34:51 +00003701 case TK_ISNULL:
3702 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003703 int addr;
drh7d176102014-02-18 03:07:12 +00003704 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3705 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003706 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003707 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003708 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003709 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003710 VdbeCoverageIf(v, op==TK_ISNULL);
3711 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003712 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003713 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003714 break;
drhcce7d172000-05-31 15:34:51 +00003715 }
drh22827922000-06-06 17:27:05 +00003716 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003717 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003718 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003719 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3720 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003721 }else{
drhc332cc32016-09-19 10:24:19 +00003722 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003723 }
drh22827922000-06-06 17:27:05 +00003724 break;
3725 }
drhcce7d172000-05-31 15:34:51 +00003726 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003727 ExprList *pFarg; /* List of function arguments */
3728 int nFarg; /* Number of function arguments */
3729 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003730 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003731 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003732 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003733 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003734 u8 enc = ENC(db); /* The text encoding used by this database */
3735 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003736
dan67a9b8e2018-06-22 20:51:35 +00003737#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003738 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3739 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003740 }
dan67a9b8e2018-06-22 20:51:35 +00003741#endif
dan86fb6e12018-05-16 20:58:07 +00003742
drh1e9b53f2017-01-04 01:07:24 +00003743 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003744 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003745 ** out of the inner loop, even if that means an extra OP_Copy. */
3746 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003747 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003748 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003749 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003750 pFarg = 0;
3751 }else{
3752 pFarg = pExpr->x.pList;
3753 }
3754 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003755 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3756 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003757 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003758#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3759 if( pDef==0 && pParse->explain ){
3760 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3761 }
3762#endif
danb6e9f7a2018-05-19 14:15:29 +00003763 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003764 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003765 break;
3766 }
drhae6bb952009-11-11 00:24:31 +00003767
3768 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003769 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003770 ** arguments past the first non-NULL argument.
3771 */
drhd36e1042013-09-06 13:10:12 +00003772 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003773 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003774 assert( nFarg>=2 );
3775 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3776 for(i=1; i<nFarg; i++){
3777 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003778 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003779 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003780 }
3781 sqlite3VdbeResolveLabel(v, endCoalesce);
3782 break;
3783 }
3784
drhcca9f3d2013-09-06 15:23:29 +00003785 /* The UNLIKELY() function is a no-op. The result is the value
3786 ** of the first argument.
3787 */
3788 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3789 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003790 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003791 }
drhae6bb952009-11-11 00:24:31 +00003792
drh54240752017-01-03 14:39:30 +00003793#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003794 /* The AFFINITY() function evaluates to a string that describes
3795 ** the type affinity of the argument. This is used for testing of
3796 ** the SQLite type logic.
3797 */
3798 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3799 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3800 char aff;
3801 assert( nFarg==1 );
3802 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3803 sqlite3VdbeLoadString(v, target,
3804 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3805 return target;
3806 }
drh54240752017-01-03 14:39:30 +00003807#endif
drha1a523a2016-12-26 00:18:36 +00003808
drhd1a01ed2013-11-21 16:08:52 +00003809 for(i=0; i<nFarg; i++){
3810 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003811 testcase( i==31 );
3812 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003813 }
3814 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3815 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3816 }
3817 }
drh12ffee82009-04-08 13:51:51 +00003818 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003819 if( constMask ){
3820 r1 = pParse->nMem+1;
3821 pParse->nMem += nFarg;
3822 }else{
3823 r1 = sqlite3GetTempRange(pParse, nFarg);
3824 }
drha748fdc2012-03-28 01:34:47 +00003825
3826 /* For length() and typeof() functions with a column argument,
3827 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3828 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3829 ** loading.
3830 */
drhd36e1042013-09-06 13:10:12 +00003831 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003832 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003833 assert( nFarg==1 );
3834 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003835 exprOp = pFarg->a[0].pExpr->op;
3836 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003837 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3838 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003839 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3840 pFarg->a[0].pExpr->op2 =
3841 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003842 }
3843 }
3844
drh5579d592015-08-26 14:01:41 +00003845 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003846 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003847 }else{
drh12ffee82009-04-08 13:51:51 +00003848 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003849 }
drhb7f6f682006-07-08 17:06:43 +00003850#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003851 /* Possibly overload the function if the first argument is
3852 ** a virtual table column.
3853 **
3854 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3855 ** second argument, not the first, as the argument to test to
3856 ** see if it is a column in a virtual table. This is done because
3857 ** the left operand of infix functions (the operand we want to
3858 ** control overloading) ends up as the second argument to the
3859 ** function. The expression "A glob B" is equivalent to
3860 ** "glob(B,A). We want to use the A in "A glob B" to test
3861 ** for function overloading. But we use the B term in "glob(B,A)".
3862 */
drh59155062018-05-26 18:03:48 +00003863 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003864 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3865 }else if( nFarg>0 ){
3866 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003867 }
3868#endif
drhd36e1042013-09-06 13:10:12 +00003869 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003870 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003871 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003872 }
drh092457b2017-12-29 15:04:49 +00003873#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3874 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003875 Expr *pArg = pFarg->a[0].pExpr;
3876 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003877 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003878 }else{
3879 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3880 }
drh092457b2017-12-29 15:04:49 +00003881 }else
3882#endif
3883 {
drh2fc865c2017-12-16 20:20:37 +00003884 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3885 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3886 sqlite3VdbeChangeP5(v, (u8)nFarg);
3887 }
drhd1a01ed2013-11-21 16:08:52 +00003888 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003889 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003890 }
drhc332cc32016-09-19 10:24:19 +00003891 return target;
drhcce7d172000-05-31 15:34:51 +00003892 }
drhfe2093d2005-01-20 22:48:47 +00003893#ifndef SQLITE_OMIT_SUBQUERY
3894 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003895 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003896 int nCol;
drhc5499be2008-04-01 15:06:33 +00003897 testcase( op==TK_EXISTS );
3898 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003899 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3900 sqlite3SubselectError(pParse, nCol, 1);
3901 }else{
drh85bcdce2018-12-23 21:27:29 +00003902 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003903 }
drh19a775c2000-06-05 18:54:46 +00003904 break;
3905 }
drhfc7f27b2016-08-20 00:07:01 +00003906 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003907 int n;
drhfc7f27b2016-08-20 00:07:01 +00003908 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003909 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003910 }
drh966e2912017-01-03 02:58:01 +00003911 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3912 if( pExpr->iTable
3913 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3914 ){
3915 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3916 pExpr->iTable, n);
3917 }
drhc332cc32016-09-19 10:24:19 +00003918 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003919 }
drhfef52082000-06-06 01:50:43 +00003920 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003921 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3922 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003923 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3924 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3925 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3926 sqlite3VdbeResolveLabel(v, destIfFalse);
3927 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3928 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003929 return target;
drhfef52082000-06-06 01:50:43 +00003930 }
drhe3365e62009-11-12 17:52:24 +00003931#endif /* SQLITE_OMIT_SUBQUERY */
3932
3933
drh2dcef112008-01-12 19:03:48 +00003934 /*
3935 ** x BETWEEN y AND z
3936 **
3937 ** This is equivalent to
3938 **
3939 ** x>=y AND x<=z
3940 **
3941 ** X is stored in pExpr->pLeft.
3942 ** Y is stored in pExpr->pList->a[0].pExpr.
3943 ** Z is stored in pExpr->pList->a[1].pExpr.
3944 */
drhfef52082000-06-06 01:50:43 +00003945 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003946 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003947 return target;
drhfef52082000-06-06 01:50:43 +00003948 }
drh94fa9c42016-02-27 21:16:04 +00003949 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003950 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003951 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003952 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003953 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003954 }
drh2dcef112008-01-12 19:03:48 +00003955
dan165921a2009-08-28 18:53:45 +00003956 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003957 /* If the opcode is TK_TRIGGER, then the expression is a reference
3958 ** to a column in the new.* or old.* pseudo-tables available to
3959 ** trigger programs. In this case Expr.iTable is set to 1 for the
3960 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3961 ** is set to the column of the pseudo-table to read, or to -1 to
3962 ** read the rowid field.
3963 **
3964 ** The expression is implemented using an OP_Param opcode. The p1
3965 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3966 ** to reference another column of the old.* pseudo-table, where
3967 ** i is the index of the column. For a new.rowid reference, p1 is
3968 ** set to (n+1), where n is the number of columns in each pseudo-table.
3969 ** For a reference to any other column in the new.* pseudo-table, p1
3970 ** is set to (n+2+i), where n and i are as defined previously. For
3971 ** example, if the table on which triggers are being fired is
3972 ** declared as:
3973 **
3974 ** CREATE TABLE t1(a, b);
3975 **
3976 ** Then p1 is interpreted as follows:
3977 **
3978 ** p1==0 -> old.rowid p1==3 -> new.rowid
3979 ** p1==1 -> old.a p1==4 -> new.a
3980 ** p1==2 -> old.b p1==5 -> new.b
3981 */
drheda079c2018-09-20 19:02:15 +00003982 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003983 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3984
3985 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3986 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3987 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3988 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3989
3990 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003991 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003992 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003993 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003994 ));
dan65a7cd12009-09-01 12:16:01 +00003995
drh44dbca82010-01-13 04:22:20 +00003996#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003997 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003998 ** integer. Use OP_RealAffinity to make sure it is really real.
3999 **
4000 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4001 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004002 if( pExpr->iColumn>=0
4003 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4004 ){
4005 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4006 }
drh44dbca82010-01-13 04:22:20 +00004007#endif
dan165921a2009-08-28 18:53:45 +00004008 break;
4009 }
4010
dan71c57db2016-07-09 20:23:55 +00004011 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004012 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004013 break;
4014 }
4015
drh31d6fd52017-04-14 19:03:10 +00004016 case TK_IF_NULL_ROW: {
4017 int addrINR;
4018 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00004019 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00004020 sqlite3VdbeJumpHere(v, addrINR);
4021 sqlite3VdbeChangeP3(v, addrINR, inReg);
4022 break;
4023 }
4024
drh2dcef112008-01-12 19:03:48 +00004025 /*
4026 ** Form A:
4027 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4028 **
4029 ** Form B:
4030 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4031 **
4032 ** Form A is can be transformed into the equivalent form B as follows:
4033 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4034 ** WHEN x=eN THEN rN ELSE y END
4035 **
4036 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004037 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4038 ** odd. The Y is also optional. If the number of elements in x.pList
4039 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004040 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4041 **
4042 ** The result of the expression is the Ri for the first matching Ei,
4043 ** or if there is no matching Ei, the ELSE term Y, or if there is
4044 ** no ELSE term, NULL.
4045 */
drh33cd4902009-05-30 20:49:20 +00004046 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004047 int endLabel; /* GOTO label for end of CASE stmt */
4048 int nextCase; /* GOTO label for next WHEN clause */
4049 int nExpr; /* 2x number of WHEN terms */
4050 int i; /* Loop counter */
4051 ExprList *pEList; /* List of WHEN terms */
4052 struct ExprList_item *aListelem; /* Array of WHEN terms */
4053 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004054 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004055 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00004056
danielk19776ab3a2e2009-02-19 14:39:25 +00004057 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004058 assert(pExpr->x.pList->nExpr > 0);
4059 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004060 aListelem = pEList->a;
4061 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004062 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004063 if( (pX = pExpr->pLeft)!=0 ){
drha8e05762019-01-05 21:56:12 +00004064 exprNodeCopy(&tempX, pX);
drh33cd4902009-05-30 20:49:20 +00004065 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004066 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004067 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004068 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004069 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004070 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004071 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004072 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4073 ** The value in regFree1 might get SCopy-ed into the file result.
4074 ** So make sure that the regFree1 register is not reused for other
4075 ** purposes and possibly overwritten. */
4076 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004077 }
drhc5cd1242013-09-12 16:50:49 +00004078 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004079 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004080 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004081 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004082 }else{
drh2dcef112008-01-12 19:03:48 +00004083 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004084 }
drhec4ccdb2018-12-29 02:26:59 +00004085 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004086 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004087 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004088 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004089 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004090 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004091 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004092 }
drhc5cd1242013-09-12 16:50:49 +00004093 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004094 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004095 }else{
drh9de221d2008-01-05 06:51:30 +00004096 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004097 }
drh2dcef112008-01-12 19:03:48 +00004098 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004099 break;
4100 }
danielk19775338a5f2005-01-20 13:03:10 +00004101#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004102 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004103 assert( pExpr->affinity==OE_Rollback
4104 || pExpr->affinity==OE_Abort
4105 || pExpr->affinity==OE_Fail
4106 || pExpr->affinity==OE_Ignore
4107 );
dane0af83a2009-09-08 19:15:01 +00004108 if( !pParse->pTriggerTab ){
4109 sqlite3ErrorMsg(pParse,
4110 "RAISE() may only be used within a trigger-program");
4111 return 0;
4112 }
4113 if( pExpr->affinity==OE_Abort ){
4114 sqlite3MayAbort(pParse);
4115 }
dan165921a2009-08-28 18:53:45 +00004116 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004117 if( pExpr->affinity==OE_Ignore ){
4118 sqlite3VdbeAddOp4(
4119 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004120 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004121 }else{
drh433dccf2013-02-09 15:37:11 +00004122 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004123 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004124 }
4125
drhffe07b22005-11-03 00:41:17 +00004126 break;
drh17a7f8d2002-03-24 13:13:27 +00004127 }
danielk19775338a5f2005-01-20 13:03:10 +00004128#endif
drhffe07b22005-11-03 00:41:17 +00004129 }
drh2dcef112008-01-12 19:03:48 +00004130 sqlite3ReleaseTempReg(pParse, regFree1);
4131 sqlite3ReleaseTempReg(pParse, regFree2);
4132 return inReg;
4133}
4134
4135/*
drhd1a01ed2013-11-21 16:08:52 +00004136** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004137**
drhad879ff2017-01-04 04:10:02 +00004138** If regDest>=0 then the result is always stored in that register and the
4139** result is not reusable. If regDest<0 then this routine is free to
4140** store the value whereever it wants. The register where the expression
4141** is stored is returned. When regDest<0, two identical expressions will
4142** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004143*/
drh1e9b53f2017-01-04 01:07:24 +00004144int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004145 Parse *pParse, /* Parsing context */
4146 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004147 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004148){
drhd1a01ed2013-11-21 16:08:52 +00004149 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004150 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004151 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004152 if( regDest<0 && p ){
4153 struct ExprList_item *pItem;
4154 int i;
4155 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004156 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004157 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004158 }
4159 }
drh1e9b53f2017-01-04 01:07:24 +00004160 }
drhd1a01ed2013-11-21 16:08:52 +00004161 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4162 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004163 if( p ){
4164 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004165 pItem->reusable = regDest<0;
4166 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004167 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004168 }
drhd1a01ed2013-11-21 16:08:52 +00004169 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004170 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004171}
4172
4173/*
drh2dcef112008-01-12 19:03:48 +00004174** Generate code to evaluate an expression and store the results
4175** into a register. Return the register number where the results
4176** are stored.
4177**
4178** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004179** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004180** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004181**
4182** If pExpr is a constant, then this routine might generate this
4183** code to fill the register in the initialization section of the
4184** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004185*/
4186int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004187 int r2;
4188 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004189 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004190 && pExpr->op!=TK_REGISTER
4191 && sqlite3ExprIsConstantNotJoin(pExpr)
4192 ){
drhf30a9692013-11-15 01:10:18 +00004193 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004194 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004195 }else{
drhf30a9692013-11-15 01:10:18 +00004196 int r1 = sqlite3GetTempReg(pParse);
4197 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4198 if( r2==r1 ){
4199 *pReg = r1;
4200 }else{
4201 sqlite3ReleaseTempReg(pParse, r1);
4202 *pReg = 0;
4203 }
drh2dcef112008-01-12 19:03:48 +00004204 }
4205 return r2;
4206}
4207
4208/*
4209** Generate code that will evaluate expression pExpr and store the
4210** results in register target. The results are guaranteed to appear
4211** in register target.
4212*/
drh05a86c52014-02-16 01:55:49 +00004213void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004214 int inReg;
4215
4216 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004217 if( pExpr && pExpr->op==TK_REGISTER ){
4218 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4219 }else{
4220 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004221 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004222 if( inReg!=target && pParse->pVdbe ){
4223 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4224 }
drhcce7d172000-05-31 15:34:51 +00004225 }
drhcce7d172000-05-31 15:34:51 +00004226}
4227
4228/*
drh1c75c9d2015-12-21 15:22:13 +00004229** Make a transient copy of expression pExpr and then code it using
4230** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4231** except that the input expression is guaranteed to be unchanged.
4232*/
4233void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4234 sqlite3 *db = pParse->db;
4235 pExpr = sqlite3ExprDup(db, pExpr, 0);
4236 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4237 sqlite3ExprDelete(db, pExpr);
4238}
4239
4240/*
drh05a86c52014-02-16 01:55:49 +00004241** Generate code that will evaluate expression pExpr and store the
4242** results in register target. The results are guaranteed to appear
4243** in register target. If the expression is constant, then this routine
4244** might choose to code the expression at initialization time.
4245*/
4246void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004247 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004248 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004249 }else{
4250 sqlite3ExprCode(pParse, pExpr, target);
4251 }
drhcce7d172000-05-31 15:34:51 +00004252}
4253
4254/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004255** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004256** in register target.
drh25303782004-12-07 15:41:48 +00004257**
drh2dcef112008-01-12 19:03:48 +00004258** Also make a copy of the expression results into another "cache" register
4259** and modify the expression so that the next time it is evaluated,
4260** the result is a copy of the cache register.
4261**
4262** This routine is used for expressions that are used multiple
4263** times. They are evaluated once and the results of the expression
4264** are reused.
drh25303782004-12-07 15:41:48 +00004265*/
drh05a86c52014-02-16 01:55:49 +00004266void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004267 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004268 int iMem;
4269
drhde4fcfd2008-01-19 23:50:26 +00004270 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004271 assert( pExpr->op!=TK_REGISTER );
4272 sqlite3ExprCode(pParse, pExpr, target);
4273 iMem = ++pParse->nMem;
4274 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4275 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004276}
drh2dcef112008-01-12 19:03:48 +00004277
drh678ccce2008-03-31 18:19:54 +00004278/*
drh268380c2004-02-25 13:47:31 +00004279** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004280** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004281**
drh3df6c3b2017-09-15 15:38:01 +00004282** Return the number of elements evaluated. The number returned will
4283** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4284** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004285**
4286** The SQLITE_ECEL_DUP flag prevents the arguments from being
4287** filled using OP_SCopy. OP_Copy must be used instead.
4288**
4289** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4290** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004291**
4292** The SQLITE_ECEL_REF flag means that expressions in the list with
4293** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4294** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004295** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4296** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004297*/
danielk19774adee202004-05-08 08:23:19 +00004298int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004299 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004300 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004301 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004302 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004303 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004304){
4305 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004306 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004307 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004308 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004309 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004310 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004311 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004312 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004313 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004314 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004315 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004316#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4317 if( pItem->bSorterRef ){
4318 i--;
4319 n--;
4320 }else
4321#endif
dan257c13f2016-11-10 20:14:06 +00004322 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4323 if( flags & SQLITE_ECEL_OMITREF ){
4324 i--;
4325 n--;
4326 }else{
4327 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4328 }
drhb8b06692018-08-04 15:16:20 +00004329 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4330 && sqlite3ExprIsConstantNotJoin(pExpr)
4331 ){
drhad879ff2017-01-04 04:10:02 +00004332 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004333 }else{
4334 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4335 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004336 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004337 if( copyOp==OP_Copy
4338 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4339 && pOp->p1+pOp->p3+1==inReg
4340 && pOp->p2+pOp->p3+1==target+i
4341 ){
4342 pOp->p3++;
4343 }else{
4344 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4345 }
drhd1a01ed2013-11-21 16:08:52 +00004346 }
drhd1766112008-09-17 00:13:12 +00004347 }
drh268380c2004-02-25 13:47:31 +00004348 }
drhf9b596e2004-05-26 16:54:42 +00004349 return n;
drh268380c2004-02-25 13:47:31 +00004350}
4351
4352/*
drh36c563a2009-11-12 13:32:22 +00004353** Generate code for a BETWEEN operator.
4354**
4355** x BETWEEN y AND z
4356**
4357** The above is equivalent to
4358**
4359** x>=y AND x<=z
4360**
4361** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004362** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004363**
4364** The xJumpIf parameter determines details:
4365**
4366** NULL: Store the boolean result in reg[dest]
4367** sqlite3ExprIfTrue: Jump to dest if true
4368** sqlite3ExprIfFalse: Jump to dest if false
4369**
4370** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004371*/
4372static void exprCodeBetween(
4373 Parse *pParse, /* Parsing and code generating context */
4374 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004375 int dest, /* Jump destination or storage location */
4376 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004377 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4378){
drhdb45bd52016-08-22 00:48:58 +00004379 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004380 Expr compLeft; /* The x>=y term */
4381 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004382 Expr exprX; /* The x subexpression */
4383 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004384
dan71c57db2016-07-09 20:23:55 +00004385 memset(&compLeft, 0, sizeof(Expr));
4386 memset(&compRight, 0, sizeof(Expr));
4387 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004388
4389 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drha8e05762019-01-05 21:56:12 +00004390 exprNodeCopy(&exprX, pExpr->pLeft);
drh36c563a2009-11-12 13:32:22 +00004391 exprAnd.op = TK_AND;
4392 exprAnd.pLeft = &compLeft;
4393 exprAnd.pRight = &compRight;
4394 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004395 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004396 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4397 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004398 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004399 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004400 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004401 if( xJump ){
4402 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004403 }else{
drh36fd41e2016-11-25 14:30:42 +00004404 /* Mark the expression is being from the ON or USING clause of a join
4405 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4406 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4407 ** for clarity, but we are out of bits in the Expr.flags field so we
4408 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004409 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004410 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004411 }
drhdb45bd52016-08-22 00:48:58 +00004412 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004413
4414 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004415 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4416 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4417 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4418 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4419 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4420 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4421 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4422 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004423 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004424}
4425
4426/*
drhcce7d172000-05-31 15:34:51 +00004427** Generate code for a boolean expression such that a jump is made
4428** to the label "dest" if the expression is true but execution
4429** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004430**
4431** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004432** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004433**
4434** This code depends on the fact that certain token values (ex: TK_EQ)
4435** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4436** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4437** the make process cause these values to align. Assert()s in the code
4438** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004439*/
danielk19774adee202004-05-08 08:23:19 +00004440void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004441 Vdbe *v = pParse->pVdbe;
4442 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004443 int regFree1 = 0;
4444 int regFree2 = 0;
4445 int r1, r2;
4446
drh35573352008-01-08 23:54:25 +00004447 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004448 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004449 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004450 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004451 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004452 case TK_AND: {
drhec4ccdb2018-12-29 02:26:59 +00004453 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004454 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004455 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004456 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4457 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004458 break;
4459 }
4460 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004461 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004462 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4463 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004464 break;
4465 }
4466 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004467 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004468 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004469 break;
4470 }
drh8abed7b2018-02-26 18:49:05 +00004471 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004472 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4473 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004474 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004475 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004476 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004477 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004478 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004479 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004480 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4481 isNot ? SQLITE_JUMPIFNULL : 0);
4482 }else{
4483 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4484 isNot ? SQLITE_JUMPIFNULL : 0);
4485 }
drh007c8432018-02-26 03:20:18 +00004486 break;
4487 }
drhde845c22016-03-17 19:07:52 +00004488 case TK_IS:
4489 case TK_ISNOT:
4490 testcase( op==TK_IS );
4491 testcase( op==TK_ISNOT );
4492 op = (op==TK_IS) ? TK_EQ : TK_NE;
4493 jumpIfNull = SQLITE_NULLEQ;
4494 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004495 case TK_LT:
4496 case TK_LE:
4497 case TK_GT:
4498 case TK_GE:
4499 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004500 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004501 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004502 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004503 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4504 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004505 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004506 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004507 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4508 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4509 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4510 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004511 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4512 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4513 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4514 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4515 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4516 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004517 testcase( regFree1==0 );
4518 testcase( regFree2==0 );
4519 break;
4520 }
drhcce7d172000-05-31 15:34:51 +00004521 case TK_ISNULL:
4522 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004523 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4524 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004525 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4526 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004527 VdbeCoverageIf(v, op==TK_ISNULL);
4528 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004529 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004530 break;
4531 }
drhfef52082000-06-06 01:50:43 +00004532 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004533 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004534 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004535 break;
4536 }
drh84e30ca2011-02-10 17:46:14 +00004537#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004538 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004539 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004540 int destIfNull = jumpIfNull ? dest : destIfFalse;
4541 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004542 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004543 sqlite3VdbeResolveLabel(v, destIfFalse);
4544 break;
4545 }
shanehbb201342011-02-09 19:55:20 +00004546#endif
drhcce7d172000-05-31 15:34:51 +00004547 default: {
dan7b35a772016-07-28 19:47:15 +00004548 default_expr:
drh991a1982014-01-02 17:57:16 +00004549 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004550 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004551 }else if( exprAlwaysFalse(pExpr) ){
4552 /* No-op */
4553 }else{
4554 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4555 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004556 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004557 testcase( regFree1==0 );
4558 testcase( jumpIfNull==0 );
4559 }
drhcce7d172000-05-31 15:34:51 +00004560 break;
4561 }
4562 }
drh2dcef112008-01-12 19:03:48 +00004563 sqlite3ReleaseTempReg(pParse, regFree1);
4564 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004565}
4566
4567/*
drh66b89c82000-11-28 20:47:17 +00004568** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004569** to the label "dest" if the expression is false but execution
4570** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004571**
4572** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004573** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4574** is 0.
drhcce7d172000-05-31 15:34:51 +00004575*/
danielk19774adee202004-05-08 08:23:19 +00004576void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004577 Vdbe *v = pParse->pVdbe;
4578 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004579 int regFree1 = 0;
4580 int regFree2 = 0;
4581 int r1, r2;
4582
drh35573352008-01-08 23:54:25 +00004583 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004584 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004585 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004586
4587 /* The value of pExpr->op and op are related as follows:
4588 **
4589 ** pExpr->op op
4590 ** --------- ----------
4591 ** TK_ISNULL OP_NotNull
4592 ** TK_NOTNULL OP_IsNull
4593 ** TK_NE OP_Eq
4594 ** TK_EQ OP_Ne
4595 ** TK_GT OP_Le
4596 ** TK_LE OP_Gt
4597 ** TK_GE OP_Lt
4598 ** TK_LT OP_Ge
4599 **
4600 ** For other values of pExpr->op, op is undefined and unused.
4601 ** The value of TK_ and OP_ constants are arranged such that we
4602 ** can compute the mapping above using the following expression.
4603 ** Assert()s verify that the computation is correct.
4604 */
4605 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4606
4607 /* Verify correct alignment of TK_ and OP_ constants
4608 */
4609 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4610 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4611 assert( pExpr->op!=TK_NE || op==OP_Eq );
4612 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4613 assert( pExpr->op!=TK_LT || op==OP_Ge );
4614 assert( pExpr->op!=TK_LE || op==OP_Gt );
4615 assert( pExpr->op!=TK_GT || op==OP_Le );
4616 assert( pExpr->op!=TK_GE || op==OP_Lt );
4617
danba00e302016-07-23 20:24:06 +00004618 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004619 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004620 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004621 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4622 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004623 break;
4624 }
4625 case TK_OR: {
drhec4ccdb2018-12-29 02:26:59 +00004626 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004627 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004628 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004629 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4630 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004631 break;
4632 }
4633 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004634 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004635 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004636 break;
4637 }
drh8abed7b2018-02-26 18:49:05 +00004638 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004639 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4640 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004641 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004642 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004643 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004644 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004645 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004646 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004647 /* IS TRUE and IS NOT FALSE */
4648 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4649 isNot ? 0 : SQLITE_JUMPIFNULL);
4650
4651 }else{
4652 /* IS FALSE and IS NOT TRUE */
4653 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004654 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004655 }
drh007c8432018-02-26 03:20:18 +00004656 break;
4657 }
drhde845c22016-03-17 19:07:52 +00004658 case TK_IS:
4659 case TK_ISNOT:
4660 testcase( pExpr->op==TK_IS );
4661 testcase( pExpr->op==TK_ISNOT );
4662 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4663 jumpIfNull = SQLITE_NULLEQ;
4664 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004665 case TK_LT:
4666 case TK_LE:
4667 case TK_GT:
4668 case TK_GE:
4669 case TK_NE:
4670 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004671 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004672 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004673 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4674 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004675 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004676 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004677 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4678 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4679 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4680 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004681 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4682 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4683 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4684 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4685 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4686 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004687 testcase( regFree1==0 );
4688 testcase( regFree2==0 );
4689 break;
4690 }
drhcce7d172000-05-31 15:34:51 +00004691 case TK_ISNULL:
4692 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004693 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4694 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004695 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4696 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004697 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004698 break;
4699 }
drhfef52082000-06-06 01:50:43 +00004700 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004701 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004702 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004703 break;
4704 }
drh84e30ca2011-02-10 17:46:14 +00004705#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004706 case TK_IN: {
4707 if( jumpIfNull ){
4708 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4709 }else{
drhec4ccdb2018-12-29 02:26:59 +00004710 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004711 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4712 sqlite3VdbeResolveLabel(v, destIfNull);
4713 }
4714 break;
4715 }
shanehbb201342011-02-09 19:55:20 +00004716#endif
drhcce7d172000-05-31 15:34:51 +00004717 default: {
danba00e302016-07-23 20:24:06 +00004718 default_expr:
drh991a1982014-01-02 17:57:16 +00004719 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004720 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004721 }else if( exprAlwaysTrue(pExpr) ){
4722 /* no-op */
4723 }else{
4724 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4725 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004726 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004727 testcase( regFree1==0 );
4728 testcase( jumpIfNull==0 );
4729 }
drhcce7d172000-05-31 15:34:51 +00004730 break;
4731 }
4732 }
drh2dcef112008-01-12 19:03:48 +00004733 sqlite3ReleaseTempReg(pParse, regFree1);
4734 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004735}
drh22827922000-06-06 17:27:05 +00004736
4737/*
drh72bc8202015-06-11 13:58:35 +00004738** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4739** code generation, and that copy is deleted after code generation. This
4740** ensures that the original pExpr is unchanged.
4741*/
4742void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4743 sqlite3 *db = pParse->db;
4744 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4745 if( db->mallocFailed==0 ){
4746 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4747 }
4748 sqlite3ExprDelete(db, pCopy);
4749}
4750
dan5aa550c2017-06-24 18:10:29 +00004751/*
4752** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4753** type of expression.
4754**
4755** If pExpr is a simple SQL value - an integer, real, string, blob
4756** or NULL value - then the VDBE currently being prepared is configured
4757** to re-prepare each time a new value is bound to variable pVar.
4758**
4759** Additionally, if pExpr is a simple SQL value and the value is the
4760** same as that currently bound to variable pVar, non-zero is returned.
4761** Otherwise, if the values are not the same or if pExpr is not a simple
4762** SQL value, zero is returned.
4763*/
4764static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4765 int res = 0;
drhc0804222017-06-28 21:47:16 +00004766 int iVar;
4767 sqlite3_value *pL, *pR = 0;
4768
4769 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4770 if( pR ){
4771 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004772 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004773 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004774 if( pL ){
4775 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4776 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4777 }
4778 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004779 }
drhc0804222017-06-28 21:47:16 +00004780 sqlite3ValueFree(pR);
4781 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004782 }
4783
4784 return res;
4785}
drh72bc8202015-06-11 13:58:35 +00004786
4787/*
drh1d9da702010-01-07 15:17:02 +00004788** Do a deep comparison of two expression trees. Return 0 if the two
4789** expressions are completely identical. Return 1 if they differ only
4790** by a COLLATE operator at the top level. Return 2 if there are differences
4791** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004792**
drh619a1302013-08-01 13:04:46 +00004793** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4794** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4795**
drh66518ca2013-08-01 15:09:57 +00004796** The pA side might be using TK_REGISTER. If that is the case and pB is
4797** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4798**
drh1d9da702010-01-07 15:17:02 +00004799** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004800** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004801** identical, we return 2 just to be safe. So if this routine
4802** returns 2, then you do not really know for certain if the two
4803** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004804** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004805** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004806** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004807** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004808**
drhc0804222017-06-28 21:47:16 +00004809** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4810** pParse->pReprepare can be matched against literals in pB. The
4811** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4812** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4813** Argument pParse should normally be NULL. If it is not NULL and pA or
4814** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004815*/
dan5aa550c2017-06-24 18:10:29 +00004816int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004817 u32 combinedFlags;
4818 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004819 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004820 }
dan5aa550c2017-06-24 18:10:29 +00004821 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4822 return 0;
4823 }
drh10d1edf2013-11-15 15:52:39 +00004824 combinedFlags = pA->flags | pB->flags;
4825 if( combinedFlags & EP_IntValue ){
4826 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4827 return 0;
4828 }
drh1d9da702010-01-07 15:17:02 +00004829 return 2;
drh22827922000-06-06 17:27:05 +00004830 }
dan16dd3982018-12-20 15:04:38 +00004831 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004832 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004833 return 1;
4834 }
dan5aa550c2017-06-24 18:10:29 +00004835 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004836 return 1;
4837 }
4838 return 2;
4839 }
drh2edc5fd2015-11-24 02:10:52 +00004840 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004841 if( pA->op==TK_FUNCTION ){
4842 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004843#ifndef SQLITE_OMIT_WINDOWFUNC
4844 /* Justification for the assert():
4845 ** window functions have p->op==TK_FUNCTION but aggregate functions
4846 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4847 ** function and a window function should have failed before reaching
4848 ** this point. And, it is not possible to have a window function and
4849 ** a scalar function with the same name and number of arguments. So
4850 ** if we reach this point, either A and B both window functions or
4851 ** neither are a window functions. */
4852 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4853 if( ExprHasProperty(pA,EP_WinFunc) ){
4854 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4855 }
4856#endif
drhd5af5422018-04-13 14:27:01 +00004857 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004858 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhefad2e22018-07-27 16:57:11 +00004859 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004860 return 2;
drh2646da72005-12-09 20:02:05 +00004861 }
drh22827922000-06-06 17:27:05 +00004862 }
drh10d1edf2013-11-15 15:52:39 +00004863 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004864 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004865 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004866 if( (combinedFlags & EP_FixedCol)==0
4867 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004868 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004869 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004870 if( pA->op!=TK_STRING
4871 && pA->op!=TK_TRUEFALSE
4872 && (combinedFlags & EP_Reduced)==0
4873 ){
drh10d1edf2013-11-15 15:52:39 +00004874 if( pA->iColumn!=pB->iColumn ) return 2;
4875 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004876 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004877 }
4878 }
drh1d9da702010-01-07 15:17:02 +00004879 return 0;
drh22827922000-06-06 17:27:05 +00004880}
4881
drh8c6f6662010-04-26 19:17:26 +00004882/*
4883** Compare two ExprList objects. Return 0 if they are identical and
4884** non-zero if they differ in any way.
4885**
drh619a1302013-08-01 13:04:46 +00004886** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4887** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4888**
drh8c6f6662010-04-26 19:17:26 +00004889** This routine might return non-zero for equivalent ExprLists. The
4890** only consequence will be disabled optimizations. But this routine
4891** must never return 0 if the two ExprList objects are different, or
4892** a malfunction will result.
4893**
4894** Two NULL pointers are considered to be the same. But a NULL pointer
4895** always differs from a non-NULL pointer.
4896*/
drh619a1302013-08-01 13:04:46 +00004897int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004898 int i;
4899 if( pA==0 && pB==0 ) return 0;
4900 if( pA==0 || pB==0 ) return 1;
4901 if( pA->nExpr!=pB->nExpr ) return 1;
4902 for(i=0; i<pA->nExpr; i++){
4903 Expr *pExprA = pA->a[i].pExpr;
4904 Expr *pExprB = pB->a[i].pExpr;
4905 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004906 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004907 }
4908 return 0;
4909}
drh13449892005-09-07 21:22:45 +00004910
drh22827922000-06-06 17:27:05 +00004911/*
drhf9463df2017-02-11 14:59:58 +00004912** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4913** are ignored.
4914*/
4915int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004916 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004917 sqlite3ExprSkipCollate(pA),
4918 sqlite3ExprSkipCollate(pB),
4919 iTab);
4920}
4921
4922/*
drh4bd5f732013-07-31 23:22:39 +00004923** Return true if we can prove the pE2 will always be true if pE1 is
4924** true. Return false if we cannot complete the proof or if pE2 might
4925** be false. Examples:
4926**
drh619a1302013-08-01 13:04:46 +00004927** pE1: x==5 pE2: x==5 Result: true
4928** pE1: x>0 pE2: x==5 Result: false
4929** pE1: x=21 pE2: x=21 OR y=43 Result: true
4930** pE1: x!=123 pE2: x IS NOT NULL Result: true
4931** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4932** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4933** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004934**
4935** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4936** Expr.iTable<0 then assume a table number given by iTab.
4937**
drhc0804222017-06-28 21:47:16 +00004938** If pParse is not NULL, then the values of bound variables in pE1 are
4939** compared against literal values in pE2 and pParse->pVdbe->expmask is
4940** modified to record which bound variables are referenced. If pParse
4941** is NULL, then false will be returned if pE1 contains any bound variables.
4942**
drh4bd5f732013-07-31 23:22:39 +00004943** When in doubt, return false. Returning true might give a performance
4944** improvement. Returning false might cause a performance reduction, but
4945** it will always give the correct answer and is hence always safe.
4946*/
dan5aa550c2017-06-24 18:10:29 +00004947int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4948 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004949 return 1;
4950 }
4951 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004952 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4953 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004954 ){
4955 return 1;
4956 }
drh1ad93a02016-11-02 02:17:52 +00004957 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4958 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4959 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004960 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004961 }
4962 return 0;
drh4bd5f732013-07-31 23:22:39 +00004963}
4964
4965/*
drh25897872018-03-20 21:16:15 +00004966** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4967** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004968** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4969**
4970** This routine controls an optimization. False positives (setting
4971** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4972** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004973*/
4974static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004975 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004976 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004977 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4978 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004979 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004980 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004981 case TK_ISNULL:
4982 case TK_IS:
4983 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004984 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004985 case TK_IN:
drh25897872018-03-20 21:16:15 +00004986 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004987 testcase( pExpr->op==TK_ISNOT );
4988 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004989 testcase( pExpr->op==TK_ISNULL );
4990 testcase( pExpr->op==TK_IS );
4991 testcase( pExpr->op==TK_OR );
4992 testcase( pExpr->op==TK_CASE );
4993 testcase( pExpr->op==TK_IN );
4994 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00004995 return WRC_Prune;
4996 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00004997 if( pWalker->u.iCur==pExpr->iTable ){
4998 pWalker->eCode = 1;
4999 return WRC_Abort;
5000 }
5001 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005002
5003 /* Virtual tables are allowed to use constraints like x=NULL. So
5004 ** a term of the form x=y does not prove that y is not null if x
5005 ** is the column of a virtual table */
5006 case TK_EQ:
5007 case TK_NE:
5008 case TK_LT:
5009 case TK_LE:
5010 case TK_GT:
5011 case TK_GE:
5012 testcase( pExpr->op==TK_EQ );
5013 testcase( pExpr->op==TK_NE );
5014 testcase( pExpr->op==TK_LT );
5015 testcase( pExpr->op==TK_LE );
5016 testcase( pExpr->op==TK_GT );
5017 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005018 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5019 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005020 ){
5021 return WRC_Prune;
5022 }
drh25897872018-03-20 21:16:15 +00005023 default:
5024 return WRC_Continue;
5025 }
5026}
5027
5028/*
5029** Return true (non-zero) if expression p can only be true if at least
5030** one column of table iTab is non-null. In other words, return true
5031** if expression p will always be NULL or false if every column of iTab
5032** is NULL.
5033**
drh821b6102018-03-24 18:01:51 +00005034** False negatives are acceptable. In other words, it is ok to return
5035** zero even if expression p will never be true of every column of iTab
5036** is NULL. A false negative is merely a missed optimization opportunity.
5037**
5038** False positives are not allowed, however. A false positive may result
5039** in an incorrect answer.
5040**
drh25897872018-03-20 21:16:15 +00005041** Terms of p that are marked with EP_FromJoin (and hence that come from
5042** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5043**
5044** This routine is used to check if a LEFT JOIN can be converted into
5045** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5046** clause requires that some column of the right table of the LEFT JOIN
5047** be non-NULL, then the LEFT JOIN can be safely converted into an
5048** ordinary join.
5049*/
5050int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5051 Walker w;
5052 w.xExprCallback = impliesNotNullRow;
5053 w.xSelectCallback = 0;
5054 w.xSelectCallback2 = 0;
5055 w.eCode = 0;
5056 w.u.iCur = iTab;
5057 sqlite3WalkExpr(&w, p);
5058 return w.eCode;
5059}
5060
5061/*
drh030796d2012-08-23 16:18:10 +00005062** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005063** to determine if an expression can be evaluated by reference to the
5064** index only, without having to do a search for the corresponding
5065** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5066** is the cursor for the table.
5067*/
5068struct IdxCover {
5069 Index *pIdx; /* The index to be tested for coverage */
5070 int iCur; /* Cursor number for the table corresponding to the index */
5071};
5072
5073/*
5074** Check to see if there are references to columns in table
5075** pWalker->u.pIdxCover->iCur can be satisfied using the index
5076** pWalker->u.pIdxCover->pIdx.
5077*/
5078static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5079 if( pExpr->op==TK_COLUMN
5080 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5081 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5082 ){
5083 pWalker->eCode = 1;
5084 return WRC_Abort;
5085 }
5086 return WRC_Continue;
5087}
5088
5089/*
drhe604ec02016-07-27 19:20:58 +00005090** Determine if an index pIdx on table with cursor iCur contains will
5091** the expression pExpr. Return true if the index does cover the
5092** expression and false if the pExpr expression references table columns
5093** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005094**
5095** An index covering an expression means that the expression can be
5096** evaluated using only the index and without having to lookup the
5097** corresponding table entry.
5098*/
5099int sqlite3ExprCoveredByIndex(
5100 Expr *pExpr, /* The index to be tested */
5101 int iCur, /* The cursor number for the corresponding table */
5102 Index *pIdx /* The index that might be used for coverage */
5103){
5104 Walker w;
5105 struct IdxCover xcov;
5106 memset(&w, 0, sizeof(w));
5107 xcov.iCur = iCur;
5108 xcov.pIdx = pIdx;
5109 w.xExprCallback = exprIdxCover;
5110 w.u.pIdxCover = &xcov;
5111 sqlite3WalkExpr(&w, pExpr);
5112 return !w.eCode;
5113}
5114
5115
5116/*
5117** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005118** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005119** aggregate function, in order to implement the
5120** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005121*/
drh030796d2012-08-23 16:18:10 +00005122struct SrcCount {
5123 SrcList *pSrc; /* One particular FROM clause in a nested query */
5124 int nThis; /* Number of references to columns in pSrcList */
5125 int nOther; /* Number of references to columns in other FROM clauses */
5126};
5127
5128/*
5129** Count the number of references to columns.
5130*/
5131static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005132 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5133 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5134 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5135 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5136 ** NEVER() will need to be removed. */
5137 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005138 int i;
drh030796d2012-08-23 16:18:10 +00005139 struct SrcCount *p = pWalker->u.pSrcCount;
5140 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005141 int nSrc = pSrc ? pSrc->nSrc : 0;
5142 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005143 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005144 }
drh655814d2015-01-09 01:27:29 +00005145 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005146 p->nThis++;
5147 }else{
5148 p->nOther++;
5149 }
drh374fdce2012-04-17 16:38:53 +00005150 }
drh030796d2012-08-23 16:18:10 +00005151 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005152}
5153
5154/*
drh030796d2012-08-23 16:18:10 +00005155** Determine if any of the arguments to the pExpr Function reference
5156** pSrcList. Return true if they do. Also return true if the function
5157** has no arguments or has only constant arguments. Return false if pExpr
5158** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005159*/
drh030796d2012-08-23 16:18:10 +00005160int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005161 Walker w;
drh030796d2012-08-23 16:18:10 +00005162 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005163 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005164 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005165 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005166 w.u.pSrcCount = &cnt;
5167 cnt.pSrc = pSrcList;
5168 cnt.nThis = 0;
5169 cnt.nOther = 0;
5170 sqlite3WalkExprList(&w, pExpr->x.pList);
5171 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005172}
5173
5174/*
drh13449892005-09-07 21:22:45 +00005175** Add a new element to the pAggInfo->aCol[] array. Return the index of
5176** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005177*/
drh17435752007-08-16 04:30:38 +00005178static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005179 int i;
drhcf643722007-03-27 13:36:37 +00005180 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005181 db,
drhcf643722007-03-27 13:36:37 +00005182 pInfo->aCol,
5183 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005184 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005185 &i
5186 );
drh13449892005-09-07 21:22:45 +00005187 return i;
5188}
5189
5190/*
5191** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5192** the new element. Return a negative number if malloc fails.
5193*/
drh17435752007-08-16 04:30:38 +00005194static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005195 int i;
drhcf643722007-03-27 13:36:37 +00005196 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005197 db,
drhcf643722007-03-27 13:36:37 +00005198 pInfo->aFunc,
5199 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005200 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005201 &i
5202 );
drh13449892005-09-07 21:22:45 +00005203 return i;
5204}
drh22827922000-06-06 17:27:05 +00005205
5206/*
drh7d10d5a2008-08-20 16:35:10 +00005207** This is the xExprCallback for a tree walker. It is used to
5208** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005209** for additional information.
drh22827922000-06-06 17:27:05 +00005210*/
drh7d10d5a2008-08-20 16:35:10 +00005211static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005212 int i;
drh7d10d5a2008-08-20 16:35:10 +00005213 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005214 Parse *pParse = pNC->pParse;
5215 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005216 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005217
drh25c3b8c2018-04-16 10:34:13 +00005218 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005219 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005220 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005221 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005222 testcase( pExpr->op==TK_AGG_COLUMN );
5223 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005224 /* Check to see if the column is in one of the tables in the FROM
5225 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005226 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005227 struct SrcList_item *pItem = pSrcList->a;
5228 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5229 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005230 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005231 if( pExpr->iTable==pItem->iCursor ){
5232 /* If we reach this point, it means that pExpr refers to a table
5233 ** that is in the FROM clause of the aggregate query.
5234 **
5235 ** Make an entry for the column in pAggInfo->aCol[] if there
5236 ** is not an entry there already.
5237 */
drh7f906d62007-03-12 23:48:52 +00005238 int k;
drh13449892005-09-07 21:22:45 +00005239 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005240 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005241 if( pCol->iTable==pExpr->iTable &&
5242 pCol->iColumn==pExpr->iColumn ){
5243 break;
5244 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005245 }
danielk19771e536952007-08-16 10:09:01 +00005246 if( (k>=pAggInfo->nColumn)
5247 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5248 ){
drh7f906d62007-03-12 23:48:52 +00005249 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005250 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005251 pCol->iTable = pExpr->iTable;
5252 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005253 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005254 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005255 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005256 if( pAggInfo->pGroupBy ){
5257 int j, n;
5258 ExprList *pGB = pAggInfo->pGroupBy;
5259 struct ExprList_item *pTerm = pGB->a;
5260 n = pGB->nExpr;
5261 for(j=0; j<n; j++, pTerm++){
5262 Expr *pE = pTerm->pExpr;
5263 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5264 pE->iColumn==pExpr->iColumn ){
5265 pCol->iSorterColumn = j;
5266 break;
5267 }
5268 }
5269 }
5270 if( pCol->iSorterColumn<0 ){
5271 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5272 }
5273 }
5274 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5275 ** because it was there before or because we just created it).
5276 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5277 ** pAggInfo->aCol[] entry.
5278 */
drhebb6a652013-09-12 23:42:22 +00005279 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005280 pExpr->pAggInfo = pAggInfo;
5281 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005282 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005283 break;
5284 } /* endif pExpr->iTable==pItem->iCursor */
5285 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005286 }
drh7d10d5a2008-08-20 16:35:10 +00005287 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005288 }
5289 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005290 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005291 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005292 ){
drh13449892005-09-07 21:22:45 +00005293 /* Check to see if pExpr is a duplicate of another aggregate
5294 ** function that is already in the pAggInfo structure
5295 */
5296 struct AggInfo_func *pItem = pAggInfo->aFunc;
5297 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005298 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005299 break;
5300 }
drh22827922000-06-06 17:27:05 +00005301 }
drh13449892005-09-07 21:22:45 +00005302 if( i>=pAggInfo->nFunc ){
5303 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5304 */
danielk197714db2662006-01-09 16:12:04 +00005305 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005306 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005307 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005308 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005309 pItem = &pAggInfo->aFunc[i];
5310 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005311 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005312 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005313 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005314 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005315 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005316 if( pExpr->flags & EP_Distinct ){
5317 pItem->iDistinct = pParse->nTab++;
5318 }else{
5319 pItem->iDistinct = -1;
5320 }
drh13449892005-09-07 21:22:45 +00005321 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005322 }
drh13449892005-09-07 21:22:45 +00005323 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5324 */
drhc5cd1242013-09-12 16:50:49 +00005325 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005326 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005327 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005328 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005329 return WRC_Prune;
5330 }else{
5331 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005332 }
drh22827922000-06-06 17:27:05 +00005333 }
5334 }
drh7d10d5a2008-08-20 16:35:10 +00005335 return WRC_Continue;
5336}
5337static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005338 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005339 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005340 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005341}
drh979dd1b2017-05-29 14:26:07 +00005342static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5343 UNUSED_PARAMETER(pSelect);
5344 pWalker->walkerDepth--;
5345}
drh626a8792005-01-17 22:08:19 +00005346
5347/*
drhe8abb4c2012-11-02 18:24:57 +00005348** Analyze the pExpr expression looking for aggregate functions and
5349** for variables that need to be added to AggInfo object that pNC->pAggInfo
5350** points to. Additional entries are made on the AggInfo object as
5351** necessary.
drh626a8792005-01-17 22:08:19 +00005352**
5353** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005354** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005355*/
drhd2b3e232008-01-23 14:51:49 +00005356void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005357 Walker w;
5358 w.xExprCallback = analyzeAggregate;
5359 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005360 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5361 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005362 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00005363 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005364 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005365}
drh5d9a4af2005-08-30 00:54:01 +00005366
5367/*
5368** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5369** expression list. Return the number of errors.
5370**
5371** If an error is found, the analysis is cut short.
5372*/
drhd2b3e232008-01-23 14:51:49 +00005373void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005374 struct ExprList_item *pItem;
5375 int i;
drh5d9a4af2005-08-30 00:54:01 +00005376 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005377 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5378 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005379 }
5380 }
drh5d9a4af2005-08-30 00:54:01 +00005381}
drh892d3172008-01-10 03:46:36 +00005382
5383/*
drhceea3322009-04-23 13:22:42 +00005384** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005385*/
5386int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005387 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005388 return ++pParse->nMem;
5389 }
danielk19772f425f62008-07-04 09:41:39 +00005390 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005391}
drhceea3322009-04-23 13:22:42 +00005392
5393/*
5394** Deallocate a register, making available for reuse for some other
5395** purpose.
drhceea3322009-04-23 13:22:42 +00005396*/
drh892d3172008-01-10 03:46:36 +00005397void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005398 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005399 pParse->aTempReg[pParse->nTempReg++] = iReg;
5400 }
5401}
5402
5403/*
drhed24da42016-09-06 14:37:05 +00005404** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005405*/
5406int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005407 int i, n;
drhed24da42016-09-06 14:37:05 +00005408 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005409 i = pParse->iRangeReg;
5410 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005411 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005412 pParse->iRangeReg += nReg;
5413 pParse->nRangeReg -= nReg;
5414 }else{
5415 i = pParse->nMem+1;
5416 pParse->nMem += nReg;
5417 }
5418 return i;
5419}
5420void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005421 if( nReg==1 ){
5422 sqlite3ReleaseTempReg(pParse, iReg);
5423 return;
5424 }
drh892d3172008-01-10 03:46:36 +00005425 if( nReg>pParse->nRangeReg ){
5426 pParse->nRangeReg = nReg;
5427 pParse->iRangeReg = iReg;
5428 }
5429}
drhcdc69552011-12-06 13:24:59 +00005430
5431/*
5432** Mark all temporary registers as being unavailable for reuse.
5433*/
5434void sqlite3ClearTempRegCache(Parse *pParse){
5435 pParse->nTempReg = 0;
5436 pParse->nRangeReg = 0;
5437}
drhbb9b5f22016-03-19 00:35:02 +00005438
5439/*
5440** Validate that no temporary register falls within the range of
5441** iFirst..iLast, inclusive. This routine is only call from within assert()
5442** statements.
5443*/
5444#ifdef SQLITE_DEBUG
5445int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5446 int i;
5447 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005448 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5449 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005450 ){
5451 return 0;
5452 }
5453 for(i=0; i<pParse->nTempReg; i++){
5454 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5455 return 0;
5456 }
5457 }
5458 return 1;
5459}
5460#endif /* SQLITE_DEBUG */