blob: 0484f3b452fb78a9e95a089ad8f8f71d19058ae5 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
47 pExpr = sqlite3ExprSkipCollate(pExpr);
mistachkin9bec6fb2014-06-26 21:28:21 +000048 if( pExpr->flags & EP_Generic ) return 0;
drh580c8c12012-12-08 03:34:04 +000049 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000050 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000051 assert( pExpr->flags&EP_xIsSelect );
52 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000053 }
drhdb45bd52016-08-22 00:48:58 +000054 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000055#ifndef SQLITE_OMIT_CAST
56 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000057 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000058 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000059 }
60#endif
drheda079c2018-09-20 19:02:15 +000061 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000063 }
dan80aa5452016-09-03 19:52:12 +000064 if( op==TK_SELECT_COLUMN ){
65 assert( pExpr->pLeft->flags&EP_xIsSelect );
66 return sqlite3ExprAffinity(
67 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
68 );
69 }
danielk1977a37cdde2004-05-16 11:15:36 +000070 return pExpr->affinity;
71}
72
drh53db1452004-05-20 13:54:53 +000073/*
drh8b4c40d2007-02-01 23:02:45 +000074** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000075** sequence named by pToken. Return a pointer to a new Expr node that
76** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000077**
78** If a memory allocation error occurs, that fact is recorded in pParse->db
79** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000080*/
drh4ef7efa2014-03-20 15:14:08 +000081Expr *sqlite3ExprAddCollateToken(
82 Parse *pParse, /* Parsing context */
83 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000084 const Token *pCollName, /* Name of collating sequence */
85 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000086){
drh0a8a4062012-12-07 18:38:16 +000087 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000088 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000089 if( pNew ){
90 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000091 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000092 pExpr = pNew;
93 }
drhae80dde2012-12-06 21:16:43 +000094 }
drh0a8a4062012-12-07 18:38:16 +000095 return pExpr;
96}
97Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +000098 Token s;
99 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000100 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000101 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000102}
103
104/*
drh0b8d2552015-09-05 22:36:07 +0000105** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000106** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000107*/
108Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +0000109 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000111 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000113 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000114 pExpr = pExpr->x.pList->a[0].pExpr;
115 }else{
drh0b8d2552015-09-05 22:36:07 +0000116 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000117 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000118 }
drha4c3c872013-09-12 17:29:25 +0000119 }
drh0a8a4062012-12-07 18:38:16 +0000120 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000121}
122
123/*
drhae80dde2012-12-06 21:16:43 +0000124** Return the collation sequence for the expression pExpr. If
125** there is no defined collating sequence, return NULL.
126**
drh70efa842017-09-28 01:58:23 +0000127** See also: sqlite3ExprNNCollSeq()
128**
129** The sqlite3ExprNNCollSeq() works the same exact that it returns the
130** default collation if pExpr has no defined collation.
131**
drhae80dde2012-12-06 21:16:43 +0000132** The collating sequence might be determined by a COLLATE operator
133** or by the presence of a column with a defined collating sequence.
134** COLLATE operators take first precedence. Left operands take
135** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000136*/
danielk19777cedc8d2004-06-10 10:50:08 +0000137CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000138 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000139 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000140 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000141 while( p ){
drhae80dde2012-12-06 21:16:43 +0000142 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000143 if( p->flags & EP_Generic ) break;
drhcb0e04f2018-12-12 21:34:17 +0000144 if( op==TK_REGISTER ) op = p->op2;
145 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000146 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000147 ){
drheda079c2018-09-20 19:02:15 +0000148 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000149 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000150 int j = p->iColumn;
151 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000152 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000153 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000154 }
155 break;
danielk19770202b292004-06-09 09:55:16 +0000156 }
drhe081d732018-07-27 18:19:12 +0000157 if( op==TK_CAST || op==TK_UPLUS ){
158 p = p->pLeft;
159 continue;
160 }
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000162 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163 break;
164 }
drhae80dde2012-12-06 21:16:43 +0000165 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000166 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000167 p = p->pLeft;
168 }else{
drh2308ed32015-02-09 16:09:34 +0000169 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000170 /* The Expr.x union is never used at the same time as Expr.pRight */
171 assert( p->x.pList==0 || p->pRight==0 );
172 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
173 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
174 ** least one EP_Collate. Thus the following two ALWAYS. */
175 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000176 int i;
drh6728cd92015-02-09 18:28:03 +0000177 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000178 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
179 pNext = p->x.pList->a[i].pExpr;
180 break;
181 }
182 }
183 }
184 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000185 }
186 }else{
drh7d10d5a2008-08-20 16:35:10 +0000187 break;
188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
danielk19777cedc8d2004-06-10 10:50:08 +0000190 if( sqlite3CheckCollSeq(pParse, pColl) ){
191 pColl = 0;
192 }
193 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000194}
195
196/*
drh70efa842017-09-28 01:58:23 +0000197** Return the collation sequence for the expression pExpr. If
198** there is no defined collating sequence, return a pointer to the
199** defautl collation sequence.
200**
201** See also: sqlite3ExprCollSeq()
202**
203** The sqlite3ExprCollSeq() routine works the same except that it
204** returns NULL if there is no defined collation.
205*/
206CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
207 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
208 if( p==0 ) p = pParse->db->pDfltColl;
209 assert( p!=0 );
210 return p;
211}
212
213/*
214** Return TRUE if the two expressions have equivalent collating sequences.
215*/
216int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
217 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
218 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
219 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
220}
221
222/*
drh626a8792005-01-17 22:08:19 +0000223** pExpr is an operand of a comparison operator. aff2 is the
224** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000225** type affinity that should be used for the comparison operator.
226*/
danielk1977e014a832004-05-17 10:48:57 +0000227char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000228 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000229 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000230 /* Both sides of the comparison are columns. If one has numeric
231 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000232 */
drh8a512562005-11-14 22:29:05 +0000233 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000234 return SQLITE_AFF_NUMERIC;
235 }else{
drh05883a32015-06-02 15:32:08 +0000236 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000237 }
238 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000239 /* Neither side of the comparison is a column. Compare the
240 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000241 */
drh05883a32015-06-02 15:32:08 +0000242 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000243 }else{
244 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000245 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000246 return (aff1 + aff2);
247 }
248}
249
drh53db1452004-05-20 13:54:53 +0000250/*
251** pExpr is a comparison operator. Return the type affinity that should
252** be applied to both operands prior to doing the comparison.
253*/
danielk1977e014a832004-05-17 10:48:57 +0000254static char comparisonAffinity(Expr *pExpr){
255 char aff;
256 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000258 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000259 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000260 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000261 if( pExpr->pRight ){
262 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000263 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
264 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000265 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000266 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000267 }
268 return aff;
269}
270
271/*
272** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273** idx_affinity is the affinity of an indexed column. Return true
274** if the index with affinity idx_affinity may be used to implement
275** the comparison in pExpr.
276*/
277int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000279 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000280 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000281 return 1;
282 case SQLITE_AFF_TEXT:
283 return idx_affinity==SQLITE_AFF_TEXT;
284 default:
285 return sqlite3IsNumericAffinity(idx_affinity);
286 }
danielk1977e014a832004-05-17 10:48:57 +0000287}
288
danielk1977a37cdde2004-05-16 11:15:36 +0000289/*
drh35573352008-01-08 23:54:25 +0000290** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000291** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000292*/
drh35573352008-01-08 23:54:25 +0000293static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
294 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000295 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000296 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000297}
298
drha2e00042002-01-22 03:13:42 +0000299/*
danielk19770202b292004-06-09 09:55:16 +0000300** Return a pointer to the collation sequence that should be used by
301** a binary comparison operator comparing pLeft and pRight.
302**
303** If the left hand expression has a collating sequence type, then it is
304** used. Otherwise the collation sequence for the right hand expression
305** is used, or the default (BINARY) if neither expression has a collating
306** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000307**
308** Argument pRight (but not pLeft) may be a null pointer. In this case,
309** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000310*/
drh0a0e1312007-08-07 17:04:59 +0000311CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000312 Parse *pParse,
313 Expr *pLeft,
314 Expr *pRight
315){
drhec41dda2007-02-07 13:09:45 +0000316 CollSeq *pColl;
317 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000318 if( pLeft->flags & EP_Collate ){
319 pColl = sqlite3ExprCollSeq(pParse, pLeft);
320 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000322 }else{
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 if( !pColl ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
326 }
danielk19770202b292004-06-09 09:55:16 +0000327 }
328 return pColl;
329}
330
331/*
drhbe5c89a2004-07-26 00:31:09 +0000332** Generate code for a comparison operator.
333*/
334static int codeCompare(
335 Parse *pParse, /* The parsing (and code generating) context */
336 Expr *pLeft, /* The left operand */
337 Expr *pRight, /* The right operand */
338 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000339 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000340 int dest, /* Jump here if true. */
341 int jumpIfNull /* If true, jump if either operand is NULL */
342){
drh35573352008-01-08 23:54:25 +0000343 int p5;
344 int addr;
345 CollSeq *p4;
346
347 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
348 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
349 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
350 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000351 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000352 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000353}
354
dancfbb5e82016-07-13 19:48:13 +0000355/*
dan870a0702016-08-01 16:37:43 +0000356** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000357**
358** A vector is defined as any expression that results in two or more
359** columns of result. Every TK_VECTOR node is an vector because the
360** parser will not generate a TK_VECTOR with fewer than two entries.
361** But a TK_SELECT might be either a vector or a scalar. It is only
362** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000363*/
364int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000365 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000366}
367
368/*
dancfbb5e82016-07-13 19:48:13 +0000369** If the expression passed as the only argument is of type TK_VECTOR
370** return the number of expressions in the vector. Or, if the expression
371** is a sub-select, return the number of columns in the sub-select. For
372** any other type of expression, return 1.
373*/
dan71c57db2016-07-09 20:23:55 +0000374int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000375 u8 op = pExpr->op;
376 if( op==TK_REGISTER ) op = pExpr->op2;
377 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000378 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000379 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000380 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000381 }else{
382 return 1;
dan71c57db2016-07-09 20:23:55 +0000383 }
dan71c57db2016-07-09 20:23:55 +0000384}
385
danba00e302016-07-23 20:24:06 +0000386/*
drhfc7f27b2016-08-20 00:07:01 +0000387** Return a pointer to a subexpression of pVector that is the i-th
388** column of the vector (numbered starting with 0). The caller must
389** ensure that i is within range.
390**
drh76dbe7a2016-08-20 21:02:38 +0000391** If pVector is really a scalar (and "scalar" here includes subqueries
392** that return a single column!) then return pVector unmodified.
393**
drhfc7f27b2016-08-20 00:07:01 +0000394** pVector retains ownership of the returned subexpression.
395**
396** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000397** just the expression for the i-th term of the result set, and may
398** not be ready for evaluation because the table cursor has not yet
399** been positioned.
danba00e302016-07-23 20:24:06 +0000400*/
drhfc7f27b2016-08-20 00:07:01 +0000401Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000402 assert( i<sqlite3ExprVectorSize(pVector) );
403 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000404 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
405 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000406 return pVector->x.pSelect->pEList->a[i].pExpr;
407 }else{
408 return pVector->x.pList->a[i].pExpr;
409 }
dan71c57db2016-07-09 20:23:55 +0000410 }
dan870a0702016-08-01 16:37:43 +0000411 return pVector;
dan71c57db2016-07-09 20:23:55 +0000412}
drhfc7f27b2016-08-20 00:07:01 +0000413
drhfc7f27b2016-08-20 00:07:01 +0000414/*
415** Compute and return a new Expr object which when passed to
416** sqlite3ExprCode() will generate all necessary code to compute
417** the iField-th column of the vector expression pVector.
418**
drh8762ec12016-08-20 01:06:22 +0000419** It is ok for pVector to be a scalar (as long as iField==0).
420** In that case, this routine works like sqlite3ExprDup().
421**
drhfc7f27b2016-08-20 00:07:01 +0000422** The caller owns the returned Expr object and is responsible for
423** ensuring that the returned value eventually gets freed.
424**
drh8762ec12016-08-20 01:06:22 +0000425** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000426** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000427** valid for the life of the returned object. If pVector is a TK_VECTOR
428** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000429** returns.
drh8762ec12016-08-20 01:06:22 +0000430**
431** A trick to cause a TK_SELECT pVector to be deleted together with
432** the returned Expr object is to attach the pVector to the pRight field
433** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000434*/
435Expr *sqlite3ExprForVectorField(
436 Parse *pParse, /* Parsing context */
437 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000438 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000439){
440 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000441 if( pVector->op==TK_SELECT ){
442 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000443 /* The TK_SELECT_COLUMN Expr node:
444 **
drh966e2912017-01-03 02:58:01 +0000445 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000446 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000447 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000448 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000449 ** pLeft->iTable: First in an array of register holding result, or 0
450 ** if the result is not yet computed.
451 **
452 ** sqlite3ExprDelete() specifically skips the recursive delete of
453 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000454 ** can be attached to pRight to cause this node to take ownership of
455 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
456 ** with the same pLeft pointer to the pVector, but only one of them
457 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000458 */
drhabfd35e2016-12-06 22:47:23 +0000459 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000460 if( pRet ){
461 pRet->iColumn = iField;
462 pRet->pLeft = pVector;
463 }
drhfc7f27b2016-08-20 00:07:01 +0000464 assert( pRet==0 || pRet->iTable==0 );
465 }else{
drha1251bc2016-08-20 00:51:37 +0000466 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000468 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000469 }
470 return pRet;
471}
dan71c57db2016-07-09 20:23:55 +0000472
dan5c288b92016-07-30 21:02:33 +0000473/*
474** If expression pExpr is of type TK_SELECT, generate code to evaluate
475** it. Return the register in which the result is stored (or, if the
476** sub-select returns more than one column, the first in an array
477** of registers in which the result is stored).
478**
479** If pExpr is not a TK_SELECT expression, return 0.
480*/
481static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000482 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000483#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000484 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000485 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000486 }
danf9b2e052016-08-02 17:45:00 +0000487#endif
dan8da209b2016-07-26 18:06:08 +0000488 return reg;
489}
490
dan5c288b92016-07-30 21:02:33 +0000491/*
492** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000493** or TK_SELECT that returns more than one column. This function returns
494** the register number of a register that contains the value of
495** element iField of the vector.
496**
497** If pVector is a TK_SELECT expression, then code for it must have
498** already been generated using the exprCodeSubselect() routine. In this
499** case parameter regSelect should be the first in an array of registers
500** containing the results of the sub-select.
501**
502** If pVector is of type TK_VECTOR, then code for the requested field
503** is generated. In this case (*pRegFree) may be set to the number of
504** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000505**
506** Before returning, output parameter (*ppExpr) is set to point to the
507** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000508*/
509static int exprVectorRegister(
510 Parse *pParse, /* Parse context */
511 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000512 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000513 int regSelect, /* First in array of registers */
514 Expr **ppExpr, /* OUT: Expression element */
515 int *pRegFree /* OUT: Temp register to free */
516){
drh12abf402016-08-22 14:30:05 +0000517 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000518 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000519 if( op==TK_REGISTER ){
520 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
521 return pVector->iTable+iField;
522 }
523 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000524 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
525 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000526 }
dan870a0702016-08-01 16:37:43 +0000527 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000528 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
529}
530
531/*
532** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000533** the result of the comparison (1, 0, or NULL) and write that
534** result into register dest.
535**
536** The caller must satisfy the following preconditions:
537**
538** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
539** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
540** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000541*/
drh79752b62016-08-13 10:02:17 +0000542static void codeVectorCompare(
543 Parse *pParse, /* Code generator context */
544 Expr *pExpr, /* The comparison operation */
545 int dest, /* Write results into this register */
546 u8 op, /* Comparison operator */
547 u8 p5 /* SQLITE_NULLEQ or zero */
548){
dan71c57db2016-07-09 20:23:55 +0000549 Vdbe *v = pParse->pVdbe;
550 Expr *pLeft = pExpr->pLeft;
551 Expr *pRight = pExpr->pRight;
552 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000553 int i;
554 int regLeft = 0;
555 int regRight = 0;
556 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000557 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000558
drh245ce622017-01-01 12:44:07 +0000559 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
560 sqlite3ErrorMsg(pParse, "row value misused");
561 return;
562 }
drhb29e60c2016-09-05 12:02:34 +0000563 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
564 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
565 || pExpr->op==TK_LT || pExpr->op==TK_GT
566 || pExpr->op==TK_LE || pExpr->op==TK_GE
567 );
568 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
569 || (pExpr->op==TK_ISNOT && op==TK_NE) );
570 assert( p5==0 || pExpr->op!=op );
571 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000572
drhb29e60c2016-09-05 12:02:34 +0000573 p5 |= SQLITE_STOREP2;
574 if( opx==TK_LE ) opx = TK_LT;
575 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000576
drhb29e60c2016-09-05 12:02:34 +0000577 regLeft = exprCodeSubselect(pParse, pLeft);
578 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000579
drhb29e60c2016-09-05 12:02:34 +0000580 for(i=0; 1 /*Loop exits by "break"*/; i++){
581 int regFree1 = 0, regFree2 = 0;
582 Expr *pL, *pR;
583 int r1, r2;
584 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000585 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
586 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
587 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
588 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
589 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
590 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
591 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
592 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
593 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
594 sqlite3ReleaseTempReg(pParse, regFree1);
595 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000596 if( i==nLeft-1 ){
597 break;
dan71c57db2016-07-09 20:23:55 +0000598 }
drhb29e60c2016-09-05 12:02:34 +0000599 if( opx==TK_EQ ){
600 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
601 p5 |= SQLITE_KEEPNULL;
602 }else if( opx==TK_NE ){
603 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
604 p5 |= SQLITE_KEEPNULL;
605 }else{
606 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
607 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
608 VdbeCoverageIf(v, op==TK_LT);
609 VdbeCoverageIf(v, op==TK_GT);
610 VdbeCoverageIf(v, op==TK_LE);
611 VdbeCoverageIf(v, op==TK_GE);
612 if( i==nLeft-2 ) opx = op;
613 }
dan71c57db2016-07-09 20:23:55 +0000614 }
drhb29e60c2016-09-05 12:02:34 +0000615 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000616}
617
danielk19774b5255a2008-06-05 16:47:39 +0000618#if SQLITE_MAX_EXPR_DEPTH>0
619/*
620** Check that argument nHeight is less than or equal to the maximum
621** expression depth allowed. If it is not, leave an error message in
622** pParse.
623*/
drh7d10d5a2008-08-20 16:35:10 +0000624int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000625 int rc = SQLITE_OK;
626 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
627 if( nHeight>mxHeight ){
628 sqlite3ErrorMsg(pParse,
629 "Expression tree is too large (maximum depth %d)", mxHeight
630 );
631 rc = SQLITE_ERROR;
632 }
633 return rc;
634}
635
636/* The following three functions, heightOfExpr(), heightOfExprList()
637** and heightOfSelect(), are used to determine the maximum height
638** of any expression tree referenced by the structure passed as the
639** first argument.
640**
641** If this maximum height is greater than the current value pointed
642** to by pnHeight, the second parameter, then set *pnHeight to that
643** value.
644*/
645static void heightOfExpr(Expr *p, int *pnHeight){
646 if( p ){
647 if( p->nHeight>*pnHeight ){
648 *pnHeight = p->nHeight;
649 }
650 }
651}
652static void heightOfExprList(ExprList *p, int *pnHeight){
653 if( p ){
654 int i;
655 for(i=0; i<p->nExpr; i++){
656 heightOfExpr(p->a[i].pExpr, pnHeight);
657 }
658 }
659}
dan1a3a3082018-01-18 19:00:54 +0000660static void heightOfSelect(Select *pSelect, int *pnHeight){
661 Select *p;
662 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000663 heightOfExpr(p->pWhere, pnHeight);
664 heightOfExpr(p->pHaving, pnHeight);
665 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000666 heightOfExprList(p->pEList, pnHeight);
667 heightOfExprList(p->pGroupBy, pnHeight);
668 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000669 }
670}
671
672/*
673** Set the Expr.nHeight variable in the structure passed as an
674** argument. An expression with no children, Expr.pList or
675** Expr.pSelect member has a height of 1. Any other expression
676** has a height equal to the maximum height of any other
677** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000678**
679** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
680** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000681*/
682static void exprSetHeight(Expr *p){
683 int nHeight = 0;
684 heightOfExpr(p->pLeft, &nHeight);
685 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000686 if( ExprHasProperty(p, EP_xIsSelect) ){
687 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000688 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000689 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000690 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000691 }
danielk19774b5255a2008-06-05 16:47:39 +0000692 p->nHeight = nHeight + 1;
693}
694
695/*
696** Set the Expr.nHeight variable using the exprSetHeight() function. If
697** the height is greater than the maximum allowed expression depth,
698** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000699**
700** Also propagate all EP_Propagate flags from the Expr.x.pList into
701** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000702*/
drh2308ed32015-02-09 16:09:34 +0000703void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000704 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000705 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000706 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000707}
708
709/*
710** Return the maximum height of any expression tree referenced
711** by the select statement passed as an argument.
712*/
713int sqlite3SelectExprHeight(Select *p){
714 int nHeight = 0;
715 heightOfSelect(p, &nHeight);
716 return nHeight;
717}
drh2308ed32015-02-09 16:09:34 +0000718#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
719/*
720** Propagate all EP_Propagate flags from the Expr.x.pList into
721** Expr.flags.
722*/
723void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
724 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
725 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
726 }
727}
728#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000729#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
730
drhbe5c89a2004-07-26 00:31:09 +0000731/*
drhb7916a72009-05-27 10:31:29 +0000732** This routine is the core allocator for Expr nodes.
733**
drha76b5df2002-02-23 02:32:10 +0000734** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000735** for this node and for the pToken argument is a single allocation
736** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000737** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000738**
739** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000740** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000741** parameter is ignored if pToken is NULL or if the token does not
742** appear to be quoted. If the quotes were of the form "..." (double-quotes)
743** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000744**
745** Special case: If op==TK_INTEGER and pToken points to a string that
746** can be translated into a 32-bit integer, then the token is not
747** stored in u.zToken. Instead, the integer values is written
748** into u.iValue and the EP_IntValue flag is set. No extra storage
749** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000750*/
drhb7916a72009-05-27 10:31:29 +0000751Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000752 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000753 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000754 const Token *pToken, /* Token argument. Might be NULL */
755 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000756){
drha76b5df2002-02-23 02:32:10 +0000757 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000758 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000759 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000760
drh575fad62016-02-05 13:38:36 +0000761 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000762 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000763 if( op!=TK_INTEGER || pToken->z==0
764 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
765 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000766 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000767 }
drhb7916a72009-05-27 10:31:29 +0000768 }
drh575fad62016-02-05 13:38:36 +0000769 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000770 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000771 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000772 pNew->op = (u8)op;
773 pNew->iAgg = -1;
774 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000775 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000776 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000777 pNew->u.iValue = iValue;
778 }else{
drh33e619f2009-05-28 01:00:55 +0000779 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000780 assert( pToken->z!=0 || pToken->n==0 );
781 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000782 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000783 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000784 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000785 }
drhb7916a72009-05-27 10:31:29 +0000786 }
787 }
788#if SQLITE_MAX_EXPR_DEPTH>0
789 pNew->nHeight = 1;
790#endif
791 }
drha76b5df2002-02-23 02:32:10 +0000792 return pNew;
793}
794
795/*
drhb7916a72009-05-27 10:31:29 +0000796** Allocate a new expression node from a zero-terminated token that has
797** already been dequoted.
798*/
799Expr *sqlite3Expr(
800 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
801 int op, /* Expression opcode */
802 const char *zToken /* Token argument. Might be NULL */
803){
804 Token x;
805 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000806 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000807 return sqlite3ExprAlloc(db, op, &x, 0);
808}
809
810/*
811** Attach subtrees pLeft and pRight to the Expr node pRoot.
812**
813** If pRoot==NULL that means that a memory allocation error has occurred.
814** In that case, delete the subtrees pLeft and pRight.
815*/
816void sqlite3ExprAttachSubtrees(
817 sqlite3 *db,
818 Expr *pRoot,
819 Expr *pLeft,
820 Expr *pRight
821){
822 if( pRoot==0 ){
823 assert( db->mallocFailed );
824 sqlite3ExprDelete(db, pLeft);
825 sqlite3ExprDelete(db, pRight);
826 }else{
827 if( pRight ){
828 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000829 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000830 }
831 if( pLeft ){
832 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 exprSetHeight(pRoot);
836 }
837}
838
839/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000840** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000841**
drhbf664462009-06-19 18:32:54 +0000842** One or both of the subtrees can be NULL. Return a pointer to the new
843** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
844** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000845*/
drh17435752007-08-16 04:30:38 +0000846Expr *sqlite3PExpr(
847 Parse *pParse, /* Parsing context */
848 int op, /* Expression opcode */
849 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000850 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000851){
drh5fb52ca2012-03-31 02:34:35 +0000852 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000853 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
854 if( p ){
855 memset(p, 0, sizeof(Expr));
856 p->op = op & 0xff;
857 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000858 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000859 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000860 }else{
861 sqlite3ExprDelete(pParse->db, pLeft);
862 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000863 }
drh4e0cff62004-11-05 05:10:28 +0000864 return p;
865}
866
867/*
drh08de4f72016-04-11 01:06:47 +0000868** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
869** do a memory allocation failure) then delete the pSelect object.
870*/
871void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
872 if( pExpr ){
873 pExpr->x.pSelect = pSelect;
874 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
875 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
876 }else{
877 assert( pParse->db->mallocFailed );
878 sqlite3SelectDelete(pParse->db, pSelect);
879 }
880}
881
882
883/*
drh91bb0ee2004-09-01 03:06:34 +0000884** Join two expressions using an AND operator. If either expression is
885** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000886**
887** If one side or the other of the AND is known to be false, then instead
888** of returning an AND expression, just return a constant expression with
889** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000890*/
drhd5c851c2019-04-19 13:38:34 +0000891Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
892 sqlite3 *db = pParse->db;
893 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000894 return pRight;
895 }else if( pRight==0 ){
896 return pLeft;
drhd5c851c2019-04-19 13:38:34 +0000897 }else if( pParse->nErr || IN_RENAME_OBJECT ){
898 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drhad317272019-04-19 16:21:51 +0000899 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh5fb52ca2012-03-31 02:34:35 +0000900 sqlite3ExprDelete(db, pLeft);
901 sqlite3ExprDelete(db, pRight);
902 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000903 }else{
drhd5c851c2019-04-19 13:38:34 +0000904 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000905 }
906}
907
908/*
909** Construct a new expression node for a function with multiple
910** arguments.
911*/
drh954733b2018-07-27 23:33:16 +0000912Expr *sqlite3ExprFunction(
913 Parse *pParse, /* Parsing context */
914 ExprList *pList, /* Argument list */
915 Token *pToken, /* Name of the function */
916 int eDistinct /* SF_Distinct or SF_ALL or 0 */
917){
drha76b5df2002-02-23 02:32:10 +0000918 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000919 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000920 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000921 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000922 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000923 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000924 return 0;
925 }
drh954733b2018-07-27 23:33:16 +0000926 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
927 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
928 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000929 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000930 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000931 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000932 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000933 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000934 return pNew;
935}
936
937/*
drhfa6bc002004-09-07 16:19:52 +0000938** Assign a variable number to an expression that encodes a wildcard
939** in the original SQL statement.
940**
941** Wildcards consisting of a single "?" are assigned the next sequential
942** variable number.
943**
944** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000945** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000946** the SQL statement comes from an external source.
947**
drh51f49f12009-05-21 20:41:32 +0000948** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000949** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000950** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000951** assigned.
952*/
drhde25a882016-10-03 15:28:24 +0000953void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000954 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000955 const char *z;
drhf326d662016-12-23 13:30:53 +0000956 ynVar x;
drh17435752007-08-16 04:30:38 +0000957
drhfa6bc002004-09-07 16:19:52 +0000958 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000959 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000960 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000961 assert( z!=0 );
962 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000963 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000964 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000965 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000966 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000967 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000968 }else{
drhf326d662016-12-23 13:30:53 +0000969 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000970 if( z[0]=='?' ){
971 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
972 ** use it as the variable number */
973 i64 i;
drh18814df2017-01-31 03:52:34 +0000974 int bOk;
975 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
976 i = z[1]-'0'; /* The common case of ?N for a single digit N */
977 bOk = 1;
978 }else{
979 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
980 }
drh124c0b42011-06-01 18:15:55 +0000981 testcase( i==0 );
982 testcase( i==1 );
983 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
984 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
985 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
986 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
987 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000988 return;
drhfa6bc002004-09-07 16:19:52 +0000989 }
drh8e74e7b2017-01-31 12:41:48 +0000990 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +0000991 if( x>pParse->nVar ){
992 pParse->nVar = (int)x;
993 doAdd = 1;
994 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
995 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +0000996 }
997 }else{
998 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
999 ** number as the prior appearance of the same name, or if the name
1000 ** has never appeared before, reuse the same variable number
1001 */
drh9bf755c2016-12-23 03:59:31 +00001002 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1003 if( x==0 ){
1004 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001005 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001006 }
drhfa6bc002004-09-07 16:19:52 +00001007 }
drhf326d662016-12-23 13:30:53 +00001008 if( doAdd ){
1009 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1010 }
1011 }
1012 pExpr->iColumn = x;
1013 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001014 sqlite3ErrorMsg(pParse, "too many SQL variables");
1015 }
drhfa6bc002004-09-07 16:19:52 +00001016}
1017
1018/*
danf6963f92009-11-23 14:39:14 +00001019** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001020*/
drh4f0010b2016-04-11 14:49:39 +00001021static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1022 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001023 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1024 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001025
1026 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1027 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1028 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001029#ifdef SQLITE_DEBUG
1030 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1031 assert( p->pLeft==0 );
1032 assert( p->pRight==0 );
1033 assert( p->x.pSelect==0 );
1034 }
1035#endif
1036 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001037 /* The Expr.x union is never used at the same time as Expr.pRight */
1038 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001039 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001040 if( p->pRight ){
1041 sqlite3ExprDeleteNN(db, p->pRight);
1042 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001043 sqlite3SelectDelete(db, p->x.pSelect);
1044 }else{
1045 sqlite3ExprListDelete(db, p->x.pList);
1046 }
drheda079c2018-09-20 19:02:15 +00001047 if( ExprHasProperty(p, EP_WinFunc) ){
1048 assert( p->op==TK_FUNCTION );
1049 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001050 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001051 }
drh209bc522016-09-23 21:36:24 +00001052 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001053 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001054 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001055 }
drha2e00042002-01-22 03:13:42 +00001056}
drh4f0010b2016-04-11 14:49:39 +00001057void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1058 if( p ) sqlite3ExprDeleteNN(db, p);
1059}
drha2e00042002-01-22 03:13:42 +00001060
drhd2687b72005-08-12 22:56:09 +00001061/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001062** Return the number of bytes allocated for the expression structure
1063** passed as the first argument. This is always one of EXPR_FULLSIZE,
1064** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1065*/
1066static int exprStructSize(Expr *p){
1067 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001068 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1069 return EXPR_FULLSIZE;
1070}
1071
1072/*
drha8e05762019-01-05 21:56:12 +00001073** Copy the complete content of an Expr node, taking care not to read
1074** past the end of the structure for a reduced-size version of the source
1075** Expr.
1076*/
1077static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1078 memset(pDest, 0, sizeof(Expr));
1079 memcpy(pDest, pSrc, exprStructSize(pSrc));
1080}
1081
1082/*
drh33e619f2009-05-28 01:00:55 +00001083** The dupedExpr*Size() routines each return the number of bytes required
1084** to store a copy of an expression or expression tree. They differ in
1085** how much of the tree is measured.
1086**
1087** dupedExprStructSize() Size of only the Expr structure
1088** dupedExprNodeSize() Size of Expr + space for token
1089** dupedExprSize() Expr + token + subtree components
1090**
1091***************************************************************************
1092**
1093** The dupedExprStructSize() function returns two values OR-ed together:
1094** (1) the space required for a copy of the Expr structure only and
1095** (2) the EP_xxx flags that indicate what the structure size should be.
1096** The return values is always one of:
1097**
1098** EXPR_FULLSIZE
1099** EXPR_REDUCEDSIZE | EP_Reduced
1100** EXPR_TOKENONLYSIZE | EP_TokenOnly
1101**
1102** The size of the structure can be found by masking the return value
1103** of this routine with 0xfff. The flags can be found by masking the
1104** return value with EP_Reduced|EP_TokenOnly.
1105**
1106** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1107** (unreduced) Expr objects as they or originally constructed by the parser.
1108** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001109** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001110** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001111** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001112** to reduce a pristine expression tree from the parser. The implementation
1113** of dupedExprStructSize() contain multiple assert() statements that attempt
1114** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001115*/
1116static int dupedExprStructSize(Expr *p, int flags){
1117 int nSize;
drh33e619f2009-05-28 01:00:55 +00001118 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001119 assert( EXPR_FULLSIZE<=0xfff );
1120 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001121 if( 0==flags || p->op==TK_SELECT_COLUMN
1122#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001123 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001124#endif
1125 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001126 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 }else{
drhc5cd1242013-09-12 16:50:49 +00001128 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001129 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001130 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001131 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001132 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001133 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1134 }else{
drhaecd8022013-09-13 18:15:15 +00001135 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001136 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1137 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001138 }
1139 return nSize;
1140}
1141
1142/*
drh33e619f2009-05-28 01:00:55 +00001143** This function returns the space in bytes required to store the copy
1144** of the Expr structure and a copy of the Expr.u.zToken string (if that
1145** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001146*/
1147static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001148 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1149 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001150 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001151 }
danielk1977bc739712009-03-23 04:33:32 +00001152 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001153}
1154
1155/*
1156** Return the number of bytes required to create a duplicate of the
1157** expression passed as the first argument. The second argument is a
1158** mask containing EXPRDUP_XXX flags.
1159**
1160** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001161** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001162**
1163** If the EXPRDUP_REDUCE flag is set, then the return value includes
1164** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1165** and Expr.pRight variables (but not for any structures pointed to or
1166** descended from the Expr.x.pList or Expr.x.pSelect variables).
1167*/
1168static int dupedExprSize(Expr *p, int flags){
1169 int nByte = 0;
1170 if( p ){
1171 nByte = dupedExprNodeSize(p, flags);
1172 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001173 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001174 }
1175 }
1176 return nByte;
1177}
1178
1179/*
1180** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1181** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001182** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001183** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001184** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001185** portion of the buffer copied into by this function.
1186*/
drh3c194692016-04-11 16:43:43 +00001187static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1188 Expr *pNew; /* Value to return */
1189 u8 *zAlloc; /* Memory space from which to build Expr object */
1190 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1191
drh575fad62016-02-05 13:38:36 +00001192 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001193 assert( p );
1194 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1195 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001196
drh3c194692016-04-11 16:43:43 +00001197 /* Figure out where to write the new Expr structure. */
1198 if( pzBuffer ){
1199 zAlloc = *pzBuffer;
1200 staticFlag = EP_Static;
1201 }else{
1202 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1203 staticFlag = 0;
1204 }
1205 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001206
drh3c194692016-04-11 16:43:43 +00001207 if( pNew ){
1208 /* Set nNewSize to the size allocated for the structure pointed to
1209 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1210 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1211 ** by the copy of the p->u.zToken string (if any).
1212 */
1213 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1214 const int nNewSize = nStructSize & 0xfff;
1215 int nToken;
1216 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1217 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001218 }else{
drh3c194692016-04-11 16:43:43 +00001219 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001220 }
drh3c194692016-04-11 16:43:43 +00001221 if( dupFlags ){
1222 assert( ExprHasProperty(p, EP_Reduced)==0 );
1223 memcpy(zAlloc, p, nNewSize);
1224 }else{
1225 u32 nSize = (u32)exprStructSize(p);
1226 memcpy(zAlloc, p, nSize);
1227 if( nSize<EXPR_FULLSIZE ){
1228 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1229 }
1230 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001231
drh3c194692016-04-11 16:43:43 +00001232 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1233 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1234 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1235 pNew->flags |= staticFlag;
1236
1237 /* Copy the p->u.zToken string, if any. */
1238 if( nToken ){
1239 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1240 memcpy(zToken, p->u.zToken, nToken);
1241 }
1242
drh209bc522016-09-23 21:36:24 +00001243 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001244 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1245 if( ExprHasProperty(p, EP_xIsSelect) ){
1246 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001247 }else{
drh3c194692016-04-11 16:43:43 +00001248 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001249 }
drh3c194692016-04-11 16:43:43 +00001250 }
1251
1252 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001253 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1254 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001255 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001256 pNew->pLeft = p->pLeft ?
1257 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1258 pNew->pRight = p->pRight ?
1259 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001260 }
dan67a9b8e2018-06-22 20:51:35 +00001261#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001262 if( ExprHasProperty(p, EP_WinFunc) ){
1263 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1264 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001265 }
dan67a9b8e2018-06-22 20:51:35 +00001266#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001267 if( pzBuffer ){
1268 *pzBuffer = zAlloc;
1269 }
1270 }else{
drh209bc522016-09-23 21:36:24 +00001271 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001272 if( pNew->op==TK_SELECT_COLUMN ){
1273 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001274 assert( p->iColumn==0 || p->pRight==0 );
1275 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001276 }else{
1277 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1278 }
drh3c194692016-04-11 16:43:43 +00001279 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001280 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001281 }
1282 }
1283 return pNew;
1284}
1285
1286/*
danbfe31e72014-01-15 14:17:31 +00001287** Create and return a deep copy of the object passed as the second
1288** argument. If an OOM condition is encountered, NULL is returned
1289** and the db->mallocFailed flag set.
1290*/
daneede6a52014-01-15 19:42:23 +00001291#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001292static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001293 With *pRet = 0;
1294 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001295 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001296 pRet = sqlite3DbMallocZero(db, nByte);
1297 if( pRet ){
1298 int i;
1299 pRet->nCte = p->nCte;
1300 for(i=0; i<p->nCte; i++){
1301 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1302 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1303 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1304 }
1305 }
1306 }
1307 return pRet;
1308}
daneede6a52014-01-15 19:42:23 +00001309#else
1310# define withDup(x,y) 0
1311#endif
dan4e9119d2014-01-13 15:12:23 +00001312
drha8389972018-12-06 22:04:19 +00001313#ifndef SQLITE_OMIT_WINDOWFUNC
1314/*
1315** The gatherSelectWindows() procedure and its helper routine
1316** gatherSelectWindowsCallback() are used to scan all the expressions
1317** an a newly duplicated SELECT statement and gather all of the Window
1318** objects found there, assembling them onto the linked list at Select->pWin.
1319*/
1320static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1321 if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1322 assert( ExprHasProperty(pExpr, EP_WinFunc) );
1323 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1324 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1325 }
1326 return WRC_Continue;
1327}
drha37b6a52018-12-06 22:12:18 +00001328static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1329 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1330}
drha8389972018-12-06 22:04:19 +00001331static void gatherSelectWindows(Select *p){
1332 Walker w;
1333 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001334 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1335 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001336 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001337 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001338 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001339}
1340#endif
1341
1342
drha76b5df2002-02-23 02:32:10 +00001343/*
drhff78bd22002-02-27 01:47:11 +00001344** The following group of routines make deep copies of expressions,
1345** expression lists, ID lists, and select statements. The copies can
1346** be deleted (by being passed to their respective ...Delete() routines)
1347** without effecting the originals.
1348**
danielk19774adee202004-05-08 08:23:19 +00001349** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1350** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001351** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001352**
drhad3cab52002-05-24 02:04:32 +00001353** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001354**
drhb7916a72009-05-27 10:31:29 +00001355** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001356** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1357** truncated version of the usual Expr structure that will be stored as
1358** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001359*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001360Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001361 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001362 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001363}
danielk19776ab3a2e2009-02-19 14:39:25 +00001364ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001365 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001366 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001367 int i;
drhb1637482017-01-03 00:27:16 +00001368 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001369 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001370 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001371 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001372 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001373 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001374 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001375 pOldItem = p->a;
1376 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001377 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001378 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001379 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001380 if( pOldExpr
1381 && pOldExpr->op==TK_SELECT_COLUMN
1382 && (pNewExpr = pItem->pExpr)!=0
1383 ){
1384 assert( pNewExpr->iColumn==0 || i>0 );
1385 if( pNewExpr->iColumn==0 ){
1386 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001387 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1388 }else{
1389 assert( i>0 );
1390 assert( pItem[-1].pExpr!=0 );
1391 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1392 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1393 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001394 }
1395 }
drh17435752007-08-16 04:30:38 +00001396 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001397 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001398 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001399 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001400 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001401 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001402 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001403 }
1404 return pNew;
1405}
danielk197793758c82005-01-21 08:13:14 +00001406
1407/*
1408** If cursors, triggers, views and subqueries are all omitted from
1409** the build, then none of the following routines, except for
1410** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1411** called with a NULL argument.
1412*/
danielk19776a67fe82005-02-04 04:07:16 +00001413#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1414 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001415SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001416 SrcList *pNew;
1417 int i;
drh113088e2003-03-20 01:16:58 +00001418 int nByte;
drh575fad62016-02-05 13:38:36 +00001419 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001420 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001421 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001422 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001423 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001424 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001425 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001426 struct SrcList_item *pNewItem = &pNew->a[i];
1427 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001428 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001429 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001430 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1431 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1432 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001433 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001434 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001435 pNewItem->addrFillSub = pOldItem->addrFillSub;
1436 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001437 if( pNewItem->fg.isIndexedBy ){
1438 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1439 }
1440 pNewItem->pIBIndex = pOldItem->pIBIndex;
1441 if( pNewItem->fg.isTabFunc ){
1442 pNewItem->u1.pFuncArg =
1443 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1444 }
drhed8a3bb2005-06-06 21:19:56 +00001445 pTab = pNewItem->pTab = pOldItem->pTab;
1446 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001447 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001448 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001449 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1450 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001451 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001452 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001453 }
1454 return pNew;
1455}
drh17435752007-08-16 04:30:38 +00001456IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001457 IdList *pNew;
1458 int i;
drh575fad62016-02-05 13:38:36 +00001459 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001460 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001461 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001462 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001463 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001464 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001465 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001466 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001467 return 0;
1468 }
drh6c535152012-02-02 03:38:30 +00001469 /* Note that because the size of the allocation for p->a[] is not
1470 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1471 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001472 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001473 struct IdList_item *pNewItem = &pNew->a[i];
1474 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001475 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001476 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001477 }
1478 return pNew;
1479}
dana7466202017-02-03 14:44:52 +00001480Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1481 Select *pRet = 0;
1482 Select *pNext = 0;
1483 Select **pp = &pRet;
1484 Select *p;
1485
drh575fad62016-02-05 13:38:36 +00001486 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001487 for(p=pDup; p; p=p->pPrior){
1488 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1489 if( pNew==0 ) break;
1490 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1491 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1492 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1493 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1494 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1495 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1496 pNew->op = p->op;
1497 pNew->pNext = pNext;
1498 pNew->pPrior = 0;
1499 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001500 pNew->iLimit = 0;
1501 pNew->iOffset = 0;
1502 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1503 pNew->addrOpenEphm[0] = -1;
1504 pNew->addrOpenEphm[1] = -1;
1505 pNew->nSelectRow = p->nSelectRow;
1506 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001507#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001508 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001509 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001510 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001511#endif
drhfef37762018-07-10 19:48:35 +00001512 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001513 *pp = pNew;
1514 pp = &pNew->pPrior;
1515 pNext = pNew;
1516 }
1517
1518 return pRet;
drhff78bd22002-02-27 01:47:11 +00001519}
danielk197793758c82005-01-21 08:13:14 +00001520#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001521Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001522 assert( p==0 );
1523 return 0;
1524}
1525#endif
drhff78bd22002-02-27 01:47:11 +00001526
1527
1528/*
drha76b5df2002-02-23 02:32:10 +00001529** Add a new element to the end of an expression list. If pList is
1530** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001531**
drha19543f2017-09-15 15:17:48 +00001532** The pList argument must be either NULL or a pointer to an ExprList
1533** obtained from a prior call to sqlite3ExprListAppend(). This routine
1534** may not be used with an ExprList obtained from sqlite3ExprListDup().
1535** Reason: This routine assumes that the number of slots in pList->a[]
1536** is a power of two. That is true for sqlite3ExprListAppend() returns
1537** but is not necessarily true from the return value of sqlite3ExprListDup().
1538**
drhb7916a72009-05-27 10:31:29 +00001539** If a memory allocation error occurs, the entire list is freed and
1540** NULL is returned. If non-NULL is returned, then it is guaranteed
1541** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001542*/
drh17435752007-08-16 04:30:38 +00001543ExprList *sqlite3ExprListAppend(
1544 Parse *pParse, /* Parsing context */
1545 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001546 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001547){
drh43606172017-04-05 11:32:13 +00001548 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001549 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001550 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001551 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001552 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001553 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001554 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001555 }
drhc263f7c2016-01-18 13:18:54 +00001556 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001557 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001558 ExprList *pNew;
1559 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001560 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001561 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001562 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001563 }
drh43606172017-04-05 11:32:13 +00001564 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001565 }
drh43606172017-04-05 11:32:13 +00001566 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001567 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1568 assert( offsetof(struct ExprList_item,pExpr)==0 );
1569 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001570 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001571 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001572
1573no_mem:
1574 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001575 sqlite3ExprDelete(db, pExpr);
1576 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001577 return 0;
drha76b5df2002-02-23 02:32:10 +00001578}
1579
1580/*
drh8762ec12016-08-20 01:06:22 +00001581** pColumns and pExpr form a vector assignment which is part of the SET
1582** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001583**
1584** (a,b,c) = (expr1,expr2,expr3)
1585** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1586**
1587** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001588** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001589** TK_SELECT_COLUMN expressions.
1590*/
1591ExprList *sqlite3ExprListAppendVector(
1592 Parse *pParse, /* Parsing context */
1593 ExprList *pList, /* List to which to append. Might be NULL */
1594 IdList *pColumns, /* List of names of LHS of the assignment */
1595 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1596){
1597 sqlite3 *db = pParse->db;
1598 int n;
1599 int i;
drh66860af2016-08-23 18:30:10 +00001600 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001601 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1602 ** exit prior to this routine being invoked */
1603 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001604 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001605
1606 /* If the RHS is a vector, then we can immediately check to see that
1607 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1608 ** wildcards ("*") in the result set of the SELECT must be expanded before
1609 ** we can do the size check, so defer the size check until code generation.
1610 */
1611 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001612 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1613 pColumns->nId, n);
1614 goto vector_append_error;
1615 }
drh966e2912017-01-03 02:58:01 +00001616
1617 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001618 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1619 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1620 if( pList ){
drh66860af2016-08-23 18:30:10 +00001621 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001622 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1623 pColumns->a[i].zName = 0;
1624 }
1625 }
drh966e2912017-01-03 02:58:01 +00001626
drhffe28052017-05-06 18:09:36 +00001627 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001628 Expr *pFirst = pList->a[iFirst].pExpr;
1629 assert( pFirst!=0 );
1630 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001631
drhf4dd26c2017-04-05 11:49:06 +00001632 /* Store the SELECT statement in pRight so it will be deleted when
1633 ** sqlite3ExprListDelete() is called */
1634 pFirst->pRight = pExpr;
1635 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001636
drhf4dd26c2017-04-05 11:49:06 +00001637 /* Remember the size of the LHS in iTable so that we can check that
1638 ** the RHS and LHS sizes match during code generation. */
1639 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001640 }
1641
1642vector_append_error:
dandfb5c962019-01-15 20:51:35 +00001643 if( IN_RENAME_OBJECT ){
1644 sqlite3RenameExprUnmap(pParse, pExpr);
1645 }
drha1251bc2016-08-20 00:51:37 +00001646 sqlite3ExprDelete(db, pExpr);
1647 sqlite3IdListDelete(db, pColumns);
1648 return pList;
1649}
1650
1651/*
drhbc622bc2015-08-24 15:39:42 +00001652** Set the sort order for the last element on the given ExprList.
1653*/
1654void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1655 if( p==0 ) return;
1656 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1657 assert( p->nExpr>0 );
1658 if( iSortOrder<0 ){
1659 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1660 return;
1661 }
1662 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001663}
1664
1665/*
drhb7916a72009-05-27 10:31:29 +00001666** Set the ExprList.a[].zName element of the most recently added item
1667** on the expression list.
1668**
1669** pList might be NULL following an OOM error. But pName should never be
1670** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1671** is set.
1672*/
1673void sqlite3ExprListSetName(
1674 Parse *pParse, /* Parsing context */
1675 ExprList *pList, /* List to which to add the span. */
1676 Token *pName, /* Name to be added */
1677 int dequote /* True to cause the name to be dequoted */
1678){
1679 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1680 if( pList ){
1681 struct ExprList_item *pItem;
1682 assert( pList->nExpr>0 );
1683 pItem = &pList->a[pList->nExpr-1];
1684 assert( pItem->zName==0 );
1685 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001686 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001687 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001688 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001689 }
drhb7916a72009-05-27 10:31:29 +00001690 }
1691}
1692
1693/*
1694** Set the ExprList.a[].zSpan element of the most recently added item
1695** on the expression list.
1696**
1697** pList might be NULL following an OOM error. But pSpan should never be
1698** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1699** is set.
1700*/
1701void sqlite3ExprListSetSpan(
1702 Parse *pParse, /* Parsing context */
1703 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001704 const char *zStart, /* Start of the span */
1705 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001706){
1707 sqlite3 *db = pParse->db;
1708 assert( pList!=0 || db->mallocFailed!=0 );
1709 if( pList ){
1710 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1711 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001712 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001713 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001714 }
1715}
1716
1717/*
danielk19777a15a4b2007-05-08 17:54:43 +00001718** If the expression list pEList contains more than iLimit elements,
1719** leave an error message in pParse.
1720*/
1721void sqlite3ExprListCheckLength(
1722 Parse *pParse,
1723 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001724 const char *zObject
1725){
drhb1a6c3c2008-03-20 16:30:17 +00001726 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001727 testcase( pEList && pEList->nExpr==mx );
1728 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001729 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001730 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1731 }
1732}
1733
1734/*
drha76b5df2002-02-23 02:32:10 +00001735** Delete an entire expression list.
1736*/
drhaffa8552016-04-11 18:25:05 +00001737static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001738 int i = pList->nExpr;
1739 struct ExprList_item *pItem = pList->a;
1740 assert( pList->nExpr>0 );
1741 do{
drh633e6d52008-07-28 19:34:53 +00001742 sqlite3ExprDelete(db, pItem->pExpr);
1743 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001744 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001745 pItem++;
1746 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001747 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001748}
drhaffa8552016-04-11 18:25:05 +00001749void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1750 if( pList ) exprListDeleteNN(db, pList);
1751}
drha76b5df2002-02-23 02:32:10 +00001752
1753/*
drh2308ed32015-02-09 16:09:34 +00001754** Return the bitwise-OR of all Expr.flags fields in the given
1755** ExprList.
drh885a5b02015-02-09 15:21:36 +00001756*/
drh2308ed32015-02-09 16:09:34 +00001757u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001758 int i;
drh2308ed32015-02-09 16:09:34 +00001759 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001760 assert( pList!=0 );
1761 for(i=0; i<pList->nExpr; i++){
1762 Expr *pExpr = pList->a[i].pExpr;
1763 assert( pExpr!=0 );
1764 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001765 }
drh2308ed32015-02-09 16:09:34 +00001766 return m;
drh885a5b02015-02-09 15:21:36 +00001767}
1768
1769/*
drh7e6f9802017-09-04 00:33:04 +00001770** This is a SELECT-node callback for the expression walker that
1771** always "fails". By "fail" in this case, we mean set
1772** pWalker->eCode to zero and abort.
1773**
1774** This callback is used by multiple expression walkers.
1775*/
1776int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1777 UNUSED_PARAMETER(NotUsed);
1778 pWalker->eCode = 0;
1779 return WRC_Abort;
1780}
1781
1782/*
drh171d16b2018-02-26 20:15:54 +00001783** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001784** then convert it into an TK_TRUEFALSE term. Return non-zero if
1785** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001786*/
1787int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1788 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001789 if( !ExprHasProperty(pExpr, EP_Quoted)
1790 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1791 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001792 ){
1793 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001794 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001795 return 1;
1796 }
1797 return 0;
1798}
1799
drh43c4ac82018-02-26 21:26:27 +00001800/*
drh96acafb2018-02-27 14:49:25 +00001801** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001802** and 0 if it is FALSE.
1803*/
drh96acafb2018-02-27 14:49:25 +00001804int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001805 assert( pExpr->op==TK_TRUEFALSE );
1806 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1807 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1808 return pExpr->u.zToken[4]==0;
1809}
1810
drh171d16b2018-02-26 20:15:54 +00001811
1812/*
drh059b2d52014-10-24 19:28:09 +00001813** These routines are Walker callbacks used to check expressions to
1814** see if they are "constant" for some definition of constant. The
1815** Walker.eCode value determines the type of "constant" we are looking
1816** for.
drh73b211a2005-01-18 04:00:42 +00001817**
drh7d10d5a2008-08-20 16:35:10 +00001818** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001819**
drh059b2d52014-10-24 19:28:09 +00001820** sqlite3ExprIsConstant() pWalker->eCode==1
1821** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001822** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001823** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001824**
drh059b2d52014-10-24 19:28:09 +00001825** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1826** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001827**
drhfeada2d2014-09-24 13:20:22 +00001828** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001829** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1830** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001831** parameter raises an error for new statements, but is silently converted
1832** to NULL for existing schemas. This allows sqlite_master tables that
1833** contain a bound parameter because they were generated by older versions
1834** of SQLite to be parsed by newer versions of SQLite without raising a
1835** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001836*/
drh7d10d5a2008-08-20 16:35:10 +00001837static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001838
drh059b2d52014-10-24 19:28:09 +00001839 /* If pWalker->eCode is 2 then any term of the expression that comes from
1840 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001841 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001842 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1843 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001844 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001845 }
1846
drh626a8792005-01-17 22:08:19 +00001847 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001848 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001849 ** and either pWalker->eCode==4 or 5 or the function has the
1850 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001851 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001852 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001853 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001854 }else{
1855 pWalker->eCode = 0;
1856 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001857 }
drh626a8792005-01-17 22:08:19 +00001858 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001859 /* Convert "true" or "false" in a DEFAULT clause into the
1860 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001861 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001862 return WRC_Prune;
1863 }
1864 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001865 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001866 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001867 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001868 testcase( pExpr->op==TK_ID );
1869 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001870 testcase( pExpr->op==TK_AGG_FUNCTION );
1871 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001872 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001873 return WRC_Continue;
1874 }
drh059b2d52014-10-24 19:28:09 +00001875 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1876 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001877 }
drhf43ce0b2017-05-25 00:08:48 +00001878 /* Fall through */
1879 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001880 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001881 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001882 testcase( pExpr->op==TK_IF_NULL_ROW );
1883 pWalker->eCode = 0;
1884 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001885 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001886 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001887 /* Silently convert bound parameters that appear inside of CREATE
1888 ** statements into a NULL when parsing the CREATE statement text out
1889 ** of the sqlite_master table */
1890 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001891 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001892 /* A bound parameter in a CREATE statement that originates from
1893 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001894 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001895 return WRC_Abort;
1896 }
1897 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001898 default:
drh6e341b92018-04-17 18:50:40 +00001899 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1900 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001901 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001902 }
1903}
drh059b2d52014-10-24 19:28:09 +00001904static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001905 Walker w;
drh059b2d52014-10-24 19:28:09 +00001906 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001907 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001908 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001909#ifdef SQLITE_DEBUG
1910 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1911#endif
drh059b2d52014-10-24 19:28:09 +00001912 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001913 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001914 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001915}
drh626a8792005-01-17 22:08:19 +00001916
1917/*
drh059b2d52014-10-24 19:28:09 +00001918** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001919** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001920**
1921** For the purposes of this function, a double-quoted string (ex: "abc")
1922** is considered a variable but a single-quoted string (ex: 'abc') is
1923** a constant.
drhfef52082000-06-06 01:50:43 +00001924*/
danielk19774adee202004-05-08 08:23:19 +00001925int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001926 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001927}
1928
1929/*
drh07aded62018-07-28 16:24:08 +00001930** Walk an expression tree. Return non-zero if
1931**
1932** (1) the expression is constant, and
1933** (2) the expression does originate in the ON or USING clause
1934** of a LEFT JOIN, and
1935** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1936** operands created by the constant propagation optimization.
1937**
1938** When this routine returns true, it indicates that the expression
1939** can be added to the pParse->pConstExpr list and evaluated once when
1940** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001941*/
1942int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001943 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001944}
1945
1946/*
drhfcb9f4f2015-06-01 18:13:16 +00001947** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001948** for any single row of the table with cursor iCur. In other words, the
1949** expression must not refer to any non-deterministic function nor any
1950** table other than iCur.
1951*/
1952int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1953 return exprIsConst(p, 3, iCur);
1954}
1955
danab31a842017-04-29 20:53:09 +00001956
1957/*
1958** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1959*/
1960static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1961 ExprList *pGroupBy = pWalker->u.pGroupBy;
1962 int i;
1963
1964 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1965 ** it constant. */
1966 for(i=0; i<pGroupBy->nExpr; i++){
1967 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001968 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001969 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001970 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001971 return WRC_Prune;
1972 }
1973 }
1974 }
1975
1976 /* Check if pExpr is a sub-select. If so, consider it variable. */
1977 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1978 pWalker->eCode = 0;
1979 return WRC_Abort;
1980 }
1981
1982 return exprNodeIsConstant(pWalker, pExpr);
1983}
1984
1985/*
1986** Walk the expression tree passed as the first argument. Return non-zero
1987** if the expression consists entirely of constants or copies of terms
1988** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00001989**
1990** This routine is used to determine if a term of the HAVING clause can
1991** be promoted into the WHERE clause. In order for such a promotion to work,
1992** the value of the HAVING clause term must be the same for all members of
1993** a "group". The requirement that the GROUP BY term must be BINARY
1994** assumes that no other collating sequence will have a finer-grained
1995** grouping than binary. In other words (A=B COLLATE binary) implies
1996** A=B in every other collating sequence. The requirement that the
1997** GROUP BY be BINARY is stricter than necessary. It would also work
1998** to promote HAVING clauses that use the same alternative collating
1999** sequence as the GROUP BY term, but that is much harder to check,
2000** alternative collating sequences are uncommon, and this is only an
2001** optimization, so we take the easy way out and simply require the
2002** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002003*/
2004int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2005 Walker w;
danab31a842017-04-29 20:53:09 +00002006 w.eCode = 1;
2007 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002008 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002009 w.u.pGroupBy = pGroupBy;
2010 w.pParse = pParse;
2011 sqlite3WalkExpr(&w, p);
2012 return w.eCode;
2013}
2014
drh059b2d52014-10-24 19:28:09 +00002015/*
2016** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002017** or a function call with constant arguments. Return and 0 if there
2018** are any variables.
2019**
2020** For the purposes of this function, a double-quoted string (ex: "abc")
2021** is considered a variable but a single-quoted string (ex: 'abc') is
2022** a constant.
2023*/
drhfeada2d2014-09-24 13:20:22 +00002024int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2025 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002026 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002027}
2028
drh5b88bc42013-12-07 23:35:21 +00002029#ifdef SQLITE_ENABLE_CURSOR_HINTS
2030/*
2031** Walk an expression tree. Return 1 if the expression contains a
2032** subquery of some kind. Return 0 if there are no subqueries.
2033*/
2034int sqlite3ExprContainsSubquery(Expr *p){
2035 Walker w;
drhbec24762015-08-13 20:07:13 +00002036 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002037 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002038 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002039#ifdef SQLITE_DEBUG
2040 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2041#endif
drh5b88bc42013-12-07 23:35:21 +00002042 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002043 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002044}
2045#endif
2046
drheb55bd22005-06-30 17:04:21 +00002047/*
drh73b211a2005-01-18 04:00:42 +00002048** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002049** to fit in a 32-bit integer, return 1 and put the value of the integer
2050** in *pValue. If the expression is not an integer or if it is too big
2051** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002052*/
danielk19774adee202004-05-08 08:23:19 +00002053int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002054 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002055 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002056
2057 /* If an expression is an integer literal that fits in a signed 32-bit
2058 ** integer, then the EP_IntValue flag will have already been set */
2059 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2060 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2061
drh92b01d52008-06-24 00:32:35 +00002062 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002063 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002064 return 1;
2065 }
drhe4de1fe2002-06-02 16:09:01 +00002066 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002067 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002068 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002069 break;
drh4b59ab52002-08-24 18:24:51 +00002070 }
drhe4de1fe2002-06-02 16:09:01 +00002071 case TK_UMINUS: {
2072 int v;
danielk19774adee202004-05-08 08:23:19 +00002073 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002074 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002075 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002076 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002077 }
2078 break;
2079 }
2080 default: break;
2081 }
drh92b01d52008-06-24 00:32:35 +00002082 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002083}
2084
2085/*
drh039fc322009-11-17 18:31:47 +00002086** Return FALSE if there is no chance that the expression can be NULL.
2087**
2088** If the expression might be NULL or if the expression is too complex
2089** to tell return TRUE.
2090**
2091** This routine is used as an optimization, to skip OP_IsNull opcodes
2092** when we know that a value cannot be NULL. Hence, a false positive
2093** (returning TRUE when in fact the expression can never be NULL) might
2094** be a small performance hit but is otherwise harmless. On the other
2095** hand, a false negative (returning FALSE when the result could be NULL)
2096** will likely result in an incorrect answer. So when in doubt, return
2097** TRUE.
2098*/
2099int sqlite3ExprCanBeNull(const Expr *p){
2100 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002101 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2102 p = p->pLeft;
2103 }
drh039fc322009-11-17 18:31:47 +00002104 op = p->op;
2105 if( op==TK_REGISTER ) op = p->op2;
2106 switch( op ){
2107 case TK_INTEGER:
2108 case TK_STRING:
2109 case TK_FLOAT:
2110 case TK_BLOB:
2111 return 0;
drh7248a8b2014-08-04 18:50:54 +00002112 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002113 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002114 p->y.pTab==0 || /* Reference to column of index on expression */
2115 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002116 default:
2117 return 1;
2118 }
2119}
2120
2121/*
2122** Return TRUE if the given expression is a constant which would be
2123** unchanged by OP_Affinity with the affinity given in the second
2124** argument.
2125**
2126** This routine is used to determine if the OP_Affinity operation
2127** can be omitted. When in doubt return FALSE. A false negative
2128** is harmless. A false positive, however, can result in the wrong
2129** answer.
2130*/
2131int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2132 u8 op;
drh05883a32015-06-02 15:32:08 +00002133 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002134 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002135 op = p->op;
2136 if( op==TK_REGISTER ) op = p->op2;
2137 switch( op ){
2138 case TK_INTEGER: {
2139 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2140 }
2141 case TK_FLOAT: {
2142 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2143 }
2144 case TK_STRING: {
2145 return aff==SQLITE_AFF_TEXT;
2146 }
2147 case TK_BLOB: {
2148 return 1;
2149 }
drh2f2855b2009-11-18 01:25:26 +00002150 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002151 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2152 return p->iColumn<0
2153 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002154 }
drh039fc322009-11-17 18:31:47 +00002155 default: {
2156 return 0;
2157 }
2158 }
2159}
2160
2161/*
drhc4a3c772001-04-04 11:48:57 +00002162** Return TRUE if the given string is a row-id column name.
2163*/
danielk19774adee202004-05-08 08:23:19 +00002164int sqlite3IsRowid(const char *z){
2165 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2166 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2167 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002168 return 0;
2169}
2170
danielk19779a96b662007-11-29 17:05:18 +00002171/*
drh69c355b2016-03-09 15:34:51 +00002172** pX is the RHS of an IN operator. If pX is a SELECT statement
2173** that can be simplified to a direct table access, then return
2174** a pointer to the SELECT statement. If pX is not a SELECT statement,
2175** or if the SELECT statement needs to be manifested into a transient
2176** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002177*/
2178#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002179static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002180 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002181 SrcList *pSrc;
2182 ExprList *pEList;
2183 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002184 int i;
drh69c355b2016-03-09 15:34:51 +00002185 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2186 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2187 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002188 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002189 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002190 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2191 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2192 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002193 }
drhb74b1012009-05-28 21:04:37 +00002194 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002195 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002196 if( p->pWhere ) return 0; /* Has no WHERE clause */
2197 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002198 assert( pSrc!=0 );
2199 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002200 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002201 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002202 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002203 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002204 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2205 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002206 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002207 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002208 for(i=0; i<pEList->nExpr; i++){
2209 Expr *pRes = pEList->a[i].pExpr;
2210 if( pRes->op!=TK_COLUMN ) return 0;
2211 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002212 }
drh69c355b2016-03-09 15:34:51 +00002213 return p;
drhb287f4b2008-04-25 00:08:38 +00002214}
2215#endif /* SQLITE_OMIT_SUBQUERY */
2216
danf9b2e052016-08-02 17:45:00 +00002217#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002218/*
drh4c259e92014-08-01 21:12:35 +00002219** Generate code that checks the left-most column of index table iCur to see if
2220** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002221** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2222** to be set to NULL if iCur contains one or more NULL values.
2223*/
2224static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002225 int addr1;
drh6be515e2014-08-01 21:00:53 +00002226 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002227 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002228 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2229 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002230 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002231 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002232}
danf9b2e052016-08-02 17:45:00 +00002233#endif
drh6be515e2014-08-01 21:00:53 +00002234
drhbb53ecb2014-08-02 21:03:33 +00002235
2236#ifndef SQLITE_OMIT_SUBQUERY
2237/*
2238** The argument is an IN operator with a list (not a subquery) on the
2239** right-hand side. Return TRUE if that list is constant.
2240*/
2241static int sqlite3InRhsIsConstant(Expr *pIn){
2242 Expr *pLHS;
2243 int res;
2244 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2245 pLHS = pIn->pLeft;
2246 pIn->pLeft = 0;
2247 res = sqlite3ExprIsConstant(pIn);
2248 pIn->pLeft = pLHS;
2249 return res;
2250}
2251#endif
2252
drh6be515e2014-08-01 21:00:53 +00002253/*
danielk19779a96b662007-11-29 17:05:18 +00002254** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002255** The pX parameter is the expression on the RHS of the IN operator, which
2256** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002257**
drhd4305ca2012-09-18 17:08:33 +00002258** The job of this routine is to find or create a b-tree object that can
2259** be used either to test for membership in the RHS set or to iterate through
2260** all members of the RHS set, skipping duplicates.
2261**
drh3a856252014-08-01 14:46:57 +00002262** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002263** and pX->iTable is set to the index of that cursor.
2264**
drhb74b1012009-05-28 21:04:37 +00002265** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002266**
drh1ccce442013-03-12 20:38:51 +00002267** IN_INDEX_ROWID - The cursor was opened on a database table.
2268** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2269** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2270** IN_INDEX_EPH - The cursor was opened on a specially created and
2271** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002272** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2273** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002274**
drhd4305ca2012-09-18 17:08:33 +00002275** An existing b-tree might be used if the RHS expression pX is a simple
2276** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002277**
dan553168c2016-08-01 20:14:31 +00002278** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002279**
drhd4305ca2012-09-18 17:08:33 +00002280** If the RHS of the IN operator is a list or a more complex subquery, then
2281** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002282** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002283** existing table.
drhd4305ca2012-09-18 17:08:33 +00002284**
drh7fc0ba02017-11-17 15:02:00 +00002285** The inFlags parameter must contain, at a minimum, one of the bits
2286** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2287** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2288** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2289** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002290**
2291** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2292** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002293** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002294** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2295** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002296**
drh3a856252014-08-01 14:46:57 +00002297** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2298** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002299** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2300** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002301**
drhbb53ecb2014-08-02 21:03:33 +00002302** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2303** if the RHS of the IN operator is a list (not a subquery) then this
2304** routine might decide that creating an ephemeral b-tree for membership
2305** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2306** calling routine should implement the IN operator using a sequence
2307** of Eq or Ne comparison operations.
2308**
drhb74b1012009-05-28 21:04:37 +00002309** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002310** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002311** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002312** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002313** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002314** to *prRhsHasNull. If there is no chance that the (...) contains a
2315** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002316**
drhe21a6e12014-08-01 18:00:24 +00002317** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002318** the value in that register will be NULL if the b-tree contains one or more
2319** NULL values, and it will be some non-NULL value if the b-tree contains no
2320** NULL values.
dan553168c2016-08-01 20:14:31 +00002321**
2322** If the aiMap parameter is not NULL, it must point to an array containing
2323** one element for each column returned by the SELECT statement on the RHS
2324** of the IN(...) operator. The i'th entry of the array is populated with the
2325** offset of the index column that matches the i'th column returned by the
2326** SELECT. For example, if the expression and selected index are:
2327**
2328** (?,?,?) IN (SELECT a, b, c FROM t1)
2329** CREATE INDEX i1 ON t1(b, c, a);
2330**
2331** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002332*/
danielk1977284f4ac2007-12-10 05:03:46 +00002333#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002334int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002335 Parse *pParse, /* Parsing context */
2336 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2337 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2338 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002339 int *aiMap, /* Mapping from Index fields to RHS fields */
2340 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002341){
drhb74b1012009-05-28 21:04:37 +00002342 Select *p; /* SELECT to the right of IN operator */
2343 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2344 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002345 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002346 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002347
drh1450bc62009-10-30 13:25:56 +00002348 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002349 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002350
dan7b35a772016-07-28 19:47:15 +00002351 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2352 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002353 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002354 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002355 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002356 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2357 int i;
2358 ExprList *pEList = pX->x.pSelect->pEList;
2359 for(i=0; i<pEList->nExpr; i++){
2360 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2361 }
2362 if( i==pEList->nExpr ){
2363 prRhsHasNull = 0;
2364 }
2365 }
2366
drhb74b1012009-05-28 21:04:37 +00002367 /* Check to see if an existing table or index can be used to
2368 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002369 ** ephemeral table. */
2370 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002371 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002372 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002373 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002374 ExprList *pEList = p->pEList;
2375 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002376
drhb07028f2011-10-14 21:49:18 +00002377 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2378 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2379 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2380 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002381
drhb22f7c82014-02-06 23:56:27 +00002382 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002383 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2384 sqlite3CodeVerifySchema(pParse, iDb);
2385 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002386
drha84a2832016-08-26 21:15:35 +00002387 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002388 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002389 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002390 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002391 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002392
2393 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2394 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002395 ExplainQueryPlan((pParse, 0,
2396 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002397 sqlite3VdbeJumpHere(v, iAddr);
2398 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002399 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002400 int affinity_ok = 1;
2401 int i;
2402
2403 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002404 ** comparison is the same as the affinity of each column in table
2405 ** on the RHS of the IN operator. If it not, it is not possible to
2406 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002407 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002408 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002409 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002410 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002411 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002412 testcase( cmpaff==SQLITE_AFF_BLOB );
2413 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002414 switch( cmpaff ){
2415 case SQLITE_AFF_BLOB:
2416 break;
2417 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002418 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2419 ** other has no affinity and the other side is TEXT. Hence,
2420 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2421 ** and for the term on the LHS of the IN to have no affinity. */
2422 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002423 break;
2424 default:
2425 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2426 }
2427 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002428
drha84a2832016-08-26 21:15:35 +00002429 if( affinity_ok ){
2430 /* Search for an existing index that will work for this IN operator */
2431 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2432 Bitmask colUsed; /* Columns of the index used */
2433 Bitmask mCol; /* Mask for the current column */
2434 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002435 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002436 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2437 ** BITMASK(nExpr) without overflowing */
2438 testcase( pIdx->nColumn==BMS-2 );
2439 testcase( pIdx->nColumn==BMS-1 );
2440 if( pIdx->nColumn>=BMS-1 ) continue;
2441 if( mustBeUnique ){
2442 if( pIdx->nKeyCol>nExpr
2443 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2444 ){
2445 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002446 }
danielk19770cdc0222008-06-26 18:04:03 +00002447 }
drha84a2832016-08-26 21:15:35 +00002448
2449 colUsed = 0; /* Columns of index used so far */
2450 for(i=0; i<nExpr; i++){
2451 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2452 Expr *pRhs = pEList->a[i].pExpr;
2453 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2454 int j;
2455
2456 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2457 for(j=0; j<nExpr; j++){
2458 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2459 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002460 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2461 continue;
2462 }
drha84a2832016-08-26 21:15:35 +00002463 break;
2464 }
2465 if( j==nExpr ) break;
2466 mCol = MASKBIT(j);
2467 if( mCol & colUsed ) break; /* Each column used only once */
2468 colUsed |= mCol;
2469 if( aiMap ) aiMap[i] = j;
2470 }
2471
2472 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2473 if( colUsed==(MASKBIT(nExpr)-1) ){
2474 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002475 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002476 ExplainQueryPlan((pParse, 0,
2477 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002478 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2479 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2480 VdbeComment((v, "%s", pIdx->zName));
2481 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2482 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2483
2484 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002485#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002486 i64 mask = (1<<nExpr)-1;
2487 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2488 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002489#endif
2490 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002491 if( nExpr==1 ){
2492 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2493 }
2494 }
2495 sqlite3VdbeJumpHere(v, iAddr);
2496 }
2497 } /* End loop over indexes */
2498 } /* End if( affinity_ok ) */
2499 } /* End if not an rowid index */
2500 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002501
drhbb53ecb2014-08-02 21:03:33 +00002502 /* If no preexisting index is available for the IN clause
2503 ** and IN_INDEX_NOOP is an allowed reply
2504 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002505 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002506 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002507 ** the IN operator so return IN_INDEX_NOOP.
2508 */
2509 if( eType==0
2510 && (inFlags & IN_INDEX_NOOP_OK)
2511 && !ExprHasProperty(pX, EP_xIsSelect)
2512 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2513 ){
2514 eType = IN_INDEX_NOOP;
2515 }
drhbb53ecb2014-08-02 21:03:33 +00002516
danielk19779a96b662007-11-29 17:05:18 +00002517 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002518 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002519 ** We will have to generate an ephemeral table to do the job.
2520 */
drh8e23daf2013-06-11 13:30:04 +00002521 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002522 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002523 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002524 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002525 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002526 }else if( prRhsHasNull ){
2527 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002528 }
drh85bcdce2018-12-23 21:27:29 +00002529 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002530 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002531 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002532 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002533 }
drhcf4d38a2010-07-28 02:53:36 +00002534 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002535 }
danba00e302016-07-23 20:24:06 +00002536
2537 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2538 int i, n;
2539 n = sqlite3ExprVectorSize(pX->pLeft);
2540 for(i=0; i<n; i++) aiMap[i] = i;
2541 }
drh2c041312018-12-24 02:34:49 +00002542 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002543 return eType;
2544}
danielk1977284f4ac2007-12-10 05:03:46 +00002545#endif
drh626a8792005-01-17 22:08:19 +00002546
danf9b2e052016-08-02 17:45:00 +00002547#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002548/*
2549** Argument pExpr is an (?, ?...) IN(...) expression. This
2550** function allocates and returns a nul-terminated string containing
2551** the affinities to be used for each column of the comparison.
2552**
2553** It is the responsibility of the caller to ensure that the returned
2554** string is eventually freed using sqlite3DbFree().
2555*/
dan71c57db2016-07-09 20:23:55 +00002556static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2557 Expr *pLeft = pExpr->pLeft;
2558 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002559 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002560 char *zRet;
2561
dan553168c2016-08-01 20:14:31 +00002562 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002563 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002564 if( zRet ){
2565 int i;
2566 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002567 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002568 char a = sqlite3ExprAffinity(pA);
2569 if( pSelect ){
2570 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2571 }else{
2572 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002573 }
dan71c57db2016-07-09 20:23:55 +00002574 }
2575 zRet[nVal] = '\0';
2576 }
2577 return zRet;
2578}
danf9b2e052016-08-02 17:45:00 +00002579#endif
dan71c57db2016-07-09 20:23:55 +00002580
dan8da209b2016-07-26 18:06:08 +00002581#ifndef SQLITE_OMIT_SUBQUERY
2582/*
2583** Load the Parse object passed as the first argument with an error
2584** message of the form:
2585**
2586** "sub-select returns N columns - expected M"
2587*/
2588void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2589 const char *zFmt = "sub-select returns %d columns - expected %d";
2590 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2591}
2592#endif
2593
drh626a8792005-01-17 22:08:19 +00002594/*
dan44c56042016-12-07 15:38:37 +00002595** Expression pExpr is a vector that has been used in a context where
2596** it is not permitted. If pExpr is a sub-select vector, this routine
2597** loads the Parse object with a message of the form:
2598**
2599** "sub-select returns N columns - expected 1"
2600**
2601** Or, if it is a regular scalar vector:
2602**
2603** "row value misused"
2604*/
2605void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2606#ifndef SQLITE_OMIT_SUBQUERY
2607 if( pExpr->flags & EP_xIsSelect ){
2608 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2609 }else
2610#endif
2611 {
2612 sqlite3ErrorMsg(pParse, "row value misused");
2613 }
2614}
2615
drh85bcdce2018-12-23 21:27:29 +00002616#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002617/*
drh85bcdce2018-12-23 21:27:29 +00002618** Generate code that will construct an ephemeral table containing all terms
2619** in the RHS of an IN operator. The IN operator can be in either of two
2620** forms:
drh626a8792005-01-17 22:08:19 +00002621**
drh9cbe6352005-11-29 03:13:21 +00002622** x IN (4,5,11) -- IN operator with list on right-hand side
2623** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002624**
drh2c041312018-12-24 02:34:49 +00002625** The pExpr parameter is the IN operator. The cursor number for the
2626** constructed ephermeral table is returned. The first time the ephemeral
2627** table is computed, the cursor number is also stored in pExpr->iTable,
2628** however the cursor number returned might not be the same, as it might
2629** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002630**
drh85bcdce2018-12-23 21:27:29 +00002631** If the LHS expression ("x" in the examples) is a column value, or
2632** the SELECT statement returns a column value, then the affinity of that
2633** column is used to build the index keys. If both 'x' and the
2634** SELECT... statement are columns, then numeric affinity is used
2635** if either column has NUMERIC or INTEGER affinity. If neither
2636** 'x' nor the SELECT... statement are columns, then numeric affinity
2637** is used.
drhcce7d172000-05-31 15:34:51 +00002638*/
drh85bcdce2018-12-23 21:27:29 +00002639void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002640 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002641 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002642 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002643){
drh2c041312018-12-24 02:34:49 +00002644 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002645 int addr; /* Address of OP_OpenEphemeral instruction */
2646 Expr *pLeft; /* the LHS of the IN operator */
2647 KeyInfo *pKeyInfo = 0; /* Key information */
2648 int nVal; /* Size of vector pLeft */
2649 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002650
drh2c041312018-12-24 02:34:49 +00002651 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002652 assert( v!=0 );
2653
drh2c041312018-12-24 02:34:49 +00002654 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002655 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002656 **
2657 ** * The right-hand side is a correlated subquery
2658 ** * The right-hand side is an expression list containing variables
2659 ** * We are inside a trigger
2660 **
drh2c041312018-12-24 02:34:49 +00002661 ** If all of the above are false, then we can compute the RHS just once
2662 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002663 */
drhefb699f2018-12-24 11:55:44 +00002664 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002665 /* Reuse of the RHS is allowed */
2666 /* If this routine has already been coded, but the previous code
2667 ** might not have been invoked yet, so invoke it now as a subroutine.
2668 */
2669 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002670 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002671 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2672 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2673 pExpr->x.pSelect->selId));
2674 }
drh2c041312018-12-24 02:34:49 +00002675 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2676 pExpr->y.sub.iAddr);
2677 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002678 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002679 return;
2680 }
2681
2682 /* Begin coding the subroutine */
2683 ExprSetProperty(pExpr, EP_Subrtn);
2684 pExpr->y.sub.regReturn = ++pParse->nMem;
2685 pExpr->y.sub.iAddr =
2686 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2687 VdbeComment((v, "return address"));
2688
2689 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002690 }
2691
drh85bcdce2018-12-23 21:27:29 +00002692 /* Check to see if this is a vector IN operator */
2693 pLeft = pExpr->pLeft;
2694 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002695
drh85bcdce2018-12-23 21:27:29 +00002696 /* Construct the ephemeral table that will contain the content of
2697 ** RHS of the IN operator.
2698 */
drh2c041312018-12-24 02:34:49 +00002699 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002700 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002701#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2702 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2703 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2704 }else{
2705 VdbeComment((v, "RHS of IN operator"));
2706 }
2707#endif
drh50ef6712019-02-22 23:29:56 +00002708 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002709
drh85bcdce2018-12-23 21:27:29 +00002710 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2711 /* Case 1: expr IN (SELECT ...)
2712 **
2713 ** Generate code to write the results of the select into the temporary
2714 ** table allocated and opened above.
2715 */
2716 Select *pSelect = pExpr->x.pSelect;
2717 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002718
drh2c041312018-12-24 02:34:49 +00002719 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2720 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002721 ));
drh85bcdce2018-12-23 21:27:29 +00002722 /* If the LHS and RHS of the IN operator do not match, that
2723 ** error will have been caught long before we reach this point. */
2724 if( ALWAYS(pEList->nExpr==nVal) ){
2725 SelectDest dest;
2726 int i;
drhbd462bc2018-12-24 20:21:06 +00002727 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002728 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2729 pSelect->iLimit = 0;
2730 testcase( pSelect->selFlags & SF_Distinct );
2731 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2732 if( sqlite3Select(pParse, pSelect, &dest) ){
2733 sqlite3DbFree(pParse->db, dest.zAffSdst);
2734 sqlite3KeyInfoUnref(pKeyInfo);
2735 return;
drhfef52082000-06-06 01:50:43 +00002736 }
drh85bcdce2018-12-23 21:27:29 +00002737 sqlite3DbFree(pParse->db, dest.zAffSdst);
2738 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2739 assert( pEList!=0 );
2740 assert( pEList->nExpr>0 );
2741 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2742 for(i=0; i<nVal; i++){
2743 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2744 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2745 pParse, p, pEList->a[i].pExpr
2746 );
danielk197741a05b72008-10-02 13:50:55 +00002747 }
drh85bcdce2018-12-23 21:27:29 +00002748 }
2749 }else if( ALWAYS(pExpr->x.pList!=0) ){
2750 /* Case 2: expr IN (exprlist)
2751 **
2752 ** For each expression, build an index key from the evaluation and
2753 ** store it in the temporary table. If <expr> is a column, then use
2754 ** that columns affinity when building index keys. If <expr> is not
2755 ** a column, use numeric affinity.
2756 */
2757 char affinity; /* Affinity of the LHS of the IN */
2758 int i;
2759 ExprList *pList = pExpr->x.pList;
2760 struct ExprList_item *pItem;
2761 int r1, r2, r3;
2762 affinity = sqlite3ExprAffinity(pLeft);
2763 if( !affinity ){
2764 affinity = SQLITE_AFF_BLOB;
2765 }
2766 if( pKeyInfo ){
2767 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2768 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002769 }
2770
drh85bcdce2018-12-23 21:27:29 +00002771 /* Loop through each expression in <exprlist>. */
2772 r1 = sqlite3GetTempReg(pParse);
2773 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002774 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2775 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002776
2777 /* If the expression is not constant then we will need to
2778 ** disable the test that was generated above that makes sure
2779 ** this code only executes once. Because for a non-constant
2780 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002781 */
drh2c041312018-12-24 02:34:49 +00002782 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2783 sqlite3VdbeChangeToNoop(v, addrOnce);
2784 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002785 }
drh1398ad32005-01-19 23:24:50 +00002786
drh85bcdce2018-12-23 21:27:29 +00002787 /* Evaluate the expression and insert it into the temp table */
drh50ef6712019-02-22 23:29:56 +00002788 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2789 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2790 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drhcce7d172000-05-31 15:34:51 +00002791 }
drh85bcdce2018-12-23 21:27:29 +00002792 sqlite3ReleaseTempReg(pParse, r1);
2793 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002794 }
drh85bcdce2018-12-23 21:27:29 +00002795 if( pKeyInfo ){
2796 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2797 }
drh2c041312018-12-24 02:34:49 +00002798 if( addrOnce ){
2799 sqlite3VdbeJumpHere(v, addrOnce);
2800 /* Subroutine return */
2801 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2802 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002803 }
2804}
2805#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002806
drh85bcdce2018-12-23 21:27:29 +00002807/*
2808** Generate code for scalar subqueries used as a subquery expression
2809** or EXISTS operator:
2810**
2811** (SELECT a FROM b) -- subquery
2812** EXISTS (SELECT a FROM b) -- EXISTS subquery
2813**
2814** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2815**
2816** The register that holds the result. For a multi-column SELECT,
2817** the result is stored in a contiguous array of registers and the
2818** return value is the register of the left-most result column.
2819** Return 0 if an error occurs.
2820*/
2821#ifndef SQLITE_OMIT_SUBQUERY
2822int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002823 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002824 int rReg = 0; /* Register storing resulting */
2825 Select *pSel; /* SELECT statement to encode */
2826 SelectDest dest; /* How to deal with SELECT result */
2827 int nReg; /* Registers to allocate */
2828 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002829
2830 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002831 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002832 testcase( pExpr->op==TK_EXISTS );
2833 testcase( pExpr->op==TK_SELECT );
2834 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2835 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2836 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002837
drh5198ff52018-12-24 12:09:47 +00002838 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002839 ** is encountered if any of the following is true:
2840 **
2841 ** * The right-hand side is a correlated subquery
2842 ** * The right-hand side is an expression list containing variables
2843 ** * We are inside a trigger
2844 **
2845 ** If all of the above are false, then we can run this code just once
2846 ** save the results, and reuse the same result on subsequent invocations.
2847 */
2848 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002849 /* If this routine has already been coded, then invoke it as a
2850 ** subroutine. */
2851 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002852 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002853 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2854 pExpr->y.sub.iAddr);
2855 return pExpr->iTable;
2856 }
2857
2858 /* Begin coding the subroutine */
2859 ExprSetProperty(pExpr, EP_Subrtn);
2860 pExpr->y.sub.regReturn = ++pParse->nMem;
2861 pExpr->y.sub.iAddr =
2862 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2863 VdbeComment((v, "return address"));
2864
drh2c041312018-12-24 02:34:49 +00002865 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002866 }
drh85bcdce2018-12-23 21:27:29 +00002867
2868 /* For a SELECT, generate code to put the values for all columns of
2869 ** the first row into an array of registers and return the index of
2870 ** the first register.
2871 **
2872 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2873 ** into a register and return that register number.
2874 **
2875 ** In both cases, the query is augmented with "LIMIT 1". Any
2876 ** preexisting limit is discarded in place of the new LIMIT 1.
2877 */
drhbd462bc2018-12-24 20:21:06 +00002878 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2879 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002880 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2881 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2882 pParse->nMem += nReg;
2883 if( pExpr->op==TK_SELECT ){
2884 dest.eDest = SRT_Mem;
2885 dest.iSdst = dest.iSDParm;
2886 dest.nSdst = nReg;
2887 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2888 VdbeComment((v, "Init subquery result"));
2889 }else{
2890 dest.eDest = SRT_Exists;
2891 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2892 VdbeComment((v, "Init EXISTS result"));
2893 }
2894 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2895 if( pSel->pLimit ){
2896 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2897 pSel->pLimit->pLeft = pLimit;
2898 }else{
2899 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2900 }
2901 pSel->iLimit = 0;
2902 if( sqlite3Select(pParse, pSel, &dest) ){
2903 return 0;
2904 }
drh2c041312018-12-24 02:34:49 +00002905 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002906 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002907 if( addrOnce ){
2908 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002909
drh5198ff52018-12-24 12:09:47 +00002910 /* Subroutine return */
2911 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2912 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2913 }
drh2c041312018-12-24 02:34:49 +00002914
drh1450bc62009-10-30 13:25:56 +00002915 return rReg;
drhcce7d172000-05-31 15:34:51 +00002916}
drh51522cd2005-01-20 13:36:19 +00002917#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002918
drhe3365e62009-11-12 17:52:24 +00002919#ifndef SQLITE_OMIT_SUBQUERY
2920/*
dan7b35a772016-07-28 19:47:15 +00002921** Expr pIn is an IN(...) expression. This function checks that the
2922** sub-select on the RHS of the IN() operator has the same number of
2923** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2924** a sub-query, that the LHS is a vector of size 1.
2925*/
2926int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2927 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2928 if( (pIn->flags & EP_xIsSelect) ){
2929 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2930 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2931 return 1;
2932 }
2933 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002934 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002935 return 1;
2936 }
2937 return 0;
2938}
2939#endif
2940
2941#ifndef SQLITE_OMIT_SUBQUERY
2942/*
drhe3365e62009-11-12 17:52:24 +00002943** Generate code for an IN expression.
2944**
2945** x IN (SELECT ...)
2946** x IN (value, value, ...)
2947**
drhecb87ac2016-08-25 15:46:25 +00002948** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002949** right-hand side (RHS) is an array of zero or more scalar values, or a
2950** subquery. If the RHS is a subquery, the number of result columns must
2951** match the number of columns in the vector on the LHS. If the RHS is
2952** a list of values, the LHS must be a scalar.
2953**
2954** The IN operator is true if the LHS value is contained within the RHS.
2955** The result is false if the LHS is definitely not in the RHS. The
2956** result is NULL if the presence of the LHS in the RHS cannot be
2957** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002958**
drh6be515e2014-08-01 21:00:53 +00002959** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002960** contained within the RHS. If due to NULLs we cannot determine if the LHS
2961** is contained in the RHS then jump to destIfNull. If the LHS is contained
2962** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002963**
2964** See the separate in-operator.md documentation file in the canonical
2965** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002966*/
2967static void sqlite3ExprCodeIN(
2968 Parse *pParse, /* Parsing and code generating context */
2969 Expr *pExpr, /* The IN expression */
2970 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2971 int destIfNull /* Jump here if the results are unknown due to NULLs */
2972){
2973 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00002974 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00002975 int rLhs; /* Register(s) holding the LHS values */
2976 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00002977 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00002978 int *aiMap = 0; /* Map from vector field to index column */
2979 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00002980 int nVector; /* Size of vectors for this IN operator */
2981 int iDummy; /* Dummy parameter to exprCodeVector() */
2982 Expr *pLeft; /* The LHS of the IN operator */
2983 int i; /* loop counter */
2984 int destStep2; /* Where to jump when NULLs seen in step 2 */
2985 int destStep6 = 0; /* Start of code for Step 6 */
2986 int addrTruthOp; /* Address of opcode that determines the IN is true */
2987 int destNotNull; /* Jump here if a comparison is not true in step 6 */
2988 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00002989 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00002990
drhe347d3e2016-08-25 21:14:34 +00002991 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00002992 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00002993 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00002994 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2995 aiMap = (int*)sqlite3DbMallocZero(
2996 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2997 );
drhe347d3e2016-08-25 21:14:34 +00002998 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00002999
danba00e302016-07-23 20:24:06 +00003000 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003001 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003002 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3003 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003004 v = pParse->pVdbe;
3005 assert( v!=0 ); /* OOM detected prior to this routine */
3006 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003007 eType = sqlite3FindInIndex(pParse, pExpr,
3008 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003009 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3010 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003011
danba00e302016-07-23 20:24:06 +00003012 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3013 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3014 );
drhecb87ac2016-08-25 15:46:25 +00003015#ifdef SQLITE_DEBUG
3016 /* Confirm that aiMap[] contains nVector integer values between 0 and
3017 ** nVector-1. */
3018 for(i=0; i<nVector; i++){
3019 int j, cnt;
3020 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3021 assert( cnt==1 );
3022 }
3023#endif
drhe3365e62009-11-12 17:52:24 +00003024
danba00e302016-07-23 20:24:06 +00003025 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3026 ** vector, then it is stored in an array of nVector registers starting
3027 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003028 **
3029 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3030 ** so that the fields are in the same order as an existing index. The
3031 ** aiMap[] array contains a mapping from the original LHS field order to
3032 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003033 */
drhe347d3e2016-08-25 21:14:34 +00003034 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3035 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003036 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003037 /* LHS fields are not reordered */
3038 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003039 }else{
3040 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003041 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003042 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003043 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003044 }
danba00e302016-07-23 20:24:06 +00003045 }
drhe3365e62009-11-12 17:52:24 +00003046
drhbb53ecb2014-08-02 21:03:33 +00003047 /* If sqlite3FindInIndex() did not find or create an index that is
3048 ** suitable for evaluating the IN operator, then evaluate using a
3049 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003050 **
3051 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003052 */
drhbb53ecb2014-08-02 21:03:33 +00003053 if( eType==IN_INDEX_NOOP ){
3054 ExprList *pList = pExpr->x.pList;
3055 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003056 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003057 int r2, regToFree;
3058 int regCkNull = 0;
3059 int ii;
3060 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003061 if( destIfNull!=destIfFalse ){
3062 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003063 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003064 }
3065 for(ii=0; ii<pList->nExpr; ii++){
3066 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003067 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003068 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3069 }
3070 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003071 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003072 (void*)pColl, P4_COLLSEQ);
3073 VdbeCoverageIf(v, ii<pList->nExpr-1);
3074 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003075 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003076 }else{
3077 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003078 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003079 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003080 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003081 }
3082 sqlite3ReleaseTempReg(pParse, regToFree);
3083 }
3084 if( regCkNull ){
3085 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003086 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003087 }
3088 sqlite3VdbeResolveLabel(v, labelOk);
3089 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003090 goto sqlite3ExprCodeIN_finished;
3091 }
3092
3093 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3094 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3095 ** We will then skip the binary search of the RHS.
3096 */
3097 if( destIfNull==destIfFalse ){
3098 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003099 }else{
drhec4ccdb2018-12-29 02:26:59 +00003100 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003101 }
3102 for(i=0; i<nVector; i++){
3103 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3104 if( sqlite3ExprCanBeNull(p) ){
3105 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003106 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003107 }
drhe3365e62009-11-12 17:52:24 +00003108 }
drhe347d3e2016-08-25 21:14:34 +00003109
3110 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3111 ** of the RHS using the LHS as a probe. If found, the result is
3112 ** true.
3113 */
3114 if( eType==IN_INDEX_ROWID ){
3115 /* In this case, the RHS is the ROWID of table b-tree and so we also
3116 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3117 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003118 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003119 VdbeCoverage(v);
3120 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3121 }else{
3122 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3123 if( destIfFalse==destIfNull ){
3124 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003125 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003126 rLhs, nVector); VdbeCoverage(v);
3127 goto sqlite3ExprCodeIN_finished;
3128 }
3129 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003130 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003131 rLhs, nVector); VdbeCoverage(v);
3132 }
3133
3134 /* Step 4. If the RHS is known to be non-NULL and we did not find
3135 ** an match on the search above, then the result must be FALSE.
3136 */
3137 if( rRhsHasNull && nVector==1 ){
3138 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3139 VdbeCoverage(v);
3140 }
3141
3142 /* Step 5. If we do not care about the difference between NULL and
3143 ** FALSE, then just return false.
3144 */
3145 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3146
3147 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3148 ** If any comparison is NULL, then the result is NULL. If all
3149 ** comparisons are FALSE then the final result is FALSE.
3150 **
3151 ** For a scalar LHS, it is sufficient to check just the first row
3152 ** of the RHS.
3153 */
3154 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003155 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003156 VdbeCoverage(v);
3157 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003158 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003159 }else{
3160 /* For nVector==1, combine steps 6 and 7 by immediately returning
3161 ** FALSE if the first comparison is not NULL */
3162 destNotNull = destIfFalse;
3163 }
3164 for(i=0; i<nVector; i++){
3165 Expr *p;
3166 CollSeq *pColl;
3167 int r3 = sqlite3GetTempReg(pParse);
3168 p = sqlite3VectorFieldSubexpr(pLeft, i);
3169 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003170 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003171 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3172 (void*)pColl, P4_COLLSEQ);
3173 VdbeCoverage(v);
3174 sqlite3ReleaseTempReg(pParse, r3);
3175 }
3176 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3177 if( nVector>1 ){
3178 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003179 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003180 VdbeCoverage(v);
3181
3182 /* Step 7: If we reach this point, we know that the result must
3183 ** be false. */
3184 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3185 }
3186
3187 /* Jumps here in order to return true. */
3188 sqlite3VdbeJumpHere(v, addrTruthOp);
3189
3190sqlite3ExprCodeIN_finished:
3191 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003192 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003193sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003194 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003195 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003196}
3197#endif /* SQLITE_OMIT_SUBQUERY */
3198
drh13573c72010-01-12 17:04:07 +00003199#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003200/*
3201** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003202** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003203**
3204** The z[] string will probably not be zero-terminated. But the
3205** z[n] character is guaranteed to be something that does not look
3206** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003207*/
drhb7916a72009-05-27 10:31:29 +00003208static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003209 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003210 double value;
drh9339da12010-09-30 00:50:49 +00003211 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003212 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3213 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003214 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003215 }
3216}
drh13573c72010-01-12 17:04:07 +00003217#endif
drh598f1342007-10-23 15:39:45 +00003218
3219
3220/*
drhfec19aa2004-05-19 20:41:03 +00003221** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003222** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003223**
shaneh5f1d6b62010-09-30 16:51:25 +00003224** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003225*/
drh13573c72010-01-12 17:04:07 +00003226static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3227 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003228 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003229 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003230 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003231 if( negFlag ) i = -i;
3232 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003233 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003234 int c;
3235 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003236 const char *z = pExpr->u.zToken;
3237 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003238 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003239 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003240#ifdef SQLITE_OMIT_FLOATING_POINT
3241 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3242#else
drh1b7ddc52014-07-23 14:52:05 +00003243#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003244 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003245 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003246 }else
3247#endif
3248 {
drh9296c182014-07-23 13:40:49 +00003249 codeReal(v, z, negFlag, iMem);
3250 }
drh13573c72010-01-12 17:04:07 +00003251#endif
drh77320ea2016-11-30 14:47:37 +00003252 }else{
drh84d4f1a2017-09-20 10:47:10 +00003253 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003254 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003255 }
drhfec19aa2004-05-19 20:41:03 +00003256 }
3257}
3258
drh5cd79232009-05-25 11:46:29 +00003259
drh1f9ca2c2015-08-25 16:57:52 +00003260/* Generate code that will load into register regOut a value that is
3261** appropriate for the iIdxCol-th column of index pIdx.
3262*/
3263void sqlite3ExprCodeLoadIndexColumn(
3264 Parse *pParse, /* The parsing context */
3265 Index *pIdx, /* The index whose column is to be loaded */
3266 int iTabCur, /* Cursor pointing to a table row */
3267 int iIdxCol, /* The column of the index to be loaded */
3268 int regOut /* Store the index column value in this register */
3269){
3270 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003271 if( iTabCol==XN_EXPR ){
3272 assert( pIdx->aColExpr );
3273 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003274 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003275 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003276 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003277 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003278 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3279 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003280 }
drh1f9ca2c2015-08-25 16:57:52 +00003281}
3282
drh5cd79232009-05-25 11:46:29 +00003283/*
drh5c092e82010-05-14 19:24:02 +00003284** Generate code to extract the value of the iCol-th column of a table.
3285*/
3286void sqlite3ExprCodeGetColumnOfTable(
3287 Vdbe *v, /* The VDBE under construction */
3288 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003289 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003290 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003291 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003292){
drhaca19e12017-04-07 19:41:31 +00003293 if( pTab==0 ){
3294 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3295 return;
3296 }
drh5c092e82010-05-14 19:24:02 +00003297 if( iCol<0 || iCol==pTab->iPKey ){
3298 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3299 }else{
3300 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003301 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003302 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003303 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3304 }
3305 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003306 }
3307 if( iCol>=0 ){
3308 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3309 }
3310}
3311
3312/*
drh945498f2007-02-24 11:52:52 +00003313** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003314** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003315**
3316** There must be an open cursor to pTab in iTable when this routine
3317** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003318*/
drhe55cbd72008-03-31 23:48:03 +00003319int sqlite3ExprCodeGetColumn(
3320 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003321 Table *pTab, /* Description of the table we are reading from */
3322 int iColumn, /* Index of the table column */
3323 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003324 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003325 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003326){
drhe55cbd72008-03-31 23:48:03 +00003327 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003328 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003329 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003330 if( p5 ){
3331 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003332 }
drhe55cbd72008-03-31 23:48:03 +00003333 return iReg;
3334}
drhe55cbd72008-03-31 23:48:03 +00003335
3336/*
drhb21e7c72008-06-22 12:37:57 +00003337** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003338** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003339*/
drhb21e7c72008-06-22 12:37:57 +00003340void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003341 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003342 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003343}
3344
drh652fbf52008-04-01 01:42:41 +00003345/*
drh12abf402016-08-22 14:30:05 +00003346** Convert a scalar expression node to a TK_REGISTER referencing
3347** register iReg. The caller must ensure that iReg already contains
3348** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003349*/
3350static void exprToRegister(Expr *p, int iReg){
3351 p->op2 = p->op;
3352 p->op = TK_REGISTER;
3353 p->iTable = iReg;
3354 ExprClearProperty(p, EP_Skip);
3355}
3356
drh12abf402016-08-22 14:30:05 +00003357/*
3358** Evaluate an expression (either a vector or a scalar expression) and store
3359** the result in continguous temporary registers. Return the index of
3360** the first register used to store the result.
3361**
3362** If the returned result register is a temporary scalar, then also write
3363** that register number into *piFreeable. If the returned result register
3364** is not a temporary or if the expression is a vector set *piFreeable
3365** to 0.
3366*/
3367static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3368 int iResult;
3369 int nResult = sqlite3ExprVectorSize(p);
3370 if( nResult==1 ){
3371 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3372 }else{
3373 *piFreeable = 0;
3374 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003375#if SQLITE_OMIT_SUBQUERY
3376 iResult = 0;
3377#else
drh85bcdce2018-12-23 21:27:29 +00003378 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003379#endif
drh12abf402016-08-22 14:30:05 +00003380 }else{
3381 int i;
3382 iResult = pParse->nMem+1;
3383 pParse->nMem += nResult;
3384 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003385 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003386 }
3387 }
3388 }
3389 return iResult;
3390}
3391
dan71c57db2016-07-09 20:23:55 +00003392
drha4c3c872013-09-12 17:29:25 +00003393/*
drhcce7d172000-05-31 15:34:51 +00003394** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003395** expression. Attempt to store the results in register "target".
3396** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003397**
drh8b213892008-08-29 02:14:02 +00003398** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003399** be stored in target. The result might be stored in some other
3400** register if it is convenient to do so. The calling function
3401** must check the return code and move the results to the desired
3402** register.
drhcce7d172000-05-31 15:34:51 +00003403*/
drh678ccce2008-03-31 18:19:54 +00003404int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003405 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3406 int op; /* The opcode being coded */
3407 int inReg = target; /* Results stored in register inReg */
3408 int regFree1 = 0; /* If non-zero free this temporary register */
3409 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003410 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003411 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003412 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003413
drh9cbf3422008-01-17 16:22:13 +00003414 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003415 if( v==0 ){
3416 assert( pParse->db->mallocFailed );
3417 return 0;
3418 }
drh389a1ad2008-01-03 23:44:53 +00003419
drh1efa8022018-04-28 04:16:43 +00003420expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003421 if( pExpr==0 ){
3422 op = TK_NULL;
3423 }else{
3424 op = pExpr->op;
3425 }
drhf2bc0132004-10-04 13:19:23 +00003426 switch( op ){
drh13449892005-09-07 21:22:45 +00003427 case TK_AGG_COLUMN: {
3428 AggInfo *pAggInfo = pExpr->pAggInfo;
3429 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3430 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003431 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003432 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003433 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003434 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003435 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003436 return target;
drh13449892005-09-07 21:22:45 +00003437 }
3438 /* Otherwise, fall thru into the TK_COLUMN case */
3439 }
drh967e8b72000-06-21 13:59:10 +00003440 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003441 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003442 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003443 /* This COLUMN expression is really a constant due to WHERE clause
3444 ** constraints, and that constant is coded by the pExpr->pLeft
3445 ** expresssion. However, make sure the constant has the correct
3446 ** datatype by applying the Affinity of the table column to the
3447 ** constant.
3448 */
3449 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003450 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003451 if( aff!=SQLITE_AFF_BLOB ){
3452 static const char zAff[] = "B\000C\000D\000E";
3453 assert( SQLITE_AFF_BLOB=='A' );
3454 assert( SQLITE_AFF_TEXT=='B' );
3455 if( iReg!=target ){
3456 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3457 iReg = target;
3458 }
3459 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3460 &zAff[(aff-'B')*2], P4_STATIC);
3461 }
3462 return iReg;
drhefad2e22018-07-27 16:57:11 +00003463 }
drhb2b9d3d2013-08-01 01:14:43 +00003464 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003465 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003466 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003467 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003468 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003469 /* Coding an expression that is part of an index where column names
3470 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003471 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003472 }
drh22827922000-06-06 17:27:05 +00003473 }
drheda079c2018-09-20 19:02:15 +00003474 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003475 pExpr->iColumn, iTab, target,
3476 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003477 }
3478 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003479 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003480 return target;
drhfec19aa2004-05-19 20:41:03 +00003481 }
drh8abed7b2018-02-26 18:49:05 +00003482 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003483 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003484 return target;
3485 }
drh13573c72010-01-12 17:04:07 +00003486#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003487 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003488 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3489 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003490 return target;
drh598f1342007-10-23 15:39:45 +00003491 }
drh13573c72010-01-12 17:04:07 +00003492#endif
drhfec19aa2004-05-19 20:41:03 +00003493 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003494 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003495 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003496 return target;
drhcce7d172000-05-31 15:34:51 +00003497 }
drhf0863fe2005-06-12 21:35:51 +00003498 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003499 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003500 return target;
drhf0863fe2005-06-12 21:35:51 +00003501 }
danielk19775338a5f2005-01-20 13:03:10 +00003502#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003503 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003504 int n;
3505 const char *z;
drhca48c902008-01-18 14:08:24 +00003506 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003507 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3508 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3509 assert( pExpr->u.zToken[1]=='\'' );
3510 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003511 n = sqlite3Strlen30(z) - 1;
3512 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003513 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3514 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003515 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003516 }
danielk19775338a5f2005-01-20 13:03:10 +00003517#endif
drh50457892003-09-06 01:10:47 +00003518 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003519 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3520 assert( pExpr->u.zToken!=0 );
3521 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003522 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3523 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003524 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003525 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003526 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003527 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003528 }
drhc332cc32016-09-19 10:24:19 +00003529 return target;
drh50457892003-09-06 01:10:47 +00003530 }
drh4e0cff62004-11-05 05:10:28 +00003531 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003532 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003533 }
drh487e2622005-06-25 18:42:14 +00003534#ifndef SQLITE_OMIT_CAST
3535 case TK_CAST: {
3536 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003537 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003538 if( inReg!=target ){
3539 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3540 inReg = target;
3541 }
drh4169e432014-08-25 20:11:52 +00003542 sqlite3VdbeAddOp2(v, OP_Cast, target,
3543 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003544 return inReg;
drh487e2622005-06-25 18:42:14 +00003545 }
3546#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003547 case TK_IS:
3548 case TK_ISNOT:
3549 op = (op==TK_IS) ? TK_EQ : TK_NE;
3550 p5 = SQLITE_NULLEQ;
3551 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003552 case TK_LT:
3553 case TK_LE:
3554 case TK_GT:
3555 case TK_GE:
3556 case TK_NE:
3557 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003558 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003559 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003560 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003561 }else{
3562 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3563 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3564 codeCompare(pParse, pLeft, pExpr->pRight, op,
3565 r1, r2, inReg, SQLITE_STOREP2 | p5);
3566 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3567 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3568 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3569 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3570 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3571 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3572 testcase( regFree1==0 );
3573 testcase( regFree2==0 );
3574 }
drh6a2fe092009-09-23 02:29:36 +00003575 break;
3576 }
drhcce7d172000-05-31 15:34:51 +00003577 case TK_AND:
3578 case TK_OR:
3579 case TK_PLUS:
3580 case TK_STAR:
3581 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003582 case TK_REM:
3583 case TK_BITAND:
3584 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003585 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003586 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003587 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003588 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003589 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3590 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3591 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3592 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3593 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3594 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3595 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3596 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3597 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3598 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3599 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003600 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3601 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003602 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003603 testcase( regFree1==0 );
3604 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003605 break;
3606 }
drhcce7d172000-05-31 15:34:51 +00003607 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003608 Expr *pLeft = pExpr->pLeft;
3609 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003610 if( pLeft->op==TK_INTEGER ){
3611 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003612 return target;
drh13573c72010-01-12 17:04:07 +00003613#ifndef SQLITE_OMIT_FLOATING_POINT
3614 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003615 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3616 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003617 return target;
drh13573c72010-01-12 17:04:07 +00003618#endif
drh3c84ddf2008-01-09 02:15:38 +00003619 }else{
drh10d1edf2013-11-15 15:52:39 +00003620 tempX.op = TK_INTEGER;
3621 tempX.flags = EP_IntValue|EP_TokenOnly;
3622 tempX.u.iValue = 0;
3623 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003624 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003625 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003626 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003627 }
drh3c84ddf2008-01-09 02:15:38 +00003628 break;
drh6e142f52000-06-08 13:36:40 +00003629 }
drhbf4133c2001-10-13 02:59:08 +00003630 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003631 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003632 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3633 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003634 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3635 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003636 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003637 break;
3638 }
drh8abed7b2018-02-26 18:49:05 +00003639 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003640 int isTrue; /* IS TRUE or IS NOT TRUE */
3641 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003642 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3643 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003644 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3645 bNormal = pExpr->op2==TK_IS;
3646 testcase( isTrue && bNormal);
3647 testcase( !isTrue && bNormal);
3648 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003649 break;
3650 }
drhcce7d172000-05-31 15:34:51 +00003651 case TK_ISNULL:
3652 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003653 int addr;
drh7d176102014-02-18 03:07:12 +00003654 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3655 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003656 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003657 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003658 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003659 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003660 VdbeCoverageIf(v, op==TK_ISNULL);
3661 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003662 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003663 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003664 break;
drhcce7d172000-05-31 15:34:51 +00003665 }
drh22827922000-06-06 17:27:05 +00003666 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003667 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003668 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003669 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3670 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003671 }else{
drhc332cc32016-09-19 10:24:19 +00003672 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003673 }
drh22827922000-06-06 17:27:05 +00003674 break;
3675 }
drhcce7d172000-05-31 15:34:51 +00003676 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003677 ExprList *pFarg; /* List of function arguments */
3678 int nFarg; /* Number of function arguments */
3679 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003680 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003681 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003682 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003683 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003684 u8 enc = ENC(db); /* The text encoding used by this database */
3685 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003686
dan67a9b8e2018-06-22 20:51:35 +00003687#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003688 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3689 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003690 }
dan67a9b8e2018-06-22 20:51:35 +00003691#endif
dan86fb6e12018-05-16 20:58:07 +00003692
drh1e9b53f2017-01-04 01:07:24 +00003693 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003694 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003695 ** out of the inner loop, even if that means an extra OP_Copy. */
3696 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003697 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003698 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003699 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003700 pFarg = 0;
3701 }else{
3702 pFarg = pExpr->x.pList;
3703 }
3704 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003705 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3706 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003707 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003708#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3709 if( pDef==0 && pParse->explain ){
3710 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3711 }
3712#endif
danb6e9f7a2018-05-19 14:15:29 +00003713 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003714 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003715 break;
3716 }
drhae6bb952009-11-11 00:24:31 +00003717
3718 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003719 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003720 ** arguments past the first non-NULL argument.
3721 */
drhd36e1042013-09-06 13:10:12 +00003722 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003723 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003724 assert( nFarg>=2 );
3725 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3726 for(i=1; i<nFarg; i++){
3727 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003728 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003729 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003730 }
3731 sqlite3VdbeResolveLabel(v, endCoalesce);
3732 break;
3733 }
3734
drhcca9f3d2013-09-06 15:23:29 +00003735 /* The UNLIKELY() function is a no-op. The result is the value
3736 ** of the first argument.
3737 */
3738 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3739 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003740 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003741 }
drhae6bb952009-11-11 00:24:31 +00003742
drh54240752017-01-03 14:39:30 +00003743#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003744 /* The AFFINITY() function evaluates to a string that describes
3745 ** the type affinity of the argument. This is used for testing of
3746 ** the SQLite type logic.
3747 */
3748 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3749 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3750 char aff;
3751 assert( nFarg==1 );
3752 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3753 sqlite3VdbeLoadString(v, target,
3754 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3755 return target;
3756 }
drh54240752017-01-03 14:39:30 +00003757#endif
drha1a523a2016-12-26 00:18:36 +00003758
drhd1a01ed2013-11-21 16:08:52 +00003759 for(i=0; i<nFarg; i++){
3760 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003761 testcase( i==31 );
3762 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003763 }
3764 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3765 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3766 }
3767 }
drh12ffee82009-04-08 13:51:51 +00003768 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003769 if( constMask ){
3770 r1 = pParse->nMem+1;
3771 pParse->nMem += nFarg;
3772 }else{
3773 r1 = sqlite3GetTempRange(pParse, nFarg);
3774 }
drha748fdc2012-03-28 01:34:47 +00003775
3776 /* For length() and typeof() functions with a column argument,
3777 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3778 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3779 ** loading.
3780 */
drhd36e1042013-09-06 13:10:12 +00003781 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003782 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003783 assert( nFarg==1 );
3784 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003785 exprOp = pFarg->a[0].pExpr->op;
3786 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003787 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3788 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003789 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3790 pFarg->a[0].pExpr->op2 =
3791 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003792 }
3793 }
3794
drh5579d592015-08-26 14:01:41 +00003795 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003796 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003797 }else{
drh12ffee82009-04-08 13:51:51 +00003798 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003799 }
drhb7f6f682006-07-08 17:06:43 +00003800#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003801 /* Possibly overload the function if the first argument is
3802 ** a virtual table column.
3803 **
3804 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3805 ** second argument, not the first, as the argument to test to
3806 ** see if it is a column in a virtual table. This is done because
3807 ** the left operand of infix functions (the operand we want to
3808 ** control overloading) ends up as the second argument to the
3809 ** function. The expression "A glob B" is equivalent to
3810 ** "glob(B,A). We want to use the A in "A glob B" to test
3811 ** for function overloading. But we use the B term in "glob(B,A)".
3812 */
drh59155062018-05-26 18:03:48 +00003813 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003814 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3815 }else if( nFarg>0 ){
3816 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003817 }
3818#endif
drhd36e1042013-09-06 13:10:12 +00003819 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003820 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003821 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003822 }
drh092457b2017-12-29 15:04:49 +00003823#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3824 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003825 Expr *pArg = pFarg->a[0].pExpr;
3826 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003827 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003828 }else{
3829 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3830 }
drh092457b2017-12-29 15:04:49 +00003831 }else
3832#endif
3833 {
drh2fc865c2017-12-16 20:20:37 +00003834 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3835 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3836 sqlite3VdbeChangeP5(v, (u8)nFarg);
3837 }
drhd1a01ed2013-11-21 16:08:52 +00003838 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003839 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003840 }
drhc332cc32016-09-19 10:24:19 +00003841 return target;
drhcce7d172000-05-31 15:34:51 +00003842 }
drhfe2093d2005-01-20 22:48:47 +00003843#ifndef SQLITE_OMIT_SUBQUERY
3844 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003845 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003846 int nCol;
drhc5499be2008-04-01 15:06:33 +00003847 testcase( op==TK_EXISTS );
3848 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003849 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3850 sqlite3SubselectError(pParse, nCol, 1);
3851 }else{
drh85bcdce2018-12-23 21:27:29 +00003852 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003853 }
drh19a775c2000-06-05 18:54:46 +00003854 break;
3855 }
drhfc7f27b2016-08-20 00:07:01 +00003856 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003857 int n;
drhfc7f27b2016-08-20 00:07:01 +00003858 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003859 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003860 }
drh966e2912017-01-03 02:58:01 +00003861 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3862 if( pExpr->iTable
3863 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3864 ){
3865 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3866 pExpr->iTable, n);
3867 }
drhc332cc32016-09-19 10:24:19 +00003868 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003869 }
drhfef52082000-06-06 01:50:43 +00003870 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003871 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3872 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003873 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3874 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3875 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3876 sqlite3VdbeResolveLabel(v, destIfFalse);
3877 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3878 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003879 return target;
drhfef52082000-06-06 01:50:43 +00003880 }
drhe3365e62009-11-12 17:52:24 +00003881#endif /* SQLITE_OMIT_SUBQUERY */
3882
3883
drh2dcef112008-01-12 19:03:48 +00003884 /*
3885 ** x BETWEEN y AND z
3886 **
3887 ** This is equivalent to
3888 **
3889 ** x>=y AND x<=z
3890 **
3891 ** X is stored in pExpr->pLeft.
3892 ** Y is stored in pExpr->pList->a[0].pExpr.
3893 ** Z is stored in pExpr->pList->a[1].pExpr.
3894 */
drhfef52082000-06-06 01:50:43 +00003895 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003896 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003897 return target;
drhfef52082000-06-06 01:50:43 +00003898 }
drh94fa9c42016-02-27 21:16:04 +00003899 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003900 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003901 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003902 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003903 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003904 }
drh2dcef112008-01-12 19:03:48 +00003905
dan165921a2009-08-28 18:53:45 +00003906 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003907 /* If the opcode is TK_TRIGGER, then the expression is a reference
3908 ** to a column in the new.* or old.* pseudo-tables available to
3909 ** trigger programs. In this case Expr.iTable is set to 1 for the
3910 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3911 ** is set to the column of the pseudo-table to read, or to -1 to
3912 ** read the rowid field.
3913 **
3914 ** The expression is implemented using an OP_Param opcode. The p1
3915 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3916 ** to reference another column of the old.* pseudo-table, where
3917 ** i is the index of the column. For a new.rowid reference, p1 is
3918 ** set to (n+1), where n is the number of columns in each pseudo-table.
3919 ** For a reference to any other column in the new.* pseudo-table, p1
3920 ** is set to (n+2+i), where n and i are as defined previously. For
3921 ** example, if the table on which triggers are being fired is
3922 ** declared as:
3923 **
3924 ** CREATE TABLE t1(a, b);
3925 **
3926 ** Then p1 is interpreted as follows:
3927 **
3928 ** p1==0 -> old.rowid p1==3 -> new.rowid
3929 ** p1==1 -> old.a p1==4 -> new.a
3930 ** p1==2 -> old.b p1==5 -> new.b
3931 */
drheda079c2018-09-20 19:02:15 +00003932 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003933 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3934
3935 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3936 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3937 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3938 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3939
3940 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003941 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003942 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003943 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003944 ));
dan65a7cd12009-09-01 12:16:01 +00003945
drh44dbca82010-01-13 04:22:20 +00003946#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003947 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003948 ** integer. Use OP_RealAffinity to make sure it is really real.
3949 **
3950 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3951 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003952 if( pExpr->iColumn>=0
3953 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3954 ){
3955 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3956 }
drh44dbca82010-01-13 04:22:20 +00003957#endif
dan165921a2009-08-28 18:53:45 +00003958 break;
3959 }
3960
dan71c57db2016-07-09 20:23:55 +00003961 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00003962 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00003963 break;
3964 }
3965
drh31d6fd52017-04-14 19:03:10 +00003966 case TK_IF_NULL_ROW: {
3967 int addrINR;
3968 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00003969 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00003970 sqlite3VdbeJumpHere(v, addrINR);
3971 sqlite3VdbeChangeP3(v, addrINR, inReg);
3972 break;
3973 }
3974
drh2dcef112008-01-12 19:03:48 +00003975 /*
3976 ** Form A:
3977 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3978 **
3979 ** Form B:
3980 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3981 **
3982 ** Form A is can be transformed into the equivalent form B as follows:
3983 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3984 ** WHEN x=eN THEN rN ELSE y END
3985 **
3986 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003987 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3988 ** odd. The Y is also optional. If the number of elements in x.pList
3989 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003990 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3991 **
3992 ** The result of the expression is the Ri for the first matching Ei,
3993 ** or if there is no matching Ei, the ELSE term Y, or if there is
3994 ** no ELSE term, NULL.
3995 */
drh33cd4902009-05-30 20:49:20 +00003996 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003997 int endLabel; /* GOTO label for end of CASE stmt */
3998 int nextCase; /* GOTO label for next WHEN clause */
3999 int nExpr; /* 2x number of WHEN terms */
4000 int i; /* Loop counter */
4001 ExprList *pEList; /* List of WHEN terms */
4002 struct ExprList_item *aListelem; /* Array of WHEN terms */
4003 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004004 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004005 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00004006
danielk19776ab3a2e2009-02-19 14:39:25 +00004007 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004008 assert(pExpr->x.pList->nExpr > 0);
4009 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004010 aListelem = pEList->a;
4011 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004012 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004013 if( (pX = pExpr->pLeft)!=0 ){
drha8e05762019-01-05 21:56:12 +00004014 exprNodeCopy(&tempX, pX);
drh33cd4902009-05-30 20:49:20 +00004015 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004016 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004017 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004018 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004019 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004020 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004021 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004022 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4023 ** The value in regFree1 might get SCopy-ed into the file result.
4024 ** So make sure that the regFree1 register is not reused for other
4025 ** purposes and possibly overwritten. */
4026 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004027 }
drhc5cd1242013-09-12 16:50:49 +00004028 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004029 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004030 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004031 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004032 }else{
drh2dcef112008-01-12 19:03:48 +00004033 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004034 }
drhec4ccdb2018-12-29 02:26:59 +00004035 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004036 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004037 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004038 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004039 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004040 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004041 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004042 }
drhc5cd1242013-09-12 16:50:49 +00004043 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004044 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004045 }else{
drh9de221d2008-01-05 06:51:30 +00004046 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004047 }
drh2dcef112008-01-12 19:03:48 +00004048 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004049 break;
4050 }
danielk19775338a5f2005-01-20 13:03:10 +00004051#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004052 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004053 assert( pExpr->affinity==OE_Rollback
4054 || pExpr->affinity==OE_Abort
4055 || pExpr->affinity==OE_Fail
4056 || pExpr->affinity==OE_Ignore
4057 );
dane0af83a2009-09-08 19:15:01 +00004058 if( !pParse->pTriggerTab ){
4059 sqlite3ErrorMsg(pParse,
4060 "RAISE() may only be used within a trigger-program");
4061 return 0;
4062 }
4063 if( pExpr->affinity==OE_Abort ){
4064 sqlite3MayAbort(pParse);
4065 }
dan165921a2009-08-28 18:53:45 +00004066 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004067 if( pExpr->affinity==OE_Ignore ){
4068 sqlite3VdbeAddOp4(
4069 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004070 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004071 }else{
drh433dccf2013-02-09 15:37:11 +00004072 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004073 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004074 }
4075
drhffe07b22005-11-03 00:41:17 +00004076 break;
drh17a7f8d2002-03-24 13:13:27 +00004077 }
danielk19775338a5f2005-01-20 13:03:10 +00004078#endif
drhffe07b22005-11-03 00:41:17 +00004079 }
drh2dcef112008-01-12 19:03:48 +00004080 sqlite3ReleaseTempReg(pParse, regFree1);
4081 sqlite3ReleaseTempReg(pParse, regFree2);
4082 return inReg;
4083}
4084
4085/*
drhd1a01ed2013-11-21 16:08:52 +00004086** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004087**
drhad879ff2017-01-04 04:10:02 +00004088** If regDest>=0 then the result is always stored in that register and the
4089** result is not reusable. If regDest<0 then this routine is free to
4090** store the value whereever it wants. The register where the expression
4091** is stored is returned. When regDest<0, two identical expressions will
4092** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004093*/
drh1e9b53f2017-01-04 01:07:24 +00004094int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004095 Parse *pParse, /* Parsing context */
4096 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004097 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004098){
drhd1a01ed2013-11-21 16:08:52 +00004099 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004100 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004101 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004102 if( regDest<0 && p ){
4103 struct ExprList_item *pItem;
4104 int i;
4105 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004106 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004107 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004108 }
4109 }
drh1e9b53f2017-01-04 01:07:24 +00004110 }
drhd1a01ed2013-11-21 16:08:52 +00004111 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4112 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004113 if( p ){
4114 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004115 pItem->reusable = regDest<0;
4116 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004117 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004118 }
drhd1a01ed2013-11-21 16:08:52 +00004119 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004120 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004121}
4122
4123/*
drh2dcef112008-01-12 19:03:48 +00004124** Generate code to evaluate an expression and store the results
4125** into a register. Return the register number where the results
4126** are stored.
4127**
4128** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004129** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004130** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004131**
4132** If pExpr is a constant, then this routine might generate this
4133** code to fill the register in the initialization section of the
4134** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004135*/
4136int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004137 int r2;
4138 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004139 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004140 && pExpr->op!=TK_REGISTER
4141 && sqlite3ExprIsConstantNotJoin(pExpr)
4142 ){
drhf30a9692013-11-15 01:10:18 +00004143 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004144 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004145 }else{
drhf30a9692013-11-15 01:10:18 +00004146 int r1 = sqlite3GetTempReg(pParse);
4147 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4148 if( r2==r1 ){
4149 *pReg = r1;
4150 }else{
4151 sqlite3ReleaseTempReg(pParse, r1);
4152 *pReg = 0;
4153 }
drh2dcef112008-01-12 19:03:48 +00004154 }
4155 return r2;
4156}
4157
4158/*
4159** Generate code that will evaluate expression pExpr and store the
4160** results in register target. The results are guaranteed to appear
4161** in register target.
4162*/
drh05a86c52014-02-16 01:55:49 +00004163void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004164 int inReg;
4165
4166 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004167 if( pExpr && pExpr->op==TK_REGISTER ){
4168 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4169 }else{
4170 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004171 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004172 if( inReg!=target && pParse->pVdbe ){
4173 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4174 }
drhcce7d172000-05-31 15:34:51 +00004175 }
drhcce7d172000-05-31 15:34:51 +00004176}
4177
4178/*
drh1c75c9d2015-12-21 15:22:13 +00004179** Make a transient copy of expression pExpr and then code it using
4180** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4181** except that the input expression is guaranteed to be unchanged.
4182*/
4183void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4184 sqlite3 *db = pParse->db;
4185 pExpr = sqlite3ExprDup(db, pExpr, 0);
4186 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4187 sqlite3ExprDelete(db, pExpr);
4188}
4189
4190/*
drh05a86c52014-02-16 01:55:49 +00004191** Generate code that will evaluate expression pExpr and store the
4192** results in register target. The results are guaranteed to appear
4193** in register target. If the expression is constant, then this routine
4194** might choose to code the expression at initialization time.
4195*/
4196void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004197 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004198 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004199 }else{
4200 sqlite3ExprCode(pParse, pExpr, target);
4201 }
drhcce7d172000-05-31 15:34:51 +00004202}
4203
4204/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004205** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004206** in register target.
drh25303782004-12-07 15:41:48 +00004207**
drh2dcef112008-01-12 19:03:48 +00004208** Also make a copy of the expression results into another "cache" register
4209** and modify the expression so that the next time it is evaluated,
4210** the result is a copy of the cache register.
4211**
4212** This routine is used for expressions that are used multiple
4213** times. They are evaluated once and the results of the expression
4214** are reused.
drh25303782004-12-07 15:41:48 +00004215*/
drh05a86c52014-02-16 01:55:49 +00004216void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004217 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004218 int iMem;
4219
drhde4fcfd2008-01-19 23:50:26 +00004220 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004221 assert( pExpr->op!=TK_REGISTER );
4222 sqlite3ExprCode(pParse, pExpr, target);
4223 iMem = ++pParse->nMem;
4224 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4225 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004226}
drh2dcef112008-01-12 19:03:48 +00004227
drh678ccce2008-03-31 18:19:54 +00004228/*
drh268380c2004-02-25 13:47:31 +00004229** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004230** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004231**
drh3df6c3b2017-09-15 15:38:01 +00004232** Return the number of elements evaluated. The number returned will
4233** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4234** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004235**
4236** The SQLITE_ECEL_DUP flag prevents the arguments from being
4237** filled using OP_SCopy. OP_Copy must be used instead.
4238**
4239** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4240** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004241**
4242** The SQLITE_ECEL_REF flag means that expressions in the list with
4243** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4244** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004245** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4246** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004247*/
danielk19774adee202004-05-08 08:23:19 +00004248int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004249 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004250 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004251 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004252 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004253 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004254){
4255 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004256 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004257 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004258 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004259 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004260 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004261 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004262 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004263 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004264 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004265 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004266#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4267 if( pItem->bSorterRef ){
4268 i--;
4269 n--;
4270 }else
4271#endif
dan257c13f2016-11-10 20:14:06 +00004272 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4273 if( flags & SQLITE_ECEL_OMITREF ){
4274 i--;
4275 n--;
4276 }else{
4277 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4278 }
drhb8b06692018-08-04 15:16:20 +00004279 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4280 && sqlite3ExprIsConstantNotJoin(pExpr)
4281 ){
drhad879ff2017-01-04 04:10:02 +00004282 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004283 }else{
4284 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4285 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004286 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004287 if( copyOp==OP_Copy
4288 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4289 && pOp->p1+pOp->p3+1==inReg
4290 && pOp->p2+pOp->p3+1==target+i
4291 ){
4292 pOp->p3++;
4293 }else{
4294 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4295 }
drhd1a01ed2013-11-21 16:08:52 +00004296 }
drhd1766112008-09-17 00:13:12 +00004297 }
drh268380c2004-02-25 13:47:31 +00004298 }
drhf9b596e2004-05-26 16:54:42 +00004299 return n;
drh268380c2004-02-25 13:47:31 +00004300}
4301
4302/*
drh36c563a2009-11-12 13:32:22 +00004303** Generate code for a BETWEEN operator.
4304**
4305** x BETWEEN y AND z
4306**
4307** The above is equivalent to
4308**
4309** x>=y AND x<=z
4310**
4311** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004312** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004313**
4314** The xJumpIf parameter determines details:
4315**
4316** NULL: Store the boolean result in reg[dest]
4317** sqlite3ExprIfTrue: Jump to dest if true
4318** sqlite3ExprIfFalse: Jump to dest if false
4319**
4320** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004321*/
4322static void exprCodeBetween(
4323 Parse *pParse, /* Parsing and code generating context */
4324 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004325 int dest, /* Jump destination or storage location */
4326 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004327 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4328){
drhdb45bd52016-08-22 00:48:58 +00004329 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004330 Expr compLeft; /* The x>=y term */
4331 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004332 Expr exprX; /* The x subexpression */
4333 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004334
dan71c57db2016-07-09 20:23:55 +00004335 memset(&compLeft, 0, sizeof(Expr));
4336 memset(&compRight, 0, sizeof(Expr));
4337 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004338
4339 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drha8e05762019-01-05 21:56:12 +00004340 exprNodeCopy(&exprX, pExpr->pLeft);
drh36c563a2009-11-12 13:32:22 +00004341 exprAnd.op = TK_AND;
4342 exprAnd.pLeft = &compLeft;
4343 exprAnd.pRight = &compRight;
4344 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004345 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004346 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4347 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004348 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004349 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004350 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004351 if( xJump ){
4352 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004353 }else{
drh36fd41e2016-11-25 14:30:42 +00004354 /* Mark the expression is being from the ON or USING clause of a join
4355 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4356 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4357 ** for clarity, but we are out of bits in the Expr.flags field so we
4358 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004359 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004360 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004361 }
drhdb45bd52016-08-22 00:48:58 +00004362 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004363
4364 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004365 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4366 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4367 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4368 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4369 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4370 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4371 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4372 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004373 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004374}
4375
4376/*
drhcce7d172000-05-31 15:34:51 +00004377** Generate code for a boolean expression such that a jump is made
4378** to the label "dest" if the expression is true but execution
4379** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004380**
4381** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004382** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004383**
4384** This code depends on the fact that certain token values (ex: TK_EQ)
4385** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4386** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4387** the make process cause these values to align. Assert()s in the code
4388** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004389*/
danielk19774adee202004-05-08 08:23:19 +00004390void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004391 Vdbe *v = pParse->pVdbe;
4392 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004393 int regFree1 = 0;
4394 int regFree2 = 0;
4395 int r1, r2;
4396
drh35573352008-01-08 23:54:25 +00004397 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004398 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004399 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004400 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004401 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004402 case TK_AND: {
drhec4ccdb2018-12-29 02:26:59 +00004403 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004404 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004405 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004406 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4407 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004408 break;
4409 }
4410 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004411 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004412 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4413 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004414 break;
4415 }
4416 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004417 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004418 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004419 break;
4420 }
drh8abed7b2018-02-26 18:49:05 +00004421 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004422 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4423 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004424 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004425 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004426 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004427 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004428 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004429 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004430 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4431 isNot ? SQLITE_JUMPIFNULL : 0);
4432 }else{
4433 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4434 isNot ? SQLITE_JUMPIFNULL : 0);
4435 }
drh007c8432018-02-26 03:20:18 +00004436 break;
4437 }
drhde845c22016-03-17 19:07:52 +00004438 case TK_IS:
4439 case TK_ISNOT:
4440 testcase( op==TK_IS );
4441 testcase( op==TK_ISNOT );
4442 op = (op==TK_IS) ? TK_EQ : TK_NE;
4443 jumpIfNull = SQLITE_NULLEQ;
4444 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004445 case TK_LT:
4446 case TK_LE:
4447 case TK_GT:
4448 case TK_GE:
4449 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004450 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004451 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004452 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004453 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4454 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004455 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004456 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004457 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4458 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4459 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4460 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004461 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4462 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4463 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4464 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4465 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4466 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004467 testcase( regFree1==0 );
4468 testcase( regFree2==0 );
4469 break;
4470 }
drhcce7d172000-05-31 15:34:51 +00004471 case TK_ISNULL:
4472 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004473 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4474 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004475 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4476 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004477 VdbeCoverageIf(v, op==TK_ISNULL);
4478 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004479 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004480 break;
4481 }
drhfef52082000-06-06 01:50:43 +00004482 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004483 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004484 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004485 break;
4486 }
drh84e30ca2011-02-10 17:46:14 +00004487#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004488 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004489 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004490 int destIfNull = jumpIfNull ? dest : destIfFalse;
4491 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004492 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004493 sqlite3VdbeResolveLabel(v, destIfFalse);
4494 break;
4495 }
shanehbb201342011-02-09 19:55:20 +00004496#endif
drhcce7d172000-05-31 15:34:51 +00004497 default: {
dan7b35a772016-07-28 19:47:15 +00004498 default_expr:
drhad317272019-04-19 16:21:51 +00004499 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004500 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004501 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004502 /* No-op */
4503 }else{
4504 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4505 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004506 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004507 testcase( regFree1==0 );
4508 testcase( jumpIfNull==0 );
4509 }
drhcce7d172000-05-31 15:34:51 +00004510 break;
4511 }
4512 }
drh2dcef112008-01-12 19:03:48 +00004513 sqlite3ReleaseTempReg(pParse, regFree1);
4514 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004515}
4516
4517/*
drh66b89c82000-11-28 20:47:17 +00004518** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004519** to the label "dest" if the expression is false but execution
4520** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004521**
4522** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004523** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4524** is 0.
drhcce7d172000-05-31 15:34:51 +00004525*/
danielk19774adee202004-05-08 08:23:19 +00004526void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004527 Vdbe *v = pParse->pVdbe;
4528 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004529 int regFree1 = 0;
4530 int regFree2 = 0;
4531 int r1, r2;
4532
drh35573352008-01-08 23:54:25 +00004533 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004534 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004535 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004536
4537 /* The value of pExpr->op and op are related as follows:
4538 **
4539 ** pExpr->op op
4540 ** --------- ----------
4541 ** TK_ISNULL OP_NotNull
4542 ** TK_NOTNULL OP_IsNull
4543 ** TK_NE OP_Eq
4544 ** TK_EQ OP_Ne
4545 ** TK_GT OP_Le
4546 ** TK_LE OP_Gt
4547 ** TK_GE OP_Lt
4548 ** TK_LT OP_Ge
4549 **
4550 ** For other values of pExpr->op, op is undefined and unused.
4551 ** The value of TK_ and OP_ constants are arranged such that we
4552 ** can compute the mapping above using the following expression.
4553 ** Assert()s verify that the computation is correct.
4554 */
4555 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4556
4557 /* Verify correct alignment of TK_ and OP_ constants
4558 */
4559 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4560 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4561 assert( pExpr->op!=TK_NE || op==OP_Eq );
4562 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4563 assert( pExpr->op!=TK_LT || op==OP_Ge );
4564 assert( pExpr->op!=TK_LE || op==OP_Gt );
4565 assert( pExpr->op!=TK_GT || op==OP_Le );
4566 assert( pExpr->op!=TK_GE || op==OP_Lt );
4567
danba00e302016-07-23 20:24:06 +00004568 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004569 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004570 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004571 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4572 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004573 break;
4574 }
4575 case TK_OR: {
drhec4ccdb2018-12-29 02:26:59 +00004576 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004577 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004578 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004579 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4580 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004581 break;
4582 }
4583 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004584 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004585 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004586 break;
4587 }
drh8abed7b2018-02-26 18:49:05 +00004588 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004589 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4590 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004591 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004592 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004593 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004594 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004595 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004596 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004597 /* IS TRUE and IS NOT FALSE */
4598 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4599 isNot ? 0 : SQLITE_JUMPIFNULL);
4600
4601 }else{
4602 /* IS FALSE and IS NOT TRUE */
4603 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004604 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004605 }
drh007c8432018-02-26 03:20:18 +00004606 break;
4607 }
drhde845c22016-03-17 19:07:52 +00004608 case TK_IS:
4609 case TK_ISNOT:
4610 testcase( pExpr->op==TK_IS );
4611 testcase( pExpr->op==TK_ISNOT );
4612 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4613 jumpIfNull = SQLITE_NULLEQ;
4614 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004615 case TK_LT:
4616 case TK_LE:
4617 case TK_GT:
4618 case TK_GE:
4619 case TK_NE:
4620 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004621 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004622 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004623 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4624 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004625 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004626 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004627 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4628 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4629 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4630 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004631 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4632 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4633 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4634 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4635 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4636 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004637 testcase( regFree1==0 );
4638 testcase( regFree2==0 );
4639 break;
4640 }
drhcce7d172000-05-31 15:34:51 +00004641 case TK_ISNULL:
4642 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004643 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4644 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004645 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4646 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004647 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004648 break;
4649 }
drhfef52082000-06-06 01:50:43 +00004650 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004651 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004652 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004653 break;
4654 }
drh84e30ca2011-02-10 17:46:14 +00004655#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004656 case TK_IN: {
4657 if( jumpIfNull ){
4658 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4659 }else{
drhec4ccdb2018-12-29 02:26:59 +00004660 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004661 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4662 sqlite3VdbeResolveLabel(v, destIfNull);
4663 }
4664 break;
4665 }
shanehbb201342011-02-09 19:55:20 +00004666#endif
drhcce7d172000-05-31 15:34:51 +00004667 default: {
danba00e302016-07-23 20:24:06 +00004668 default_expr:
drhad317272019-04-19 16:21:51 +00004669 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004670 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004671 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004672 /* no-op */
4673 }else{
4674 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4675 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004676 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004677 testcase( regFree1==0 );
4678 testcase( jumpIfNull==0 );
4679 }
drhcce7d172000-05-31 15:34:51 +00004680 break;
4681 }
4682 }
drh2dcef112008-01-12 19:03:48 +00004683 sqlite3ReleaseTempReg(pParse, regFree1);
4684 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004685}
drh22827922000-06-06 17:27:05 +00004686
4687/*
drh72bc8202015-06-11 13:58:35 +00004688** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4689** code generation, and that copy is deleted after code generation. This
4690** ensures that the original pExpr is unchanged.
4691*/
4692void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4693 sqlite3 *db = pParse->db;
4694 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4695 if( db->mallocFailed==0 ){
4696 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4697 }
4698 sqlite3ExprDelete(db, pCopy);
4699}
4700
dan5aa550c2017-06-24 18:10:29 +00004701/*
4702** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4703** type of expression.
4704**
4705** If pExpr is a simple SQL value - an integer, real, string, blob
4706** or NULL value - then the VDBE currently being prepared is configured
4707** to re-prepare each time a new value is bound to variable pVar.
4708**
4709** Additionally, if pExpr is a simple SQL value and the value is the
4710** same as that currently bound to variable pVar, non-zero is returned.
4711** Otherwise, if the values are not the same or if pExpr is not a simple
4712** SQL value, zero is returned.
4713*/
4714static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4715 int res = 0;
drhc0804222017-06-28 21:47:16 +00004716 int iVar;
4717 sqlite3_value *pL, *pR = 0;
4718
4719 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4720 if( pR ){
4721 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004722 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004723 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004724 if( pL ){
4725 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4726 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4727 }
4728 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004729 }
drhc0804222017-06-28 21:47:16 +00004730 sqlite3ValueFree(pR);
4731 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004732 }
4733
4734 return res;
4735}
drh72bc8202015-06-11 13:58:35 +00004736
4737/*
drh1d9da702010-01-07 15:17:02 +00004738** Do a deep comparison of two expression trees. Return 0 if the two
4739** expressions are completely identical. Return 1 if they differ only
4740** by a COLLATE operator at the top level. Return 2 if there are differences
4741** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004742**
drh619a1302013-08-01 13:04:46 +00004743** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4744** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4745**
drh66518ca2013-08-01 15:09:57 +00004746** The pA side might be using TK_REGISTER. If that is the case and pB is
4747** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4748**
drh1d9da702010-01-07 15:17:02 +00004749** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004750** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004751** identical, we return 2 just to be safe. So if this routine
4752** returns 2, then you do not really know for certain if the two
4753** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004754** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004755** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004756** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004757** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004758**
drhc0804222017-06-28 21:47:16 +00004759** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4760** pParse->pReprepare can be matched against literals in pB. The
4761** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4762** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4763** Argument pParse should normally be NULL. If it is not NULL and pA or
4764** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004765*/
dan5aa550c2017-06-24 18:10:29 +00004766int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004767 u32 combinedFlags;
4768 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004769 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004770 }
dan5aa550c2017-06-24 18:10:29 +00004771 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4772 return 0;
4773 }
drh10d1edf2013-11-15 15:52:39 +00004774 combinedFlags = pA->flags | pB->flags;
4775 if( combinedFlags & EP_IntValue ){
4776 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4777 return 0;
4778 }
drh1d9da702010-01-07 15:17:02 +00004779 return 2;
drh22827922000-06-06 17:27:05 +00004780 }
dan16dd3982018-12-20 15:04:38 +00004781 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004782 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004783 return 1;
4784 }
dan5aa550c2017-06-24 18:10:29 +00004785 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004786 return 1;
4787 }
4788 return 2;
4789 }
drh2edc5fd2015-11-24 02:10:52 +00004790 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004791 if( pA->op==TK_FUNCTION ){
4792 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004793#ifndef SQLITE_OMIT_WINDOWFUNC
4794 /* Justification for the assert():
4795 ** window functions have p->op==TK_FUNCTION but aggregate functions
4796 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4797 ** function and a window function should have failed before reaching
4798 ** this point. And, it is not possible to have a window function and
4799 ** a scalar function with the same name and number of arguments. So
4800 ** if we reach this point, either A and B both window functions or
4801 ** neither are a window functions. */
4802 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4803 if( ExprHasProperty(pA,EP_WinFunc) ){
4804 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4805 }
4806#endif
drhf20bbc52019-01-17 01:06:00 +00004807 }else if( pA->op==TK_NULL ){
4808 return 0;
drhd5af5422018-04-13 14:27:01 +00004809 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004810 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004811 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004812 return 2;
drh2646da72005-12-09 20:02:05 +00004813 }
drh22827922000-06-06 17:27:05 +00004814 }
drh10d1edf2013-11-15 15:52:39 +00004815 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004816 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004817 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004818 if( (combinedFlags & EP_FixedCol)==0
4819 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004820 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004821 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004822 if( pA->op!=TK_STRING
4823 && pA->op!=TK_TRUEFALSE
4824 && (combinedFlags & EP_Reduced)==0
4825 ){
drh10d1edf2013-11-15 15:52:39 +00004826 if( pA->iColumn!=pB->iColumn ) return 2;
4827 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004828 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004829 }
4830 }
drh1d9da702010-01-07 15:17:02 +00004831 return 0;
drh22827922000-06-06 17:27:05 +00004832}
4833
drh8c6f6662010-04-26 19:17:26 +00004834/*
4835** Compare two ExprList objects. Return 0 if they are identical and
4836** non-zero if they differ in any way.
4837**
drh619a1302013-08-01 13:04:46 +00004838** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4839** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4840**
drh8c6f6662010-04-26 19:17:26 +00004841** This routine might return non-zero for equivalent ExprLists. The
4842** only consequence will be disabled optimizations. But this routine
4843** must never return 0 if the two ExprList objects are different, or
4844** a malfunction will result.
4845**
4846** Two NULL pointers are considered to be the same. But a NULL pointer
4847** always differs from a non-NULL pointer.
4848*/
drh619a1302013-08-01 13:04:46 +00004849int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004850 int i;
4851 if( pA==0 && pB==0 ) return 0;
4852 if( pA==0 || pB==0 ) return 1;
4853 if( pA->nExpr!=pB->nExpr ) return 1;
4854 for(i=0; i<pA->nExpr; i++){
4855 Expr *pExprA = pA->a[i].pExpr;
4856 Expr *pExprB = pB->a[i].pExpr;
4857 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004858 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004859 }
4860 return 0;
4861}
drh13449892005-09-07 21:22:45 +00004862
drh22827922000-06-06 17:27:05 +00004863/*
drhf9463df2017-02-11 14:59:58 +00004864** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4865** are ignored.
4866*/
4867int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004868 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004869 sqlite3ExprSkipCollate(pA),
4870 sqlite3ExprSkipCollate(pB),
4871 iTab);
4872}
4873
4874/*
drh4bd5f732013-07-31 23:22:39 +00004875** Return true if we can prove the pE2 will always be true if pE1 is
4876** true. Return false if we cannot complete the proof or if pE2 might
4877** be false. Examples:
4878**
drh619a1302013-08-01 13:04:46 +00004879** pE1: x==5 pE2: x==5 Result: true
4880** pE1: x>0 pE2: x==5 Result: false
4881** pE1: x=21 pE2: x=21 OR y=43 Result: true
4882** pE1: x!=123 pE2: x IS NOT NULL Result: true
4883** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4884** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4885** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004886**
4887** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4888** Expr.iTable<0 then assume a table number given by iTab.
4889**
drhc0804222017-06-28 21:47:16 +00004890** If pParse is not NULL, then the values of bound variables in pE1 are
4891** compared against literal values in pE2 and pParse->pVdbe->expmask is
4892** modified to record which bound variables are referenced. If pParse
4893** is NULL, then false will be returned if pE1 contains any bound variables.
4894**
drh4bd5f732013-07-31 23:22:39 +00004895** When in doubt, return false. Returning true might give a performance
4896** improvement. Returning false might cause a performance reduction, but
4897** it will always give the correct answer and is hence always safe.
4898*/
dan5aa550c2017-06-24 18:10:29 +00004899int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4900 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004901 return 1;
4902 }
4903 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004904 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4905 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004906 ){
4907 return 1;
4908 }
drh1ad93a02016-11-02 02:17:52 +00004909 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4910 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4911 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004912 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004913 }
4914 return 0;
drh4bd5f732013-07-31 23:22:39 +00004915}
4916
4917/*
drh25897872018-03-20 21:16:15 +00004918** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4919** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004920** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4921**
4922** This routine controls an optimization. False positives (setting
4923** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4924** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004925*/
4926static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004927 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004928 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004929 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4930 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004931 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004932 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004933 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00004934 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00004935 case TK_IS:
4936 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004937 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004938 case TK_IN:
drh25897872018-03-20 21:16:15 +00004939 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004940 testcase( pExpr->op==TK_ISNOT );
4941 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004942 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00004943 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00004944 testcase( pExpr->op==TK_IS );
4945 testcase( pExpr->op==TK_OR );
4946 testcase( pExpr->op==TK_CASE );
4947 testcase( pExpr->op==TK_IN );
4948 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00004949 return WRC_Prune;
4950 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00004951 if( pWalker->u.iCur==pExpr->iTable ){
4952 pWalker->eCode = 1;
4953 return WRC_Abort;
4954 }
4955 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00004956
4957 /* Virtual tables are allowed to use constraints like x=NULL. So
4958 ** a term of the form x=y does not prove that y is not null if x
4959 ** is the column of a virtual table */
4960 case TK_EQ:
4961 case TK_NE:
4962 case TK_LT:
4963 case TK_LE:
4964 case TK_GT:
4965 case TK_GE:
4966 testcase( pExpr->op==TK_EQ );
4967 testcase( pExpr->op==TK_NE );
4968 testcase( pExpr->op==TK_LT );
4969 testcase( pExpr->op==TK_LE );
4970 testcase( pExpr->op==TK_GT );
4971 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00004972 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
4973 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00004974 ){
4975 return WRC_Prune;
4976 }
drh25897872018-03-20 21:16:15 +00004977 default:
4978 return WRC_Continue;
4979 }
4980}
4981
4982/*
4983** Return true (non-zero) if expression p can only be true if at least
4984** one column of table iTab is non-null. In other words, return true
4985** if expression p will always be NULL or false if every column of iTab
4986** is NULL.
4987**
drh821b6102018-03-24 18:01:51 +00004988** False negatives are acceptable. In other words, it is ok to return
4989** zero even if expression p will never be true of every column of iTab
4990** is NULL. A false negative is merely a missed optimization opportunity.
4991**
4992** False positives are not allowed, however. A false positive may result
4993** in an incorrect answer.
4994**
drh25897872018-03-20 21:16:15 +00004995** Terms of p that are marked with EP_FromJoin (and hence that come from
4996** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
4997**
4998** This routine is used to check if a LEFT JOIN can be converted into
4999** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5000** clause requires that some column of the right table of the LEFT JOIN
5001** be non-NULL, then the LEFT JOIN can be safely converted into an
5002** ordinary join.
5003*/
5004int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5005 Walker w;
drhd6db6592019-04-01 19:42:42 +00005006 p = sqlite3ExprSkipCollate(p);
5007 while( p ){
5008 if( p->op==TK_NOTNULL ){
5009 p = p->pLeft;
5010 }else if( p->op==TK_AND ){
5011 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5012 p = p->pRight;
5013 }else{
5014 break;
5015 }
5016 }
drh25897872018-03-20 21:16:15 +00005017 w.xExprCallback = impliesNotNullRow;
5018 w.xSelectCallback = 0;
5019 w.xSelectCallback2 = 0;
5020 w.eCode = 0;
5021 w.u.iCur = iTab;
5022 sqlite3WalkExpr(&w, p);
5023 return w.eCode;
5024}
5025
5026/*
drh030796d2012-08-23 16:18:10 +00005027** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005028** to determine if an expression can be evaluated by reference to the
5029** index only, without having to do a search for the corresponding
5030** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5031** is the cursor for the table.
5032*/
5033struct IdxCover {
5034 Index *pIdx; /* The index to be tested for coverage */
5035 int iCur; /* Cursor number for the table corresponding to the index */
5036};
5037
5038/*
5039** Check to see if there are references to columns in table
5040** pWalker->u.pIdxCover->iCur can be satisfied using the index
5041** pWalker->u.pIdxCover->pIdx.
5042*/
5043static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5044 if( pExpr->op==TK_COLUMN
5045 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5046 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5047 ){
5048 pWalker->eCode = 1;
5049 return WRC_Abort;
5050 }
5051 return WRC_Continue;
5052}
5053
5054/*
drhe604ec02016-07-27 19:20:58 +00005055** Determine if an index pIdx on table with cursor iCur contains will
5056** the expression pExpr. Return true if the index does cover the
5057** expression and false if the pExpr expression references table columns
5058** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005059**
5060** An index covering an expression means that the expression can be
5061** evaluated using only the index and without having to lookup the
5062** corresponding table entry.
5063*/
5064int sqlite3ExprCoveredByIndex(
5065 Expr *pExpr, /* The index to be tested */
5066 int iCur, /* The cursor number for the corresponding table */
5067 Index *pIdx /* The index that might be used for coverage */
5068){
5069 Walker w;
5070 struct IdxCover xcov;
5071 memset(&w, 0, sizeof(w));
5072 xcov.iCur = iCur;
5073 xcov.pIdx = pIdx;
5074 w.xExprCallback = exprIdxCover;
5075 w.u.pIdxCover = &xcov;
5076 sqlite3WalkExpr(&w, pExpr);
5077 return !w.eCode;
5078}
5079
5080
5081/*
5082** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005083** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005084** aggregate function, in order to implement the
5085** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005086*/
drh030796d2012-08-23 16:18:10 +00005087struct SrcCount {
5088 SrcList *pSrc; /* One particular FROM clause in a nested query */
5089 int nThis; /* Number of references to columns in pSrcList */
5090 int nOther; /* Number of references to columns in other FROM clauses */
5091};
5092
5093/*
5094** Count the number of references to columns.
5095*/
5096static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005097 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5098 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5099 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5100 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5101 ** NEVER() will need to be removed. */
5102 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005103 int i;
drh030796d2012-08-23 16:18:10 +00005104 struct SrcCount *p = pWalker->u.pSrcCount;
5105 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005106 int nSrc = pSrc ? pSrc->nSrc : 0;
5107 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005108 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005109 }
drh655814d2015-01-09 01:27:29 +00005110 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005111 p->nThis++;
5112 }else{
5113 p->nOther++;
5114 }
drh374fdce2012-04-17 16:38:53 +00005115 }
drh030796d2012-08-23 16:18:10 +00005116 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005117}
5118
5119/*
drh030796d2012-08-23 16:18:10 +00005120** Determine if any of the arguments to the pExpr Function reference
5121** pSrcList. Return true if they do. Also return true if the function
5122** has no arguments or has only constant arguments. Return false if pExpr
5123** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005124*/
drh030796d2012-08-23 16:18:10 +00005125int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005126 Walker w;
drh030796d2012-08-23 16:18:10 +00005127 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005128 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005129 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005130 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005131 w.u.pSrcCount = &cnt;
5132 cnt.pSrc = pSrcList;
5133 cnt.nThis = 0;
5134 cnt.nOther = 0;
5135 sqlite3WalkExprList(&w, pExpr->x.pList);
5136 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005137}
5138
5139/*
drh13449892005-09-07 21:22:45 +00005140** Add a new element to the pAggInfo->aCol[] array. Return the index of
5141** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005142*/
drh17435752007-08-16 04:30:38 +00005143static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005144 int i;
drhcf643722007-03-27 13:36:37 +00005145 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005146 db,
drhcf643722007-03-27 13:36:37 +00005147 pInfo->aCol,
5148 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005149 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005150 &i
5151 );
drh13449892005-09-07 21:22:45 +00005152 return i;
5153}
5154
5155/*
5156** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5157** the new element. Return a negative number if malloc fails.
5158*/
drh17435752007-08-16 04:30:38 +00005159static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005160 int i;
drhcf643722007-03-27 13:36:37 +00005161 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005162 db,
drhcf643722007-03-27 13:36:37 +00005163 pInfo->aFunc,
5164 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005165 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005166 &i
5167 );
drh13449892005-09-07 21:22:45 +00005168 return i;
5169}
drh22827922000-06-06 17:27:05 +00005170
5171/*
drh7d10d5a2008-08-20 16:35:10 +00005172** This is the xExprCallback for a tree walker. It is used to
5173** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005174** for additional information.
drh22827922000-06-06 17:27:05 +00005175*/
drh7d10d5a2008-08-20 16:35:10 +00005176static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005177 int i;
drh7d10d5a2008-08-20 16:35:10 +00005178 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005179 Parse *pParse = pNC->pParse;
5180 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005181 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005182
drh25c3b8c2018-04-16 10:34:13 +00005183 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005184 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005185 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005186 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005187 testcase( pExpr->op==TK_AGG_COLUMN );
5188 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005189 /* Check to see if the column is in one of the tables in the FROM
5190 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005191 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005192 struct SrcList_item *pItem = pSrcList->a;
5193 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5194 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005195 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005196 if( pExpr->iTable==pItem->iCursor ){
5197 /* If we reach this point, it means that pExpr refers to a table
5198 ** that is in the FROM clause of the aggregate query.
5199 **
5200 ** Make an entry for the column in pAggInfo->aCol[] if there
5201 ** is not an entry there already.
5202 */
drh7f906d62007-03-12 23:48:52 +00005203 int k;
drh13449892005-09-07 21:22:45 +00005204 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005205 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005206 if( pCol->iTable==pExpr->iTable &&
5207 pCol->iColumn==pExpr->iColumn ){
5208 break;
5209 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005210 }
danielk19771e536952007-08-16 10:09:01 +00005211 if( (k>=pAggInfo->nColumn)
5212 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5213 ){
drh7f906d62007-03-12 23:48:52 +00005214 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005215 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005216 pCol->iTable = pExpr->iTable;
5217 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005218 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005219 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005220 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005221 if( pAggInfo->pGroupBy ){
5222 int j, n;
5223 ExprList *pGB = pAggInfo->pGroupBy;
5224 struct ExprList_item *pTerm = pGB->a;
5225 n = pGB->nExpr;
5226 for(j=0; j<n; j++, pTerm++){
5227 Expr *pE = pTerm->pExpr;
5228 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5229 pE->iColumn==pExpr->iColumn ){
5230 pCol->iSorterColumn = j;
5231 break;
5232 }
5233 }
5234 }
5235 if( pCol->iSorterColumn<0 ){
5236 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5237 }
5238 }
5239 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5240 ** because it was there before or because we just created it).
5241 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5242 ** pAggInfo->aCol[] entry.
5243 */
drhebb6a652013-09-12 23:42:22 +00005244 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005245 pExpr->pAggInfo = pAggInfo;
5246 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005247 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005248 break;
5249 } /* endif pExpr->iTable==pItem->iCursor */
5250 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005251 }
drh7d10d5a2008-08-20 16:35:10 +00005252 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005253 }
5254 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005255 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005256 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005257 ){
drh13449892005-09-07 21:22:45 +00005258 /* Check to see if pExpr is a duplicate of another aggregate
5259 ** function that is already in the pAggInfo structure
5260 */
5261 struct AggInfo_func *pItem = pAggInfo->aFunc;
5262 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005263 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005264 break;
5265 }
drh22827922000-06-06 17:27:05 +00005266 }
drh13449892005-09-07 21:22:45 +00005267 if( i>=pAggInfo->nFunc ){
5268 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5269 */
danielk197714db2662006-01-09 16:12:04 +00005270 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005271 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005272 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005273 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005274 pItem = &pAggInfo->aFunc[i];
5275 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005276 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005277 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005278 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005279 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005280 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005281 if( pExpr->flags & EP_Distinct ){
5282 pItem->iDistinct = pParse->nTab++;
5283 }else{
5284 pItem->iDistinct = -1;
5285 }
drh13449892005-09-07 21:22:45 +00005286 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005287 }
drh13449892005-09-07 21:22:45 +00005288 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5289 */
drhc5cd1242013-09-12 16:50:49 +00005290 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005291 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005292 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005293 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005294 return WRC_Prune;
5295 }else{
5296 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005297 }
drh22827922000-06-06 17:27:05 +00005298 }
5299 }
drh7d10d5a2008-08-20 16:35:10 +00005300 return WRC_Continue;
5301}
5302static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005303 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005304 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005305 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005306}
drh979dd1b2017-05-29 14:26:07 +00005307static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5308 UNUSED_PARAMETER(pSelect);
5309 pWalker->walkerDepth--;
5310}
drh626a8792005-01-17 22:08:19 +00005311
5312/*
drhe8abb4c2012-11-02 18:24:57 +00005313** Analyze the pExpr expression looking for aggregate functions and
5314** for variables that need to be added to AggInfo object that pNC->pAggInfo
5315** points to. Additional entries are made on the AggInfo object as
5316** necessary.
drh626a8792005-01-17 22:08:19 +00005317**
5318** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005319** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005320*/
drhd2b3e232008-01-23 14:51:49 +00005321void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005322 Walker w;
5323 w.xExprCallback = analyzeAggregate;
5324 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005325 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5326 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005327 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005328 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005329 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005330 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005331}
drh5d9a4af2005-08-30 00:54:01 +00005332
5333/*
5334** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5335** expression list. Return the number of errors.
5336**
5337** If an error is found, the analysis is cut short.
5338*/
drhd2b3e232008-01-23 14:51:49 +00005339void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005340 struct ExprList_item *pItem;
5341 int i;
drh5d9a4af2005-08-30 00:54:01 +00005342 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005343 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5344 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005345 }
5346 }
drh5d9a4af2005-08-30 00:54:01 +00005347}
drh892d3172008-01-10 03:46:36 +00005348
5349/*
drhceea3322009-04-23 13:22:42 +00005350** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005351*/
5352int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005353 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005354 return ++pParse->nMem;
5355 }
danielk19772f425f62008-07-04 09:41:39 +00005356 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005357}
drhceea3322009-04-23 13:22:42 +00005358
5359/*
5360** Deallocate a register, making available for reuse for some other
5361** purpose.
drhceea3322009-04-23 13:22:42 +00005362*/
drh892d3172008-01-10 03:46:36 +00005363void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005364 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005365 pParse->aTempReg[pParse->nTempReg++] = iReg;
5366 }
5367}
5368
5369/*
drhed24da42016-09-06 14:37:05 +00005370** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005371*/
5372int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005373 int i, n;
drhed24da42016-09-06 14:37:05 +00005374 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005375 i = pParse->iRangeReg;
5376 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005377 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005378 pParse->iRangeReg += nReg;
5379 pParse->nRangeReg -= nReg;
5380 }else{
5381 i = pParse->nMem+1;
5382 pParse->nMem += nReg;
5383 }
5384 return i;
5385}
5386void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005387 if( nReg==1 ){
5388 sqlite3ReleaseTempReg(pParse, iReg);
5389 return;
5390 }
drh892d3172008-01-10 03:46:36 +00005391 if( nReg>pParse->nRangeReg ){
5392 pParse->nRangeReg = nReg;
5393 pParse->iRangeReg = iReg;
5394 }
5395}
drhcdc69552011-12-06 13:24:59 +00005396
5397/*
5398** Mark all temporary registers as being unavailable for reuse.
5399*/
5400void sqlite3ClearTempRegCache(Parse *pParse){
5401 pParse->nTempReg = 0;
5402 pParse->nRangeReg = 0;
5403}
drhbb9b5f22016-03-19 00:35:02 +00005404
5405/*
5406** Validate that no temporary register falls within the range of
5407** iFirst..iLast, inclusive. This routine is only call from within assert()
5408** statements.
5409*/
5410#ifdef SQLITE_DEBUG
5411int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5412 int i;
5413 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005414 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5415 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005416 ){
5417 return 0;
5418 }
5419 for(i=0; i<pParse->nTempReg; i++){
5420 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5421 return 0;
5422 }
5423 }
5424 return 1;
5425}
5426#endif /* SQLITE_DEBUG */