blob: 0b2e797752a05dcbb5b642235882518cb87d8738 [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;
drha58d4a92015-01-27 13:17:05 +0000144 if( (op==TK_AGG_COLUMN || op==TK_COLUMN
drhae80dde2012-12-06 21:16:43 +0000145 || op==TK_REGISTER || 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 }
161 if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
162 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 ){
484 reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
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;
556 int addrDone = sqlite3VdbeMakeLabel(v);
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]) ){
783 if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
drh33e619f2009-05-28 01:00:55 +0000784 sqlite3Dequote(pNew->u.zToken);
drh33e619f2009-05-28 01:00:55 +0000785 }
drhb7916a72009-05-27 10:31:29 +0000786 }
787 }
788#if SQLITE_MAX_EXPR_DEPTH>0
789 pNew->nHeight = 1;
790#endif
791 }
drha76b5df2002-02-23 02:32:10 +0000792 return pNew;
793}
794
795/*
drhb7916a72009-05-27 10:31:29 +0000796** Allocate a new expression node from a zero-terminated token that has
797** already been dequoted.
798*/
799Expr *sqlite3Expr(
800 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
801 int op, /* Expression opcode */
802 const char *zToken /* Token argument. Might be NULL */
803){
804 Token x;
805 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000806 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000807 return sqlite3ExprAlloc(db, op, &x, 0);
808}
809
810/*
811** Attach subtrees pLeft and pRight to the Expr node pRoot.
812**
813** If pRoot==NULL that means that a memory allocation error has occurred.
814** In that case, delete the subtrees pLeft and pRight.
815*/
816void sqlite3ExprAttachSubtrees(
817 sqlite3 *db,
818 Expr *pRoot,
819 Expr *pLeft,
820 Expr *pRight
821){
822 if( pRoot==0 ){
823 assert( db->mallocFailed );
824 sqlite3ExprDelete(db, pLeft);
825 sqlite3ExprDelete(db, pRight);
826 }else{
827 if( pRight ){
828 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000829 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000830 }
831 if( pLeft ){
832 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 exprSetHeight(pRoot);
836 }
837}
838
839/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000840** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000841**
drhbf664462009-06-19 18:32:54 +0000842** One or both of the subtrees can be NULL. Return a pointer to the new
843** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
844** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000845*/
drh17435752007-08-16 04:30:38 +0000846Expr *sqlite3PExpr(
847 Parse *pParse, /* Parsing context */
848 int op, /* Expression opcode */
849 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000850 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000851){
drh5fb52ca2012-03-31 02:34:35 +0000852 Expr *p;
drh1167d322015-10-28 20:01:45 +0000853 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000854 /* Take advantage of short-circuit false optimization for AND */
855 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
856 }else{
drhabfd35e2016-12-06 22:47:23 +0000857 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858 if( p ){
859 memset(p, 0, sizeof(Expr));
860 p->op = op & TKFLG_MASK;
861 p->iAgg = -1;
862 }
drh5fb52ca2012-03-31 02:34:35 +0000863 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
864 }
dan2b359bd2010-10-28 11:31:23 +0000865 if( p ) {
866 sqlite3ExprCheckHeight(pParse, p->nHeight);
867 }
drh4e0cff62004-11-05 05:10:28 +0000868 return p;
869}
870
871/*
drh08de4f72016-04-11 01:06:47 +0000872** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
873** do a memory allocation failure) then delete the pSelect object.
874*/
875void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
876 if( pExpr ){
877 pExpr->x.pSelect = pSelect;
878 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
879 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
880 }else{
881 assert( pParse->db->mallocFailed );
882 sqlite3SelectDelete(pParse->db, pSelect);
883 }
884}
885
886
887/*
drh991a1982014-01-02 17:57:16 +0000888** If the expression is always either TRUE or FALSE (respectively),
889** then return 1. If one cannot determine the truth value of the
890** expression at compile-time return 0.
891**
892** This is an optimization. If is OK to return 0 here even if
893** the expression really is always false or false (a false negative).
894** But it is a bug to return 1 if the expression might have different
895** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000896**
897** Note that if the expression is part of conditional for a
898** LEFT JOIN, then we cannot determine at compile-time whether or not
899** is it true or false, so always return 0.
900*/
drh991a1982014-01-02 17:57:16 +0000901static int exprAlwaysTrue(Expr *p){
902 int v = 0;
903 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
904 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
905 return v!=0;
906}
drh5fb52ca2012-03-31 02:34:35 +0000907static int exprAlwaysFalse(Expr *p){
908 int v = 0;
909 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
910 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
911 return v==0;
912}
913
914/*
drh91bb0ee2004-09-01 03:06:34 +0000915** Join two expressions using an AND operator. If either expression is
916** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000917**
918** If one side or the other of the AND is known to be false, then instead
919** of returning an AND expression, just return a constant expression with
920** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000921*/
danielk19771e536952007-08-16 10:09:01 +0000922Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000923 if( pLeft==0 ){
924 return pRight;
925 }else if( pRight==0 ){
926 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000927 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
928 sqlite3ExprDelete(db, pLeft);
929 sqlite3ExprDelete(db, pRight);
930 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000931 }else{
drhb7916a72009-05-27 10:31:29 +0000932 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
933 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
934 return pNew;
drha76b5df2002-02-23 02:32:10 +0000935 }
936}
937
938/*
939** Construct a new expression node for a function with multiple
940** arguments.
941*/
drh954733b2018-07-27 23:33:16 +0000942Expr *sqlite3ExprFunction(
943 Parse *pParse, /* Parsing context */
944 ExprList *pList, /* Argument list */
945 Token *pToken, /* Name of the function */
946 int eDistinct /* SF_Distinct or SF_ALL or 0 */
947){
drha76b5df2002-02-23 02:32:10 +0000948 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000949 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000950 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000951 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000952 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000953 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000954 return 0;
955 }
drh954733b2018-07-27 23:33:16 +0000956 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
957 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
958 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000959 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000960 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000961 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000962 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000963 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000964 return pNew;
965}
966
967/*
drhfa6bc002004-09-07 16:19:52 +0000968** Assign a variable number to an expression that encodes a wildcard
969** in the original SQL statement.
970**
971** Wildcards consisting of a single "?" are assigned the next sequential
972** variable number.
973**
974** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000975** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000976** the SQL statement comes from an external source.
977**
drh51f49f12009-05-21 20:41:32 +0000978** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000979** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000980** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000981** assigned.
982*/
drhde25a882016-10-03 15:28:24 +0000983void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000984 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000985 const char *z;
drhf326d662016-12-23 13:30:53 +0000986 ynVar x;
drh17435752007-08-16 04:30:38 +0000987
drhfa6bc002004-09-07 16:19:52 +0000988 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000989 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000990 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000991 assert( z!=0 );
992 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000993 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000994 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000995 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000996 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000997 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000998 }else{
drhf326d662016-12-23 13:30:53 +0000999 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001000 if( z[0]=='?' ){
1001 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1002 ** use it as the variable number */
1003 i64 i;
drh18814df2017-01-31 03:52:34 +00001004 int bOk;
1005 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1006 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1007 bOk = 1;
1008 }else{
1009 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1010 }
drh124c0b42011-06-01 18:15:55 +00001011 testcase( i==0 );
1012 testcase( i==1 );
1013 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1014 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1015 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1017 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001018 return;
drhfa6bc002004-09-07 16:19:52 +00001019 }
drh8e74e7b2017-01-31 12:41:48 +00001020 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001021 if( x>pParse->nVar ){
1022 pParse->nVar = (int)x;
1023 doAdd = 1;
1024 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1025 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001026 }
1027 }else{
1028 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1029 ** number as the prior appearance of the same name, or if the name
1030 ** has never appeared before, reuse the same variable number
1031 */
drh9bf755c2016-12-23 03:59:31 +00001032 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1033 if( x==0 ){
1034 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001035 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001036 }
drhfa6bc002004-09-07 16:19:52 +00001037 }
drhf326d662016-12-23 13:30:53 +00001038 if( doAdd ){
1039 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1040 }
1041 }
1042 pExpr->iColumn = x;
1043 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001044 sqlite3ErrorMsg(pParse, "too many SQL variables");
1045 }
drhfa6bc002004-09-07 16:19:52 +00001046}
1047
1048/*
danf6963f92009-11-23 14:39:14 +00001049** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001050*/
drh4f0010b2016-04-11 14:49:39 +00001051static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1052 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001053 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1054 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001055
1056 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1057 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1058 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001059#ifdef SQLITE_DEBUG
1060 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1061 assert( p->pLeft==0 );
1062 assert( p->pRight==0 );
1063 assert( p->x.pSelect==0 );
1064 }
1065#endif
1066 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001067 /* The Expr.x union is never used at the same time as Expr.pRight */
1068 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001069 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001070 if( p->pRight ){
1071 sqlite3ExprDeleteNN(db, p->pRight);
1072 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001073 sqlite3SelectDelete(db, p->x.pSelect);
1074 }else{
1075 sqlite3ExprListDelete(db, p->x.pList);
1076 }
drheda079c2018-09-20 19:02:15 +00001077 if( ExprHasProperty(p, EP_WinFunc) ){
1078 assert( p->op==TK_FUNCTION );
1079 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001080 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001081 }
drh209bc522016-09-23 21:36:24 +00001082 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001083 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001084 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001085 }
drha2e00042002-01-22 03:13:42 +00001086}
drh4f0010b2016-04-11 14:49:39 +00001087void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1088 if( p ) sqlite3ExprDeleteNN(db, p);
1089}
drha2e00042002-01-22 03:13:42 +00001090
drhd2687b72005-08-12 22:56:09 +00001091/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001092** Return the number of bytes allocated for the expression structure
1093** passed as the first argument. This is always one of EXPR_FULLSIZE,
1094** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1095*/
1096static int exprStructSize(Expr *p){
1097 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001098 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1099 return EXPR_FULLSIZE;
1100}
1101
1102/*
drh33e619f2009-05-28 01:00:55 +00001103** The dupedExpr*Size() routines each return the number of bytes required
1104** to store a copy of an expression or expression tree. They differ in
1105** how much of the tree is measured.
1106**
1107** dupedExprStructSize() Size of only the Expr structure
1108** dupedExprNodeSize() Size of Expr + space for token
1109** dupedExprSize() Expr + token + subtree components
1110**
1111***************************************************************************
1112**
1113** The dupedExprStructSize() function returns two values OR-ed together:
1114** (1) the space required for a copy of the Expr structure only and
1115** (2) the EP_xxx flags that indicate what the structure size should be.
1116** The return values is always one of:
1117**
1118** EXPR_FULLSIZE
1119** EXPR_REDUCEDSIZE | EP_Reduced
1120** EXPR_TOKENONLYSIZE | EP_TokenOnly
1121**
1122** The size of the structure can be found by masking the return value
1123** of this routine with 0xfff. The flags can be found by masking the
1124** return value with EP_Reduced|EP_TokenOnly.
1125**
1126** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1127** (unreduced) Expr objects as they or originally constructed by the parser.
1128** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001129** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001130** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001131** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001132** to reduce a pristine expression tree from the parser. The implementation
1133** of dupedExprStructSize() contain multiple assert() statements that attempt
1134** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001135*/
1136static int dupedExprStructSize(Expr *p, int flags){
1137 int nSize;
drh33e619f2009-05-28 01:00:55 +00001138 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001139 assert( EXPR_FULLSIZE<=0xfff );
1140 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001141 if( 0==flags || p->op==TK_SELECT_COLUMN
1142#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001143 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001144#endif
1145 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001146 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001147 }else{
drhc5cd1242013-09-12 16:50:49 +00001148 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001149 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001150 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001151 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001152 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001153 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1154 }else{
drhaecd8022013-09-13 18:15:15 +00001155 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001156 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1157 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001158 }
1159 return nSize;
1160}
1161
1162/*
drh33e619f2009-05-28 01:00:55 +00001163** This function returns the space in bytes required to store the copy
1164** of the Expr structure and a copy of the Expr.u.zToken string (if that
1165** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001166*/
1167static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001168 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1169 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001170 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001171 }
danielk1977bc739712009-03-23 04:33:32 +00001172 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001173}
1174
1175/*
1176** Return the number of bytes required to create a duplicate of the
1177** expression passed as the first argument. The second argument is a
1178** mask containing EXPRDUP_XXX flags.
1179**
1180** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001181** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001182**
1183** If the EXPRDUP_REDUCE flag is set, then the return value includes
1184** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1185** and Expr.pRight variables (but not for any structures pointed to or
1186** descended from the Expr.x.pList or Expr.x.pSelect variables).
1187*/
1188static int dupedExprSize(Expr *p, int flags){
1189 int nByte = 0;
1190 if( p ){
1191 nByte = dupedExprNodeSize(p, flags);
1192 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001193 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001194 }
1195 }
1196 return nByte;
1197}
1198
1199/*
1200** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1201** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001202** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001203** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001204** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001205** portion of the buffer copied into by this function.
1206*/
drh3c194692016-04-11 16:43:43 +00001207static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1208 Expr *pNew; /* Value to return */
1209 u8 *zAlloc; /* Memory space from which to build Expr object */
1210 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1211
drh575fad62016-02-05 13:38:36 +00001212 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001213 assert( p );
1214 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1215 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001216
drh3c194692016-04-11 16:43:43 +00001217 /* Figure out where to write the new Expr structure. */
1218 if( pzBuffer ){
1219 zAlloc = *pzBuffer;
1220 staticFlag = EP_Static;
1221 }else{
1222 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1223 staticFlag = 0;
1224 }
1225 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001226
drh3c194692016-04-11 16:43:43 +00001227 if( pNew ){
1228 /* Set nNewSize to the size allocated for the structure pointed to
1229 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1230 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1231 ** by the copy of the p->u.zToken string (if any).
1232 */
1233 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1234 const int nNewSize = nStructSize & 0xfff;
1235 int nToken;
1236 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1237 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001238 }else{
drh3c194692016-04-11 16:43:43 +00001239 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001240 }
drh3c194692016-04-11 16:43:43 +00001241 if( dupFlags ){
1242 assert( ExprHasProperty(p, EP_Reduced)==0 );
1243 memcpy(zAlloc, p, nNewSize);
1244 }else{
1245 u32 nSize = (u32)exprStructSize(p);
1246 memcpy(zAlloc, p, nSize);
1247 if( nSize<EXPR_FULLSIZE ){
1248 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1249 }
1250 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001251
drh3c194692016-04-11 16:43:43 +00001252 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1253 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1254 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1255 pNew->flags |= staticFlag;
1256
1257 /* Copy the p->u.zToken string, if any. */
1258 if( nToken ){
1259 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1260 memcpy(zToken, p->u.zToken, nToken);
1261 }
1262
drh209bc522016-09-23 21:36:24 +00001263 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001264 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1265 if( ExprHasProperty(p, EP_xIsSelect) ){
1266 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001267 }else{
drh3c194692016-04-11 16:43:43 +00001268 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001269 }
drh3c194692016-04-11 16:43:43 +00001270 }
1271
1272 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001273 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1274 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001275 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001276 pNew->pLeft = p->pLeft ?
1277 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1278 pNew->pRight = p->pRight ?
1279 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001280 }
dan67a9b8e2018-06-22 20:51:35 +00001281#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001282 if( ExprHasProperty(p, EP_WinFunc) ){
1283 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1284 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001285 }
dan67a9b8e2018-06-22 20:51:35 +00001286#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001287 if( pzBuffer ){
1288 *pzBuffer = zAlloc;
1289 }
1290 }else{
drh209bc522016-09-23 21:36:24 +00001291 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001292 if( pNew->op==TK_SELECT_COLUMN ){
1293 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001294 assert( p->iColumn==0 || p->pRight==0 );
1295 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001296 }else{
1297 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1298 }
drh3c194692016-04-11 16:43:43 +00001299 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001300 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001301 }
1302 }
1303 return pNew;
1304}
1305
1306/*
danbfe31e72014-01-15 14:17:31 +00001307** Create and return a deep copy of the object passed as the second
1308** argument. If an OOM condition is encountered, NULL is returned
1309** and the db->mallocFailed flag set.
1310*/
daneede6a52014-01-15 19:42:23 +00001311#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001312static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001313 With *pRet = 0;
1314 if( p ){
1315 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
1316 pRet = sqlite3DbMallocZero(db, nByte);
1317 if( pRet ){
1318 int i;
1319 pRet->nCte = p->nCte;
1320 for(i=0; i<p->nCte; i++){
1321 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1322 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1323 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1324 }
1325 }
1326 }
1327 return pRet;
1328}
daneede6a52014-01-15 19:42:23 +00001329#else
1330# define withDup(x,y) 0
1331#endif
dan4e9119d2014-01-13 15:12:23 +00001332
drha8389972018-12-06 22:04:19 +00001333#ifndef SQLITE_OMIT_WINDOWFUNC
1334/*
1335** The gatherSelectWindows() procedure and its helper routine
1336** gatherSelectWindowsCallback() are used to scan all the expressions
1337** an a newly duplicated SELECT statement and gather all of the Window
1338** objects found there, assembling them onto the linked list at Select->pWin.
1339*/
1340static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1341 if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1342 assert( ExprHasProperty(pExpr, EP_WinFunc) );
1343 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1344 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1345 }
1346 return WRC_Continue;
1347}
drha37b6a52018-12-06 22:12:18 +00001348static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1349 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1350}
drha8389972018-12-06 22:04:19 +00001351static void gatherSelectWindows(Select *p){
1352 Walker w;
1353 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001354 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1355 w.xSelectCallback2 = 0;
drha8389972018-12-06 22:04:19 +00001356 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001357 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001358}
1359#endif
1360
1361
drha76b5df2002-02-23 02:32:10 +00001362/*
drhff78bd22002-02-27 01:47:11 +00001363** The following group of routines make deep copies of expressions,
1364** expression lists, ID lists, and select statements. The copies can
1365** be deleted (by being passed to their respective ...Delete() routines)
1366** without effecting the originals.
1367**
danielk19774adee202004-05-08 08:23:19 +00001368** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1369** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001370** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001371**
drhad3cab52002-05-24 02:04:32 +00001372** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001373**
drhb7916a72009-05-27 10:31:29 +00001374** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001375** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1376** truncated version of the usual Expr structure that will be stored as
1377** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001378*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001379Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001380 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001381 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001382}
danielk19776ab3a2e2009-02-19 14:39:25 +00001383ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001384 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001385 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001386 int i;
drhb1637482017-01-03 00:27:16 +00001387 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001388 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001389 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001390 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001391 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001392 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001393 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001394 pOldItem = p->a;
1395 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001396 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001397 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001398 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001399 if( pOldExpr
1400 && pOldExpr->op==TK_SELECT_COLUMN
1401 && (pNewExpr = pItem->pExpr)!=0
1402 ){
1403 assert( pNewExpr->iColumn==0 || i>0 );
1404 if( pNewExpr->iColumn==0 ){
1405 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001406 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1407 }else{
1408 assert( i>0 );
1409 assert( pItem[-1].pExpr!=0 );
1410 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1411 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1412 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001413 }
1414 }
drh17435752007-08-16 04:30:38 +00001415 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001416 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001417 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001418 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001419 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001420 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001421 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001422 }
1423 return pNew;
1424}
danielk197793758c82005-01-21 08:13:14 +00001425
1426/*
1427** If cursors, triggers, views and subqueries are all omitted from
1428** the build, then none of the following routines, except for
1429** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1430** called with a NULL argument.
1431*/
danielk19776a67fe82005-02-04 04:07:16 +00001432#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1433 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001434SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001435 SrcList *pNew;
1436 int i;
drh113088e2003-03-20 01:16:58 +00001437 int nByte;
drh575fad62016-02-05 13:38:36 +00001438 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001439 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001440 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001441 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001442 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001443 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001444 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001445 struct SrcList_item *pNewItem = &pNew->a[i];
1446 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001447 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001448 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001449 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1450 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1451 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001452 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001453 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001454 pNewItem->addrFillSub = pOldItem->addrFillSub;
1455 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001456 if( pNewItem->fg.isIndexedBy ){
1457 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1458 }
1459 pNewItem->pIBIndex = pOldItem->pIBIndex;
1460 if( pNewItem->fg.isTabFunc ){
1461 pNewItem->u1.pFuncArg =
1462 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1463 }
drhed8a3bb2005-06-06 21:19:56 +00001464 pTab = pNewItem->pTab = pOldItem->pTab;
1465 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001466 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001467 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001468 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1469 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001470 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001471 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001472 }
1473 return pNew;
1474}
drh17435752007-08-16 04:30:38 +00001475IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001476 IdList *pNew;
1477 int i;
drh575fad62016-02-05 13:38:36 +00001478 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001479 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001480 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001481 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001482 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001483 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001484 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001485 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001486 return 0;
1487 }
drh6c535152012-02-02 03:38:30 +00001488 /* Note that because the size of the allocation for p->a[] is not
1489 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1490 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001491 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001492 struct IdList_item *pNewItem = &pNew->a[i];
1493 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001494 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001495 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001496 }
1497 return pNew;
1498}
dana7466202017-02-03 14:44:52 +00001499Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1500 Select *pRet = 0;
1501 Select *pNext = 0;
1502 Select **pp = &pRet;
1503 Select *p;
1504
drh575fad62016-02-05 13:38:36 +00001505 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001506 for(p=pDup; p; p=p->pPrior){
1507 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1508 if( pNew==0 ) break;
1509 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1510 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1511 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1512 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1513 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1514 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1515 pNew->op = p->op;
1516 pNew->pNext = pNext;
1517 pNew->pPrior = 0;
1518 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001519 pNew->iLimit = 0;
1520 pNew->iOffset = 0;
1521 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1522 pNew->addrOpenEphm[0] = -1;
1523 pNew->addrOpenEphm[1] = -1;
1524 pNew->nSelectRow = p->nSelectRow;
1525 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001526#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001527 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001528 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001529 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001530#endif
drhfef37762018-07-10 19:48:35 +00001531 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001532 *pp = pNew;
1533 pp = &pNew->pPrior;
1534 pNext = pNew;
1535 }
1536
1537 return pRet;
drhff78bd22002-02-27 01:47:11 +00001538}
danielk197793758c82005-01-21 08:13:14 +00001539#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001540Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001541 assert( p==0 );
1542 return 0;
1543}
1544#endif
drhff78bd22002-02-27 01:47:11 +00001545
1546
1547/*
drha76b5df2002-02-23 02:32:10 +00001548** Add a new element to the end of an expression list. If pList is
1549** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001550**
drha19543f2017-09-15 15:17:48 +00001551** The pList argument must be either NULL or a pointer to an ExprList
1552** obtained from a prior call to sqlite3ExprListAppend(). This routine
1553** may not be used with an ExprList obtained from sqlite3ExprListDup().
1554** Reason: This routine assumes that the number of slots in pList->a[]
1555** is a power of two. That is true for sqlite3ExprListAppend() returns
1556** but is not necessarily true from the return value of sqlite3ExprListDup().
1557**
drhb7916a72009-05-27 10:31:29 +00001558** If a memory allocation error occurs, the entire list is freed and
1559** NULL is returned. If non-NULL is returned, then it is guaranteed
1560** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001561*/
drh17435752007-08-16 04:30:38 +00001562ExprList *sqlite3ExprListAppend(
1563 Parse *pParse, /* Parsing context */
1564 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001565 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001566){
drh43606172017-04-05 11:32:13 +00001567 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001568 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001569 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001570 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001571 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001572 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001573 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001574 }
drhc263f7c2016-01-18 13:18:54 +00001575 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001576 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001577 ExprList *pNew;
1578 pNew = sqlite3DbRealloc(db, pList,
drha19543f2017-09-15 15:17:48 +00001579 sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001580 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001581 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001582 }
drh43606172017-04-05 11:32:13 +00001583 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001584 }
drh43606172017-04-05 11:32:13 +00001585 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001586 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1587 assert( offsetof(struct ExprList_item,pExpr)==0 );
1588 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001589 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001590 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001591
1592no_mem:
1593 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001594 sqlite3ExprDelete(db, pExpr);
1595 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001596 return 0;
drha76b5df2002-02-23 02:32:10 +00001597}
1598
1599/*
drh8762ec12016-08-20 01:06:22 +00001600** pColumns and pExpr form a vector assignment which is part of the SET
1601** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001602**
1603** (a,b,c) = (expr1,expr2,expr3)
1604** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1605**
1606** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001607** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001608** TK_SELECT_COLUMN expressions.
1609*/
1610ExprList *sqlite3ExprListAppendVector(
1611 Parse *pParse, /* Parsing context */
1612 ExprList *pList, /* List to which to append. Might be NULL */
1613 IdList *pColumns, /* List of names of LHS of the assignment */
1614 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1615){
1616 sqlite3 *db = pParse->db;
1617 int n;
1618 int i;
drh66860af2016-08-23 18:30:10 +00001619 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001620 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1621 ** exit prior to this routine being invoked */
1622 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001623 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001624
1625 /* If the RHS is a vector, then we can immediately check to see that
1626 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1627 ** wildcards ("*") in the result set of the SELECT must be expanded before
1628 ** we can do the size check, so defer the size check until code generation.
1629 */
1630 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001631 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1632 pColumns->nId, n);
1633 goto vector_append_error;
1634 }
drh966e2912017-01-03 02:58:01 +00001635
1636 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001637 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1638 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1639 if( pList ){
drh66860af2016-08-23 18:30:10 +00001640 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001641 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1642 pColumns->a[i].zName = 0;
1643 }
1644 }
drh966e2912017-01-03 02:58:01 +00001645
drhffe28052017-05-06 18:09:36 +00001646 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001647 Expr *pFirst = pList->a[iFirst].pExpr;
1648 assert( pFirst!=0 );
1649 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001650
drhf4dd26c2017-04-05 11:49:06 +00001651 /* Store the SELECT statement in pRight so it will be deleted when
1652 ** sqlite3ExprListDelete() is called */
1653 pFirst->pRight = pExpr;
1654 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001655
drhf4dd26c2017-04-05 11:49:06 +00001656 /* Remember the size of the LHS in iTable so that we can check that
1657 ** the RHS and LHS sizes match during code generation. */
1658 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001659 }
1660
1661vector_append_error:
1662 sqlite3ExprDelete(db, pExpr);
1663 sqlite3IdListDelete(db, pColumns);
1664 return pList;
1665}
1666
1667/*
drhbc622bc2015-08-24 15:39:42 +00001668** Set the sort order for the last element on the given ExprList.
1669*/
1670void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1671 if( p==0 ) return;
1672 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1673 assert( p->nExpr>0 );
1674 if( iSortOrder<0 ){
1675 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1676 return;
1677 }
1678 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001679}
1680
1681/*
drhb7916a72009-05-27 10:31:29 +00001682** Set the ExprList.a[].zName element of the most recently added item
1683** on the expression list.
1684**
1685** pList might be NULL following an OOM error. But pName should never be
1686** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1687** is set.
1688*/
1689void sqlite3ExprListSetName(
1690 Parse *pParse, /* Parsing context */
1691 ExprList *pList, /* List to which to add the span. */
1692 Token *pName, /* Name to be added */
1693 int dequote /* True to cause the name to be dequoted */
1694){
1695 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1696 if( pList ){
1697 struct ExprList_item *pItem;
1698 assert( pList->nExpr>0 );
1699 pItem = &pList->a[pList->nExpr-1];
1700 assert( pItem->zName==0 );
1701 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001702 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001703 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001704 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001705 }
drhb7916a72009-05-27 10:31:29 +00001706 }
1707}
1708
1709/*
1710** Set the ExprList.a[].zSpan element of the most recently added item
1711** on the expression list.
1712**
1713** pList might be NULL following an OOM error. But pSpan should never be
1714** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1715** is set.
1716*/
1717void sqlite3ExprListSetSpan(
1718 Parse *pParse, /* Parsing context */
1719 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001720 const char *zStart, /* Start of the span */
1721 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001722){
1723 sqlite3 *db = pParse->db;
1724 assert( pList!=0 || db->mallocFailed!=0 );
1725 if( pList ){
1726 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1727 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001728 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001729 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001730 }
1731}
1732
1733/*
danielk19777a15a4b2007-05-08 17:54:43 +00001734** If the expression list pEList contains more than iLimit elements,
1735** leave an error message in pParse.
1736*/
1737void sqlite3ExprListCheckLength(
1738 Parse *pParse,
1739 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001740 const char *zObject
1741){
drhb1a6c3c2008-03-20 16:30:17 +00001742 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001743 testcase( pEList && pEList->nExpr==mx );
1744 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001745 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001746 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1747 }
1748}
1749
1750/*
drha76b5df2002-02-23 02:32:10 +00001751** Delete an entire expression list.
1752*/
drhaffa8552016-04-11 18:25:05 +00001753static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001754 int i = pList->nExpr;
1755 struct ExprList_item *pItem = pList->a;
1756 assert( pList->nExpr>0 );
1757 do{
drh633e6d52008-07-28 19:34:53 +00001758 sqlite3ExprDelete(db, pItem->pExpr);
1759 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001760 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001761 pItem++;
1762 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001763 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001764}
drhaffa8552016-04-11 18:25:05 +00001765void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1766 if( pList ) exprListDeleteNN(db, pList);
1767}
drha76b5df2002-02-23 02:32:10 +00001768
1769/*
drh2308ed32015-02-09 16:09:34 +00001770** Return the bitwise-OR of all Expr.flags fields in the given
1771** ExprList.
drh885a5b02015-02-09 15:21:36 +00001772*/
drh2308ed32015-02-09 16:09:34 +00001773u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001774 int i;
drh2308ed32015-02-09 16:09:34 +00001775 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001776 assert( pList!=0 );
1777 for(i=0; i<pList->nExpr; i++){
1778 Expr *pExpr = pList->a[i].pExpr;
1779 assert( pExpr!=0 );
1780 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001781 }
drh2308ed32015-02-09 16:09:34 +00001782 return m;
drh885a5b02015-02-09 15:21:36 +00001783}
1784
1785/*
drh7e6f9802017-09-04 00:33:04 +00001786** This is a SELECT-node callback for the expression walker that
1787** always "fails". By "fail" in this case, we mean set
1788** pWalker->eCode to zero and abort.
1789**
1790** This callback is used by multiple expression walkers.
1791*/
1792int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1793 UNUSED_PARAMETER(NotUsed);
1794 pWalker->eCode = 0;
1795 return WRC_Abort;
1796}
1797
1798/*
drh171d16b2018-02-26 20:15:54 +00001799** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001800** then convert it into an TK_TRUEFALSE term. Return non-zero if
1801** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001802*/
1803int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1804 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1805 if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1806 || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1807 ){
1808 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001809 return 1;
1810 }
1811 return 0;
1812}
1813
drh43c4ac82018-02-26 21:26:27 +00001814/*
drh96acafb2018-02-27 14:49:25 +00001815** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001816** and 0 if it is FALSE.
1817*/
drh96acafb2018-02-27 14:49:25 +00001818int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001819 assert( pExpr->op==TK_TRUEFALSE );
1820 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1821 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1822 return pExpr->u.zToken[4]==0;
1823}
1824
drh171d16b2018-02-26 20:15:54 +00001825
1826/*
drh059b2d52014-10-24 19:28:09 +00001827** These routines are Walker callbacks used to check expressions to
1828** see if they are "constant" for some definition of constant. The
1829** Walker.eCode value determines the type of "constant" we are looking
1830** for.
drh73b211a2005-01-18 04:00:42 +00001831**
drh7d10d5a2008-08-20 16:35:10 +00001832** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001833**
drh059b2d52014-10-24 19:28:09 +00001834** sqlite3ExprIsConstant() pWalker->eCode==1
1835** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001836** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001837** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001838**
drh059b2d52014-10-24 19:28:09 +00001839** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1840** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001841**
drhfeada2d2014-09-24 13:20:22 +00001842** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001843** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1844** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001845** parameter raises an error for new statements, but is silently converted
1846** to NULL for existing schemas. This allows sqlite_master tables that
1847** contain a bound parameter because they were generated by older versions
1848** of SQLite to be parsed by newer versions of SQLite without raising a
1849** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001850*/
drh7d10d5a2008-08-20 16:35:10 +00001851static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001852
drh059b2d52014-10-24 19:28:09 +00001853 /* If pWalker->eCode is 2 then any term of the expression that comes from
1854 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001855 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001856 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1857 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001858 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001859 }
1860
drh626a8792005-01-17 22:08:19 +00001861 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001862 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001863 ** and either pWalker->eCode==4 or 5 or the function has the
1864 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001865 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001866 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001867 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001868 }else{
1869 pWalker->eCode = 0;
1870 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001871 }
drh626a8792005-01-17 22:08:19 +00001872 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001873 /* Convert "true" or "false" in a DEFAULT clause into the
1874 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001875 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001876 return WRC_Prune;
1877 }
1878 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001879 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001880 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001881 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001882 testcase( pExpr->op==TK_ID );
1883 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001884 testcase( pExpr->op==TK_AGG_FUNCTION );
1885 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001886 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001887 return WRC_Continue;
1888 }
drh059b2d52014-10-24 19:28:09 +00001889 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1890 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001891 }
drhf43ce0b2017-05-25 00:08:48 +00001892 /* Fall through */
1893 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001894 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001895 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001896 testcase( pExpr->op==TK_IF_NULL_ROW );
1897 pWalker->eCode = 0;
1898 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001899 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001900 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001901 /* Silently convert bound parameters that appear inside of CREATE
1902 ** statements into a NULL when parsing the CREATE statement text out
1903 ** of the sqlite_master table */
1904 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001905 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001906 /* A bound parameter in a CREATE statement that originates from
1907 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001908 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001909 return WRC_Abort;
1910 }
1911 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001912 default:
drh6e341b92018-04-17 18:50:40 +00001913 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1914 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001915 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001916 }
1917}
drh059b2d52014-10-24 19:28:09 +00001918static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001919 Walker w;
drh059b2d52014-10-24 19:28:09 +00001920 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001921 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001922 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001923#ifdef SQLITE_DEBUG
1924 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1925#endif
drh059b2d52014-10-24 19:28:09 +00001926 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001927 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001928 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001929}
drh626a8792005-01-17 22:08:19 +00001930
1931/*
drh059b2d52014-10-24 19:28:09 +00001932** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001933** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001934**
1935** For the purposes of this function, a double-quoted string (ex: "abc")
1936** is considered a variable but a single-quoted string (ex: 'abc') is
1937** a constant.
drhfef52082000-06-06 01:50:43 +00001938*/
danielk19774adee202004-05-08 08:23:19 +00001939int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001940 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001941}
1942
1943/*
drh07aded62018-07-28 16:24:08 +00001944** Walk an expression tree. Return non-zero if
1945**
1946** (1) the expression is constant, and
1947** (2) the expression does originate in the ON or USING clause
1948** of a LEFT JOIN, and
1949** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1950** operands created by the constant propagation optimization.
1951**
1952** When this routine returns true, it indicates that the expression
1953** can be added to the pParse->pConstExpr list and evaluated once when
1954** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001955*/
1956int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001957 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001958}
1959
1960/*
drhfcb9f4f2015-06-01 18:13:16 +00001961** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001962** for any single row of the table with cursor iCur. In other words, the
1963** expression must not refer to any non-deterministic function nor any
1964** table other than iCur.
1965*/
1966int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1967 return exprIsConst(p, 3, iCur);
1968}
1969
danab31a842017-04-29 20:53:09 +00001970
1971/*
1972** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1973*/
1974static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1975 ExprList *pGroupBy = pWalker->u.pGroupBy;
1976 int i;
1977
1978 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1979 ** it constant. */
1980 for(i=0; i<pGroupBy->nExpr; i++){
1981 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001982 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001983 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001984 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001985 return WRC_Prune;
1986 }
1987 }
1988 }
1989
1990 /* Check if pExpr is a sub-select. If so, consider it variable. */
1991 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1992 pWalker->eCode = 0;
1993 return WRC_Abort;
1994 }
1995
1996 return exprNodeIsConstant(pWalker, pExpr);
1997}
1998
1999/*
2000** Walk the expression tree passed as the first argument. Return non-zero
2001** if the expression consists entirely of constants or copies of terms
2002** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002003**
2004** This routine is used to determine if a term of the HAVING clause can
2005** be promoted into the WHERE clause. In order for such a promotion to work,
2006** the value of the HAVING clause term must be the same for all members of
2007** a "group". The requirement that the GROUP BY term must be BINARY
2008** assumes that no other collating sequence will have a finer-grained
2009** grouping than binary. In other words (A=B COLLATE binary) implies
2010** A=B in every other collating sequence. The requirement that the
2011** GROUP BY be BINARY is stricter than necessary. It would also work
2012** to promote HAVING clauses that use the same alternative collating
2013** sequence as the GROUP BY term, but that is much harder to check,
2014** alternative collating sequences are uncommon, and this is only an
2015** optimization, so we take the easy way out and simply require the
2016** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002017*/
2018int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2019 Walker w;
danab31a842017-04-29 20:53:09 +00002020 w.eCode = 1;
2021 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002022 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002023 w.u.pGroupBy = pGroupBy;
2024 w.pParse = pParse;
2025 sqlite3WalkExpr(&w, p);
2026 return w.eCode;
2027}
2028
drh059b2d52014-10-24 19:28:09 +00002029/*
2030** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002031** or a function call with constant arguments. Return and 0 if there
2032** are any variables.
2033**
2034** For the purposes of this function, a double-quoted string (ex: "abc")
2035** is considered a variable but a single-quoted string (ex: 'abc') is
2036** a constant.
2037*/
drhfeada2d2014-09-24 13:20:22 +00002038int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2039 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002040 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002041}
2042
drh5b88bc42013-12-07 23:35:21 +00002043#ifdef SQLITE_ENABLE_CURSOR_HINTS
2044/*
2045** Walk an expression tree. Return 1 if the expression contains a
2046** subquery of some kind. Return 0 if there are no subqueries.
2047*/
2048int sqlite3ExprContainsSubquery(Expr *p){
2049 Walker w;
drhbec24762015-08-13 20:07:13 +00002050 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002051 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002052 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002053#ifdef SQLITE_DEBUG
2054 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2055#endif
drh5b88bc42013-12-07 23:35:21 +00002056 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002057 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002058}
2059#endif
2060
drheb55bd22005-06-30 17:04:21 +00002061/*
drh73b211a2005-01-18 04:00:42 +00002062** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002063** to fit in a 32-bit integer, return 1 and put the value of the integer
2064** in *pValue. If the expression is not an integer or if it is too big
2065** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002066*/
danielk19774adee202004-05-08 08:23:19 +00002067int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002068 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002069 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002070
2071 /* If an expression is an integer literal that fits in a signed 32-bit
2072 ** integer, then the EP_IntValue flag will have already been set */
2073 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2074 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2075
drh92b01d52008-06-24 00:32:35 +00002076 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002077 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002078 return 1;
2079 }
drhe4de1fe2002-06-02 16:09:01 +00002080 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002081 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002082 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002083 break;
drh4b59ab52002-08-24 18:24:51 +00002084 }
drhe4de1fe2002-06-02 16:09:01 +00002085 case TK_UMINUS: {
2086 int v;
danielk19774adee202004-05-08 08:23:19 +00002087 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002088 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002089 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002090 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002091 }
2092 break;
2093 }
2094 default: break;
2095 }
drh92b01d52008-06-24 00:32:35 +00002096 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002097}
2098
2099/*
drh039fc322009-11-17 18:31:47 +00002100** Return FALSE if there is no chance that the expression can be NULL.
2101**
2102** If the expression might be NULL or if the expression is too complex
2103** to tell return TRUE.
2104**
2105** This routine is used as an optimization, to skip OP_IsNull opcodes
2106** when we know that a value cannot be NULL. Hence, a false positive
2107** (returning TRUE when in fact the expression can never be NULL) might
2108** be a small performance hit but is otherwise harmless. On the other
2109** hand, a false negative (returning FALSE when the result could be NULL)
2110** will likely result in an incorrect answer. So when in doubt, return
2111** TRUE.
2112*/
2113int sqlite3ExprCanBeNull(const Expr *p){
2114 u8 op;
drhcd7f4572009-11-19 14:48:40 +00002115 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002116 op = p->op;
2117 if( op==TK_REGISTER ) op = p->op2;
2118 switch( op ){
2119 case TK_INTEGER:
2120 case TK_STRING:
2121 case TK_FLOAT:
2122 case TK_BLOB:
2123 return 0;
drh7248a8b2014-08-04 18:50:54 +00002124 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002125 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002126 p->y.pTab==0 || /* Reference to column of index on expression */
2127 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002128 default:
2129 return 1;
2130 }
2131}
2132
2133/*
2134** Return TRUE if the given expression is a constant which would be
2135** unchanged by OP_Affinity with the affinity given in the second
2136** argument.
2137**
2138** This routine is used to determine if the OP_Affinity operation
2139** can be omitted. When in doubt return FALSE. A false negative
2140** is harmless. A false positive, however, can result in the wrong
2141** answer.
2142*/
2143int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2144 u8 op;
drh05883a32015-06-02 15:32:08 +00002145 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002146 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002147 op = p->op;
2148 if( op==TK_REGISTER ) op = p->op2;
2149 switch( op ){
2150 case TK_INTEGER: {
2151 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2152 }
2153 case TK_FLOAT: {
2154 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2155 }
2156 case TK_STRING: {
2157 return aff==SQLITE_AFF_TEXT;
2158 }
2159 case TK_BLOB: {
2160 return 1;
2161 }
drh2f2855b2009-11-18 01:25:26 +00002162 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002163 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2164 return p->iColumn<0
2165 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002166 }
drh039fc322009-11-17 18:31:47 +00002167 default: {
2168 return 0;
2169 }
2170 }
2171}
2172
2173/*
drhc4a3c772001-04-04 11:48:57 +00002174** Return TRUE if the given string is a row-id column name.
2175*/
danielk19774adee202004-05-08 08:23:19 +00002176int sqlite3IsRowid(const char *z){
2177 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2178 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2179 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002180 return 0;
2181}
2182
danielk19779a96b662007-11-29 17:05:18 +00002183/*
drh69c355b2016-03-09 15:34:51 +00002184** pX is the RHS of an IN operator. If pX is a SELECT statement
2185** that can be simplified to a direct table access, then return
2186** a pointer to the SELECT statement. If pX is not a SELECT statement,
2187** or if the SELECT statement needs to be manifested into a transient
2188** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002189*/
2190#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002191static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002192 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002193 SrcList *pSrc;
2194 ExprList *pEList;
2195 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002196 int i;
drh69c355b2016-03-09 15:34:51 +00002197 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2198 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2199 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002200 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002201 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002202 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2203 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2204 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002205 }
drhb74b1012009-05-28 21:04:37 +00002206 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002207 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002208 if( p->pWhere ) return 0; /* Has no WHERE clause */
2209 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002210 assert( pSrc!=0 );
2211 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002212 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002213 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002214 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002215 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002216 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2217 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002218 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002219 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002220 for(i=0; i<pEList->nExpr; i++){
2221 Expr *pRes = pEList->a[i].pExpr;
2222 if( pRes->op!=TK_COLUMN ) return 0;
2223 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002224 }
drh69c355b2016-03-09 15:34:51 +00002225 return p;
drhb287f4b2008-04-25 00:08:38 +00002226}
2227#endif /* SQLITE_OMIT_SUBQUERY */
2228
danf9b2e052016-08-02 17:45:00 +00002229#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002230/*
drh4c259e92014-08-01 21:12:35 +00002231** Generate code that checks the left-most column of index table iCur to see if
2232** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002233** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2234** to be set to NULL if iCur contains one or more NULL values.
2235*/
2236static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002237 int addr1;
drh6be515e2014-08-01 21:00:53 +00002238 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002239 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002240 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2241 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002242 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002243 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002244}
danf9b2e052016-08-02 17:45:00 +00002245#endif
drh6be515e2014-08-01 21:00:53 +00002246
drhbb53ecb2014-08-02 21:03:33 +00002247
2248#ifndef SQLITE_OMIT_SUBQUERY
2249/*
2250** The argument is an IN operator with a list (not a subquery) on the
2251** right-hand side. Return TRUE if that list is constant.
2252*/
2253static int sqlite3InRhsIsConstant(Expr *pIn){
2254 Expr *pLHS;
2255 int res;
2256 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2257 pLHS = pIn->pLeft;
2258 pIn->pLeft = 0;
2259 res = sqlite3ExprIsConstant(pIn);
2260 pIn->pLeft = pLHS;
2261 return res;
2262}
2263#endif
2264
drh6be515e2014-08-01 21:00:53 +00002265/*
danielk19779a96b662007-11-29 17:05:18 +00002266** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002267** The pX parameter is the expression on the RHS of the IN operator, which
2268** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002269**
drhd4305ca2012-09-18 17:08:33 +00002270** The job of this routine is to find or create a b-tree object that can
2271** be used either to test for membership in the RHS set or to iterate through
2272** all members of the RHS set, skipping duplicates.
2273**
drh3a856252014-08-01 14:46:57 +00002274** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002275** and pX->iTable is set to the index of that cursor.
2276**
drhb74b1012009-05-28 21:04:37 +00002277** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002278**
drh1ccce442013-03-12 20:38:51 +00002279** IN_INDEX_ROWID - The cursor was opened on a database table.
2280** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2281** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2282** IN_INDEX_EPH - The cursor was opened on a specially created and
2283** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002284** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2285** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002286**
drhd4305ca2012-09-18 17:08:33 +00002287** An existing b-tree might be used if the RHS expression pX is a simple
2288** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002289**
dan553168c2016-08-01 20:14:31 +00002290** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002291**
drhd4305ca2012-09-18 17:08:33 +00002292** If the RHS of the IN operator is a list or a more complex subquery, then
2293** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002294** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002295** existing table.
drhd4305ca2012-09-18 17:08:33 +00002296**
drh7fc0ba02017-11-17 15:02:00 +00002297** The inFlags parameter must contain, at a minimum, one of the bits
2298** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2299** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2300** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2301** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002302**
2303** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2304** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002305** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002306** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2307** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002308**
drh3a856252014-08-01 14:46:57 +00002309** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2310** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002311** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2312** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002313**
drhbb53ecb2014-08-02 21:03:33 +00002314** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2315** if the RHS of the IN operator is a list (not a subquery) then this
2316** routine might decide that creating an ephemeral b-tree for membership
2317** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2318** calling routine should implement the IN operator using a sequence
2319** of Eq or Ne comparison operations.
2320**
drhb74b1012009-05-28 21:04:37 +00002321** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002322** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002323** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002324** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002325** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002326** to *prRhsHasNull. If there is no chance that the (...) contains a
2327** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002328**
drhe21a6e12014-08-01 18:00:24 +00002329** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002330** the value in that register will be NULL if the b-tree contains one or more
2331** NULL values, and it will be some non-NULL value if the b-tree contains no
2332** NULL values.
dan553168c2016-08-01 20:14:31 +00002333**
2334** If the aiMap parameter is not NULL, it must point to an array containing
2335** one element for each column returned by the SELECT statement on the RHS
2336** of the IN(...) operator. The i'th entry of the array is populated with the
2337** offset of the index column that matches the i'th column returned by the
2338** SELECT. For example, if the expression and selected index are:
2339**
2340** (?,?,?) IN (SELECT a, b, c FROM t1)
2341** CREATE INDEX i1 ON t1(b, c, a);
2342**
2343** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002344*/
danielk1977284f4ac2007-12-10 05:03:46 +00002345#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002346int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002347 Parse *pParse, /* Parsing context */
2348 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2349 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2350 int *prRhsHasNull, /* Register holding NULL status. See notes */
2351 int *aiMap /* Mapping from Index fields to RHS fields */
danba00e302016-07-23 20:24:06 +00002352){
drhb74b1012009-05-28 21:04:37 +00002353 Select *p; /* SELECT to the right of IN operator */
2354 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2355 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002356 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002357 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002358
drh1450bc62009-10-30 13:25:56 +00002359 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002360 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002361
dan7b35a772016-07-28 19:47:15 +00002362 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2363 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002364 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002365 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002366 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002367 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2368 int i;
2369 ExprList *pEList = pX->x.pSelect->pEList;
2370 for(i=0; i<pEList->nExpr; i++){
2371 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2372 }
2373 if( i==pEList->nExpr ){
2374 prRhsHasNull = 0;
2375 }
2376 }
2377
drhb74b1012009-05-28 21:04:37 +00002378 /* Check to see if an existing table or index can be used to
2379 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002380 ** ephemeral table. */
2381 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002382 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002383 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002384 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002385 ExprList *pEList = p->pEList;
2386 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002387
drhb07028f2011-10-14 21:49:18 +00002388 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2389 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2390 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2391 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002392
drhb22f7c82014-02-06 23:56:27 +00002393 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002394 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2395 sqlite3CodeVerifySchema(pParse, iDb);
2396 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002397
drha84a2832016-08-26 21:15:35 +00002398 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002399 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002400 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002401 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002402 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002403
2404 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2405 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002406 ExplainQueryPlan((pParse, 0,
2407 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002408 sqlite3VdbeJumpHere(v, iAddr);
2409 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002410 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002411 int affinity_ok = 1;
2412 int i;
2413
2414 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002415 ** comparison is the same as the affinity of each column in table
2416 ** on the RHS of the IN operator. If it not, it is not possible to
2417 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002418 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002419 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002420 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002421 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002422 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002423 testcase( cmpaff==SQLITE_AFF_BLOB );
2424 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002425 switch( cmpaff ){
2426 case SQLITE_AFF_BLOB:
2427 break;
2428 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002429 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2430 ** other has no affinity and the other side is TEXT. Hence,
2431 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2432 ** and for the term on the LHS of the IN to have no affinity. */
2433 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002434 break;
2435 default:
2436 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2437 }
2438 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002439
drha84a2832016-08-26 21:15:35 +00002440 if( affinity_ok ){
2441 /* Search for an existing index that will work for this IN operator */
2442 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2443 Bitmask colUsed; /* Columns of the index used */
2444 Bitmask mCol; /* Mask for the current column */
2445 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002446 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002447 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2448 ** BITMASK(nExpr) without overflowing */
2449 testcase( pIdx->nColumn==BMS-2 );
2450 testcase( pIdx->nColumn==BMS-1 );
2451 if( pIdx->nColumn>=BMS-1 ) continue;
2452 if( mustBeUnique ){
2453 if( pIdx->nKeyCol>nExpr
2454 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2455 ){
2456 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002457 }
danielk19770cdc0222008-06-26 18:04:03 +00002458 }
drha84a2832016-08-26 21:15:35 +00002459
2460 colUsed = 0; /* Columns of index used so far */
2461 for(i=0; i<nExpr; i++){
2462 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2463 Expr *pRhs = pEList->a[i].pExpr;
2464 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2465 int j;
2466
2467 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2468 for(j=0; j<nExpr; j++){
2469 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2470 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002471 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2472 continue;
2473 }
drha84a2832016-08-26 21:15:35 +00002474 break;
2475 }
2476 if( j==nExpr ) break;
2477 mCol = MASKBIT(j);
2478 if( mCol & colUsed ) break; /* Each column used only once */
2479 colUsed |= mCol;
2480 if( aiMap ) aiMap[i] = j;
2481 }
2482
2483 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2484 if( colUsed==(MASKBIT(nExpr)-1) ){
2485 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002486 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002487 ExplainQueryPlan((pParse, 0,
2488 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002489 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2490 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2491 VdbeComment((v, "%s", pIdx->zName));
2492 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2493 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2494
2495 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002496#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002497 i64 mask = (1<<nExpr)-1;
2498 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2499 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002500#endif
2501 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002502 if( nExpr==1 ){
2503 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2504 }
2505 }
2506 sqlite3VdbeJumpHere(v, iAddr);
2507 }
2508 } /* End loop over indexes */
2509 } /* End if( affinity_ok ) */
2510 } /* End if not an rowid index */
2511 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002512
drhbb53ecb2014-08-02 21:03:33 +00002513 /* If no preexisting index is available for the IN clause
2514 ** and IN_INDEX_NOOP is an allowed reply
2515 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002516 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002517 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002518 ** the IN operator so return IN_INDEX_NOOP.
2519 */
2520 if( eType==0
2521 && (inFlags & IN_INDEX_NOOP_OK)
2522 && !ExprHasProperty(pX, EP_xIsSelect)
2523 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2524 ){
2525 eType = IN_INDEX_NOOP;
2526 }
drhbb53ecb2014-08-02 21:03:33 +00002527
danielk19779a96b662007-11-29 17:05:18 +00002528 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002529 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002530 ** We will have to generate an ephemeral table to do the job.
2531 */
drh8e23daf2013-06-11 13:30:04 +00002532 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002533 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002534 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002535 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002536 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00002537 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00002538 eType = IN_INDEX_ROWID;
2539 }
drhe21a6e12014-08-01 18:00:24 +00002540 }else if( prRhsHasNull ){
2541 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002542 }
danielk197741a05b72008-10-02 13:50:55 +00002543 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00002544 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002545 }else{
2546 pX->iTable = iTab;
2547 }
danba00e302016-07-23 20:24:06 +00002548
2549 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2550 int i, n;
2551 n = sqlite3ExprVectorSize(pX->pLeft);
2552 for(i=0; i<n; i++) aiMap[i] = i;
2553 }
danielk19779a96b662007-11-29 17:05:18 +00002554 return eType;
2555}
danielk1977284f4ac2007-12-10 05:03:46 +00002556#endif
drh626a8792005-01-17 22:08:19 +00002557
danf9b2e052016-08-02 17:45:00 +00002558#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002559/*
2560** Argument pExpr is an (?, ?...) IN(...) expression. This
2561** function allocates and returns a nul-terminated string containing
2562** the affinities to be used for each column of the comparison.
2563**
2564** It is the responsibility of the caller to ensure that the returned
2565** string is eventually freed using sqlite3DbFree().
2566*/
dan71c57db2016-07-09 20:23:55 +00002567static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2568 Expr *pLeft = pExpr->pLeft;
2569 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002570 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002571 char *zRet;
2572
dan553168c2016-08-01 20:14:31 +00002573 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002574 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002575 if( zRet ){
2576 int i;
2577 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002578 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002579 char a = sqlite3ExprAffinity(pA);
2580 if( pSelect ){
2581 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2582 }else{
2583 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002584 }
dan71c57db2016-07-09 20:23:55 +00002585 }
2586 zRet[nVal] = '\0';
2587 }
2588 return zRet;
2589}
danf9b2e052016-08-02 17:45:00 +00002590#endif
dan71c57db2016-07-09 20:23:55 +00002591
dan8da209b2016-07-26 18:06:08 +00002592#ifndef SQLITE_OMIT_SUBQUERY
2593/*
2594** Load the Parse object passed as the first argument with an error
2595** message of the form:
2596**
2597** "sub-select returns N columns - expected M"
2598*/
2599void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2600 const char *zFmt = "sub-select returns %d columns - expected %d";
2601 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2602}
2603#endif
2604
drh626a8792005-01-17 22:08:19 +00002605/*
dan44c56042016-12-07 15:38:37 +00002606** Expression pExpr is a vector that has been used in a context where
2607** it is not permitted. If pExpr is a sub-select vector, this routine
2608** loads the Parse object with a message of the form:
2609**
2610** "sub-select returns N columns - expected 1"
2611**
2612** Or, if it is a regular scalar vector:
2613**
2614** "row value misused"
2615*/
2616void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2617#ifndef SQLITE_OMIT_SUBQUERY
2618 if( pExpr->flags & EP_xIsSelect ){
2619 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2620 }else
2621#endif
2622 {
2623 sqlite3ErrorMsg(pParse, "row value misused");
2624 }
2625}
2626
2627/*
drhd4187c72010-08-30 22:15:45 +00002628** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2629** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00002630**
drh9cbe6352005-11-29 03:13:21 +00002631** (SELECT a FROM b) -- subquery
2632** EXISTS (SELECT a FROM b) -- EXISTS subquery
2633** x IN (4,5,11) -- IN operator with list on right-hand side
2634** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002635**
drh9cbe6352005-11-29 03:13:21 +00002636** The pExpr parameter describes the expression that contains the IN
2637** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00002638**
2639** If parameter isRowid is non-zero, then expression pExpr is guaranteed
2640** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
2641** to some integer key column of a table B-Tree. In this case, use an
2642** intkey B-Tree to store the set of IN(...) values instead of the usual
2643** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00002644**
2645** If rMayHaveNull is non-zero, that means that the operation is an IN
2646** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00002647** All this routine does is initialize the register given by rMayHaveNull
2648** to NULL. Calling routines will take care of changing this register
2649** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00002650**
2651** For a SELECT or EXISTS operator, return the register that holds the
drh39a11812016-08-19 19:12:58 +00002652** result. For a multi-column SELECT, the result is stored in a contiguous
2653** array of registers and the return value is the register of the left-most
2654** result column. Return 0 for IN operators or if an error occurs.
drhcce7d172000-05-31 15:34:51 +00002655*/
drh51522cd2005-01-20 13:36:19 +00002656#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00002657int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00002658 Parse *pParse, /* Parsing context */
2659 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00002660 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00002661 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00002662){
drh6be515e2014-08-01 21:00:53 +00002663 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00002664 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00002665 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00002666 if( NEVER(v==0) ) return 0;
danielk1977fc976062007-05-10 10:46:56 +00002667
drh39a11812016-08-19 19:12:58 +00002668 /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
2669 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002670 **
2671 ** * The right-hand side is a correlated subquery
2672 ** * The right-hand side is an expression list containing variables
2673 ** * We are inside a trigger
2674 **
2675 ** If all of the above are false, then we can run this code just once
2676 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00002677 */
drhc5cd1242013-09-12 16:50:49 +00002678 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh511f9e82016-09-22 18:53:13 +00002679 jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002680 }
2681
drhcce7d172000-05-31 15:34:51 +00002682 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00002683 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00002684 int addr; /* Address of OP_OpenEphemeral instruction */
2685 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00002686 KeyInfo *pKeyInfo = 0; /* Key information */
dan71c57db2016-07-09 20:23:55 +00002687 int nVal; /* Size of vector pLeft */
2688
2689 nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002690 assert( !isRowid || nVal==1 );
danielk1977e014a832004-05-17 10:48:57 +00002691
2692 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00002693 ** expression it is handled the same way. An ephemeral table is
dan553168c2016-08-01 20:14:31 +00002694 ** filled with index keys representing the results from the
2695 ** SELECT or the <exprlist>.
danielk1977e014a832004-05-17 10:48:57 +00002696 **
2697 ** If the 'x' expression is a column value, or the SELECT...
2698 ** statement returns a column value, then the affinity of that
2699 ** column is used to build the index keys. If both 'x' and the
2700 ** SELECT... statement are columns, then numeric affinity is used
2701 ** if either column has NUMERIC or INTEGER affinity. If neither
2702 ** 'x' nor the SELECT... statement are columns, then numeric affinity
2703 ** is used.
2704 */
2705 pExpr->iTable = pParse->nTab++;
dan71c57db2016-07-09 20:23:55 +00002706 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
2707 pExpr->iTable, (isRowid?0:nVal));
2708 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002709
danielk19776ab3a2e2009-02-19 14:39:25 +00002710 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00002711 /* Case 1: expr IN (SELECT ...)
2712 **
danielk1977e014a832004-05-17 10:48:57 +00002713 ** Generate code to write the results of the select into the temporary
2714 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00002715 */
drh43870062014-07-31 15:44:44 +00002716 Select *pSelect = pExpr->x.pSelect;
dan71c57db2016-07-09 20:23:55 +00002717 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002718
drhe2ca99c2018-05-02 00:33:43 +00002719 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2720 jmpIfDynamic>=0?"":"CORRELATED "
2721 ));
danielk197741a05b72008-10-02 13:50:55 +00002722 assert( !isRowid );
drh64bcb8c2016-08-26 03:42:57 +00002723 /* If the LHS and RHS of the IN operator do not match, that
2724 ** error will have been caught long before we reach this point. */
2725 if( ALWAYS(pEList->nExpr==nVal) ){
dan71c57db2016-07-09 20:23:55 +00002726 SelectDest dest;
2727 int i;
2728 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
2729 dest.zAffSdst = exprINAffinity(pParse, pExpr);
dan71c57db2016-07-09 20:23:55 +00002730 pSelect->iLimit = 0;
2731 testcase( pSelect->selFlags & SF_Distinct );
2732 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2733 if( sqlite3Select(pParse, pSelect, &dest) ){
2734 sqlite3DbFree(pParse->db, dest.zAffSdst);
2735 sqlite3KeyInfoUnref(pKeyInfo);
2736 return 0;
2737 }
2738 sqlite3DbFree(pParse->db, dest.zAffSdst);
2739 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2740 assert( pEList!=0 );
2741 assert( pEList->nExpr>0 );
2742 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2743 for(i=0; i<nVal; i++){
dan773d3af2016-09-06 17:21:17 +00002744 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
dan71c57db2016-07-09 20:23:55 +00002745 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2746 pParse, p, pEList->a[i].pExpr
2747 );
2748 }
drh94ccde52007-04-13 16:06:32 +00002749 }
drha7d2db12010-07-14 20:23:52 +00002750 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00002751 /* Case 2: expr IN (exprlist)
2752 **
drhfd131da2007-08-07 17:13:03 +00002753 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00002754 ** store it in the temporary table. If <expr> is a column, then use
2755 ** that columns affinity when building index keys. If <expr> is not
2756 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00002757 */
dan71c57db2016-07-09 20:23:55 +00002758 char affinity; /* Affinity of the LHS of the IN */
danielk1977e014a832004-05-17 10:48:57 +00002759 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00002760 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00002761 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00002762 int r1, r2, r3;
dan71c57db2016-07-09 20:23:55 +00002763 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002764 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00002765 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00002766 }
drh323df792013-08-05 19:11:29 +00002767 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002768 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00002769 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2770 }
danielk1977e014a832004-05-17 10:48:57 +00002771
2772 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00002773 r1 = sqlite3GetTempReg(pParse);
2774 r2 = sqlite3GetTempReg(pParse);
dan21cd29a2017-10-23 16:03:54 +00002775 if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
drh57dbd7b2005-07-08 18:25:26 +00002776 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2777 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00002778 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00002779
drh57dbd7b2005-07-08 18:25:26 +00002780 /* If the expression is not constant then we will need to
2781 ** disable the test that was generated above that makes sure
2782 ** this code only executes once. Because for a non-constant
2783 ** expression we need to rerun this code each time.
2784 */
drh6be515e2014-08-01 21:00:53 +00002785 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
2786 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
2787 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00002788 }
danielk1977e014a832004-05-17 10:48:57 +00002789
2790 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00002791 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2792 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002793 }else{
drhe05c9292009-10-29 13:48:10 +00002794 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2795 if( isRowid ){
2796 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2797 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002798 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002799 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2800 }else{
2801 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
drh9b4eaeb2016-11-09 00:10:33 +00002802 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
drhe05c9292009-10-29 13:48:10 +00002803 }
danielk197741a05b72008-10-02 13:50:55 +00002804 }
drhfef52082000-06-06 01:50:43 +00002805 }
drh2d401ab2008-01-10 23:50:11 +00002806 sqlite3ReleaseTempReg(pParse, r1);
2807 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002808 }
drh323df792013-08-05 19:11:29 +00002809 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002810 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002811 }
danielk1977b3bce662005-01-29 08:32:43 +00002812 break;
drhfef52082000-06-06 01:50:43 +00002813 }
2814
drh51522cd2005-01-20 13:36:19 +00002815 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002816 case TK_SELECT:
2817 default: {
drh39a11812016-08-19 19:12:58 +00002818 /* Case 3: (SELECT ... FROM ...)
2819 ** or: EXISTS(SELECT ... FROM ...)
2820 **
2821 ** For a SELECT, generate code to put the values for all columns of
2822 ** the first row into an array of registers and return the index of
2823 ** the first register.
2824 **
2825 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2826 ** into a register and return that register number.
2827 **
2828 ** In both cases, the query is augmented with "LIMIT 1". Any
2829 ** preexisting limit is discarded in place of the new LIMIT 1.
drhfef52082000-06-06 01:50:43 +00002830 */
drhfd773cf2009-05-29 14:39:07 +00002831 Select *pSel; /* SELECT statement to encode */
drh39a11812016-08-19 19:12:58 +00002832 SelectDest dest; /* How to deal with SELECT result */
dan71c57db2016-07-09 20:23:55 +00002833 int nReg; /* Registers to allocate */
drh8c0833f2017-11-14 23:48:23 +00002834 Expr *pLimit; /* New limit expression */
drh1398ad32005-01-19 23:24:50 +00002835
shanecf697392009-06-01 16:53:09 +00002836 testcase( pExpr->op==TK_EXISTS );
2837 testcase( pExpr->op==TK_SELECT );
2838 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
danielk19776ab3a2e2009-02-19 14:39:25 +00002839 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
dan71c57db2016-07-09 20:23:55 +00002840
danielk19776ab3a2e2009-02-19 14:39:25 +00002841 pSel = pExpr->x.pSelect;
drhe2ca99c2018-05-02 00:33:43 +00002842 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2843 jmpIfDynamic>=0?"":"CORRELATED "));
dan71c57db2016-07-09 20:23:55 +00002844 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2845 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2846 pParse->nMem += nReg;
drh51522cd2005-01-20 13:36:19 +00002847 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002848 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002849 dest.iSdst = dest.iSDParm;
dan71c57db2016-07-09 20:23:55 +00002850 dest.nSdst = nReg;
2851 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
drhd4e70eb2008-01-02 00:34:36 +00002852 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002853 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002854 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002855 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002856 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002857 }
drh8c0833f2017-11-14 23:48:23 +00002858 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2859 if( pSel->pLimit ){
2860 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2861 pSel->pLimit->pLeft = pLimit;
2862 }else{
2863 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2864 }
drh48b5b042010-12-06 18:50:32 +00002865 pSel->iLimit = 0;
drh7d10d5a2008-08-20 16:35:10 +00002866 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002867 return 0;
drh94ccde52007-04-13 16:06:32 +00002868 }
drh2b596da2012-07-23 21:43:19 +00002869 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002870 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002871 break;
drhcce7d172000-05-31 15:34:51 +00002872 }
2873 }
danielk1977b3bce662005-01-29 08:32:43 +00002874
drh6be515e2014-08-01 21:00:53 +00002875 if( rHasNullFlag ){
2876 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002877 }
drh6be515e2014-08-01 21:00:53 +00002878
2879 if( jmpIfDynamic>=0 ){
2880 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002881 }
danielk1977fc976062007-05-10 10:46:56 +00002882
drh1450bc62009-10-30 13:25:56 +00002883 return rReg;
drhcce7d172000-05-31 15:34:51 +00002884}
drh51522cd2005-01-20 13:36:19 +00002885#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002886
drhe3365e62009-11-12 17:52:24 +00002887#ifndef SQLITE_OMIT_SUBQUERY
2888/*
dan7b35a772016-07-28 19:47:15 +00002889** Expr pIn is an IN(...) expression. This function checks that the
2890** sub-select on the RHS of the IN() operator has the same number of
2891** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2892** a sub-query, that the LHS is a vector of size 1.
2893*/
2894int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2895 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2896 if( (pIn->flags & EP_xIsSelect) ){
2897 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2898 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2899 return 1;
2900 }
2901 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002902 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002903 return 1;
2904 }
2905 return 0;
2906}
2907#endif
2908
2909#ifndef SQLITE_OMIT_SUBQUERY
2910/*
drhe3365e62009-11-12 17:52:24 +00002911** Generate code for an IN expression.
2912**
2913** x IN (SELECT ...)
2914** x IN (value, value, ...)
2915**
drhecb87ac2016-08-25 15:46:25 +00002916** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002917** right-hand side (RHS) is an array of zero or more scalar values, or a
2918** subquery. If the RHS is a subquery, the number of result columns must
2919** match the number of columns in the vector on the LHS. If the RHS is
2920** a list of values, the LHS must be a scalar.
2921**
2922** The IN operator is true if the LHS value is contained within the RHS.
2923** The result is false if the LHS is definitely not in the RHS. The
2924** result is NULL if the presence of the LHS in the RHS cannot be
2925** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002926**
drh6be515e2014-08-01 21:00:53 +00002927** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002928** contained within the RHS. If due to NULLs we cannot determine if the LHS
2929** is contained in the RHS then jump to destIfNull. If the LHS is contained
2930** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002931**
2932** See the separate in-operator.md documentation file in the canonical
2933** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002934*/
2935static void sqlite3ExprCodeIN(
2936 Parse *pParse, /* Parsing and code generating context */
2937 Expr *pExpr, /* The IN expression */
2938 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2939 int destIfNull /* Jump here if the results are unknown due to NULLs */
2940){
2941 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00002942 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00002943 int rLhs; /* Register(s) holding the LHS values */
2944 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00002945 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00002946 int *aiMap = 0; /* Map from vector field to index column */
2947 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00002948 int nVector; /* Size of vectors for this IN operator */
2949 int iDummy; /* Dummy parameter to exprCodeVector() */
2950 Expr *pLeft; /* The LHS of the IN operator */
2951 int i; /* loop counter */
2952 int destStep2; /* Where to jump when NULLs seen in step 2 */
2953 int destStep6 = 0; /* Start of code for Step 6 */
2954 int addrTruthOp; /* Address of opcode that determines the IN is true */
2955 int destNotNull; /* Jump here if a comparison is not true in step 6 */
2956 int addrTop; /* Top of the step-6 loop */
drhe3365e62009-11-12 17:52:24 +00002957
drhe347d3e2016-08-25 21:14:34 +00002958 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00002959 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00002960 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00002961 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2962 aiMap = (int*)sqlite3DbMallocZero(
2963 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2964 );
drhe347d3e2016-08-25 21:14:34 +00002965 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00002966
danba00e302016-07-23 20:24:06 +00002967 /* Attempt to compute the RHS. After this step, if anything other than
2968 ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2969 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2970 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00002971 v = pParse->pVdbe;
2972 assert( v!=0 ); /* OOM detected prior to this routine */
2973 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002974 eType = sqlite3FindInIndex(pParse, pExpr,
2975 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
danba00e302016-07-23 20:24:06 +00002976 destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
drhe3365e62009-11-12 17:52:24 +00002977
danba00e302016-07-23 20:24:06 +00002978 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2979 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2980 );
drhecb87ac2016-08-25 15:46:25 +00002981#ifdef SQLITE_DEBUG
2982 /* Confirm that aiMap[] contains nVector integer values between 0 and
2983 ** nVector-1. */
2984 for(i=0; i<nVector; i++){
2985 int j, cnt;
2986 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2987 assert( cnt==1 );
2988 }
2989#endif
drhe3365e62009-11-12 17:52:24 +00002990
danba00e302016-07-23 20:24:06 +00002991 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2992 ** vector, then it is stored in an array of nVector registers starting
2993 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00002994 **
2995 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2996 ** so that the fields are in the same order as an existing index. The
2997 ** aiMap[] array contains a mapping from the original LHS field order to
2998 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00002999 */
drhe347d3e2016-08-25 21:14:34 +00003000 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3001 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003002 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003003 /* LHS fields are not reordered */
3004 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003005 }else{
3006 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003007 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003008 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003009 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003010 }
danba00e302016-07-23 20:24:06 +00003011 }
drhe3365e62009-11-12 17:52:24 +00003012
drhbb53ecb2014-08-02 21:03:33 +00003013 /* If sqlite3FindInIndex() did not find or create an index that is
3014 ** suitable for evaluating the IN operator, then evaluate using a
3015 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003016 **
3017 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003018 */
drhbb53ecb2014-08-02 21:03:33 +00003019 if( eType==IN_INDEX_NOOP ){
3020 ExprList *pList = pExpr->x.pList;
3021 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3022 int labelOk = sqlite3VdbeMakeLabel(v);
3023 int r2, regToFree;
3024 int regCkNull = 0;
3025 int ii;
3026 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003027 if( destIfNull!=destIfFalse ){
3028 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003029 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003030 }
3031 for(ii=0; ii<pList->nExpr; ii++){
3032 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003033 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003034 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3035 }
3036 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003037 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003038 (void*)pColl, P4_COLLSEQ);
3039 VdbeCoverageIf(v, ii<pList->nExpr-1);
3040 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003041 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003042 }else{
3043 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003044 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003045 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003046 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003047 }
3048 sqlite3ReleaseTempReg(pParse, regToFree);
3049 }
3050 if( regCkNull ){
3051 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003052 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003053 }
3054 sqlite3VdbeResolveLabel(v, labelOk);
3055 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003056 goto sqlite3ExprCodeIN_finished;
3057 }
3058
3059 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3060 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3061 ** We will then skip the binary search of the RHS.
3062 */
3063 if( destIfNull==destIfFalse ){
3064 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003065 }else{
drhe347d3e2016-08-25 21:14:34 +00003066 destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3067 }
3068 for(i=0; i<nVector; i++){
3069 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3070 if( sqlite3ExprCanBeNull(p) ){
3071 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003072 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003073 }
drhe3365e62009-11-12 17:52:24 +00003074 }
drhe347d3e2016-08-25 21:14:34 +00003075
3076 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3077 ** of the RHS using the LHS as a probe. If found, the result is
3078 ** true.
3079 */
3080 if( eType==IN_INDEX_ROWID ){
3081 /* In this case, the RHS is the ROWID of table b-tree and so we also
3082 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3083 ** into a single opcode. */
3084 sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3085 VdbeCoverage(v);
3086 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3087 }else{
3088 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3089 if( destIfFalse==destIfNull ){
3090 /* Combine Step 3 and Step 5 into a single opcode */
3091 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3092 rLhs, nVector); VdbeCoverage(v);
3093 goto sqlite3ExprCodeIN_finished;
3094 }
3095 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3096 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3097 rLhs, nVector); VdbeCoverage(v);
3098 }
3099
3100 /* Step 4. If the RHS is known to be non-NULL and we did not find
3101 ** an match on the search above, then the result must be FALSE.
3102 */
3103 if( rRhsHasNull && nVector==1 ){
3104 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3105 VdbeCoverage(v);
3106 }
3107
3108 /* Step 5. If we do not care about the difference between NULL and
3109 ** FALSE, then just return false.
3110 */
3111 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3112
3113 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3114 ** If any comparison is NULL, then the result is NULL. If all
3115 ** comparisons are FALSE then the final result is FALSE.
3116 **
3117 ** For a scalar LHS, it is sufficient to check just the first row
3118 ** of the RHS.
3119 */
3120 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3121 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3122 VdbeCoverage(v);
3123 if( nVector>1 ){
3124 destNotNull = sqlite3VdbeMakeLabel(v);
3125 }else{
3126 /* For nVector==1, combine steps 6 and 7 by immediately returning
3127 ** FALSE if the first comparison is not NULL */
3128 destNotNull = destIfFalse;
3129 }
3130 for(i=0; i<nVector; i++){
3131 Expr *p;
3132 CollSeq *pColl;
3133 int r3 = sqlite3GetTempReg(pParse);
3134 p = sqlite3VectorFieldSubexpr(pLeft, i);
3135 pColl = sqlite3ExprCollSeq(pParse, p);
3136 sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3137 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3138 (void*)pColl, P4_COLLSEQ);
3139 VdbeCoverage(v);
3140 sqlite3ReleaseTempReg(pParse, r3);
3141 }
3142 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3143 if( nVector>1 ){
3144 sqlite3VdbeResolveLabel(v, destNotNull);
3145 sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
3146 VdbeCoverage(v);
3147
3148 /* Step 7: If we reach this point, we know that the result must
3149 ** be false. */
3150 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3151 }
3152
3153 /* Jumps here in order to return true. */
3154 sqlite3VdbeJumpHere(v, addrTruthOp);
3155
3156sqlite3ExprCodeIN_finished:
3157 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003158 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003159sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003160 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003161 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003162}
3163#endif /* SQLITE_OMIT_SUBQUERY */
3164
drh13573c72010-01-12 17:04:07 +00003165#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003166/*
3167** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003168** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003169**
3170** The z[] string will probably not be zero-terminated. But the
3171** z[n] character is guaranteed to be something that does not look
3172** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003173*/
drhb7916a72009-05-27 10:31:29 +00003174static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003175 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003176 double value;
drh9339da12010-09-30 00:50:49 +00003177 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003178 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3179 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003180 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003181 }
3182}
drh13573c72010-01-12 17:04:07 +00003183#endif
drh598f1342007-10-23 15:39:45 +00003184
3185
3186/*
drhfec19aa2004-05-19 20:41:03 +00003187** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003188** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003189**
shaneh5f1d6b62010-09-30 16:51:25 +00003190** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003191*/
drh13573c72010-01-12 17:04:07 +00003192static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3193 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003194 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003195 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003196 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003197 if( negFlag ) i = -i;
3198 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003199 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003200 int c;
3201 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003202 const char *z = pExpr->u.zToken;
3203 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003204 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003205 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003206#ifdef SQLITE_OMIT_FLOATING_POINT
3207 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3208#else
drh1b7ddc52014-07-23 14:52:05 +00003209#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003210 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003211 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003212 }else
3213#endif
3214 {
drh9296c182014-07-23 13:40:49 +00003215 codeReal(v, z, negFlag, iMem);
3216 }
drh13573c72010-01-12 17:04:07 +00003217#endif
drh77320ea2016-11-30 14:47:37 +00003218 }else{
drh84d4f1a2017-09-20 10:47:10 +00003219 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003220 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003221 }
drhfec19aa2004-05-19 20:41:03 +00003222 }
3223}
3224
drh5cd79232009-05-25 11:46:29 +00003225
drh1f9ca2c2015-08-25 16:57:52 +00003226/* Generate code that will load into register regOut a value that is
3227** appropriate for the iIdxCol-th column of index pIdx.
3228*/
3229void sqlite3ExprCodeLoadIndexColumn(
3230 Parse *pParse, /* The parsing context */
3231 Index *pIdx, /* The index whose column is to be loaded */
3232 int iTabCur, /* Cursor pointing to a table row */
3233 int iIdxCol, /* The column of the index to be loaded */
3234 int regOut /* Store the index column value in this register */
3235){
3236 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003237 if( iTabCol==XN_EXPR ){
3238 assert( pIdx->aColExpr );
3239 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003240 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003241 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003242 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003243 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003244 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3245 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003246 }
drh1f9ca2c2015-08-25 16:57:52 +00003247}
3248
drh5cd79232009-05-25 11:46:29 +00003249/*
drh5c092e82010-05-14 19:24:02 +00003250** Generate code to extract the value of the iCol-th column of a table.
3251*/
3252void sqlite3ExprCodeGetColumnOfTable(
3253 Vdbe *v, /* The VDBE under construction */
3254 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003255 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003256 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003257 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003258){
drhaca19e12017-04-07 19:41:31 +00003259 if( pTab==0 ){
3260 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3261 return;
3262 }
drh5c092e82010-05-14 19:24:02 +00003263 if( iCol<0 || iCol==pTab->iPKey ){
3264 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3265 }else{
3266 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003267 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003268 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003269 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3270 }
3271 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003272 }
3273 if( iCol>=0 ){
3274 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3275 }
3276}
3277
3278/*
drh945498f2007-02-24 11:52:52 +00003279** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003280** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003281**
3282** There must be an open cursor to pTab in iTable when this routine
3283** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003284*/
drhe55cbd72008-03-31 23:48:03 +00003285int sqlite3ExprCodeGetColumn(
3286 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003287 Table *pTab, /* Description of the table we are reading from */
3288 int iColumn, /* Index of the table column */
3289 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003290 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003291 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003292){
drhe55cbd72008-03-31 23:48:03 +00003293 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003294 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003295 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003296 if( p5 ){
3297 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003298 }
drhe55cbd72008-03-31 23:48:03 +00003299 return iReg;
3300}
drhe55cbd72008-03-31 23:48:03 +00003301
3302/*
drhb21e7c72008-06-22 12:37:57 +00003303** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003304** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003305*/
drhb21e7c72008-06-22 12:37:57 +00003306void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003307 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003308 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003309}
3310
drh652fbf52008-04-01 01:42:41 +00003311/*
drh12abf402016-08-22 14:30:05 +00003312** Convert a scalar expression node to a TK_REGISTER referencing
3313** register iReg. The caller must ensure that iReg already contains
3314** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003315*/
3316static void exprToRegister(Expr *p, int iReg){
3317 p->op2 = p->op;
3318 p->op = TK_REGISTER;
3319 p->iTable = iReg;
3320 ExprClearProperty(p, EP_Skip);
3321}
3322
drh12abf402016-08-22 14:30:05 +00003323/*
3324** Evaluate an expression (either a vector or a scalar expression) and store
3325** the result in continguous temporary registers. Return the index of
3326** the first register used to store the result.
3327**
3328** If the returned result register is a temporary scalar, then also write
3329** that register number into *piFreeable. If the returned result register
3330** is not a temporary or if the expression is a vector set *piFreeable
3331** to 0.
3332*/
3333static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3334 int iResult;
3335 int nResult = sqlite3ExprVectorSize(p);
3336 if( nResult==1 ){
3337 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3338 }else{
3339 *piFreeable = 0;
3340 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003341#if SQLITE_OMIT_SUBQUERY
3342 iResult = 0;
3343#else
drh12abf402016-08-22 14:30:05 +00003344 iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
drhdd1bb432017-05-15 15:12:24 +00003345#endif
drh12abf402016-08-22 14:30:05 +00003346 }else{
3347 int i;
3348 iResult = pParse->nMem+1;
3349 pParse->nMem += nResult;
3350 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003351 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003352 }
3353 }
3354 }
3355 return iResult;
3356}
3357
dan71c57db2016-07-09 20:23:55 +00003358
drha4c3c872013-09-12 17:29:25 +00003359/*
drhcce7d172000-05-31 15:34:51 +00003360** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003361** expression. Attempt to store the results in register "target".
3362** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003363**
drh8b213892008-08-29 02:14:02 +00003364** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003365** be stored in target. The result might be stored in some other
3366** register if it is convenient to do so. The calling function
3367** must check the return code and move the results to the desired
3368** register.
drhcce7d172000-05-31 15:34:51 +00003369*/
drh678ccce2008-03-31 18:19:54 +00003370int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003371 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3372 int op; /* The opcode being coded */
3373 int inReg = target; /* Results stored in register inReg */
3374 int regFree1 = 0; /* If non-zero free this temporary register */
3375 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003376 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003377 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003378 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003379
drh9cbf3422008-01-17 16:22:13 +00003380 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003381 if( v==0 ){
3382 assert( pParse->db->mallocFailed );
3383 return 0;
3384 }
drh389a1ad2008-01-03 23:44:53 +00003385
drh1efa8022018-04-28 04:16:43 +00003386expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003387 if( pExpr==0 ){
3388 op = TK_NULL;
3389 }else{
3390 op = pExpr->op;
3391 }
drhf2bc0132004-10-04 13:19:23 +00003392 switch( op ){
drh13449892005-09-07 21:22:45 +00003393 case TK_AGG_COLUMN: {
3394 AggInfo *pAggInfo = pExpr->pAggInfo;
3395 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3396 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003397 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003398 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003399 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003400 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003401 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003402 return target;
drh13449892005-09-07 21:22:45 +00003403 }
3404 /* Otherwise, fall thru into the TK_COLUMN case */
3405 }
drh967e8b72000-06-21 13:59:10 +00003406 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003407 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003408 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003409 /* This COLUMN expression is really a constant due to WHERE clause
3410 ** constraints, and that constant is coded by the pExpr->pLeft
3411 ** expresssion. However, make sure the constant has the correct
3412 ** datatype by applying the Affinity of the table column to the
3413 ** constant.
3414 */
3415 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003416 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003417 if( aff!=SQLITE_AFF_BLOB ){
3418 static const char zAff[] = "B\000C\000D\000E";
3419 assert( SQLITE_AFF_BLOB=='A' );
3420 assert( SQLITE_AFF_TEXT=='B' );
3421 if( iReg!=target ){
3422 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3423 iReg = target;
3424 }
3425 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3426 &zAff[(aff-'B')*2], P4_STATIC);
3427 }
3428 return iReg;
drhefad2e22018-07-27 16:57:11 +00003429 }
drhb2b9d3d2013-08-01 01:14:43 +00003430 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003431 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003432 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003433 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003434 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003435 /* Coding an expression that is part of an index where column names
3436 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003437 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003438 }
drh22827922000-06-06 17:27:05 +00003439 }
drheda079c2018-09-20 19:02:15 +00003440 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003441 pExpr->iColumn, iTab, target,
3442 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003443 }
3444 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003445 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003446 return target;
drhfec19aa2004-05-19 20:41:03 +00003447 }
drh8abed7b2018-02-26 18:49:05 +00003448 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003449 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003450 return target;
3451 }
drh13573c72010-01-12 17:04:07 +00003452#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003453 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003454 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3455 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003456 return target;
drh598f1342007-10-23 15:39:45 +00003457 }
drh13573c72010-01-12 17:04:07 +00003458#endif
drhfec19aa2004-05-19 20:41:03 +00003459 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003460 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003461 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003462 return target;
drhcce7d172000-05-31 15:34:51 +00003463 }
drhf0863fe2005-06-12 21:35:51 +00003464 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003465 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003466 return target;
drhf0863fe2005-06-12 21:35:51 +00003467 }
danielk19775338a5f2005-01-20 13:03:10 +00003468#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003469 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003470 int n;
3471 const char *z;
drhca48c902008-01-18 14:08:24 +00003472 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003473 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3474 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3475 assert( pExpr->u.zToken[1]=='\'' );
3476 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003477 n = sqlite3Strlen30(z) - 1;
3478 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003479 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3480 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003481 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003482 }
danielk19775338a5f2005-01-20 13:03:10 +00003483#endif
drh50457892003-09-06 01:10:47 +00003484 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003485 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3486 assert( pExpr->u.zToken!=0 );
3487 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003488 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3489 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003490 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003491 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003492 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003493 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003494 }
drhc332cc32016-09-19 10:24:19 +00003495 return target;
drh50457892003-09-06 01:10:47 +00003496 }
drh4e0cff62004-11-05 05:10:28 +00003497 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003498 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003499 }
drh487e2622005-06-25 18:42:14 +00003500#ifndef SQLITE_OMIT_CAST
3501 case TK_CAST: {
3502 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003503 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003504 if( inReg!=target ){
3505 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3506 inReg = target;
3507 }
drh4169e432014-08-25 20:11:52 +00003508 sqlite3VdbeAddOp2(v, OP_Cast, target,
3509 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003510 return inReg;
drh487e2622005-06-25 18:42:14 +00003511 }
3512#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003513 case TK_IS:
3514 case TK_ISNOT:
3515 op = (op==TK_IS) ? TK_EQ : TK_NE;
3516 p5 = SQLITE_NULLEQ;
3517 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003518 case TK_LT:
3519 case TK_LE:
3520 case TK_GT:
3521 case TK_GE:
3522 case TK_NE:
3523 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003524 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003525 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003526 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003527 }else{
3528 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3529 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3530 codeCompare(pParse, pLeft, pExpr->pRight, op,
3531 r1, r2, inReg, SQLITE_STOREP2 | p5);
3532 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3533 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3534 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3535 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3536 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3537 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3538 testcase( regFree1==0 );
3539 testcase( regFree2==0 );
3540 }
drh6a2fe092009-09-23 02:29:36 +00003541 break;
3542 }
drhcce7d172000-05-31 15:34:51 +00003543 case TK_AND:
3544 case TK_OR:
3545 case TK_PLUS:
3546 case TK_STAR:
3547 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003548 case TK_REM:
3549 case TK_BITAND:
3550 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003551 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003552 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003553 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003554 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003555 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3556 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3557 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3558 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3559 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3560 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3561 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3562 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3563 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3564 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3565 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003566 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3567 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003568 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003569 testcase( regFree1==0 );
3570 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003571 break;
3572 }
drhcce7d172000-05-31 15:34:51 +00003573 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003574 Expr *pLeft = pExpr->pLeft;
3575 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003576 if( pLeft->op==TK_INTEGER ){
3577 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003578 return target;
drh13573c72010-01-12 17:04:07 +00003579#ifndef SQLITE_OMIT_FLOATING_POINT
3580 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003581 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3582 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003583 return target;
drh13573c72010-01-12 17:04:07 +00003584#endif
drh3c84ddf2008-01-09 02:15:38 +00003585 }else{
drh10d1edf2013-11-15 15:52:39 +00003586 tempX.op = TK_INTEGER;
3587 tempX.flags = EP_IntValue|EP_TokenOnly;
3588 tempX.u.iValue = 0;
3589 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003590 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003591 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003592 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003593 }
drh3c84ddf2008-01-09 02:15:38 +00003594 break;
drh6e142f52000-06-08 13:36:40 +00003595 }
drhbf4133c2001-10-13 02:59:08 +00003596 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003597 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003598 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3599 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003600 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3601 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003602 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003603 break;
3604 }
drh8abed7b2018-02-26 18:49:05 +00003605 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003606 int isTrue; /* IS TRUE or IS NOT TRUE */
3607 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003608 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3609 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003610 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3611 bNormal = pExpr->op2==TK_IS;
3612 testcase( isTrue && bNormal);
3613 testcase( !isTrue && bNormal);
3614 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003615 break;
3616 }
drhcce7d172000-05-31 15:34:51 +00003617 case TK_ISNULL:
3618 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003619 int addr;
drh7d176102014-02-18 03:07:12 +00003620 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3621 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003622 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003623 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003624 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003625 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003626 VdbeCoverageIf(v, op==TK_ISNULL);
3627 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003628 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003629 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003630 break;
drhcce7d172000-05-31 15:34:51 +00003631 }
drh22827922000-06-06 17:27:05 +00003632 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003633 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003634 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003635 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3636 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003637 }else{
drhc332cc32016-09-19 10:24:19 +00003638 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003639 }
drh22827922000-06-06 17:27:05 +00003640 break;
3641 }
drhcce7d172000-05-31 15:34:51 +00003642 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003643 ExprList *pFarg; /* List of function arguments */
3644 int nFarg; /* Number of function arguments */
3645 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003646 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003647 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003648 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003649 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003650 u8 enc = ENC(db); /* The text encoding used by this database */
3651 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003652
dan67a9b8e2018-06-22 20:51:35 +00003653#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003654 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3655 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003656 }
dan67a9b8e2018-06-22 20:51:35 +00003657#endif
dan86fb6e12018-05-16 20:58:07 +00003658
drh1e9b53f2017-01-04 01:07:24 +00003659 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003660 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003661 ** out of the inner loop, even if that means an extra OP_Copy. */
3662 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003663 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003664 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003665 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003666 pFarg = 0;
3667 }else{
3668 pFarg = pExpr->x.pList;
3669 }
3670 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003671 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3672 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003673 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003674#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3675 if( pDef==0 && pParse->explain ){
3676 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3677 }
3678#endif
danb6e9f7a2018-05-19 14:15:29 +00003679 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003680 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003681 break;
3682 }
drhae6bb952009-11-11 00:24:31 +00003683
3684 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003685 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003686 ** arguments past the first non-NULL argument.
3687 */
drhd36e1042013-09-06 13:10:12 +00003688 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00003689 int endCoalesce = sqlite3VdbeMakeLabel(v);
3690 assert( nFarg>=2 );
3691 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3692 for(i=1; i<nFarg; i++){
3693 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003694 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003695 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003696 }
3697 sqlite3VdbeResolveLabel(v, endCoalesce);
3698 break;
3699 }
3700
drhcca9f3d2013-09-06 15:23:29 +00003701 /* The UNLIKELY() function is a no-op. The result is the value
3702 ** of the first argument.
3703 */
3704 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3705 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003706 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003707 }
drhae6bb952009-11-11 00:24:31 +00003708
drh54240752017-01-03 14:39:30 +00003709#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003710 /* The AFFINITY() function evaluates to a string that describes
3711 ** the type affinity of the argument. This is used for testing of
3712 ** the SQLite type logic.
3713 */
3714 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3715 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3716 char aff;
3717 assert( nFarg==1 );
3718 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3719 sqlite3VdbeLoadString(v, target,
3720 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3721 return target;
3722 }
drh54240752017-01-03 14:39:30 +00003723#endif
drha1a523a2016-12-26 00:18:36 +00003724
drhd1a01ed2013-11-21 16:08:52 +00003725 for(i=0; i<nFarg; i++){
3726 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003727 testcase( i==31 );
3728 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003729 }
3730 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3731 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3732 }
3733 }
drh12ffee82009-04-08 13:51:51 +00003734 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003735 if( constMask ){
3736 r1 = pParse->nMem+1;
3737 pParse->nMem += nFarg;
3738 }else{
3739 r1 = sqlite3GetTempRange(pParse, nFarg);
3740 }
drha748fdc2012-03-28 01:34:47 +00003741
3742 /* For length() and typeof() functions with a column argument,
3743 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3744 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3745 ** loading.
3746 */
drhd36e1042013-09-06 13:10:12 +00003747 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003748 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003749 assert( nFarg==1 );
3750 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003751 exprOp = pFarg->a[0].pExpr->op;
3752 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003753 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3754 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003755 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3756 pFarg->a[0].pExpr->op2 =
3757 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003758 }
3759 }
3760
drh5579d592015-08-26 14:01:41 +00003761 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003762 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003763 }else{
drh12ffee82009-04-08 13:51:51 +00003764 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003765 }
drhb7f6f682006-07-08 17:06:43 +00003766#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003767 /* Possibly overload the function if the first argument is
3768 ** a virtual table column.
3769 **
3770 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3771 ** second argument, not the first, as the argument to test to
3772 ** see if it is a column in a virtual table. This is done because
3773 ** the left operand of infix functions (the operand we want to
3774 ** control overloading) ends up as the second argument to the
3775 ** function. The expression "A glob B" is equivalent to
3776 ** "glob(B,A). We want to use the A in "A glob B" to test
3777 ** for function overloading. But we use the B term in "glob(B,A)".
3778 */
drh59155062018-05-26 18:03:48 +00003779 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003780 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3781 }else if( nFarg>0 ){
3782 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003783 }
3784#endif
drhd36e1042013-09-06 13:10:12 +00003785 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003786 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003787 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003788 }
drh092457b2017-12-29 15:04:49 +00003789#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3790 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003791 Expr *pArg = pFarg->a[0].pExpr;
3792 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003793 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003794 }else{
3795 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3796 }
drh092457b2017-12-29 15:04:49 +00003797 }else
3798#endif
3799 {
drh2fc865c2017-12-16 20:20:37 +00003800 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3801 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3802 sqlite3VdbeChangeP5(v, (u8)nFarg);
3803 }
drhd1a01ed2013-11-21 16:08:52 +00003804 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003805 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003806 }
drhc332cc32016-09-19 10:24:19 +00003807 return target;
drhcce7d172000-05-31 15:34:51 +00003808 }
drhfe2093d2005-01-20 22:48:47 +00003809#ifndef SQLITE_OMIT_SUBQUERY
3810 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003811 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003812 int nCol;
drhc5499be2008-04-01 15:06:33 +00003813 testcase( op==TK_EXISTS );
3814 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003815 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3816 sqlite3SubselectError(pParse, nCol, 1);
3817 }else{
drhc332cc32016-09-19 10:24:19 +00003818 return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
dan8da209b2016-07-26 18:06:08 +00003819 }
drh19a775c2000-06-05 18:54:46 +00003820 break;
3821 }
drhfc7f27b2016-08-20 00:07:01 +00003822 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003823 int n;
drhfc7f27b2016-08-20 00:07:01 +00003824 if( pExpr->pLeft->iTable==0 ){
3825 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3826 }
drh966e2912017-01-03 02:58:01 +00003827 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3828 if( pExpr->iTable
3829 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3830 ){
3831 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3832 pExpr->iTable, n);
3833 }
drhc332cc32016-09-19 10:24:19 +00003834 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003835 }
drhfef52082000-06-06 01:50:43 +00003836 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003837 int destIfFalse = sqlite3VdbeMakeLabel(v);
3838 int destIfNull = sqlite3VdbeMakeLabel(v);
3839 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3840 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3841 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3842 sqlite3VdbeResolveLabel(v, destIfFalse);
3843 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3844 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003845 return target;
drhfef52082000-06-06 01:50:43 +00003846 }
drhe3365e62009-11-12 17:52:24 +00003847#endif /* SQLITE_OMIT_SUBQUERY */
3848
3849
drh2dcef112008-01-12 19:03:48 +00003850 /*
3851 ** x BETWEEN y AND z
3852 **
3853 ** This is equivalent to
3854 **
3855 ** x>=y AND x<=z
3856 **
3857 ** X is stored in pExpr->pLeft.
3858 ** Y is stored in pExpr->pList->a[0].pExpr.
3859 ** Z is stored in pExpr->pList->a[1].pExpr.
3860 */
drhfef52082000-06-06 01:50:43 +00003861 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003862 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003863 return target;
drhfef52082000-06-06 01:50:43 +00003864 }
drh94fa9c42016-02-27 21:16:04 +00003865 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003866 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003867 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003868 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003869 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003870 }
drh2dcef112008-01-12 19:03:48 +00003871
dan165921a2009-08-28 18:53:45 +00003872 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003873 /* If the opcode is TK_TRIGGER, then the expression is a reference
3874 ** to a column in the new.* or old.* pseudo-tables available to
3875 ** trigger programs. In this case Expr.iTable is set to 1 for the
3876 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3877 ** is set to the column of the pseudo-table to read, or to -1 to
3878 ** read the rowid field.
3879 **
3880 ** The expression is implemented using an OP_Param opcode. The p1
3881 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3882 ** to reference another column of the old.* pseudo-table, where
3883 ** i is the index of the column. For a new.rowid reference, p1 is
3884 ** set to (n+1), where n is the number of columns in each pseudo-table.
3885 ** For a reference to any other column in the new.* pseudo-table, p1
3886 ** is set to (n+2+i), where n and i are as defined previously. For
3887 ** example, if the table on which triggers are being fired is
3888 ** declared as:
3889 **
3890 ** CREATE TABLE t1(a, b);
3891 **
3892 ** Then p1 is interpreted as follows:
3893 **
3894 ** p1==0 -> old.rowid p1==3 -> new.rowid
3895 ** p1==1 -> old.a p1==4 -> new.a
3896 ** p1==2 -> old.b p1==5 -> new.b
3897 */
drheda079c2018-09-20 19:02:15 +00003898 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003899 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3900
3901 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3902 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3903 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3904 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3905
3906 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003907 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003908 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003909 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003910 ));
dan65a7cd12009-09-01 12:16:01 +00003911
drh44dbca82010-01-13 04:22:20 +00003912#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003913 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003914 ** integer. Use OP_RealAffinity to make sure it is really real.
3915 **
3916 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3917 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003918 if( pExpr->iColumn>=0
3919 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3920 ){
3921 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3922 }
drh44dbca82010-01-13 04:22:20 +00003923#endif
dan165921a2009-08-28 18:53:45 +00003924 break;
3925 }
3926
dan71c57db2016-07-09 20:23:55 +00003927 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00003928 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00003929 break;
3930 }
3931
drh31d6fd52017-04-14 19:03:10 +00003932 case TK_IF_NULL_ROW: {
3933 int addrINR;
3934 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00003935 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00003936 sqlite3VdbeJumpHere(v, addrINR);
3937 sqlite3VdbeChangeP3(v, addrINR, inReg);
3938 break;
3939 }
3940
drh2dcef112008-01-12 19:03:48 +00003941 /*
3942 ** Form A:
3943 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3944 **
3945 ** Form B:
3946 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3947 **
3948 ** Form A is can be transformed into the equivalent form B as follows:
3949 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3950 ** WHEN x=eN THEN rN ELSE y END
3951 **
3952 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003953 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3954 ** odd. The Y is also optional. If the number of elements in x.pList
3955 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003956 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3957 **
3958 ** The result of the expression is the Ri for the first matching Ei,
3959 ** or if there is no matching Ei, the ELSE term Y, or if there is
3960 ** no ELSE term, NULL.
3961 */
drh33cd4902009-05-30 20:49:20 +00003962 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003963 int endLabel; /* GOTO label for end of CASE stmt */
3964 int nextCase; /* GOTO label for next WHEN clause */
3965 int nExpr; /* 2x number of WHEN terms */
3966 int i; /* Loop counter */
3967 ExprList *pEList; /* List of WHEN terms */
3968 struct ExprList_item *aListelem; /* Array of WHEN terms */
3969 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00003970 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00003971 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00003972
danielk19776ab3a2e2009-02-19 14:39:25 +00003973 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00003974 assert(pExpr->x.pList->nExpr > 0);
3975 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00003976 aListelem = pEList->a;
3977 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00003978 endLabel = sqlite3VdbeMakeLabel(v);
3979 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00003980 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00003981 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00003982 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00003983 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00003984 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00003985 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00003986 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00003987 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00003988 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
3989 ** The value in regFree1 might get SCopy-ed into the file result.
3990 ** So make sure that the regFree1 register is not reused for other
3991 ** purposes and possibly overwritten. */
3992 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00003993 }
drhc5cd1242013-09-12 16:50:49 +00003994 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00003995 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00003996 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00003997 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003998 }else{
drh2dcef112008-01-12 19:03:48 +00003999 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004000 }
drh2dcef112008-01-12 19:03:48 +00004001 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00004002 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004003 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004004 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004005 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004006 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004007 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004008 }
drhc5cd1242013-09-12 16:50:49 +00004009 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004010 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004011 }else{
drh9de221d2008-01-05 06:51:30 +00004012 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004013 }
drh2dcef112008-01-12 19:03:48 +00004014 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004015 break;
4016 }
danielk19775338a5f2005-01-20 13:03:10 +00004017#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004018 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004019 assert( pExpr->affinity==OE_Rollback
4020 || pExpr->affinity==OE_Abort
4021 || pExpr->affinity==OE_Fail
4022 || pExpr->affinity==OE_Ignore
4023 );
dane0af83a2009-09-08 19:15:01 +00004024 if( !pParse->pTriggerTab ){
4025 sqlite3ErrorMsg(pParse,
4026 "RAISE() may only be used within a trigger-program");
4027 return 0;
4028 }
4029 if( pExpr->affinity==OE_Abort ){
4030 sqlite3MayAbort(pParse);
4031 }
dan165921a2009-08-28 18:53:45 +00004032 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004033 if( pExpr->affinity==OE_Ignore ){
4034 sqlite3VdbeAddOp4(
4035 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004036 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004037 }else{
drh433dccf2013-02-09 15:37:11 +00004038 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004039 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004040 }
4041
drhffe07b22005-11-03 00:41:17 +00004042 break;
drh17a7f8d2002-03-24 13:13:27 +00004043 }
danielk19775338a5f2005-01-20 13:03:10 +00004044#endif
drhffe07b22005-11-03 00:41:17 +00004045 }
drh2dcef112008-01-12 19:03:48 +00004046 sqlite3ReleaseTempReg(pParse, regFree1);
4047 sqlite3ReleaseTempReg(pParse, regFree2);
4048 return inReg;
4049}
4050
4051/*
drhd1a01ed2013-11-21 16:08:52 +00004052** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004053**
drhad879ff2017-01-04 04:10:02 +00004054** If regDest>=0 then the result is always stored in that register and the
4055** result is not reusable. If regDest<0 then this routine is free to
4056** store the value whereever it wants. The register where the expression
4057** is stored is returned. When regDest<0, two identical expressions will
4058** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004059*/
drh1e9b53f2017-01-04 01:07:24 +00004060int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004061 Parse *pParse, /* Parsing context */
4062 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004063 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004064){
drhd1a01ed2013-11-21 16:08:52 +00004065 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004066 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004067 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004068 if( regDest<0 && p ){
4069 struct ExprList_item *pItem;
4070 int i;
4071 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004072 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004073 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004074 }
4075 }
drh1e9b53f2017-01-04 01:07:24 +00004076 }
drhd1a01ed2013-11-21 16:08:52 +00004077 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4078 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004079 if( p ){
4080 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004081 pItem->reusable = regDest<0;
4082 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004083 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004084 }
drhd1a01ed2013-11-21 16:08:52 +00004085 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004086 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004087}
4088
4089/*
drh2dcef112008-01-12 19:03:48 +00004090** Generate code to evaluate an expression and store the results
4091** into a register. Return the register number where the results
4092** are stored.
4093**
4094** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004095** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004096** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004097**
4098** If pExpr is a constant, then this routine might generate this
4099** code to fill the register in the initialization section of the
4100** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004101*/
4102int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004103 int r2;
4104 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004105 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004106 && pExpr->op!=TK_REGISTER
4107 && sqlite3ExprIsConstantNotJoin(pExpr)
4108 ){
drhf30a9692013-11-15 01:10:18 +00004109 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004110 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004111 }else{
drhf30a9692013-11-15 01:10:18 +00004112 int r1 = sqlite3GetTempReg(pParse);
4113 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4114 if( r2==r1 ){
4115 *pReg = r1;
4116 }else{
4117 sqlite3ReleaseTempReg(pParse, r1);
4118 *pReg = 0;
4119 }
drh2dcef112008-01-12 19:03:48 +00004120 }
4121 return r2;
4122}
4123
4124/*
4125** Generate code that will evaluate expression pExpr and store the
4126** results in register target. The results are guaranteed to appear
4127** in register target.
4128*/
drh05a86c52014-02-16 01:55:49 +00004129void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004130 int inReg;
4131
4132 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004133 if( pExpr && pExpr->op==TK_REGISTER ){
4134 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4135 }else{
4136 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004137 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004138 if( inReg!=target && pParse->pVdbe ){
4139 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4140 }
drhcce7d172000-05-31 15:34:51 +00004141 }
drhcce7d172000-05-31 15:34:51 +00004142}
4143
4144/*
drh1c75c9d2015-12-21 15:22:13 +00004145** Make a transient copy of expression pExpr and then code it using
4146** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4147** except that the input expression is guaranteed to be unchanged.
4148*/
4149void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4150 sqlite3 *db = pParse->db;
4151 pExpr = sqlite3ExprDup(db, pExpr, 0);
4152 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4153 sqlite3ExprDelete(db, pExpr);
4154}
4155
4156/*
drh05a86c52014-02-16 01:55:49 +00004157** Generate code that will evaluate expression pExpr and store the
4158** results in register target. The results are guaranteed to appear
4159** in register target. If the expression is constant, then this routine
4160** might choose to code the expression at initialization time.
4161*/
4162void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004163 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004164 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004165 }else{
4166 sqlite3ExprCode(pParse, pExpr, target);
4167 }
drhcce7d172000-05-31 15:34:51 +00004168}
4169
4170/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004171** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004172** in register target.
drh25303782004-12-07 15:41:48 +00004173**
drh2dcef112008-01-12 19:03:48 +00004174** Also make a copy of the expression results into another "cache" register
4175** and modify the expression so that the next time it is evaluated,
4176** the result is a copy of the cache register.
4177**
4178** This routine is used for expressions that are used multiple
4179** times. They are evaluated once and the results of the expression
4180** are reused.
drh25303782004-12-07 15:41:48 +00004181*/
drh05a86c52014-02-16 01:55:49 +00004182void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004183 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004184 int iMem;
4185
drhde4fcfd2008-01-19 23:50:26 +00004186 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004187 assert( pExpr->op!=TK_REGISTER );
4188 sqlite3ExprCode(pParse, pExpr, target);
4189 iMem = ++pParse->nMem;
4190 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4191 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004192}
drh2dcef112008-01-12 19:03:48 +00004193
drh678ccce2008-03-31 18:19:54 +00004194/*
drh268380c2004-02-25 13:47:31 +00004195** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004196** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004197**
drh3df6c3b2017-09-15 15:38:01 +00004198** Return the number of elements evaluated. The number returned will
4199** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4200** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004201**
4202** The SQLITE_ECEL_DUP flag prevents the arguments from being
4203** filled using OP_SCopy. OP_Copy must be used instead.
4204**
4205** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4206** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004207**
4208** The SQLITE_ECEL_REF flag means that expressions in the list with
4209** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4210** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004211** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4212** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004213*/
danielk19774adee202004-05-08 08:23:19 +00004214int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004215 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004216 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004217 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004218 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004219 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004220){
4221 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004222 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004223 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004224 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004225 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004226 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004227 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004228 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004229 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004230 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004231 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004232#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4233 if( pItem->bSorterRef ){
4234 i--;
4235 n--;
4236 }else
4237#endif
dan257c13f2016-11-10 20:14:06 +00004238 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4239 if( flags & SQLITE_ECEL_OMITREF ){
4240 i--;
4241 n--;
4242 }else{
4243 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4244 }
drhb8b06692018-08-04 15:16:20 +00004245 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4246 && sqlite3ExprIsConstantNotJoin(pExpr)
4247 ){
drhad879ff2017-01-04 04:10:02 +00004248 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004249 }else{
4250 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4251 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004252 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004253 if( copyOp==OP_Copy
4254 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4255 && pOp->p1+pOp->p3+1==inReg
4256 && pOp->p2+pOp->p3+1==target+i
4257 ){
4258 pOp->p3++;
4259 }else{
4260 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4261 }
drhd1a01ed2013-11-21 16:08:52 +00004262 }
drhd1766112008-09-17 00:13:12 +00004263 }
drh268380c2004-02-25 13:47:31 +00004264 }
drhf9b596e2004-05-26 16:54:42 +00004265 return n;
drh268380c2004-02-25 13:47:31 +00004266}
4267
4268/*
drh36c563a2009-11-12 13:32:22 +00004269** Generate code for a BETWEEN operator.
4270**
4271** x BETWEEN y AND z
4272**
4273** The above is equivalent to
4274**
4275** x>=y AND x<=z
4276**
4277** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004278** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004279**
4280** The xJumpIf parameter determines details:
4281**
4282** NULL: Store the boolean result in reg[dest]
4283** sqlite3ExprIfTrue: Jump to dest if true
4284** sqlite3ExprIfFalse: Jump to dest if false
4285**
4286** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004287*/
4288static void exprCodeBetween(
4289 Parse *pParse, /* Parsing and code generating context */
4290 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004291 int dest, /* Jump destination or storage location */
4292 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004293 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4294){
drhdb45bd52016-08-22 00:48:58 +00004295 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004296 Expr compLeft; /* The x>=y term */
4297 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004298 Expr exprX; /* The x subexpression */
4299 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004300
drh36c563a2009-11-12 13:32:22 +00004301
dan71c57db2016-07-09 20:23:55 +00004302 memset(&compLeft, 0, sizeof(Expr));
4303 memset(&compRight, 0, sizeof(Expr));
4304 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004305
4306 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4307 exprX = *pExpr->pLeft;
drh36c563a2009-11-12 13:32:22 +00004308 exprAnd.op = TK_AND;
4309 exprAnd.pLeft = &compLeft;
4310 exprAnd.pRight = &compRight;
4311 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004312 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004313 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4314 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004315 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004316 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004317 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004318 if( xJump ){
4319 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004320 }else{
drh36fd41e2016-11-25 14:30:42 +00004321 /* Mark the expression is being from the ON or USING clause of a join
4322 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4323 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4324 ** for clarity, but we are out of bits in the Expr.flags field so we
4325 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004326 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004327 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004328 }
drhdb45bd52016-08-22 00:48:58 +00004329 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004330
4331 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004332 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4333 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4334 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4335 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4336 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4337 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4338 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4339 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004340 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004341}
4342
4343/*
drhcce7d172000-05-31 15:34:51 +00004344** Generate code for a boolean expression such that a jump is made
4345** to the label "dest" if the expression is true but execution
4346** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004347**
4348** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004349** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004350**
4351** This code depends on the fact that certain token values (ex: TK_EQ)
4352** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4353** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4354** the make process cause these values to align. Assert()s in the code
4355** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004356*/
danielk19774adee202004-05-08 08:23:19 +00004357void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004358 Vdbe *v = pParse->pVdbe;
4359 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004360 int regFree1 = 0;
4361 int regFree2 = 0;
4362 int r1, r2;
4363
drh35573352008-01-08 23:54:25 +00004364 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004365 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004366 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004367 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004368 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004369 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00004370 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004371 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004372 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004373 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4374 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004375 break;
4376 }
4377 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004378 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004379 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4380 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004381 break;
4382 }
4383 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004384 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004385 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004386 break;
4387 }
drh8abed7b2018-02-26 18:49:05 +00004388 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004389 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4390 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004391 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004392 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004393 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004394 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004395 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004396 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004397 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4398 isNot ? SQLITE_JUMPIFNULL : 0);
4399 }else{
4400 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4401 isNot ? SQLITE_JUMPIFNULL : 0);
4402 }
drh007c8432018-02-26 03:20:18 +00004403 break;
4404 }
drhde845c22016-03-17 19:07:52 +00004405 case TK_IS:
4406 case TK_ISNOT:
4407 testcase( op==TK_IS );
4408 testcase( op==TK_ISNOT );
4409 op = (op==TK_IS) ? TK_EQ : TK_NE;
4410 jumpIfNull = SQLITE_NULLEQ;
4411 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004412 case TK_LT:
4413 case TK_LE:
4414 case TK_GT:
4415 case TK_GE:
4416 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004417 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004418 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004419 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004420 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4421 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004422 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004423 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004424 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4425 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4426 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4427 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004428 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4429 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4430 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4431 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4432 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4433 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004434 testcase( regFree1==0 );
4435 testcase( regFree2==0 );
4436 break;
4437 }
drhcce7d172000-05-31 15:34:51 +00004438 case TK_ISNULL:
4439 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004440 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4441 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004442 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4443 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004444 VdbeCoverageIf(v, op==TK_ISNULL);
4445 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004446 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004447 break;
4448 }
drhfef52082000-06-06 01:50:43 +00004449 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004450 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004451 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004452 break;
4453 }
drh84e30ca2011-02-10 17:46:14 +00004454#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004455 case TK_IN: {
4456 int destIfFalse = sqlite3VdbeMakeLabel(v);
4457 int destIfNull = jumpIfNull ? dest : destIfFalse;
4458 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004459 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004460 sqlite3VdbeResolveLabel(v, destIfFalse);
4461 break;
4462 }
shanehbb201342011-02-09 19:55:20 +00004463#endif
drhcce7d172000-05-31 15:34:51 +00004464 default: {
dan7b35a772016-07-28 19:47:15 +00004465 default_expr:
drh991a1982014-01-02 17:57:16 +00004466 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004467 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004468 }else if( exprAlwaysFalse(pExpr) ){
4469 /* No-op */
4470 }else{
4471 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4472 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004473 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004474 testcase( regFree1==0 );
4475 testcase( jumpIfNull==0 );
4476 }
drhcce7d172000-05-31 15:34:51 +00004477 break;
4478 }
4479 }
drh2dcef112008-01-12 19:03:48 +00004480 sqlite3ReleaseTempReg(pParse, regFree1);
4481 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004482}
4483
4484/*
drh66b89c82000-11-28 20:47:17 +00004485** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004486** to the label "dest" if the expression is false but execution
4487** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004488**
4489** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004490** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4491** is 0.
drhcce7d172000-05-31 15:34:51 +00004492*/
danielk19774adee202004-05-08 08:23:19 +00004493void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004494 Vdbe *v = pParse->pVdbe;
4495 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004496 int regFree1 = 0;
4497 int regFree2 = 0;
4498 int r1, r2;
4499
drh35573352008-01-08 23:54:25 +00004500 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004501 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004502 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004503
4504 /* The value of pExpr->op and op are related as follows:
4505 **
4506 ** pExpr->op op
4507 ** --------- ----------
4508 ** TK_ISNULL OP_NotNull
4509 ** TK_NOTNULL OP_IsNull
4510 ** TK_NE OP_Eq
4511 ** TK_EQ OP_Ne
4512 ** TK_GT OP_Le
4513 ** TK_LE OP_Gt
4514 ** TK_GE OP_Lt
4515 ** TK_LT OP_Ge
4516 **
4517 ** For other values of pExpr->op, op is undefined and unused.
4518 ** The value of TK_ and OP_ constants are arranged such that we
4519 ** can compute the mapping above using the following expression.
4520 ** Assert()s verify that the computation is correct.
4521 */
4522 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4523
4524 /* Verify correct alignment of TK_ and OP_ constants
4525 */
4526 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4527 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4528 assert( pExpr->op!=TK_NE || op==OP_Eq );
4529 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4530 assert( pExpr->op!=TK_LT || op==OP_Ge );
4531 assert( pExpr->op!=TK_LE || op==OP_Gt );
4532 assert( pExpr->op!=TK_GT || op==OP_Le );
4533 assert( pExpr->op!=TK_GE || op==OP_Lt );
4534
danba00e302016-07-23 20:24:06 +00004535 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004536 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004537 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004538 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4539 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004540 break;
4541 }
4542 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00004543 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004544 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004545 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004546 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4547 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004548 break;
4549 }
4550 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004551 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004552 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004553 break;
4554 }
drh8abed7b2018-02-26 18:49:05 +00004555 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004556 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4557 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004558 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004559 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004560 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004561 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004562 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004563 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004564 /* IS TRUE and IS NOT FALSE */
4565 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4566 isNot ? 0 : SQLITE_JUMPIFNULL);
4567
4568 }else{
4569 /* IS FALSE and IS NOT TRUE */
4570 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004571 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004572 }
drh007c8432018-02-26 03:20:18 +00004573 break;
4574 }
drhde845c22016-03-17 19:07:52 +00004575 case TK_IS:
4576 case TK_ISNOT:
4577 testcase( pExpr->op==TK_IS );
4578 testcase( pExpr->op==TK_ISNOT );
4579 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4580 jumpIfNull = SQLITE_NULLEQ;
4581 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004582 case TK_LT:
4583 case TK_LE:
4584 case TK_GT:
4585 case TK_GE:
4586 case TK_NE:
4587 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004588 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004589 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004590 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4591 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004592 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004593 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004594 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4595 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4596 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4597 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004598 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4599 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4600 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4601 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4602 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4603 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004604 testcase( regFree1==0 );
4605 testcase( regFree2==0 );
4606 break;
4607 }
drhcce7d172000-05-31 15:34:51 +00004608 case TK_ISNULL:
4609 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004610 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4611 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004612 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4613 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004614 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004615 break;
4616 }
drhfef52082000-06-06 01:50:43 +00004617 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004618 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004619 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004620 break;
4621 }
drh84e30ca2011-02-10 17:46:14 +00004622#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004623 case TK_IN: {
4624 if( jumpIfNull ){
4625 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4626 }else{
4627 int destIfNull = sqlite3VdbeMakeLabel(v);
4628 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4629 sqlite3VdbeResolveLabel(v, destIfNull);
4630 }
4631 break;
4632 }
shanehbb201342011-02-09 19:55:20 +00004633#endif
drhcce7d172000-05-31 15:34:51 +00004634 default: {
danba00e302016-07-23 20:24:06 +00004635 default_expr:
drh991a1982014-01-02 17:57:16 +00004636 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004637 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004638 }else if( exprAlwaysTrue(pExpr) ){
4639 /* no-op */
4640 }else{
4641 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4642 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004643 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004644 testcase( regFree1==0 );
4645 testcase( jumpIfNull==0 );
4646 }
drhcce7d172000-05-31 15:34:51 +00004647 break;
4648 }
4649 }
drh2dcef112008-01-12 19:03:48 +00004650 sqlite3ReleaseTempReg(pParse, regFree1);
4651 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004652}
drh22827922000-06-06 17:27:05 +00004653
4654/*
drh72bc8202015-06-11 13:58:35 +00004655** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4656** code generation, and that copy is deleted after code generation. This
4657** ensures that the original pExpr is unchanged.
4658*/
4659void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4660 sqlite3 *db = pParse->db;
4661 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4662 if( db->mallocFailed==0 ){
4663 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4664 }
4665 sqlite3ExprDelete(db, pCopy);
4666}
4667
dan5aa550c2017-06-24 18:10:29 +00004668/*
4669** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4670** type of expression.
4671**
4672** If pExpr is a simple SQL value - an integer, real, string, blob
4673** or NULL value - then the VDBE currently being prepared is configured
4674** to re-prepare each time a new value is bound to variable pVar.
4675**
4676** Additionally, if pExpr is a simple SQL value and the value is the
4677** same as that currently bound to variable pVar, non-zero is returned.
4678** Otherwise, if the values are not the same or if pExpr is not a simple
4679** SQL value, zero is returned.
4680*/
4681static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4682 int res = 0;
drhc0804222017-06-28 21:47:16 +00004683 int iVar;
4684 sqlite3_value *pL, *pR = 0;
4685
4686 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4687 if( pR ){
4688 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004689 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004690 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004691 if( pL ){
4692 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4693 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4694 }
4695 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004696 }
drhc0804222017-06-28 21:47:16 +00004697 sqlite3ValueFree(pR);
4698 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004699 }
4700
4701 return res;
4702}
drh72bc8202015-06-11 13:58:35 +00004703
4704/*
drh1d9da702010-01-07 15:17:02 +00004705** Do a deep comparison of two expression trees. Return 0 if the two
4706** expressions are completely identical. Return 1 if they differ only
4707** by a COLLATE operator at the top level. Return 2 if there are differences
4708** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004709**
drh619a1302013-08-01 13:04:46 +00004710** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4711** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4712**
drh66518ca2013-08-01 15:09:57 +00004713** The pA side might be using TK_REGISTER. If that is the case and pB is
4714** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4715**
drh1d9da702010-01-07 15:17:02 +00004716** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004717** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004718** identical, we return 2 just to be safe. So if this routine
4719** returns 2, then you do not really know for certain if the two
4720** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004721** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004722** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004723** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004724** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004725**
drhc0804222017-06-28 21:47:16 +00004726** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4727** pParse->pReprepare can be matched against literals in pB. The
4728** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4729** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4730** Argument pParse should normally be NULL. If it is not NULL and pA or
4731** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004732*/
dan5aa550c2017-06-24 18:10:29 +00004733int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004734 u32 combinedFlags;
4735 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004736 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004737 }
dan5aa550c2017-06-24 18:10:29 +00004738 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4739 return 0;
4740 }
drh10d1edf2013-11-15 15:52:39 +00004741 combinedFlags = pA->flags | pB->flags;
4742 if( combinedFlags & EP_IntValue ){
4743 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4744 return 0;
4745 }
drh1d9da702010-01-07 15:17:02 +00004746 return 2;
drh22827922000-06-06 17:27:05 +00004747 }
drhc2acc4e2013-11-15 18:15:19 +00004748 if( pA->op!=pB->op ){
dan5aa550c2017-06-24 18:10:29 +00004749 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004750 return 1;
4751 }
dan5aa550c2017-06-24 18:10:29 +00004752 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004753 return 1;
4754 }
4755 return 2;
4756 }
drh2edc5fd2015-11-24 02:10:52 +00004757 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004758 if( pA->op==TK_FUNCTION ){
4759 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004760#ifndef SQLITE_OMIT_WINDOWFUNC
4761 /* Justification for the assert():
4762 ** window functions have p->op==TK_FUNCTION but aggregate functions
4763 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4764 ** function and a window function should have failed before reaching
4765 ** this point. And, it is not possible to have a window function and
4766 ** a scalar function with the same name and number of arguments. So
4767 ** if we reach this point, either A and B both window functions or
4768 ** neither are a window functions. */
4769 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4770 if( ExprHasProperty(pA,EP_WinFunc) ){
4771 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4772 }
4773#endif
drhd5af5422018-04-13 14:27:01 +00004774 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004775 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhefad2e22018-07-27 16:57:11 +00004776 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004777 return 2;
drh2646da72005-12-09 20:02:05 +00004778 }
drh22827922000-06-06 17:27:05 +00004779 }
drh10d1edf2013-11-15 15:52:39 +00004780 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00004781 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00004782 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004783 if( (combinedFlags & EP_FixedCol)==0
4784 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004785 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004786 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drhf49ff6f2018-04-23 20:38:40 +00004787 assert( (combinedFlags & EP_Reduced)==0 );
4788 if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
drh10d1edf2013-11-15 15:52:39 +00004789 if( pA->iColumn!=pB->iColumn ) return 2;
4790 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004791 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004792 }
4793 }
drh1d9da702010-01-07 15:17:02 +00004794 return 0;
drh22827922000-06-06 17:27:05 +00004795}
4796
drh8c6f6662010-04-26 19:17:26 +00004797/*
4798** Compare two ExprList objects. Return 0 if they are identical and
4799** non-zero if they differ in any way.
4800**
drh619a1302013-08-01 13:04:46 +00004801** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4802** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4803**
drh8c6f6662010-04-26 19:17:26 +00004804** This routine might return non-zero for equivalent ExprLists. The
4805** only consequence will be disabled optimizations. But this routine
4806** must never return 0 if the two ExprList objects are different, or
4807** a malfunction will result.
4808**
4809** Two NULL pointers are considered to be the same. But a NULL pointer
4810** always differs from a non-NULL pointer.
4811*/
drh619a1302013-08-01 13:04:46 +00004812int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004813 int i;
4814 if( pA==0 && pB==0 ) return 0;
4815 if( pA==0 || pB==0 ) return 1;
4816 if( pA->nExpr!=pB->nExpr ) return 1;
4817 for(i=0; i<pA->nExpr; i++){
4818 Expr *pExprA = pA->a[i].pExpr;
4819 Expr *pExprB = pB->a[i].pExpr;
4820 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004821 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004822 }
4823 return 0;
4824}
drh13449892005-09-07 21:22:45 +00004825
drh22827922000-06-06 17:27:05 +00004826/*
drhf9463df2017-02-11 14:59:58 +00004827** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4828** are ignored.
4829*/
4830int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004831 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004832 sqlite3ExprSkipCollate(pA),
4833 sqlite3ExprSkipCollate(pB),
4834 iTab);
4835}
4836
4837/*
drh4bd5f732013-07-31 23:22:39 +00004838** Return true if we can prove the pE2 will always be true if pE1 is
4839** true. Return false if we cannot complete the proof or if pE2 might
4840** be false. Examples:
4841**
drh619a1302013-08-01 13:04:46 +00004842** pE1: x==5 pE2: x==5 Result: true
4843** pE1: x>0 pE2: x==5 Result: false
4844** pE1: x=21 pE2: x=21 OR y=43 Result: true
4845** pE1: x!=123 pE2: x IS NOT NULL Result: true
4846** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4847** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4848** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004849**
4850** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4851** Expr.iTable<0 then assume a table number given by iTab.
4852**
drhc0804222017-06-28 21:47:16 +00004853** If pParse is not NULL, then the values of bound variables in pE1 are
4854** compared against literal values in pE2 and pParse->pVdbe->expmask is
4855** modified to record which bound variables are referenced. If pParse
4856** is NULL, then false will be returned if pE1 contains any bound variables.
4857**
drh4bd5f732013-07-31 23:22:39 +00004858** When in doubt, return false. Returning true might give a performance
4859** improvement. Returning false might cause a performance reduction, but
4860** it will always give the correct answer and is hence always safe.
4861*/
dan5aa550c2017-06-24 18:10:29 +00004862int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4863 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004864 return 1;
4865 }
4866 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004867 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4868 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004869 ){
4870 return 1;
4871 }
drh1ad93a02016-11-02 02:17:52 +00004872 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4873 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4874 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004875 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004876 }
4877 return 0;
drh4bd5f732013-07-31 23:22:39 +00004878}
4879
4880/*
drh25897872018-03-20 21:16:15 +00004881** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4882** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004883** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4884**
4885** This routine controls an optimization. False positives (setting
4886** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4887** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004888*/
4889static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004890 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004891 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004892 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4893 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004894 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004895 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004896 case TK_ISNULL:
4897 case TK_IS:
4898 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004899 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004900 case TK_IN:
drh25897872018-03-20 21:16:15 +00004901 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004902 testcase( pExpr->op==TK_ISNOT );
4903 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004904 testcase( pExpr->op==TK_ISNULL );
4905 testcase( pExpr->op==TK_IS );
4906 testcase( pExpr->op==TK_OR );
4907 testcase( pExpr->op==TK_CASE );
4908 testcase( pExpr->op==TK_IN );
4909 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00004910 return WRC_Prune;
4911 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00004912 if( pWalker->u.iCur==pExpr->iTable ){
4913 pWalker->eCode = 1;
4914 return WRC_Abort;
4915 }
4916 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00004917
4918 /* Virtual tables are allowed to use constraints like x=NULL. So
4919 ** a term of the form x=y does not prove that y is not null if x
4920 ** is the column of a virtual table */
4921 case TK_EQ:
4922 case TK_NE:
4923 case TK_LT:
4924 case TK_LE:
4925 case TK_GT:
4926 case TK_GE:
4927 testcase( pExpr->op==TK_EQ );
4928 testcase( pExpr->op==TK_NE );
4929 testcase( pExpr->op==TK_LT );
4930 testcase( pExpr->op==TK_LE );
4931 testcase( pExpr->op==TK_GT );
4932 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00004933 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
4934 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00004935 ){
4936 return WRC_Prune;
4937 }
drh25897872018-03-20 21:16:15 +00004938 default:
4939 return WRC_Continue;
4940 }
4941}
4942
4943/*
4944** Return true (non-zero) if expression p can only be true if at least
4945** one column of table iTab is non-null. In other words, return true
4946** if expression p will always be NULL or false if every column of iTab
4947** is NULL.
4948**
drh821b6102018-03-24 18:01:51 +00004949** False negatives are acceptable. In other words, it is ok to return
4950** zero even if expression p will never be true of every column of iTab
4951** is NULL. A false negative is merely a missed optimization opportunity.
4952**
4953** False positives are not allowed, however. A false positive may result
4954** in an incorrect answer.
4955**
drh25897872018-03-20 21:16:15 +00004956** Terms of p that are marked with EP_FromJoin (and hence that come from
4957** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
4958**
4959** This routine is used to check if a LEFT JOIN can be converted into
4960** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
4961** clause requires that some column of the right table of the LEFT JOIN
4962** be non-NULL, then the LEFT JOIN can be safely converted into an
4963** ordinary join.
4964*/
4965int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
4966 Walker w;
4967 w.xExprCallback = impliesNotNullRow;
4968 w.xSelectCallback = 0;
4969 w.xSelectCallback2 = 0;
4970 w.eCode = 0;
4971 w.u.iCur = iTab;
4972 sqlite3WalkExpr(&w, p);
4973 return w.eCode;
4974}
4975
4976/*
drh030796d2012-08-23 16:18:10 +00004977** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00004978** to determine if an expression can be evaluated by reference to the
4979** index only, without having to do a search for the corresponding
4980** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
4981** is the cursor for the table.
4982*/
4983struct IdxCover {
4984 Index *pIdx; /* The index to be tested for coverage */
4985 int iCur; /* Cursor number for the table corresponding to the index */
4986};
4987
4988/*
4989** Check to see if there are references to columns in table
4990** pWalker->u.pIdxCover->iCur can be satisfied using the index
4991** pWalker->u.pIdxCover->pIdx.
4992*/
4993static int exprIdxCover(Walker *pWalker, Expr *pExpr){
4994 if( pExpr->op==TK_COLUMN
4995 && pExpr->iTable==pWalker->u.pIdxCover->iCur
4996 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
4997 ){
4998 pWalker->eCode = 1;
4999 return WRC_Abort;
5000 }
5001 return WRC_Continue;
5002}
5003
5004/*
drhe604ec02016-07-27 19:20:58 +00005005** Determine if an index pIdx on table with cursor iCur contains will
5006** the expression pExpr. Return true if the index does cover the
5007** expression and false if the pExpr expression references table columns
5008** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005009**
5010** An index covering an expression means that the expression can be
5011** evaluated using only the index and without having to lookup the
5012** corresponding table entry.
5013*/
5014int sqlite3ExprCoveredByIndex(
5015 Expr *pExpr, /* The index to be tested */
5016 int iCur, /* The cursor number for the corresponding table */
5017 Index *pIdx /* The index that might be used for coverage */
5018){
5019 Walker w;
5020 struct IdxCover xcov;
5021 memset(&w, 0, sizeof(w));
5022 xcov.iCur = iCur;
5023 xcov.pIdx = pIdx;
5024 w.xExprCallback = exprIdxCover;
5025 w.u.pIdxCover = &xcov;
5026 sqlite3WalkExpr(&w, pExpr);
5027 return !w.eCode;
5028}
5029
5030
5031/*
5032** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005033** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005034** aggregate function, in order to implement the
5035** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005036*/
drh030796d2012-08-23 16:18:10 +00005037struct SrcCount {
5038 SrcList *pSrc; /* One particular FROM clause in a nested query */
5039 int nThis; /* Number of references to columns in pSrcList */
5040 int nOther; /* Number of references to columns in other FROM clauses */
5041};
5042
5043/*
5044** Count the number of references to columns.
5045*/
5046static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005047 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5048 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5049 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5050 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5051 ** NEVER() will need to be removed. */
5052 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005053 int i;
drh030796d2012-08-23 16:18:10 +00005054 struct SrcCount *p = pWalker->u.pSrcCount;
5055 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005056 int nSrc = pSrc ? pSrc->nSrc : 0;
5057 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005058 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005059 }
drh655814d2015-01-09 01:27:29 +00005060 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005061 p->nThis++;
5062 }else{
5063 p->nOther++;
5064 }
drh374fdce2012-04-17 16:38:53 +00005065 }
drh030796d2012-08-23 16:18:10 +00005066 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005067}
5068
5069/*
drh030796d2012-08-23 16:18:10 +00005070** Determine if any of the arguments to the pExpr Function reference
5071** pSrcList. Return true if they do. Also return true if the function
5072** has no arguments or has only constant arguments. Return false if pExpr
5073** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005074*/
drh030796d2012-08-23 16:18:10 +00005075int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005076 Walker w;
drh030796d2012-08-23 16:18:10 +00005077 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005078 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005079 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005080 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005081 w.u.pSrcCount = &cnt;
5082 cnt.pSrc = pSrcList;
5083 cnt.nThis = 0;
5084 cnt.nOther = 0;
5085 sqlite3WalkExprList(&w, pExpr->x.pList);
5086 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005087}
5088
5089/*
drh13449892005-09-07 21:22:45 +00005090** Add a new element to the pAggInfo->aCol[] array. Return the index of
5091** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005092*/
drh17435752007-08-16 04:30:38 +00005093static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005094 int i;
drhcf643722007-03-27 13:36:37 +00005095 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005096 db,
drhcf643722007-03-27 13:36:37 +00005097 pInfo->aCol,
5098 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005099 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005100 &i
5101 );
drh13449892005-09-07 21:22:45 +00005102 return i;
5103}
5104
5105/*
5106** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5107** the new element. Return a negative number if malloc fails.
5108*/
drh17435752007-08-16 04:30:38 +00005109static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005110 int i;
drhcf643722007-03-27 13:36:37 +00005111 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005112 db,
drhcf643722007-03-27 13:36:37 +00005113 pInfo->aFunc,
5114 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005115 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005116 &i
5117 );
drh13449892005-09-07 21:22:45 +00005118 return i;
5119}
drh22827922000-06-06 17:27:05 +00005120
5121/*
drh7d10d5a2008-08-20 16:35:10 +00005122** This is the xExprCallback for a tree walker. It is used to
5123** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005124** for additional information.
drh22827922000-06-06 17:27:05 +00005125*/
drh7d10d5a2008-08-20 16:35:10 +00005126static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005127 int i;
drh7d10d5a2008-08-20 16:35:10 +00005128 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005129 Parse *pParse = pNC->pParse;
5130 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005131 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005132
drh25c3b8c2018-04-16 10:34:13 +00005133 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005134 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005135 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005136 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005137 testcase( pExpr->op==TK_AGG_COLUMN );
5138 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005139 /* Check to see if the column is in one of the tables in the FROM
5140 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005141 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005142 struct SrcList_item *pItem = pSrcList->a;
5143 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5144 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005145 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005146 if( pExpr->iTable==pItem->iCursor ){
5147 /* If we reach this point, it means that pExpr refers to a table
5148 ** that is in the FROM clause of the aggregate query.
5149 **
5150 ** Make an entry for the column in pAggInfo->aCol[] if there
5151 ** is not an entry there already.
5152 */
drh7f906d62007-03-12 23:48:52 +00005153 int k;
drh13449892005-09-07 21:22:45 +00005154 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005155 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005156 if( pCol->iTable==pExpr->iTable &&
5157 pCol->iColumn==pExpr->iColumn ){
5158 break;
5159 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005160 }
danielk19771e536952007-08-16 10:09:01 +00005161 if( (k>=pAggInfo->nColumn)
5162 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5163 ){
drh7f906d62007-03-12 23:48:52 +00005164 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005165 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005166 pCol->iTable = pExpr->iTable;
5167 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005168 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005169 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005170 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005171 if( pAggInfo->pGroupBy ){
5172 int j, n;
5173 ExprList *pGB = pAggInfo->pGroupBy;
5174 struct ExprList_item *pTerm = pGB->a;
5175 n = pGB->nExpr;
5176 for(j=0; j<n; j++, pTerm++){
5177 Expr *pE = pTerm->pExpr;
5178 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5179 pE->iColumn==pExpr->iColumn ){
5180 pCol->iSorterColumn = j;
5181 break;
5182 }
5183 }
5184 }
5185 if( pCol->iSorterColumn<0 ){
5186 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5187 }
5188 }
5189 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5190 ** because it was there before or because we just created it).
5191 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5192 ** pAggInfo->aCol[] entry.
5193 */
drhebb6a652013-09-12 23:42:22 +00005194 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005195 pExpr->pAggInfo = pAggInfo;
5196 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005197 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005198 break;
5199 } /* endif pExpr->iTable==pItem->iCursor */
5200 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005201 }
drh7d10d5a2008-08-20 16:35:10 +00005202 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005203 }
5204 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005205 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005206 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005207 ){
drh13449892005-09-07 21:22:45 +00005208 /* Check to see if pExpr is a duplicate of another aggregate
5209 ** function that is already in the pAggInfo structure
5210 */
5211 struct AggInfo_func *pItem = pAggInfo->aFunc;
5212 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005213 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005214 break;
5215 }
drh22827922000-06-06 17:27:05 +00005216 }
drh13449892005-09-07 21:22:45 +00005217 if( i>=pAggInfo->nFunc ){
5218 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5219 */
danielk197714db2662006-01-09 16:12:04 +00005220 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005221 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005222 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005223 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005224 pItem = &pAggInfo->aFunc[i];
5225 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005226 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005227 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005228 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005229 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005230 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005231 if( pExpr->flags & EP_Distinct ){
5232 pItem->iDistinct = pParse->nTab++;
5233 }else{
5234 pItem->iDistinct = -1;
5235 }
drh13449892005-09-07 21:22:45 +00005236 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005237 }
drh13449892005-09-07 21:22:45 +00005238 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5239 */
drhc5cd1242013-09-12 16:50:49 +00005240 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005241 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005242 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005243 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005244 return WRC_Prune;
5245 }else{
5246 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005247 }
drh22827922000-06-06 17:27:05 +00005248 }
5249 }
drh7d10d5a2008-08-20 16:35:10 +00005250 return WRC_Continue;
5251}
5252static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005253 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005254 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005255 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005256}
drh979dd1b2017-05-29 14:26:07 +00005257static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5258 UNUSED_PARAMETER(pSelect);
5259 pWalker->walkerDepth--;
5260}
drh626a8792005-01-17 22:08:19 +00005261
5262/*
drhe8abb4c2012-11-02 18:24:57 +00005263** Analyze the pExpr expression looking for aggregate functions and
5264** for variables that need to be added to AggInfo object that pNC->pAggInfo
5265** points to. Additional entries are made on the AggInfo object as
5266** necessary.
drh626a8792005-01-17 22:08:19 +00005267**
5268** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005269** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005270*/
drhd2b3e232008-01-23 14:51:49 +00005271void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005272 Walker w;
5273 w.xExprCallback = analyzeAggregate;
5274 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005275 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5276 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005277 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00005278 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005279 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005280}
drh5d9a4af2005-08-30 00:54:01 +00005281
5282/*
5283** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5284** expression list. Return the number of errors.
5285**
5286** If an error is found, the analysis is cut short.
5287*/
drhd2b3e232008-01-23 14:51:49 +00005288void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005289 struct ExprList_item *pItem;
5290 int i;
drh5d9a4af2005-08-30 00:54:01 +00005291 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005292 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5293 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005294 }
5295 }
drh5d9a4af2005-08-30 00:54:01 +00005296}
drh892d3172008-01-10 03:46:36 +00005297
5298/*
drhceea3322009-04-23 13:22:42 +00005299** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005300*/
5301int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005302 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005303 return ++pParse->nMem;
5304 }
danielk19772f425f62008-07-04 09:41:39 +00005305 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005306}
drhceea3322009-04-23 13:22:42 +00005307
5308/*
5309** Deallocate a register, making available for reuse for some other
5310** purpose.
drhceea3322009-04-23 13:22:42 +00005311*/
drh892d3172008-01-10 03:46:36 +00005312void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005313 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005314 pParse->aTempReg[pParse->nTempReg++] = iReg;
5315 }
5316}
5317
5318/*
drhed24da42016-09-06 14:37:05 +00005319** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005320*/
5321int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005322 int i, n;
drhed24da42016-09-06 14:37:05 +00005323 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005324 i = pParse->iRangeReg;
5325 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005326 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005327 pParse->iRangeReg += nReg;
5328 pParse->nRangeReg -= nReg;
5329 }else{
5330 i = pParse->nMem+1;
5331 pParse->nMem += nReg;
5332 }
5333 return i;
5334}
5335void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005336 if( nReg==1 ){
5337 sqlite3ReleaseTempReg(pParse, iReg);
5338 return;
5339 }
drh892d3172008-01-10 03:46:36 +00005340 if( nReg>pParse->nRangeReg ){
5341 pParse->nRangeReg = nReg;
5342 pParse->iRangeReg = iReg;
5343 }
5344}
drhcdc69552011-12-06 13:24:59 +00005345
5346/*
5347** Mark all temporary registers as being unavailable for reuse.
5348*/
5349void sqlite3ClearTempRegCache(Parse *pParse){
5350 pParse->nTempReg = 0;
5351 pParse->nRangeReg = 0;
5352}
drhbb9b5f22016-03-19 00:35:02 +00005353
5354/*
5355** Validate that no temporary register falls within the range of
5356** iFirst..iLast, inclusive. This routine is only call from within assert()
5357** statements.
5358*/
5359#ifdef SQLITE_DEBUG
5360int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5361 int i;
5362 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005363 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5364 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005365 ){
5366 return 0;
5367 }
5368 for(i=0; i<pParse->nTempReg; i++){
5369 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5370 return 0;
5371 }
5372 }
5373 return 1;
5374}
5375#endif /* SQLITE_DEBUG */