blob: c9f917ce55cb8447ba4a94e090aa913baba4111c [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
47 pExpr = sqlite3ExprSkipCollate(pExpr);
mistachkin9bec6fb2014-06-26 21:28:21 +000048 if( pExpr->flags & EP_Generic ) return 0;
drh580c8c12012-12-08 03:34:04 +000049 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000050 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000051 assert( pExpr->flags&EP_xIsSelect );
52 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000053 }
drhdb45bd52016-08-22 00:48:58 +000054 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000055#ifndef SQLITE_OMIT_CAST
56 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000057 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000058 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000059 }
60#endif
drheda079c2018-09-20 19:02:15 +000061 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000063 }
dan80aa5452016-09-03 19:52:12 +000064 if( op==TK_SELECT_COLUMN ){
65 assert( pExpr->pLeft->flags&EP_xIsSelect );
66 return sqlite3ExprAffinity(
67 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
68 );
69 }
danielk1977a37cdde2004-05-16 11:15:36 +000070 return pExpr->affinity;
71}
72
drh53db1452004-05-20 13:54:53 +000073/*
drh8b4c40d2007-02-01 23:02:45 +000074** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000075** sequence named by pToken. Return a pointer to a new Expr node that
76** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000077**
78** If a memory allocation error occurs, that fact is recorded in pParse->db
79** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000080*/
drh4ef7efa2014-03-20 15:14:08 +000081Expr *sqlite3ExprAddCollateToken(
82 Parse *pParse, /* Parsing context */
83 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000084 const Token *pCollName, /* Name of collating sequence */
85 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000086){
drh0a8a4062012-12-07 18:38:16 +000087 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000088 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000089 if( pNew ){
90 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000091 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000092 pExpr = pNew;
93 }
drhae80dde2012-12-06 21:16:43 +000094 }
drh0a8a4062012-12-07 18:38:16 +000095 return pExpr;
96}
97Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +000098 Token s;
99 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000100 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000101 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000102}
103
104/*
drh0b8d2552015-09-05 22:36:07 +0000105** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000106** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000107*/
108Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +0000109 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000111 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000113 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000114 pExpr = pExpr->x.pList->a[0].pExpr;
115 }else{
drh0b8d2552015-09-05 22:36:07 +0000116 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000117 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000118 }
drha4c3c872013-09-12 17:29:25 +0000119 }
drh0a8a4062012-12-07 18:38:16 +0000120 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000121}
122
123/*
drhae80dde2012-12-06 21:16:43 +0000124** Return the collation sequence for the expression pExpr. If
125** there is no defined collating sequence, return NULL.
126**
drh70efa842017-09-28 01:58:23 +0000127** See also: sqlite3ExprNNCollSeq()
128**
129** The sqlite3ExprNNCollSeq() works the same exact that it returns the
130** default collation if pExpr has no defined collation.
131**
drhae80dde2012-12-06 21:16:43 +0000132** The collating sequence might be determined by a COLLATE operator
133** or by the presence of a column with a defined collating sequence.
134** COLLATE operators take first precedence. Left operands take
135** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000136*/
danielk19777cedc8d2004-06-10 10:50:08 +0000137CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000138 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000139 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000140 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000141 while( p ){
drhae80dde2012-12-06 21:16:43 +0000142 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000143 if( p->flags & EP_Generic ) break;
drhcb0e04f2018-12-12 21:34:17 +0000144 if( op==TK_REGISTER ) op = p->op2;
145 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000146 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000147 ){
drheda079c2018-09-20 19:02:15 +0000148 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000149 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000150 int j = p->iColumn;
151 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000152 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000153 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000154 }
155 break;
danielk19770202b292004-06-09 09:55:16 +0000156 }
drhe081d732018-07-27 18:19:12 +0000157 if( op==TK_CAST || op==TK_UPLUS ){
158 p = p->pLeft;
159 continue;
160 }
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000162 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163 break;
164 }
drhae80dde2012-12-06 21:16:43 +0000165 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000166 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000167 p = p->pLeft;
168 }else{
drh2308ed32015-02-09 16:09:34 +0000169 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000170 /* The Expr.x union is never used at the same time as Expr.pRight */
171 assert( p->x.pList==0 || p->pRight==0 );
172 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
173 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
174 ** least one EP_Collate. Thus the following two ALWAYS. */
175 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000176 int i;
drh6728cd92015-02-09 18:28:03 +0000177 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000178 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
179 pNext = p->x.pList->a[i].pExpr;
180 break;
181 }
182 }
183 }
184 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000185 }
186 }else{
drh7d10d5a2008-08-20 16:35:10 +0000187 break;
188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
danielk19777cedc8d2004-06-10 10:50:08 +0000190 if( sqlite3CheckCollSeq(pParse, pColl) ){
191 pColl = 0;
192 }
193 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000194}
195
196/*
drh70efa842017-09-28 01:58:23 +0000197** Return the collation sequence for the expression pExpr. If
198** there is no defined collating sequence, return a pointer to the
199** defautl collation sequence.
200**
201** See also: sqlite3ExprCollSeq()
202**
203** The sqlite3ExprCollSeq() routine works the same except that it
204** returns NULL if there is no defined collation.
205*/
206CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
207 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
208 if( p==0 ) p = pParse->db->pDfltColl;
209 assert( p!=0 );
210 return p;
211}
212
213/*
214** Return TRUE if the two expressions have equivalent collating sequences.
215*/
216int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
217 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
218 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
219 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
220}
221
222/*
drh626a8792005-01-17 22:08:19 +0000223** pExpr is an operand of a comparison operator. aff2 is the
224** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000225** type affinity that should be used for the comparison operator.
226*/
danielk1977e014a832004-05-17 10:48:57 +0000227char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000228 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000229 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000230 /* Both sides of the comparison are columns. If one has numeric
231 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000232 */
drh8a512562005-11-14 22:29:05 +0000233 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000234 return SQLITE_AFF_NUMERIC;
235 }else{
drh05883a32015-06-02 15:32:08 +0000236 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000237 }
238 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000239 /* Neither side of the comparison is a column. Compare the
240 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000241 */
drh05883a32015-06-02 15:32:08 +0000242 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000243 }else{
244 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000245 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000246 return (aff1 + aff2);
247 }
248}
249
drh53db1452004-05-20 13:54:53 +0000250/*
251** pExpr is a comparison operator. Return the type affinity that should
252** be applied to both operands prior to doing the comparison.
253*/
danielk1977e014a832004-05-17 10:48:57 +0000254static char comparisonAffinity(Expr *pExpr){
255 char aff;
256 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000258 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000259 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000260 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000261 if( pExpr->pRight ){
262 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000263 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
264 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000265 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000266 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000267 }
268 return aff;
269}
270
271/*
272** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273** idx_affinity is the affinity of an indexed column. Return true
274** if the index with affinity idx_affinity may be used to implement
275** the comparison in pExpr.
276*/
277int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000279 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000280 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000281 return 1;
282 case SQLITE_AFF_TEXT:
283 return idx_affinity==SQLITE_AFF_TEXT;
284 default:
285 return sqlite3IsNumericAffinity(idx_affinity);
286 }
danielk1977e014a832004-05-17 10:48:57 +0000287}
288
danielk1977a37cdde2004-05-16 11:15:36 +0000289/*
drh35573352008-01-08 23:54:25 +0000290** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000291** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000292*/
drh35573352008-01-08 23:54:25 +0000293static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
294 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000295 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000296 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000297}
298
drha2e00042002-01-22 03:13:42 +0000299/*
danielk19770202b292004-06-09 09:55:16 +0000300** Return a pointer to the collation sequence that should be used by
301** a binary comparison operator comparing pLeft and pRight.
302**
303** If the left hand expression has a collating sequence type, then it is
304** used. Otherwise the collation sequence for the right hand expression
305** is used, or the default (BINARY) if neither expression has a collating
306** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000307**
308** Argument pRight (but not pLeft) may be a null pointer. In this case,
309** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000310*/
drh0a0e1312007-08-07 17:04:59 +0000311CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000312 Parse *pParse,
313 Expr *pLeft,
314 Expr *pRight
315){
drhec41dda2007-02-07 13:09:45 +0000316 CollSeq *pColl;
317 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000318 if( pLeft->flags & EP_Collate ){
319 pColl = sqlite3ExprCollSeq(pParse, pLeft);
320 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000322 }else{
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 if( !pColl ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
326 }
danielk19770202b292004-06-09 09:55:16 +0000327 }
328 return pColl;
329}
330
331/*
drhbe5c89a2004-07-26 00:31:09 +0000332** Generate code for a comparison operator.
333*/
334static int codeCompare(
335 Parse *pParse, /* The parsing (and code generating) context */
336 Expr *pLeft, /* The left operand */
337 Expr *pRight, /* The right operand */
338 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000339 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000340 int dest, /* Jump here if true. */
341 int jumpIfNull /* If true, jump if either operand is NULL */
342){
drh35573352008-01-08 23:54:25 +0000343 int p5;
344 int addr;
345 CollSeq *p4;
346
347 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
348 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
349 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
350 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000351 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000352 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000353}
354
dancfbb5e82016-07-13 19:48:13 +0000355/*
dan870a0702016-08-01 16:37:43 +0000356** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000357**
358** A vector is defined as any expression that results in two or more
359** columns of result. Every TK_VECTOR node is an vector because the
360** parser will not generate a TK_VECTOR with fewer than two entries.
361** But a TK_SELECT might be either a vector or a scalar. It is only
362** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000363*/
364int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000365 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000366}
367
368/*
dancfbb5e82016-07-13 19:48:13 +0000369** If the expression passed as the only argument is of type TK_VECTOR
370** return the number of expressions in the vector. Or, if the expression
371** is a sub-select, return the number of columns in the sub-select. For
372** any other type of expression, return 1.
373*/
dan71c57db2016-07-09 20:23:55 +0000374int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000375 u8 op = pExpr->op;
376 if( op==TK_REGISTER ) op = pExpr->op2;
377 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000378 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000379 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000380 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000381 }else{
382 return 1;
dan71c57db2016-07-09 20:23:55 +0000383 }
dan71c57db2016-07-09 20:23:55 +0000384}
385
danba00e302016-07-23 20:24:06 +0000386/*
drhfc7f27b2016-08-20 00:07:01 +0000387** Return a pointer to a subexpression of pVector that is the i-th
388** column of the vector (numbered starting with 0). The caller must
389** ensure that i is within range.
390**
drh76dbe7a2016-08-20 21:02:38 +0000391** If pVector is really a scalar (and "scalar" here includes subqueries
392** that return a single column!) then return pVector unmodified.
393**
drhfc7f27b2016-08-20 00:07:01 +0000394** pVector retains ownership of the returned subexpression.
395**
396** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000397** just the expression for the i-th term of the result set, and may
398** not be ready for evaluation because the table cursor has not yet
399** been positioned.
danba00e302016-07-23 20:24:06 +0000400*/
drhfc7f27b2016-08-20 00:07:01 +0000401Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000402 assert( i<sqlite3ExprVectorSize(pVector) );
403 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000404 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
405 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000406 return pVector->x.pSelect->pEList->a[i].pExpr;
407 }else{
408 return pVector->x.pList->a[i].pExpr;
409 }
dan71c57db2016-07-09 20:23:55 +0000410 }
dan870a0702016-08-01 16:37:43 +0000411 return pVector;
dan71c57db2016-07-09 20:23:55 +0000412}
drhfc7f27b2016-08-20 00:07:01 +0000413
drhfc7f27b2016-08-20 00:07:01 +0000414/*
415** Compute and return a new Expr object which when passed to
416** sqlite3ExprCode() will generate all necessary code to compute
417** the iField-th column of the vector expression pVector.
418**
drh8762ec12016-08-20 01:06:22 +0000419** It is ok for pVector to be a scalar (as long as iField==0).
420** In that case, this routine works like sqlite3ExprDup().
421**
drhfc7f27b2016-08-20 00:07:01 +0000422** The caller owns the returned Expr object and is responsible for
423** ensuring that the returned value eventually gets freed.
424**
drh8762ec12016-08-20 01:06:22 +0000425** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000426** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000427** valid for the life of the returned object. If pVector is a TK_VECTOR
428** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000429** returns.
drh8762ec12016-08-20 01:06:22 +0000430**
431** A trick to cause a TK_SELECT pVector to be deleted together with
432** the returned Expr object is to attach the pVector to the pRight field
433** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000434*/
435Expr *sqlite3ExprForVectorField(
436 Parse *pParse, /* Parsing context */
437 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000438 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000439){
440 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000441 if( pVector->op==TK_SELECT ){
442 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000443 /* The TK_SELECT_COLUMN Expr node:
444 **
drh966e2912017-01-03 02:58:01 +0000445 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000446 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000447 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000448 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000449 ** pLeft->iTable: First in an array of register holding result, or 0
450 ** if the result is not yet computed.
451 **
452 ** sqlite3ExprDelete() specifically skips the recursive delete of
453 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000454 ** can be attached to pRight to cause this node to take ownership of
455 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
456 ** with the same pLeft pointer to the pVector, but only one of them
457 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000458 */
drhabfd35e2016-12-06 22:47:23 +0000459 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000460 if( pRet ){
461 pRet->iColumn = iField;
462 pRet->pLeft = pVector;
463 }
drhfc7f27b2016-08-20 00:07:01 +0000464 assert( pRet==0 || pRet->iTable==0 );
465 }else{
drha1251bc2016-08-20 00:51:37 +0000466 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000468 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000469 }
470 return pRet;
471}
dan71c57db2016-07-09 20:23:55 +0000472
dan5c288b92016-07-30 21:02:33 +0000473/*
474** If expression pExpr is of type TK_SELECT, generate code to evaluate
475** it. Return the register in which the result is stored (or, if the
476** sub-select returns more than one column, the first in an array
477** of registers in which the result is stored).
478**
479** If pExpr is not a TK_SELECT expression, return 0.
480*/
481static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000482 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000483#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000484 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000485 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000486 }
danf9b2e052016-08-02 17:45:00 +0000487#endif
dan8da209b2016-07-26 18:06:08 +0000488 return reg;
489}
490
dan5c288b92016-07-30 21:02:33 +0000491/*
492** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000493** or TK_SELECT that returns more than one column. This function returns
494** the register number of a register that contains the value of
495** element iField of the vector.
496**
497** If pVector is a TK_SELECT expression, then code for it must have
498** already been generated using the exprCodeSubselect() routine. In this
499** case parameter regSelect should be the first in an array of registers
500** containing the results of the sub-select.
501**
502** If pVector is of type TK_VECTOR, then code for the requested field
503** is generated. In this case (*pRegFree) may be set to the number of
504** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000505**
506** Before returning, output parameter (*ppExpr) is set to point to the
507** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000508*/
509static int exprVectorRegister(
510 Parse *pParse, /* Parse context */
511 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000512 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000513 int regSelect, /* First in array of registers */
514 Expr **ppExpr, /* OUT: Expression element */
515 int *pRegFree /* OUT: Temp register to free */
516){
drh12abf402016-08-22 14:30:05 +0000517 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000518 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000519 if( op==TK_REGISTER ){
520 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
521 return pVector->iTable+iField;
522 }
523 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000524 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
525 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000526 }
dan870a0702016-08-01 16:37:43 +0000527 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000528 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
529}
530
531/*
532** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000533** the result of the comparison (1, 0, or NULL) and write that
534** result into register dest.
535**
536** The caller must satisfy the following preconditions:
537**
538** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
539** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
540** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000541*/
drh79752b62016-08-13 10:02:17 +0000542static void codeVectorCompare(
543 Parse *pParse, /* Code generator context */
544 Expr *pExpr, /* The comparison operation */
545 int dest, /* Write results into this register */
546 u8 op, /* Comparison operator */
547 u8 p5 /* SQLITE_NULLEQ or zero */
548){
dan71c57db2016-07-09 20:23:55 +0000549 Vdbe *v = pParse->pVdbe;
550 Expr *pLeft = pExpr->pLeft;
551 Expr *pRight = pExpr->pRight;
552 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000553 int i;
554 int regLeft = 0;
555 int regRight = 0;
556 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000557 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000558
drh245ce622017-01-01 12:44:07 +0000559 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
560 sqlite3ErrorMsg(pParse, "row value misused");
561 return;
562 }
drhb29e60c2016-09-05 12:02:34 +0000563 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
564 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
565 || pExpr->op==TK_LT || pExpr->op==TK_GT
566 || pExpr->op==TK_LE || pExpr->op==TK_GE
567 );
568 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
569 || (pExpr->op==TK_ISNOT && op==TK_NE) );
570 assert( p5==0 || pExpr->op!=op );
571 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000572
drhb29e60c2016-09-05 12:02:34 +0000573 p5 |= SQLITE_STOREP2;
574 if( opx==TK_LE ) opx = TK_LT;
575 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000576
drhb29e60c2016-09-05 12:02:34 +0000577 regLeft = exprCodeSubselect(pParse, pLeft);
578 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000579
drhb29e60c2016-09-05 12:02:34 +0000580 for(i=0; 1 /*Loop exits by "break"*/; i++){
581 int regFree1 = 0, regFree2 = 0;
582 Expr *pL, *pR;
583 int r1, r2;
584 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000585 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
586 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
587 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
588 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
589 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
590 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
591 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
592 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
593 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
594 sqlite3ReleaseTempReg(pParse, regFree1);
595 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000596 if( i==nLeft-1 ){
597 break;
dan71c57db2016-07-09 20:23:55 +0000598 }
drhb29e60c2016-09-05 12:02:34 +0000599 if( opx==TK_EQ ){
600 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
601 p5 |= SQLITE_KEEPNULL;
602 }else if( opx==TK_NE ){
603 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
604 p5 |= SQLITE_KEEPNULL;
605 }else{
606 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
607 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
608 VdbeCoverageIf(v, op==TK_LT);
609 VdbeCoverageIf(v, op==TK_GT);
610 VdbeCoverageIf(v, op==TK_LE);
611 VdbeCoverageIf(v, op==TK_GE);
612 if( i==nLeft-2 ) opx = op;
613 }
dan71c57db2016-07-09 20:23:55 +0000614 }
drhb29e60c2016-09-05 12:02:34 +0000615 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000616}
617
danielk19774b5255a2008-06-05 16:47:39 +0000618#if SQLITE_MAX_EXPR_DEPTH>0
619/*
620** Check that argument nHeight is less than or equal to the maximum
621** expression depth allowed. If it is not, leave an error message in
622** pParse.
623*/
drh7d10d5a2008-08-20 16:35:10 +0000624int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000625 int rc = SQLITE_OK;
626 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
627 if( nHeight>mxHeight ){
628 sqlite3ErrorMsg(pParse,
629 "Expression tree is too large (maximum depth %d)", mxHeight
630 );
631 rc = SQLITE_ERROR;
632 }
633 return rc;
634}
635
636/* The following three functions, heightOfExpr(), heightOfExprList()
637** and heightOfSelect(), are used to determine the maximum height
638** of any expression tree referenced by the structure passed as the
639** first argument.
640**
641** If this maximum height is greater than the current value pointed
642** to by pnHeight, the second parameter, then set *pnHeight to that
643** value.
644*/
645static void heightOfExpr(Expr *p, int *pnHeight){
646 if( p ){
647 if( p->nHeight>*pnHeight ){
648 *pnHeight = p->nHeight;
649 }
650 }
651}
652static void heightOfExprList(ExprList *p, int *pnHeight){
653 if( p ){
654 int i;
655 for(i=0; i<p->nExpr; i++){
656 heightOfExpr(p->a[i].pExpr, pnHeight);
657 }
658 }
659}
dan1a3a3082018-01-18 19:00:54 +0000660static void heightOfSelect(Select *pSelect, int *pnHeight){
661 Select *p;
662 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000663 heightOfExpr(p->pWhere, pnHeight);
664 heightOfExpr(p->pHaving, pnHeight);
665 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000666 heightOfExprList(p->pEList, pnHeight);
667 heightOfExprList(p->pGroupBy, pnHeight);
668 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000669 }
670}
671
672/*
673** Set the Expr.nHeight variable in the structure passed as an
674** argument. An expression with no children, Expr.pList or
675** Expr.pSelect member has a height of 1. Any other expression
676** has a height equal to the maximum height of any other
677** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000678**
679** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
680** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000681*/
682static void exprSetHeight(Expr *p){
683 int nHeight = 0;
684 heightOfExpr(p->pLeft, &nHeight);
685 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000686 if( ExprHasProperty(p, EP_xIsSelect) ){
687 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000688 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000689 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000690 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000691 }
danielk19774b5255a2008-06-05 16:47:39 +0000692 p->nHeight = nHeight + 1;
693}
694
695/*
696** Set the Expr.nHeight variable using the exprSetHeight() function. If
697** the height is greater than the maximum allowed expression depth,
698** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000699**
700** Also propagate all EP_Propagate flags from the Expr.x.pList into
701** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000702*/
drh2308ed32015-02-09 16:09:34 +0000703void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000704 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000705 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000706 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000707}
708
709/*
710** Return the maximum height of any expression tree referenced
711** by the select statement passed as an argument.
712*/
713int sqlite3SelectExprHeight(Select *p){
714 int nHeight = 0;
715 heightOfSelect(p, &nHeight);
716 return nHeight;
717}
drh2308ed32015-02-09 16:09:34 +0000718#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
719/*
720** Propagate all EP_Propagate flags from the Expr.x.pList into
721** Expr.flags.
722*/
723void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
724 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
725 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
726 }
727}
728#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000729#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
730
drhbe5c89a2004-07-26 00:31:09 +0000731/*
drhb7916a72009-05-27 10:31:29 +0000732** This routine is the core allocator for Expr nodes.
733**
drha76b5df2002-02-23 02:32:10 +0000734** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000735** for this node and for the pToken argument is a single allocation
736** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000737** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000738**
739** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000740** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000741** parameter is ignored if pToken is NULL or if the token does not
742** appear to be quoted. If the quotes were of the form "..." (double-quotes)
743** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000744**
745** Special case: If op==TK_INTEGER and pToken points to a string that
746** can be translated into a 32-bit integer, then the token is not
747** stored in u.zToken. Instead, the integer values is written
748** into u.iValue and the EP_IntValue flag is set. No extra storage
749** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000750*/
drhb7916a72009-05-27 10:31:29 +0000751Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000752 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000753 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000754 const Token *pToken, /* Token argument. Might be NULL */
755 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000756){
drha76b5df2002-02-23 02:32:10 +0000757 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000758 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000759 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000760
drh575fad62016-02-05 13:38:36 +0000761 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000762 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000763 if( op!=TK_INTEGER || pToken->z==0
764 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
765 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000766 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000767 }
drhb7916a72009-05-27 10:31:29 +0000768 }
drh575fad62016-02-05 13:38:36 +0000769 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000770 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000771 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000772 pNew->op = (u8)op;
773 pNew->iAgg = -1;
774 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000775 if( nExtra==0 ){
drhb98a2e32017-07-07 12:43:57 +0000776 pNew->flags |= EP_IntValue|EP_Leaf;
drh33e619f2009-05-28 01:00:55 +0000777 pNew->u.iValue = iValue;
778 }else{
drh33e619f2009-05-28 01:00:55 +0000779 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000780 assert( pToken->z!=0 || pToken->n==0 );
781 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000782 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000783 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000784 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000785 }
drhb7916a72009-05-27 10:31:29 +0000786 }
787 }
788#if SQLITE_MAX_EXPR_DEPTH>0
789 pNew->nHeight = 1;
790#endif
791 }
drha76b5df2002-02-23 02:32:10 +0000792 return pNew;
793}
794
795/*
drhb7916a72009-05-27 10:31:29 +0000796** Allocate a new expression node from a zero-terminated token that has
797** already been dequoted.
798*/
799Expr *sqlite3Expr(
800 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
801 int op, /* Expression opcode */
802 const char *zToken /* Token argument. Might be NULL */
803){
804 Token x;
805 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000806 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000807 return sqlite3ExprAlloc(db, op, &x, 0);
808}
809
810/*
811** Attach subtrees pLeft and pRight to the Expr node pRoot.
812**
813** If pRoot==NULL that means that a memory allocation error has occurred.
814** In that case, delete the subtrees pLeft and pRight.
815*/
816void sqlite3ExprAttachSubtrees(
817 sqlite3 *db,
818 Expr *pRoot,
819 Expr *pLeft,
820 Expr *pRight
821){
822 if( pRoot==0 ){
823 assert( db->mallocFailed );
824 sqlite3ExprDelete(db, pLeft);
825 sqlite3ExprDelete(db, pRight);
826 }else{
827 if( pRight ){
828 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000829 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000830 }
831 if( pLeft ){
832 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 exprSetHeight(pRoot);
836 }
837}
838
839/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000840** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000841**
drhbf664462009-06-19 18:32:54 +0000842** One or both of the subtrees can be NULL. Return a pointer to the new
843** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
844** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000845*/
drh17435752007-08-16 04:30:38 +0000846Expr *sqlite3PExpr(
847 Parse *pParse, /* Parsing context */
848 int op, /* Expression opcode */
849 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000850 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000851){
drh5fb52ca2012-03-31 02:34:35 +0000852 Expr *p;
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/*
drh991a1982014-01-02 17:57:16 +0000884** If the expression is always either TRUE or FALSE (respectively),
885** then return 1. If one cannot determine the truth value of the
886** expression at compile-time return 0.
887**
888** This is an optimization. If is OK to return 0 here even if
889** the expression really is always false or false (a false negative).
890** But it is a bug to return 1 if the expression might have different
891** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000892**
893** Note that if the expression is part of conditional for a
894** LEFT JOIN, then we cannot determine at compile-time whether or not
895** is it true or false, so always return 0.
896*/
drh991a1982014-01-02 17:57:16 +0000897static int exprAlwaysTrue(Expr *p){
898 int v = 0;
899 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
900 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
901 return v!=0;
902}
drh5fb52ca2012-03-31 02:34:35 +0000903static int exprAlwaysFalse(Expr *p){
904 int v = 0;
905 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
906 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
907 return v==0;
908}
909
910/*
drh91bb0ee2004-09-01 03:06:34 +0000911** Join two expressions using an AND operator. If either expression is
912** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000913**
914** If one side or the other of the AND is known to be false, then instead
915** of returning an AND expression, just return a constant expression with
916** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000917*/
drhd5c851c2019-04-19 13:38:34 +0000918Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
919 sqlite3 *db = pParse->db;
920 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000921 return pRight;
922 }else if( pRight==0 ){
923 return pLeft;
drhd5c851c2019-04-19 13:38:34 +0000924 }else if( pParse->nErr || IN_RENAME_OBJECT ){
925 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drh5fb52ca2012-03-31 02:34:35 +0000926 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
927 sqlite3ExprDelete(db, pLeft);
928 sqlite3ExprDelete(db, pRight);
929 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000930 }else{
drhd5c851c2019-04-19 13:38:34 +0000931 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000932 }
933}
934
935/*
936** Construct a new expression node for a function with multiple
937** arguments.
938*/
drh954733b2018-07-27 23:33:16 +0000939Expr *sqlite3ExprFunction(
940 Parse *pParse, /* Parsing context */
941 ExprList *pList, /* Argument list */
942 Token *pToken, /* Name of the function */
943 int eDistinct /* SF_Distinct or SF_ALL or 0 */
944){
drha76b5df2002-02-23 02:32:10 +0000945 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000946 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000947 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000948 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000949 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000950 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000951 return 0;
952 }
drh954733b2018-07-27 23:33:16 +0000953 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
954 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
955 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000956 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000957 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000958 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000959 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000960 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000961 return pNew;
962}
963
964/*
drhfa6bc002004-09-07 16:19:52 +0000965** Assign a variable number to an expression that encodes a wildcard
966** in the original SQL statement.
967**
968** Wildcards consisting of a single "?" are assigned the next sequential
969** variable number.
970**
971** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000972** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000973** the SQL statement comes from an external source.
974**
drh51f49f12009-05-21 20:41:32 +0000975** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000976** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000977** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000978** assigned.
979*/
drhde25a882016-10-03 15:28:24 +0000980void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000981 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000982 const char *z;
drhf326d662016-12-23 13:30:53 +0000983 ynVar x;
drh17435752007-08-16 04:30:38 +0000984
drhfa6bc002004-09-07 16:19:52 +0000985 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000986 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000987 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000988 assert( z!=0 );
989 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000990 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000991 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000992 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000993 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000994 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000995 }else{
drhf326d662016-12-23 13:30:53 +0000996 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000997 if( z[0]=='?' ){
998 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
999 ** use it as the variable number */
1000 i64 i;
drh18814df2017-01-31 03:52:34 +00001001 int bOk;
1002 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1003 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1004 bOk = 1;
1005 }else{
1006 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1007 }
drh124c0b42011-06-01 18:15:55 +00001008 testcase( i==0 );
1009 testcase( i==1 );
1010 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1011 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1012 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1013 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1014 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001015 return;
drhfa6bc002004-09-07 16:19:52 +00001016 }
drh8e74e7b2017-01-31 12:41:48 +00001017 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001018 if( x>pParse->nVar ){
1019 pParse->nVar = (int)x;
1020 doAdd = 1;
1021 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1022 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001023 }
1024 }else{
1025 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1026 ** number as the prior appearance of the same name, or if the name
1027 ** has never appeared before, reuse the same variable number
1028 */
drh9bf755c2016-12-23 03:59:31 +00001029 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1030 if( x==0 ){
1031 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001032 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001033 }
drhfa6bc002004-09-07 16:19:52 +00001034 }
drhf326d662016-12-23 13:30:53 +00001035 if( doAdd ){
1036 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1037 }
1038 }
1039 pExpr->iColumn = x;
1040 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001041 sqlite3ErrorMsg(pParse, "too many SQL variables");
1042 }
drhfa6bc002004-09-07 16:19:52 +00001043}
1044
1045/*
danf6963f92009-11-23 14:39:14 +00001046** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001047*/
drh4f0010b2016-04-11 14:49:39 +00001048static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1049 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001050 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1051 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001052
1053 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1054 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1055 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001056#ifdef SQLITE_DEBUG
1057 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1058 assert( p->pLeft==0 );
1059 assert( p->pRight==0 );
1060 assert( p->x.pSelect==0 );
1061 }
1062#endif
1063 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001064 /* The Expr.x union is never used at the same time as Expr.pRight */
1065 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001066 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001067 if( p->pRight ){
1068 sqlite3ExprDeleteNN(db, p->pRight);
1069 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001070 sqlite3SelectDelete(db, p->x.pSelect);
1071 }else{
1072 sqlite3ExprListDelete(db, p->x.pList);
1073 }
drheda079c2018-09-20 19:02:15 +00001074 if( ExprHasProperty(p, EP_WinFunc) ){
1075 assert( p->op==TK_FUNCTION );
1076 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001077 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001078 }
drh209bc522016-09-23 21:36:24 +00001079 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001080 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001081 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001082 }
drha2e00042002-01-22 03:13:42 +00001083}
drh4f0010b2016-04-11 14:49:39 +00001084void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1085 if( p ) sqlite3ExprDeleteNN(db, p);
1086}
drha2e00042002-01-22 03:13:42 +00001087
drhd2687b72005-08-12 22:56:09 +00001088/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001089** Return the number of bytes allocated for the expression structure
1090** passed as the first argument. This is always one of EXPR_FULLSIZE,
1091** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1092*/
1093static int exprStructSize(Expr *p){
1094 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001095 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1096 return EXPR_FULLSIZE;
1097}
1098
1099/*
drha8e05762019-01-05 21:56:12 +00001100** Copy the complete content of an Expr node, taking care not to read
1101** past the end of the structure for a reduced-size version of the source
1102** Expr.
1103*/
1104static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1105 memset(pDest, 0, sizeof(Expr));
1106 memcpy(pDest, pSrc, exprStructSize(pSrc));
1107}
1108
1109/*
drh33e619f2009-05-28 01:00:55 +00001110** The dupedExpr*Size() routines each return the number of bytes required
1111** to store a copy of an expression or expression tree. They differ in
1112** how much of the tree is measured.
1113**
1114** dupedExprStructSize() Size of only the Expr structure
1115** dupedExprNodeSize() Size of Expr + space for token
1116** dupedExprSize() Expr + token + subtree components
1117**
1118***************************************************************************
1119**
1120** The dupedExprStructSize() function returns two values OR-ed together:
1121** (1) the space required for a copy of the Expr structure only and
1122** (2) the EP_xxx flags that indicate what the structure size should be.
1123** The return values is always one of:
1124**
1125** EXPR_FULLSIZE
1126** EXPR_REDUCEDSIZE | EP_Reduced
1127** EXPR_TOKENONLYSIZE | EP_TokenOnly
1128**
1129** The size of the structure can be found by masking the return value
1130** of this routine with 0xfff. The flags can be found by masking the
1131** return value with EP_Reduced|EP_TokenOnly.
1132**
1133** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1134** (unreduced) Expr objects as they or originally constructed by the parser.
1135** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001136** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001137** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001138** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001139** to reduce a pristine expression tree from the parser. The implementation
1140** of dupedExprStructSize() contain multiple assert() statements that attempt
1141** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001142*/
1143static int dupedExprStructSize(Expr *p, int flags){
1144 int nSize;
drh33e619f2009-05-28 01:00:55 +00001145 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001146 assert( EXPR_FULLSIZE<=0xfff );
1147 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001148 if( 0==flags || p->op==TK_SELECT_COLUMN
1149#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001150 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001151#endif
1152 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001153 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001154 }else{
drhc5cd1242013-09-12 16:50:49 +00001155 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001156 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001157 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001158 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001159 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001160 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1161 }else{
drhaecd8022013-09-13 18:15:15 +00001162 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001163 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1164 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001165 }
1166 return nSize;
1167}
1168
1169/*
drh33e619f2009-05-28 01:00:55 +00001170** This function returns the space in bytes required to store the copy
1171** of the Expr structure and a copy of the Expr.u.zToken string (if that
1172** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001173*/
1174static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001175 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1176 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001177 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001178 }
danielk1977bc739712009-03-23 04:33:32 +00001179 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001180}
1181
1182/*
1183** Return the number of bytes required to create a duplicate of the
1184** expression passed as the first argument. The second argument is a
1185** mask containing EXPRDUP_XXX flags.
1186**
1187** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001188** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001189**
1190** If the EXPRDUP_REDUCE flag is set, then the return value includes
1191** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1192** and Expr.pRight variables (but not for any structures pointed to or
1193** descended from the Expr.x.pList or Expr.x.pSelect variables).
1194*/
1195static int dupedExprSize(Expr *p, int flags){
1196 int nByte = 0;
1197 if( p ){
1198 nByte = dupedExprNodeSize(p, flags);
1199 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001200 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001201 }
1202 }
1203 return nByte;
1204}
1205
1206/*
1207** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1208** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001209** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001210** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001211** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001212** portion of the buffer copied into by this function.
1213*/
drh3c194692016-04-11 16:43:43 +00001214static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1215 Expr *pNew; /* Value to return */
1216 u8 *zAlloc; /* Memory space from which to build Expr object */
1217 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1218
drh575fad62016-02-05 13:38:36 +00001219 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001220 assert( p );
1221 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1222 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001223
drh3c194692016-04-11 16:43:43 +00001224 /* Figure out where to write the new Expr structure. */
1225 if( pzBuffer ){
1226 zAlloc = *pzBuffer;
1227 staticFlag = EP_Static;
1228 }else{
1229 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1230 staticFlag = 0;
1231 }
1232 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001233
drh3c194692016-04-11 16:43:43 +00001234 if( pNew ){
1235 /* Set nNewSize to the size allocated for the structure pointed to
1236 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1237 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1238 ** by the copy of the p->u.zToken string (if any).
1239 */
1240 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1241 const int nNewSize = nStructSize & 0xfff;
1242 int nToken;
1243 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1244 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001245 }else{
drh3c194692016-04-11 16:43:43 +00001246 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001247 }
drh3c194692016-04-11 16:43:43 +00001248 if( dupFlags ){
1249 assert( ExprHasProperty(p, EP_Reduced)==0 );
1250 memcpy(zAlloc, p, nNewSize);
1251 }else{
1252 u32 nSize = (u32)exprStructSize(p);
1253 memcpy(zAlloc, p, nSize);
1254 if( nSize<EXPR_FULLSIZE ){
1255 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1256 }
1257 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001258
drh3c194692016-04-11 16:43:43 +00001259 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1260 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1261 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1262 pNew->flags |= staticFlag;
1263
1264 /* Copy the p->u.zToken string, if any. */
1265 if( nToken ){
1266 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1267 memcpy(zToken, p->u.zToken, nToken);
1268 }
1269
drh209bc522016-09-23 21:36:24 +00001270 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001271 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1272 if( ExprHasProperty(p, EP_xIsSelect) ){
1273 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001274 }else{
drh3c194692016-04-11 16:43:43 +00001275 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001276 }
drh3c194692016-04-11 16:43:43 +00001277 }
1278
1279 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001280 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1281 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001282 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001283 pNew->pLeft = p->pLeft ?
1284 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1285 pNew->pRight = p->pRight ?
1286 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001287 }
dan67a9b8e2018-06-22 20:51:35 +00001288#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001289 if( ExprHasProperty(p, EP_WinFunc) ){
1290 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1291 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001292 }
dan67a9b8e2018-06-22 20:51:35 +00001293#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001294 if( pzBuffer ){
1295 *pzBuffer = zAlloc;
1296 }
1297 }else{
drh209bc522016-09-23 21:36:24 +00001298 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001299 if( pNew->op==TK_SELECT_COLUMN ){
1300 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001301 assert( p->iColumn==0 || p->pRight==0 );
1302 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001303 }else{
1304 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1305 }
drh3c194692016-04-11 16:43:43 +00001306 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001307 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001308 }
1309 }
1310 return pNew;
1311}
1312
1313/*
danbfe31e72014-01-15 14:17:31 +00001314** Create and return a deep copy of the object passed as the second
1315** argument. If an OOM condition is encountered, NULL is returned
1316** and the db->mallocFailed flag set.
1317*/
daneede6a52014-01-15 19:42:23 +00001318#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001319static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001320 With *pRet = 0;
1321 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001322 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001323 pRet = sqlite3DbMallocZero(db, nByte);
1324 if( pRet ){
1325 int i;
1326 pRet->nCte = p->nCte;
1327 for(i=0; i<p->nCte; i++){
1328 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1329 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1330 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1331 }
1332 }
1333 }
1334 return pRet;
1335}
daneede6a52014-01-15 19:42:23 +00001336#else
1337# define withDup(x,y) 0
1338#endif
dan4e9119d2014-01-13 15:12:23 +00001339
drha8389972018-12-06 22:04:19 +00001340#ifndef SQLITE_OMIT_WINDOWFUNC
1341/*
1342** The gatherSelectWindows() procedure and its helper routine
1343** gatherSelectWindowsCallback() are used to scan all the expressions
1344** an a newly duplicated SELECT statement and gather all of the Window
1345** objects found there, assembling them onto the linked list at Select->pWin.
1346*/
1347static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1348 if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1349 assert( ExprHasProperty(pExpr, EP_WinFunc) );
1350 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1351 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1352 }
1353 return WRC_Continue;
1354}
drha37b6a52018-12-06 22:12:18 +00001355static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1356 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1357}
drha8389972018-12-06 22:04:19 +00001358static void gatherSelectWindows(Select *p){
1359 Walker w;
1360 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001361 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1362 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001363 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001364 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001365 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001366}
1367#endif
1368
1369
drha76b5df2002-02-23 02:32:10 +00001370/*
drhff78bd22002-02-27 01:47:11 +00001371** The following group of routines make deep copies of expressions,
1372** expression lists, ID lists, and select statements. The copies can
1373** be deleted (by being passed to their respective ...Delete() routines)
1374** without effecting the originals.
1375**
danielk19774adee202004-05-08 08:23:19 +00001376** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1377** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001378** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001379**
drhad3cab52002-05-24 02:04:32 +00001380** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001381**
drhb7916a72009-05-27 10:31:29 +00001382** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001383** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1384** truncated version of the usual Expr structure that will be stored as
1385** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001386*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001387Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001388 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001389 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001390}
danielk19776ab3a2e2009-02-19 14:39:25 +00001391ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001392 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001393 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001394 int i;
drhb1637482017-01-03 00:27:16 +00001395 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001396 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001397 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001398 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001399 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001400 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001401 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001402 pOldItem = p->a;
1403 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001404 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001405 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001406 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001407 if( pOldExpr
1408 && pOldExpr->op==TK_SELECT_COLUMN
1409 && (pNewExpr = pItem->pExpr)!=0
1410 ){
1411 assert( pNewExpr->iColumn==0 || i>0 );
1412 if( pNewExpr->iColumn==0 ){
1413 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001414 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1415 }else{
1416 assert( i>0 );
1417 assert( pItem[-1].pExpr!=0 );
1418 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1419 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1420 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001421 }
1422 }
drh17435752007-08-16 04:30:38 +00001423 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001424 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001425 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001426 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001427 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001428 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001429 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001430 }
1431 return pNew;
1432}
danielk197793758c82005-01-21 08:13:14 +00001433
1434/*
1435** If cursors, triggers, views and subqueries are all omitted from
1436** the build, then none of the following routines, except for
1437** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1438** called with a NULL argument.
1439*/
danielk19776a67fe82005-02-04 04:07:16 +00001440#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1441 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001442SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001443 SrcList *pNew;
1444 int i;
drh113088e2003-03-20 01:16:58 +00001445 int nByte;
drh575fad62016-02-05 13:38:36 +00001446 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001447 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001448 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001449 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001450 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001451 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001452 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001453 struct SrcList_item *pNewItem = &pNew->a[i];
1454 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001455 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001456 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001457 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1458 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1459 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001460 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001461 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001462 pNewItem->addrFillSub = pOldItem->addrFillSub;
1463 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001464 if( pNewItem->fg.isIndexedBy ){
1465 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1466 }
1467 pNewItem->pIBIndex = pOldItem->pIBIndex;
1468 if( pNewItem->fg.isTabFunc ){
1469 pNewItem->u1.pFuncArg =
1470 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1471 }
drhed8a3bb2005-06-06 21:19:56 +00001472 pTab = pNewItem->pTab = pOldItem->pTab;
1473 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001474 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001475 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001476 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1477 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001478 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001479 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001480 }
1481 return pNew;
1482}
drh17435752007-08-16 04:30:38 +00001483IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001484 IdList *pNew;
1485 int i;
drh575fad62016-02-05 13:38:36 +00001486 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001487 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001488 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001489 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001490 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001491 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001492 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001493 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001494 return 0;
1495 }
drh6c535152012-02-02 03:38:30 +00001496 /* Note that because the size of the allocation for p->a[] is not
1497 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1498 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001499 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001500 struct IdList_item *pNewItem = &pNew->a[i];
1501 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001502 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001503 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001504 }
1505 return pNew;
1506}
dana7466202017-02-03 14:44:52 +00001507Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1508 Select *pRet = 0;
1509 Select *pNext = 0;
1510 Select **pp = &pRet;
1511 Select *p;
1512
drh575fad62016-02-05 13:38:36 +00001513 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001514 for(p=pDup; p; p=p->pPrior){
1515 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1516 if( pNew==0 ) break;
1517 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1518 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1519 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1520 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1521 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1522 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1523 pNew->op = p->op;
1524 pNew->pNext = pNext;
1525 pNew->pPrior = 0;
1526 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001527 pNew->iLimit = 0;
1528 pNew->iOffset = 0;
1529 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1530 pNew->addrOpenEphm[0] = -1;
1531 pNew->addrOpenEphm[1] = -1;
1532 pNew->nSelectRow = p->nSelectRow;
1533 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001534#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001535 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001536 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001537 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001538#endif
drhfef37762018-07-10 19:48:35 +00001539 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001540 *pp = pNew;
1541 pp = &pNew->pPrior;
1542 pNext = pNew;
1543 }
1544
1545 return pRet;
drhff78bd22002-02-27 01:47:11 +00001546}
danielk197793758c82005-01-21 08:13:14 +00001547#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001548Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001549 assert( p==0 );
1550 return 0;
1551}
1552#endif
drhff78bd22002-02-27 01:47:11 +00001553
1554
1555/*
drha76b5df2002-02-23 02:32:10 +00001556** Add a new element to the end of an expression list. If pList is
1557** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001558**
drha19543f2017-09-15 15:17:48 +00001559** The pList argument must be either NULL or a pointer to an ExprList
1560** obtained from a prior call to sqlite3ExprListAppend(). This routine
1561** may not be used with an ExprList obtained from sqlite3ExprListDup().
1562** Reason: This routine assumes that the number of slots in pList->a[]
1563** is a power of two. That is true for sqlite3ExprListAppend() returns
1564** but is not necessarily true from the return value of sqlite3ExprListDup().
1565**
drhb7916a72009-05-27 10:31:29 +00001566** If a memory allocation error occurs, the entire list is freed and
1567** NULL is returned. If non-NULL is returned, then it is guaranteed
1568** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001569*/
drh17435752007-08-16 04:30:38 +00001570ExprList *sqlite3ExprListAppend(
1571 Parse *pParse, /* Parsing context */
1572 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001573 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001574){
drh43606172017-04-05 11:32:13 +00001575 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001576 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001577 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001578 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001579 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001580 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001581 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001582 }
drhc263f7c2016-01-18 13:18:54 +00001583 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001584 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001585 ExprList *pNew;
1586 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001587 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001588 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001589 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001590 }
drh43606172017-04-05 11:32:13 +00001591 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001592 }
drh43606172017-04-05 11:32:13 +00001593 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001594 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1595 assert( offsetof(struct ExprList_item,pExpr)==0 );
1596 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001597 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001598 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001599
1600no_mem:
1601 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001602 sqlite3ExprDelete(db, pExpr);
1603 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001604 return 0;
drha76b5df2002-02-23 02:32:10 +00001605}
1606
1607/*
drh8762ec12016-08-20 01:06:22 +00001608** pColumns and pExpr form a vector assignment which is part of the SET
1609** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001610**
1611** (a,b,c) = (expr1,expr2,expr3)
1612** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1613**
1614** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001615** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001616** TK_SELECT_COLUMN expressions.
1617*/
1618ExprList *sqlite3ExprListAppendVector(
1619 Parse *pParse, /* Parsing context */
1620 ExprList *pList, /* List to which to append. Might be NULL */
1621 IdList *pColumns, /* List of names of LHS of the assignment */
1622 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1623){
1624 sqlite3 *db = pParse->db;
1625 int n;
1626 int i;
drh66860af2016-08-23 18:30:10 +00001627 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001628 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1629 ** exit prior to this routine being invoked */
1630 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001631 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001632
1633 /* If the RHS is a vector, then we can immediately check to see that
1634 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1635 ** wildcards ("*") in the result set of the SELECT must be expanded before
1636 ** we can do the size check, so defer the size check until code generation.
1637 */
1638 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001639 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1640 pColumns->nId, n);
1641 goto vector_append_error;
1642 }
drh966e2912017-01-03 02:58:01 +00001643
1644 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001645 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1646 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1647 if( pList ){
drh66860af2016-08-23 18:30:10 +00001648 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001649 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1650 pColumns->a[i].zName = 0;
1651 }
1652 }
drh966e2912017-01-03 02:58:01 +00001653
drhffe28052017-05-06 18:09:36 +00001654 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001655 Expr *pFirst = pList->a[iFirst].pExpr;
1656 assert( pFirst!=0 );
1657 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001658
drhf4dd26c2017-04-05 11:49:06 +00001659 /* Store the SELECT statement in pRight so it will be deleted when
1660 ** sqlite3ExprListDelete() is called */
1661 pFirst->pRight = pExpr;
1662 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001663
drhf4dd26c2017-04-05 11:49:06 +00001664 /* Remember the size of the LHS in iTable so that we can check that
1665 ** the RHS and LHS sizes match during code generation. */
1666 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001667 }
1668
1669vector_append_error:
dandfb5c962019-01-15 20:51:35 +00001670 if( IN_RENAME_OBJECT ){
1671 sqlite3RenameExprUnmap(pParse, pExpr);
1672 }
drha1251bc2016-08-20 00:51:37 +00001673 sqlite3ExprDelete(db, pExpr);
1674 sqlite3IdListDelete(db, pColumns);
1675 return pList;
1676}
1677
1678/*
drhbc622bc2015-08-24 15:39:42 +00001679** Set the sort order for the last element on the given ExprList.
1680*/
1681void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1682 if( p==0 ) return;
1683 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1684 assert( p->nExpr>0 );
1685 if( iSortOrder<0 ){
1686 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1687 return;
1688 }
1689 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001690}
1691
1692/*
drhb7916a72009-05-27 10:31:29 +00001693** Set the ExprList.a[].zName element of the most recently added item
1694** on the expression list.
1695**
1696** pList might be NULL following an OOM error. But pName should never be
1697** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1698** is set.
1699*/
1700void sqlite3ExprListSetName(
1701 Parse *pParse, /* Parsing context */
1702 ExprList *pList, /* List to which to add the span. */
1703 Token *pName, /* Name to be added */
1704 int dequote /* True to cause the name to be dequoted */
1705){
1706 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1707 if( pList ){
1708 struct ExprList_item *pItem;
1709 assert( pList->nExpr>0 );
1710 pItem = &pList->a[pList->nExpr-1];
1711 assert( pItem->zName==0 );
1712 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001713 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001714 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001715 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001716 }
drhb7916a72009-05-27 10:31:29 +00001717 }
1718}
1719
1720/*
1721** Set the ExprList.a[].zSpan element of the most recently added item
1722** on the expression list.
1723**
1724** pList might be NULL following an OOM error. But pSpan should never be
1725** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1726** is set.
1727*/
1728void sqlite3ExprListSetSpan(
1729 Parse *pParse, /* Parsing context */
1730 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001731 const char *zStart, /* Start of the span */
1732 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001733){
1734 sqlite3 *db = pParse->db;
1735 assert( pList!=0 || db->mallocFailed!=0 );
1736 if( pList ){
1737 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1738 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001739 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001740 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001741 }
1742}
1743
1744/*
danielk19777a15a4b2007-05-08 17:54:43 +00001745** If the expression list pEList contains more than iLimit elements,
1746** leave an error message in pParse.
1747*/
1748void sqlite3ExprListCheckLength(
1749 Parse *pParse,
1750 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001751 const char *zObject
1752){
drhb1a6c3c2008-03-20 16:30:17 +00001753 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001754 testcase( pEList && pEList->nExpr==mx );
1755 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001756 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001757 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1758 }
1759}
1760
1761/*
drha76b5df2002-02-23 02:32:10 +00001762** Delete an entire expression list.
1763*/
drhaffa8552016-04-11 18:25:05 +00001764static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001765 int i = pList->nExpr;
1766 struct ExprList_item *pItem = pList->a;
1767 assert( pList->nExpr>0 );
1768 do{
drh633e6d52008-07-28 19:34:53 +00001769 sqlite3ExprDelete(db, pItem->pExpr);
1770 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001771 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001772 pItem++;
1773 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001774 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001775}
drhaffa8552016-04-11 18:25:05 +00001776void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1777 if( pList ) exprListDeleteNN(db, pList);
1778}
drha76b5df2002-02-23 02:32:10 +00001779
1780/*
drh2308ed32015-02-09 16:09:34 +00001781** Return the bitwise-OR of all Expr.flags fields in the given
1782** ExprList.
drh885a5b02015-02-09 15:21:36 +00001783*/
drh2308ed32015-02-09 16:09:34 +00001784u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001785 int i;
drh2308ed32015-02-09 16:09:34 +00001786 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001787 assert( pList!=0 );
1788 for(i=0; i<pList->nExpr; i++){
1789 Expr *pExpr = pList->a[i].pExpr;
1790 assert( pExpr!=0 );
1791 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001792 }
drh2308ed32015-02-09 16:09:34 +00001793 return m;
drh885a5b02015-02-09 15:21:36 +00001794}
1795
1796/*
drh7e6f9802017-09-04 00:33:04 +00001797** This is a SELECT-node callback for the expression walker that
1798** always "fails". By "fail" in this case, we mean set
1799** pWalker->eCode to zero and abort.
1800**
1801** This callback is used by multiple expression walkers.
1802*/
1803int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1804 UNUSED_PARAMETER(NotUsed);
1805 pWalker->eCode = 0;
1806 return WRC_Abort;
1807}
1808
1809/*
drh171d16b2018-02-26 20:15:54 +00001810** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001811** then convert it into an TK_TRUEFALSE term. Return non-zero if
1812** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001813*/
1814int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1815 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001816 if( !ExprHasProperty(pExpr, EP_Quoted)
1817 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1818 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001819 ){
1820 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001821 return 1;
1822 }
1823 return 0;
1824}
1825
drh43c4ac82018-02-26 21:26:27 +00001826/*
drh96acafb2018-02-27 14:49:25 +00001827** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001828** and 0 if it is FALSE.
1829*/
drh96acafb2018-02-27 14:49:25 +00001830int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001831 assert( pExpr->op==TK_TRUEFALSE );
1832 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1833 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1834 return pExpr->u.zToken[4]==0;
1835}
1836
drh171d16b2018-02-26 20:15:54 +00001837
1838/*
drh059b2d52014-10-24 19:28:09 +00001839** These routines are Walker callbacks used to check expressions to
1840** see if they are "constant" for some definition of constant. The
1841** Walker.eCode value determines the type of "constant" we are looking
1842** for.
drh73b211a2005-01-18 04:00:42 +00001843**
drh7d10d5a2008-08-20 16:35:10 +00001844** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001845**
drh059b2d52014-10-24 19:28:09 +00001846** sqlite3ExprIsConstant() pWalker->eCode==1
1847** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001848** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001849** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001850**
drh059b2d52014-10-24 19:28:09 +00001851** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1852** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001853**
drhfeada2d2014-09-24 13:20:22 +00001854** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001855** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1856** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001857** parameter raises an error for new statements, but is silently converted
1858** to NULL for existing schemas. This allows sqlite_master tables that
1859** contain a bound parameter because they were generated by older versions
1860** of SQLite to be parsed by newer versions of SQLite without raising a
1861** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001862*/
drh7d10d5a2008-08-20 16:35:10 +00001863static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001864
drh059b2d52014-10-24 19:28:09 +00001865 /* If pWalker->eCode is 2 then any term of the expression that comes from
1866 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001867 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001868 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1869 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001870 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001871 }
1872
drh626a8792005-01-17 22:08:19 +00001873 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001874 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001875 ** and either pWalker->eCode==4 or 5 or the function has the
1876 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001877 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001878 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001879 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001880 }else{
1881 pWalker->eCode = 0;
1882 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001883 }
drh626a8792005-01-17 22:08:19 +00001884 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001885 /* Convert "true" or "false" in a DEFAULT clause into the
1886 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001887 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001888 return WRC_Prune;
1889 }
1890 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001891 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001892 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001893 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001894 testcase( pExpr->op==TK_ID );
1895 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001896 testcase( pExpr->op==TK_AGG_FUNCTION );
1897 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001898 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001899 return WRC_Continue;
1900 }
drh059b2d52014-10-24 19:28:09 +00001901 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1902 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001903 }
drhf43ce0b2017-05-25 00:08:48 +00001904 /* Fall through */
1905 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001906 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001907 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001908 testcase( pExpr->op==TK_IF_NULL_ROW );
1909 pWalker->eCode = 0;
1910 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001911 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001912 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001913 /* Silently convert bound parameters that appear inside of CREATE
1914 ** statements into a NULL when parsing the CREATE statement text out
1915 ** of the sqlite_master table */
1916 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001917 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001918 /* A bound parameter in a CREATE statement that originates from
1919 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001920 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001921 return WRC_Abort;
1922 }
1923 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001924 default:
drh6e341b92018-04-17 18:50:40 +00001925 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1926 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001927 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001928 }
1929}
drh059b2d52014-10-24 19:28:09 +00001930static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001931 Walker w;
drh059b2d52014-10-24 19:28:09 +00001932 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001933 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001934 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001935#ifdef SQLITE_DEBUG
1936 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1937#endif
drh059b2d52014-10-24 19:28:09 +00001938 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001939 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001940 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001941}
drh626a8792005-01-17 22:08:19 +00001942
1943/*
drh059b2d52014-10-24 19:28:09 +00001944** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001945** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001946**
1947** For the purposes of this function, a double-quoted string (ex: "abc")
1948** is considered a variable but a single-quoted string (ex: 'abc') is
1949** a constant.
drhfef52082000-06-06 01:50:43 +00001950*/
danielk19774adee202004-05-08 08:23:19 +00001951int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001952 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001953}
1954
1955/*
drh07aded62018-07-28 16:24:08 +00001956** Walk an expression tree. Return non-zero if
1957**
1958** (1) the expression is constant, and
1959** (2) the expression does originate in the ON or USING clause
1960** of a LEFT JOIN, and
1961** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1962** operands created by the constant propagation optimization.
1963**
1964** When this routine returns true, it indicates that the expression
1965** can be added to the pParse->pConstExpr list and evaluated once when
1966** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001967*/
1968int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001969 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001970}
1971
1972/*
drhfcb9f4f2015-06-01 18:13:16 +00001973** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001974** for any single row of the table with cursor iCur. In other words, the
1975** expression must not refer to any non-deterministic function nor any
1976** table other than iCur.
1977*/
1978int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1979 return exprIsConst(p, 3, iCur);
1980}
1981
danab31a842017-04-29 20:53:09 +00001982
1983/*
1984** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1985*/
1986static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1987 ExprList *pGroupBy = pWalker->u.pGroupBy;
1988 int i;
1989
1990 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1991 ** it constant. */
1992 for(i=0; i<pGroupBy->nExpr; i++){
1993 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001994 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001995 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001996 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001997 return WRC_Prune;
1998 }
1999 }
2000 }
2001
2002 /* Check if pExpr is a sub-select. If so, consider it variable. */
2003 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2004 pWalker->eCode = 0;
2005 return WRC_Abort;
2006 }
2007
2008 return exprNodeIsConstant(pWalker, pExpr);
2009}
2010
2011/*
2012** Walk the expression tree passed as the first argument. Return non-zero
2013** if the expression consists entirely of constants or copies of terms
2014** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002015**
2016** This routine is used to determine if a term of the HAVING clause can
2017** be promoted into the WHERE clause. In order for such a promotion to work,
2018** the value of the HAVING clause term must be the same for all members of
2019** a "group". The requirement that the GROUP BY term must be BINARY
2020** assumes that no other collating sequence will have a finer-grained
2021** grouping than binary. In other words (A=B COLLATE binary) implies
2022** A=B in every other collating sequence. The requirement that the
2023** GROUP BY be BINARY is stricter than necessary. It would also work
2024** to promote HAVING clauses that use the same alternative collating
2025** sequence as the GROUP BY term, but that is much harder to check,
2026** alternative collating sequences are uncommon, and this is only an
2027** optimization, so we take the easy way out and simply require the
2028** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002029*/
2030int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2031 Walker w;
danab31a842017-04-29 20:53:09 +00002032 w.eCode = 1;
2033 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002034 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002035 w.u.pGroupBy = pGroupBy;
2036 w.pParse = pParse;
2037 sqlite3WalkExpr(&w, p);
2038 return w.eCode;
2039}
2040
drh059b2d52014-10-24 19:28:09 +00002041/*
2042** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002043** or a function call with constant arguments. Return and 0 if there
2044** are any variables.
2045**
2046** For the purposes of this function, a double-quoted string (ex: "abc")
2047** is considered a variable but a single-quoted string (ex: 'abc') is
2048** a constant.
2049*/
drhfeada2d2014-09-24 13:20:22 +00002050int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2051 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002052 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002053}
2054
drh5b88bc42013-12-07 23:35:21 +00002055#ifdef SQLITE_ENABLE_CURSOR_HINTS
2056/*
2057** Walk an expression tree. Return 1 if the expression contains a
2058** subquery of some kind. Return 0 if there are no subqueries.
2059*/
2060int sqlite3ExprContainsSubquery(Expr *p){
2061 Walker w;
drhbec24762015-08-13 20:07:13 +00002062 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002063 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002064 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002065#ifdef SQLITE_DEBUG
2066 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2067#endif
drh5b88bc42013-12-07 23:35:21 +00002068 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002069 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002070}
2071#endif
2072
drheb55bd22005-06-30 17:04:21 +00002073/*
drh73b211a2005-01-18 04:00:42 +00002074** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002075** to fit in a 32-bit integer, return 1 and put the value of the integer
2076** in *pValue. If the expression is not an integer or if it is too big
2077** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002078*/
danielk19774adee202004-05-08 08:23:19 +00002079int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002080 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002081 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002082
2083 /* If an expression is an integer literal that fits in a signed 32-bit
2084 ** integer, then the EP_IntValue flag will have already been set */
2085 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2086 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2087
drh92b01d52008-06-24 00:32:35 +00002088 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002089 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002090 return 1;
2091 }
drhe4de1fe2002-06-02 16:09:01 +00002092 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002093 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002094 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002095 break;
drh4b59ab52002-08-24 18:24:51 +00002096 }
drhe4de1fe2002-06-02 16:09:01 +00002097 case TK_UMINUS: {
2098 int v;
danielk19774adee202004-05-08 08:23:19 +00002099 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002100 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002101 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002102 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002103 }
2104 break;
2105 }
2106 default: break;
2107 }
drh92b01d52008-06-24 00:32:35 +00002108 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002109}
2110
2111/*
drh039fc322009-11-17 18:31:47 +00002112** Return FALSE if there is no chance that the expression can be NULL.
2113**
2114** If the expression might be NULL or if the expression is too complex
2115** to tell return TRUE.
2116**
2117** This routine is used as an optimization, to skip OP_IsNull opcodes
2118** when we know that a value cannot be NULL. Hence, a false positive
2119** (returning TRUE when in fact the expression can never be NULL) might
2120** be a small performance hit but is otherwise harmless. On the other
2121** hand, a false negative (returning FALSE when the result could be NULL)
2122** will likely result in an incorrect answer. So when in doubt, return
2123** TRUE.
2124*/
2125int sqlite3ExprCanBeNull(const Expr *p){
2126 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002127 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2128 p = p->pLeft;
2129 }
drh039fc322009-11-17 18:31:47 +00002130 op = p->op;
2131 if( op==TK_REGISTER ) op = p->op2;
2132 switch( op ){
2133 case TK_INTEGER:
2134 case TK_STRING:
2135 case TK_FLOAT:
2136 case TK_BLOB:
2137 return 0;
drh7248a8b2014-08-04 18:50:54 +00002138 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002139 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002140 p->y.pTab==0 || /* Reference to column of index on expression */
2141 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002142 default:
2143 return 1;
2144 }
2145}
2146
2147/*
2148** Return TRUE if the given expression is a constant which would be
2149** unchanged by OP_Affinity with the affinity given in the second
2150** argument.
2151**
2152** This routine is used to determine if the OP_Affinity operation
2153** can be omitted. When in doubt return FALSE. A false negative
2154** is harmless. A false positive, however, can result in the wrong
2155** answer.
2156*/
2157int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2158 u8 op;
drh05883a32015-06-02 15:32:08 +00002159 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002160 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002161 op = p->op;
2162 if( op==TK_REGISTER ) op = p->op2;
2163 switch( op ){
2164 case TK_INTEGER: {
2165 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2166 }
2167 case TK_FLOAT: {
2168 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2169 }
2170 case TK_STRING: {
2171 return aff==SQLITE_AFF_TEXT;
2172 }
2173 case TK_BLOB: {
2174 return 1;
2175 }
drh2f2855b2009-11-18 01:25:26 +00002176 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002177 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2178 return p->iColumn<0
2179 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002180 }
drh039fc322009-11-17 18:31:47 +00002181 default: {
2182 return 0;
2183 }
2184 }
2185}
2186
2187/*
drhc4a3c772001-04-04 11:48:57 +00002188** Return TRUE if the given string is a row-id column name.
2189*/
danielk19774adee202004-05-08 08:23:19 +00002190int sqlite3IsRowid(const char *z){
2191 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2192 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2193 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002194 return 0;
2195}
2196
danielk19779a96b662007-11-29 17:05:18 +00002197/*
drh69c355b2016-03-09 15:34:51 +00002198** pX is the RHS of an IN operator. If pX is a SELECT statement
2199** that can be simplified to a direct table access, then return
2200** a pointer to the SELECT statement. If pX is not a SELECT statement,
2201** or if the SELECT statement needs to be manifested into a transient
2202** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002203*/
2204#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002205static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002206 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002207 SrcList *pSrc;
2208 ExprList *pEList;
2209 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002210 int i;
drh69c355b2016-03-09 15:34:51 +00002211 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2212 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2213 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002214 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002215 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002216 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2217 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2218 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002219 }
drhb74b1012009-05-28 21:04:37 +00002220 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002221 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002222 if( p->pWhere ) return 0; /* Has no WHERE clause */
2223 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002224 assert( pSrc!=0 );
2225 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002226 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002227 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002228 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002229 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002230 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2231 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002232 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002233 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002234 for(i=0; i<pEList->nExpr; i++){
2235 Expr *pRes = pEList->a[i].pExpr;
2236 if( pRes->op!=TK_COLUMN ) return 0;
2237 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002238 }
drh69c355b2016-03-09 15:34:51 +00002239 return p;
drhb287f4b2008-04-25 00:08:38 +00002240}
2241#endif /* SQLITE_OMIT_SUBQUERY */
2242
danf9b2e052016-08-02 17:45:00 +00002243#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002244/*
drh4c259e92014-08-01 21:12:35 +00002245** Generate code that checks the left-most column of index table iCur to see if
2246** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002247** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2248** to be set to NULL if iCur contains one or more NULL values.
2249*/
2250static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002251 int addr1;
drh6be515e2014-08-01 21:00:53 +00002252 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002253 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002254 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2255 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002256 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002257 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002258}
danf9b2e052016-08-02 17:45:00 +00002259#endif
drh6be515e2014-08-01 21:00:53 +00002260
drhbb53ecb2014-08-02 21:03:33 +00002261
2262#ifndef SQLITE_OMIT_SUBQUERY
2263/*
2264** The argument is an IN operator with a list (not a subquery) on the
2265** right-hand side. Return TRUE if that list is constant.
2266*/
2267static int sqlite3InRhsIsConstant(Expr *pIn){
2268 Expr *pLHS;
2269 int res;
2270 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2271 pLHS = pIn->pLeft;
2272 pIn->pLeft = 0;
2273 res = sqlite3ExprIsConstant(pIn);
2274 pIn->pLeft = pLHS;
2275 return res;
2276}
2277#endif
2278
drh6be515e2014-08-01 21:00:53 +00002279/*
danielk19779a96b662007-11-29 17:05:18 +00002280** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002281** The pX parameter is the expression on the RHS of the IN operator, which
2282** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002283**
drhd4305ca2012-09-18 17:08:33 +00002284** The job of this routine is to find or create a b-tree object that can
2285** be used either to test for membership in the RHS set or to iterate through
2286** all members of the RHS set, skipping duplicates.
2287**
drh3a856252014-08-01 14:46:57 +00002288** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002289** and pX->iTable is set to the index of that cursor.
2290**
drhb74b1012009-05-28 21:04:37 +00002291** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002292**
drh1ccce442013-03-12 20:38:51 +00002293** IN_INDEX_ROWID - The cursor was opened on a database table.
2294** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2295** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2296** IN_INDEX_EPH - The cursor was opened on a specially created and
2297** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002298** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2299** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002300**
drhd4305ca2012-09-18 17:08:33 +00002301** An existing b-tree might be used if the RHS expression pX is a simple
2302** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002303**
dan553168c2016-08-01 20:14:31 +00002304** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002305**
drhd4305ca2012-09-18 17:08:33 +00002306** If the RHS of the IN operator is a list or a more complex subquery, then
2307** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002308** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002309** existing table.
drhd4305ca2012-09-18 17:08:33 +00002310**
drh7fc0ba02017-11-17 15:02:00 +00002311** The inFlags parameter must contain, at a minimum, one of the bits
2312** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2313** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2314** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2315** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002316**
2317** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2318** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002319** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002320** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2321** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002322**
drh3a856252014-08-01 14:46:57 +00002323** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2324** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002325** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2326** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002327**
drhbb53ecb2014-08-02 21:03:33 +00002328** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2329** if the RHS of the IN operator is a list (not a subquery) then this
2330** routine might decide that creating an ephemeral b-tree for membership
2331** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2332** calling routine should implement the IN operator using a sequence
2333** of Eq or Ne comparison operations.
2334**
drhb74b1012009-05-28 21:04:37 +00002335** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002336** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002337** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002338** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002339** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002340** to *prRhsHasNull. If there is no chance that the (...) contains a
2341** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002342**
drhe21a6e12014-08-01 18:00:24 +00002343** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002344** the value in that register will be NULL if the b-tree contains one or more
2345** NULL values, and it will be some non-NULL value if the b-tree contains no
2346** NULL values.
dan553168c2016-08-01 20:14:31 +00002347**
2348** If the aiMap parameter is not NULL, it must point to an array containing
2349** one element for each column returned by the SELECT statement on the RHS
2350** of the IN(...) operator. The i'th entry of the array is populated with the
2351** offset of the index column that matches the i'th column returned by the
2352** SELECT. For example, if the expression and selected index are:
2353**
2354** (?,?,?) IN (SELECT a, b, c FROM t1)
2355** CREATE INDEX i1 ON t1(b, c, a);
2356**
2357** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002358*/
danielk1977284f4ac2007-12-10 05:03:46 +00002359#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002360int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002361 Parse *pParse, /* Parsing context */
2362 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2363 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2364 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002365 int *aiMap, /* Mapping from Index fields to RHS fields */
2366 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002367){
drhb74b1012009-05-28 21:04:37 +00002368 Select *p; /* SELECT to the right of IN operator */
2369 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2370 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002371 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002372 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002373
drh1450bc62009-10-30 13:25:56 +00002374 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002375 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002376
dan7b35a772016-07-28 19:47:15 +00002377 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2378 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002379 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002380 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002381 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002382 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2383 int i;
2384 ExprList *pEList = pX->x.pSelect->pEList;
2385 for(i=0; i<pEList->nExpr; i++){
2386 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2387 }
2388 if( i==pEList->nExpr ){
2389 prRhsHasNull = 0;
2390 }
2391 }
2392
drhb74b1012009-05-28 21:04:37 +00002393 /* Check to see if an existing table or index can be used to
2394 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002395 ** ephemeral table. */
2396 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002397 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002398 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002399 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002400 ExprList *pEList = p->pEList;
2401 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002402
drhb07028f2011-10-14 21:49:18 +00002403 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2404 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2405 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2406 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002407
drhb22f7c82014-02-06 23:56:27 +00002408 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002409 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2410 sqlite3CodeVerifySchema(pParse, iDb);
2411 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002412
drha84a2832016-08-26 21:15:35 +00002413 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002414 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002415 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002416 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002417 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002418
2419 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2420 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002421 ExplainQueryPlan((pParse, 0,
2422 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002423 sqlite3VdbeJumpHere(v, iAddr);
2424 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002425 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002426 int affinity_ok = 1;
2427 int i;
2428
2429 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002430 ** comparison is the same as the affinity of each column in table
2431 ** on the RHS of the IN operator. If it not, it is not possible to
2432 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002433 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002434 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002435 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002436 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002437 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002438 testcase( cmpaff==SQLITE_AFF_BLOB );
2439 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002440 switch( cmpaff ){
2441 case SQLITE_AFF_BLOB:
2442 break;
2443 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002444 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2445 ** other has no affinity and the other side is TEXT. Hence,
2446 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2447 ** and for the term on the LHS of the IN to have no affinity. */
2448 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002449 break;
2450 default:
2451 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2452 }
2453 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002454
drha84a2832016-08-26 21:15:35 +00002455 if( affinity_ok ){
2456 /* Search for an existing index that will work for this IN operator */
2457 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2458 Bitmask colUsed; /* Columns of the index used */
2459 Bitmask mCol; /* Mask for the current column */
2460 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002461 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002462 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2463 ** BITMASK(nExpr) without overflowing */
2464 testcase( pIdx->nColumn==BMS-2 );
2465 testcase( pIdx->nColumn==BMS-1 );
2466 if( pIdx->nColumn>=BMS-1 ) continue;
2467 if( mustBeUnique ){
2468 if( pIdx->nKeyCol>nExpr
2469 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2470 ){
2471 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002472 }
danielk19770cdc0222008-06-26 18:04:03 +00002473 }
drha84a2832016-08-26 21:15:35 +00002474
2475 colUsed = 0; /* Columns of index used so far */
2476 for(i=0; i<nExpr; i++){
2477 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2478 Expr *pRhs = pEList->a[i].pExpr;
2479 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2480 int j;
2481
2482 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2483 for(j=0; j<nExpr; j++){
2484 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2485 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002486 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2487 continue;
2488 }
drha84a2832016-08-26 21:15:35 +00002489 break;
2490 }
2491 if( j==nExpr ) break;
2492 mCol = MASKBIT(j);
2493 if( mCol & colUsed ) break; /* Each column used only once */
2494 colUsed |= mCol;
2495 if( aiMap ) aiMap[i] = j;
2496 }
2497
2498 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2499 if( colUsed==(MASKBIT(nExpr)-1) ){
2500 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002501 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002502 ExplainQueryPlan((pParse, 0,
2503 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002504 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2505 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2506 VdbeComment((v, "%s", pIdx->zName));
2507 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2508 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2509
2510 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002511#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002512 i64 mask = (1<<nExpr)-1;
2513 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2514 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002515#endif
2516 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002517 if( nExpr==1 ){
2518 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2519 }
2520 }
2521 sqlite3VdbeJumpHere(v, iAddr);
2522 }
2523 } /* End loop over indexes */
2524 } /* End if( affinity_ok ) */
2525 } /* End if not an rowid index */
2526 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002527
drhbb53ecb2014-08-02 21:03:33 +00002528 /* If no preexisting index is available for the IN clause
2529 ** and IN_INDEX_NOOP is an allowed reply
2530 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002531 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002532 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002533 ** the IN operator so return IN_INDEX_NOOP.
2534 */
2535 if( eType==0
2536 && (inFlags & IN_INDEX_NOOP_OK)
2537 && !ExprHasProperty(pX, EP_xIsSelect)
2538 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2539 ){
2540 eType = IN_INDEX_NOOP;
2541 }
drhbb53ecb2014-08-02 21:03:33 +00002542
danielk19779a96b662007-11-29 17:05:18 +00002543 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002544 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002545 ** We will have to generate an ephemeral table to do the job.
2546 */
drh8e23daf2013-06-11 13:30:04 +00002547 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002548 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002549 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002550 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002551 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002552 }else if( prRhsHasNull ){
2553 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002554 }
drh85bcdce2018-12-23 21:27:29 +00002555 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002556 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002557 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002558 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002559 }
drhcf4d38a2010-07-28 02:53:36 +00002560 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002561 }
danba00e302016-07-23 20:24:06 +00002562
2563 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2564 int i, n;
2565 n = sqlite3ExprVectorSize(pX->pLeft);
2566 for(i=0; i<n; i++) aiMap[i] = i;
2567 }
drh2c041312018-12-24 02:34:49 +00002568 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002569 return eType;
2570}
danielk1977284f4ac2007-12-10 05:03:46 +00002571#endif
drh626a8792005-01-17 22:08:19 +00002572
danf9b2e052016-08-02 17:45:00 +00002573#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002574/*
2575** Argument pExpr is an (?, ?...) IN(...) expression. This
2576** function allocates and returns a nul-terminated string containing
2577** the affinities to be used for each column of the comparison.
2578**
2579** It is the responsibility of the caller to ensure that the returned
2580** string is eventually freed using sqlite3DbFree().
2581*/
dan71c57db2016-07-09 20:23:55 +00002582static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2583 Expr *pLeft = pExpr->pLeft;
2584 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002585 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002586 char *zRet;
2587
dan553168c2016-08-01 20:14:31 +00002588 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002589 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002590 if( zRet ){
2591 int i;
2592 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002593 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002594 char a = sqlite3ExprAffinity(pA);
2595 if( pSelect ){
2596 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2597 }else{
2598 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002599 }
dan71c57db2016-07-09 20:23:55 +00002600 }
2601 zRet[nVal] = '\0';
2602 }
2603 return zRet;
2604}
danf9b2e052016-08-02 17:45:00 +00002605#endif
dan71c57db2016-07-09 20:23:55 +00002606
dan8da209b2016-07-26 18:06:08 +00002607#ifndef SQLITE_OMIT_SUBQUERY
2608/*
2609** Load the Parse object passed as the first argument with an error
2610** message of the form:
2611**
2612** "sub-select returns N columns - expected M"
2613*/
2614void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2615 const char *zFmt = "sub-select returns %d columns - expected %d";
2616 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2617}
2618#endif
2619
drh626a8792005-01-17 22:08:19 +00002620/*
dan44c56042016-12-07 15:38:37 +00002621** Expression pExpr is a vector that has been used in a context where
2622** it is not permitted. If pExpr is a sub-select vector, this routine
2623** loads the Parse object with a message of the form:
2624**
2625** "sub-select returns N columns - expected 1"
2626**
2627** Or, if it is a regular scalar vector:
2628**
2629** "row value misused"
2630*/
2631void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2632#ifndef SQLITE_OMIT_SUBQUERY
2633 if( pExpr->flags & EP_xIsSelect ){
2634 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2635 }else
2636#endif
2637 {
2638 sqlite3ErrorMsg(pParse, "row value misused");
2639 }
2640}
2641
drh85bcdce2018-12-23 21:27:29 +00002642#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002643/*
drh85bcdce2018-12-23 21:27:29 +00002644** Generate code that will construct an ephemeral table containing all terms
2645** in the RHS of an IN operator. The IN operator can be in either of two
2646** forms:
drh626a8792005-01-17 22:08:19 +00002647**
drh9cbe6352005-11-29 03:13:21 +00002648** x IN (4,5,11) -- IN operator with list on right-hand side
2649** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002650**
drh2c041312018-12-24 02:34:49 +00002651** The pExpr parameter is the IN operator. The cursor number for the
2652** constructed ephermeral table is returned. The first time the ephemeral
2653** table is computed, the cursor number is also stored in pExpr->iTable,
2654** however the cursor number returned might not be the same, as it might
2655** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002656**
drh85bcdce2018-12-23 21:27:29 +00002657** If the LHS expression ("x" in the examples) is a column value, or
2658** the SELECT statement returns a column value, then the affinity of that
2659** column is used to build the index keys. If both 'x' and the
2660** SELECT... statement are columns, then numeric affinity is used
2661** if either column has NUMERIC or INTEGER affinity. If neither
2662** 'x' nor the SELECT... statement are columns, then numeric affinity
2663** is used.
drhcce7d172000-05-31 15:34:51 +00002664*/
drh85bcdce2018-12-23 21:27:29 +00002665void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002666 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002667 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002668 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002669){
drh2c041312018-12-24 02:34:49 +00002670 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002671 int addr; /* Address of OP_OpenEphemeral instruction */
2672 Expr *pLeft; /* the LHS of the IN operator */
2673 KeyInfo *pKeyInfo = 0; /* Key information */
2674 int nVal; /* Size of vector pLeft */
2675 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002676
drh2c041312018-12-24 02:34:49 +00002677 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002678 assert( v!=0 );
2679
drh2c041312018-12-24 02:34:49 +00002680 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002681 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002682 **
2683 ** * The right-hand side is a correlated subquery
2684 ** * The right-hand side is an expression list containing variables
2685 ** * We are inside a trigger
2686 **
drh2c041312018-12-24 02:34:49 +00002687 ** If all of the above are false, then we can compute the RHS just once
2688 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002689 */
drhefb699f2018-12-24 11:55:44 +00002690 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002691 /* Reuse of the RHS is allowed */
2692 /* If this routine has already been coded, but the previous code
2693 ** might not have been invoked yet, so invoke it now as a subroutine.
2694 */
2695 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002696 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002697 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2698 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2699 pExpr->x.pSelect->selId));
2700 }
drh2c041312018-12-24 02:34:49 +00002701 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2702 pExpr->y.sub.iAddr);
2703 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002704 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002705 return;
2706 }
2707
2708 /* Begin coding the subroutine */
2709 ExprSetProperty(pExpr, EP_Subrtn);
2710 pExpr->y.sub.regReturn = ++pParse->nMem;
2711 pExpr->y.sub.iAddr =
2712 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2713 VdbeComment((v, "return address"));
2714
2715 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002716 }
2717
drh85bcdce2018-12-23 21:27:29 +00002718 /* Check to see if this is a vector IN operator */
2719 pLeft = pExpr->pLeft;
2720 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002721
drh85bcdce2018-12-23 21:27:29 +00002722 /* Construct the ephemeral table that will contain the content of
2723 ** RHS of the IN operator.
2724 */
drh2c041312018-12-24 02:34:49 +00002725 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002726 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002727#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2728 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2729 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2730 }else{
2731 VdbeComment((v, "RHS of IN operator"));
2732 }
2733#endif
drh50ef6712019-02-22 23:29:56 +00002734 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002735
drh85bcdce2018-12-23 21:27:29 +00002736 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2737 /* Case 1: expr IN (SELECT ...)
2738 **
2739 ** Generate code to write the results of the select into the temporary
2740 ** table allocated and opened above.
2741 */
2742 Select *pSelect = pExpr->x.pSelect;
2743 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002744
drh2c041312018-12-24 02:34:49 +00002745 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2746 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002747 ));
drh85bcdce2018-12-23 21:27:29 +00002748 /* If the LHS and RHS of the IN operator do not match, that
2749 ** error will have been caught long before we reach this point. */
2750 if( ALWAYS(pEList->nExpr==nVal) ){
2751 SelectDest dest;
2752 int i;
drhbd462bc2018-12-24 20:21:06 +00002753 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002754 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2755 pSelect->iLimit = 0;
2756 testcase( pSelect->selFlags & SF_Distinct );
2757 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2758 if( sqlite3Select(pParse, pSelect, &dest) ){
2759 sqlite3DbFree(pParse->db, dest.zAffSdst);
2760 sqlite3KeyInfoUnref(pKeyInfo);
2761 return;
drhfef52082000-06-06 01:50:43 +00002762 }
drh85bcdce2018-12-23 21:27:29 +00002763 sqlite3DbFree(pParse->db, dest.zAffSdst);
2764 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2765 assert( pEList!=0 );
2766 assert( pEList->nExpr>0 );
2767 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2768 for(i=0; i<nVal; i++){
2769 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2770 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2771 pParse, p, pEList->a[i].pExpr
2772 );
danielk197741a05b72008-10-02 13:50:55 +00002773 }
drh85bcdce2018-12-23 21:27:29 +00002774 }
2775 }else if( ALWAYS(pExpr->x.pList!=0) ){
2776 /* Case 2: expr IN (exprlist)
2777 **
2778 ** For each expression, build an index key from the evaluation and
2779 ** store it in the temporary table. If <expr> is a column, then use
2780 ** that columns affinity when building index keys. If <expr> is not
2781 ** a column, use numeric affinity.
2782 */
2783 char affinity; /* Affinity of the LHS of the IN */
2784 int i;
2785 ExprList *pList = pExpr->x.pList;
2786 struct ExprList_item *pItem;
2787 int r1, r2, r3;
2788 affinity = sqlite3ExprAffinity(pLeft);
2789 if( !affinity ){
2790 affinity = SQLITE_AFF_BLOB;
2791 }
2792 if( pKeyInfo ){
2793 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2794 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002795 }
2796
drh85bcdce2018-12-23 21:27:29 +00002797 /* Loop through each expression in <exprlist>. */
2798 r1 = sqlite3GetTempReg(pParse);
2799 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002800 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2801 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002802
2803 /* If the expression is not constant then we will need to
2804 ** disable the test that was generated above that makes sure
2805 ** this code only executes once. Because for a non-constant
2806 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002807 */
drh2c041312018-12-24 02:34:49 +00002808 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2809 sqlite3VdbeChangeToNoop(v, addrOnce);
2810 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002811 }
drh1398ad32005-01-19 23:24:50 +00002812
drh85bcdce2018-12-23 21:27:29 +00002813 /* Evaluate the expression and insert it into the temp table */
drh50ef6712019-02-22 23:29:56 +00002814 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2815 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2816 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drhcce7d172000-05-31 15:34:51 +00002817 }
drh85bcdce2018-12-23 21:27:29 +00002818 sqlite3ReleaseTempReg(pParse, r1);
2819 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002820 }
drh85bcdce2018-12-23 21:27:29 +00002821 if( pKeyInfo ){
2822 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2823 }
drh2c041312018-12-24 02:34:49 +00002824 if( addrOnce ){
2825 sqlite3VdbeJumpHere(v, addrOnce);
2826 /* Subroutine return */
2827 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2828 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002829 }
2830}
2831#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002832
drh85bcdce2018-12-23 21:27:29 +00002833/*
2834** Generate code for scalar subqueries used as a subquery expression
2835** or EXISTS operator:
2836**
2837** (SELECT a FROM b) -- subquery
2838** EXISTS (SELECT a FROM b) -- EXISTS subquery
2839**
2840** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2841**
2842** The register that holds the result. For a multi-column SELECT,
2843** the result is stored in a contiguous array of registers and the
2844** return value is the register of the left-most result column.
2845** Return 0 if an error occurs.
2846*/
2847#ifndef SQLITE_OMIT_SUBQUERY
2848int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002849 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002850 int rReg = 0; /* Register storing resulting */
2851 Select *pSel; /* SELECT statement to encode */
2852 SelectDest dest; /* How to deal with SELECT result */
2853 int nReg; /* Registers to allocate */
2854 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002855
2856 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002857 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002858 testcase( pExpr->op==TK_EXISTS );
2859 testcase( pExpr->op==TK_SELECT );
2860 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2861 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2862 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002863
drh5198ff52018-12-24 12:09:47 +00002864 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002865 ** is encountered if any of the following is true:
2866 **
2867 ** * The right-hand side is a correlated subquery
2868 ** * The right-hand side is an expression list containing variables
2869 ** * We are inside a trigger
2870 **
2871 ** If all of the above are false, then we can run this code just once
2872 ** save the results, and reuse the same result on subsequent invocations.
2873 */
2874 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002875 /* If this routine has already been coded, then invoke it as a
2876 ** subroutine. */
2877 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002878 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002879 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2880 pExpr->y.sub.iAddr);
2881 return pExpr->iTable;
2882 }
2883
2884 /* Begin coding the subroutine */
2885 ExprSetProperty(pExpr, EP_Subrtn);
2886 pExpr->y.sub.regReturn = ++pParse->nMem;
2887 pExpr->y.sub.iAddr =
2888 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2889 VdbeComment((v, "return address"));
2890
drh2c041312018-12-24 02:34:49 +00002891 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002892 }
drh85bcdce2018-12-23 21:27:29 +00002893
2894 /* For a SELECT, generate code to put the values for all columns of
2895 ** the first row into an array of registers and return the index of
2896 ** the first register.
2897 **
2898 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2899 ** into a register and return that register number.
2900 **
2901 ** In both cases, the query is augmented with "LIMIT 1". Any
2902 ** preexisting limit is discarded in place of the new LIMIT 1.
2903 */
drhbd462bc2018-12-24 20:21:06 +00002904 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2905 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002906 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2907 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2908 pParse->nMem += nReg;
2909 if( pExpr->op==TK_SELECT ){
2910 dest.eDest = SRT_Mem;
2911 dest.iSdst = dest.iSDParm;
2912 dest.nSdst = nReg;
2913 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2914 VdbeComment((v, "Init subquery result"));
2915 }else{
2916 dest.eDest = SRT_Exists;
2917 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2918 VdbeComment((v, "Init EXISTS result"));
2919 }
2920 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2921 if( pSel->pLimit ){
2922 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2923 pSel->pLimit->pLeft = pLimit;
2924 }else{
2925 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2926 }
2927 pSel->iLimit = 0;
2928 if( sqlite3Select(pParse, pSel, &dest) ){
2929 return 0;
2930 }
drh2c041312018-12-24 02:34:49 +00002931 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002932 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002933 if( addrOnce ){
2934 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002935
drh5198ff52018-12-24 12:09:47 +00002936 /* Subroutine return */
2937 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2938 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2939 }
drh2c041312018-12-24 02:34:49 +00002940
drh1450bc62009-10-30 13:25:56 +00002941 return rReg;
drhcce7d172000-05-31 15:34:51 +00002942}
drh51522cd2005-01-20 13:36:19 +00002943#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002944
drhe3365e62009-11-12 17:52:24 +00002945#ifndef SQLITE_OMIT_SUBQUERY
2946/*
dan7b35a772016-07-28 19:47:15 +00002947** Expr pIn is an IN(...) expression. This function checks that the
2948** sub-select on the RHS of the IN() operator has the same number of
2949** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2950** a sub-query, that the LHS is a vector of size 1.
2951*/
2952int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2953 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2954 if( (pIn->flags & EP_xIsSelect) ){
2955 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2956 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2957 return 1;
2958 }
2959 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002960 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002961 return 1;
2962 }
2963 return 0;
2964}
2965#endif
2966
2967#ifndef SQLITE_OMIT_SUBQUERY
2968/*
drhe3365e62009-11-12 17:52:24 +00002969** Generate code for an IN expression.
2970**
2971** x IN (SELECT ...)
2972** x IN (value, value, ...)
2973**
drhecb87ac2016-08-25 15:46:25 +00002974** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002975** right-hand side (RHS) is an array of zero or more scalar values, or a
2976** subquery. If the RHS is a subquery, the number of result columns must
2977** match the number of columns in the vector on the LHS. If the RHS is
2978** a list of values, the LHS must be a scalar.
2979**
2980** The IN operator is true if the LHS value is contained within the RHS.
2981** The result is false if the LHS is definitely not in the RHS. The
2982** result is NULL if the presence of the LHS in the RHS cannot be
2983** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002984**
drh6be515e2014-08-01 21:00:53 +00002985** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002986** contained within the RHS. If due to NULLs we cannot determine if the LHS
2987** is contained in the RHS then jump to destIfNull. If the LHS is contained
2988** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002989**
2990** See the separate in-operator.md documentation file in the canonical
2991** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002992*/
2993static void sqlite3ExprCodeIN(
2994 Parse *pParse, /* Parsing and code generating context */
2995 Expr *pExpr, /* The IN expression */
2996 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2997 int destIfNull /* Jump here if the results are unknown due to NULLs */
2998){
2999 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003000 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003001 int rLhs; /* Register(s) holding the LHS values */
3002 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003003 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003004 int *aiMap = 0; /* Map from vector field to index column */
3005 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003006 int nVector; /* Size of vectors for this IN operator */
3007 int iDummy; /* Dummy parameter to exprCodeVector() */
3008 Expr *pLeft; /* The LHS of the IN operator */
3009 int i; /* loop counter */
3010 int destStep2; /* Where to jump when NULLs seen in step 2 */
3011 int destStep6 = 0; /* Start of code for Step 6 */
3012 int addrTruthOp; /* Address of opcode that determines the IN is true */
3013 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3014 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003015 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003016
drhe347d3e2016-08-25 21:14:34 +00003017 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003018 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003019 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003020 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3021 aiMap = (int*)sqlite3DbMallocZero(
3022 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3023 );
drhe347d3e2016-08-25 21:14:34 +00003024 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003025
danba00e302016-07-23 20:24:06 +00003026 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003027 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003028 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3029 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003030 v = pParse->pVdbe;
3031 assert( v!=0 ); /* OOM detected prior to this routine */
3032 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003033 eType = sqlite3FindInIndex(pParse, pExpr,
3034 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003035 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3036 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003037
danba00e302016-07-23 20:24:06 +00003038 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3039 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3040 );
drhecb87ac2016-08-25 15:46:25 +00003041#ifdef SQLITE_DEBUG
3042 /* Confirm that aiMap[] contains nVector integer values between 0 and
3043 ** nVector-1. */
3044 for(i=0; i<nVector; i++){
3045 int j, cnt;
3046 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3047 assert( cnt==1 );
3048 }
3049#endif
drhe3365e62009-11-12 17:52:24 +00003050
danba00e302016-07-23 20:24:06 +00003051 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3052 ** vector, then it is stored in an array of nVector registers starting
3053 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003054 **
3055 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3056 ** so that the fields are in the same order as an existing index. The
3057 ** aiMap[] array contains a mapping from the original LHS field order to
3058 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003059 */
drhe347d3e2016-08-25 21:14:34 +00003060 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3061 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003062 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003063 /* LHS fields are not reordered */
3064 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003065 }else{
3066 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003067 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003068 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003069 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003070 }
danba00e302016-07-23 20:24:06 +00003071 }
drhe3365e62009-11-12 17:52:24 +00003072
drhbb53ecb2014-08-02 21:03:33 +00003073 /* If sqlite3FindInIndex() did not find or create an index that is
3074 ** suitable for evaluating the IN operator, then evaluate using a
3075 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003076 **
3077 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003078 */
drhbb53ecb2014-08-02 21:03:33 +00003079 if( eType==IN_INDEX_NOOP ){
3080 ExprList *pList = pExpr->x.pList;
3081 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003082 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003083 int r2, regToFree;
3084 int regCkNull = 0;
3085 int ii;
3086 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003087 if( destIfNull!=destIfFalse ){
3088 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003089 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003090 }
3091 for(ii=0; ii<pList->nExpr; ii++){
3092 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003093 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003094 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3095 }
3096 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003097 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003098 (void*)pColl, P4_COLLSEQ);
3099 VdbeCoverageIf(v, ii<pList->nExpr-1);
3100 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003101 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003102 }else{
3103 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003104 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003105 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003106 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003107 }
3108 sqlite3ReleaseTempReg(pParse, regToFree);
3109 }
3110 if( regCkNull ){
3111 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003112 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003113 }
3114 sqlite3VdbeResolveLabel(v, labelOk);
3115 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003116 goto sqlite3ExprCodeIN_finished;
3117 }
3118
3119 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3120 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3121 ** We will then skip the binary search of the RHS.
3122 */
3123 if( destIfNull==destIfFalse ){
3124 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003125 }else{
drhec4ccdb2018-12-29 02:26:59 +00003126 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003127 }
3128 for(i=0; i<nVector; i++){
3129 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3130 if( sqlite3ExprCanBeNull(p) ){
3131 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003132 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003133 }
drhe3365e62009-11-12 17:52:24 +00003134 }
drhe347d3e2016-08-25 21:14:34 +00003135
3136 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3137 ** of the RHS using the LHS as a probe. If found, the result is
3138 ** true.
3139 */
3140 if( eType==IN_INDEX_ROWID ){
3141 /* In this case, the RHS is the ROWID of table b-tree and so we also
3142 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3143 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003144 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003145 VdbeCoverage(v);
3146 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3147 }else{
3148 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3149 if( destIfFalse==destIfNull ){
3150 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003151 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003152 rLhs, nVector); VdbeCoverage(v);
3153 goto sqlite3ExprCodeIN_finished;
3154 }
3155 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003156 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003157 rLhs, nVector); VdbeCoverage(v);
3158 }
3159
3160 /* Step 4. If the RHS is known to be non-NULL and we did not find
3161 ** an match on the search above, then the result must be FALSE.
3162 */
3163 if( rRhsHasNull && nVector==1 ){
3164 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3165 VdbeCoverage(v);
3166 }
3167
3168 /* Step 5. If we do not care about the difference between NULL and
3169 ** FALSE, then just return false.
3170 */
3171 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3172
3173 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3174 ** If any comparison is NULL, then the result is NULL. If all
3175 ** comparisons are FALSE then the final result is FALSE.
3176 **
3177 ** For a scalar LHS, it is sufficient to check just the first row
3178 ** of the RHS.
3179 */
3180 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003181 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003182 VdbeCoverage(v);
3183 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003184 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003185 }else{
3186 /* For nVector==1, combine steps 6 and 7 by immediately returning
3187 ** FALSE if the first comparison is not NULL */
3188 destNotNull = destIfFalse;
3189 }
3190 for(i=0; i<nVector; i++){
3191 Expr *p;
3192 CollSeq *pColl;
3193 int r3 = sqlite3GetTempReg(pParse);
3194 p = sqlite3VectorFieldSubexpr(pLeft, i);
3195 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003196 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003197 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3198 (void*)pColl, P4_COLLSEQ);
3199 VdbeCoverage(v);
3200 sqlite3ReleaseTempReg(pParse, r3);
3201 }
3202 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3203 if( nVector>1 ){
3204 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003205 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003206 VdbeCoverage(v);
3207
3208 /* Step 7: If we reach this point, we know that the result must
3209 ** be false. */
3210 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3211 }
3212
3213 /* Jumps here in order to return true. */
3214 sqlite3VdbeJumpHere(v, addrTruthOp);
3215
3216sqlite3ExprCodeIN_finished:
3217 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003218 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003219sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003220 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003221 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003222}
3223#endif /* SQLITE_OMIT_SUBQUERY */
3224
drh13573c72010-01-12 17:04:07 +00003225#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003226/*
3227** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003228** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003229**
3230** The z[] string will probably not be zero-terminated. But the
3231** z[n] character is guaranteed to be something that does not look
3232** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003233*/
drhb7916a72009-05-27 10:31:29 +00003234static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003235 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003236 double value;
drh9339da12010-09-30 00:50:49 +00003237 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003238 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3239 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003240 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003241 }
3242}
drh13573c72010-01-12 17:04:07 +00003243#endif
drh598f1342007-10-23 15:39:45 +00003244
3245
3246/*
drhfec19aa2004-05-19 20:41:03 +00003247** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003248** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003249**
shaneh5f1d6b62010-09-30 16:51:25 +00003250** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003251*/
drh13573c72010-01-12 17:04:07 +00003252static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3253 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003254 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003255 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003256 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003257 if( negFlag ) i = -i;
3258 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003259 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003260 int c;
3261 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003262 const char *z = pExpr->u.zToken;
3263 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003264 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003265 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003266#ifdef SQLITE_OMIT_FLOATING_POINT
3267 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3268#else
drh1b7ddc52014-07-23 14:52:05 +00003269#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003270 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003271 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003272 }else
3273#endif
3274 {
drh9296c182014-07-23 13:40:49 +00003275 codeReal(v, z, negFlag, iMem);
3276 }
drh13573c72010-01-12 17:04:07 +00003277#endif
drh77320ea2016-11-30 14:47:37 +00003278 }else{
drh84d4f1a2017-09-20 10:47:10 +00003279 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003280 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003281 }
drhfec19aa2004-05-19 20:41:03 +00003282 }
3283}
3284
drh5cd79232009-05-25 11:46:29 +00003285
drh1f9ca2c2015-08-25 16:57:52 +00003286/* Generate code that will load into register regOut a value that is
3287** appropriate for the iIdxCol-th column of index pIdx.
3288*/
3289void sqlite3ExprCodeLoadIndexColumn(
3290 Parse *pParse, /* The parsing context */
3291 Index *pIdx, /* The index whose column is to be loaded */
3292 int iTabCur, /* Cursor pointing to a table row */
3293 int iIdxCol, /* The column of the index to be loaded */
3294 int regOut /* Store the index column value in this register */
3295){
3296 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003297 if( iTabCol==XN_EXPR ){
3298 assert( pIdx->aColExpr );
3299 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003300 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003301 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003302 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003303 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003304 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3305 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003306 }
drh1f9ca2c2015-08-25 16:57:52 +00003307}
3308
drh5cd79232009-05-25 11:46:29 +00003309/*
drh5c092e82010-05-14 19:24:02 +00003310** Generate code to extract the value of the iCol-th column of a table.
3311*/
3312void sqlite3ExprCodeGetColumnOfTable(
3313 Vdbe *v, /* The VDBE under construction */
3314 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003315 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003316 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003317 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003318){
drhaca19e12017-04-07 19:41:31 +00003319 if( pTab==0 ){
3320 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3321 return;
3322 }
drh5c092e82010-05-14 19:24:02 +00003323 if( iCol<0 || iCol==pTab->iPKey ){
3324 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3325 }else{
3326 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003327 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003328 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003329 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3330 }
3331 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003332 }
3333 if( iCol>=0 ){
3334 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3335 }
3336}
3337
3338/*
drh945498f2007-02-24 11:52:52 +00003339** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003340** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003341**
3342** There must be an open cursor to pTab in iTable when this routine
3343** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003344*/
drhe55cbd72008-03-31 23:48:03 +00003345int sqlite3ExprCodeGetColumn(
3346 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003347 Table *pTab, /* Description of the table we are reading from */
3348 int iColumn, /* Index of the table column */
3349 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003350 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003351 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003352){
drhe55cbd72008-03-31 23:48:03 +00003353 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003354 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003355 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003356 if( p5 ){
3357 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003358 }
drhe55cbd72008-03-31 23:48:03 +00003359 return iReg;
3360}
drhe55cbd72008-03-31 23:48:03 +00003361
3362/*
drhb21e7c72008-06-22 12:37:57 +00003363** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003364** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003365*/
drhb21e7c72008-06-22 12:37:57 +00003366void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003367 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003368 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003369}
3370
drh652fbf52008-04-01 01:42:41 +00003371/*
drh12abf402016-08-22 14:30:05 +00003372** Convert a scalar expression node to a TK_REGISTER referencing
3373** register iReg. The caller must ensure that iReg already contains
3374** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003375*/
3376static void exprToRegister(Expr *p, int iReg){
3377 p->op2 = p->op;
3378 p->op = TK_REGISTER;
3379 p->iTable = iReg;
3380 ExprClearProperty(p, EP_Skip);
3381}
3382
drh12abf402016-08-22 14:30:05 +00003383/*
3384** Evaluate an expression (either a vector or a scalar expression) and store
3385** the result in continguous temporary registers. Return the index of
3386** the first register used to store the result.
3387**
3388** If the returned result register is a temporary scalar, then also write
3389** that register number into *piFreeable. If the returned result register
3390** is not a temporary or if the expression is a vector set *piFreeable
3391** to 0.
3392*/
3393static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3394 int iResult;
3395 int nResult = sqlite3ExprVectorSize(p);
3396 if( nResult==1 ){
3397 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3398 }else{
3399 *piFreeable = 0;
3400 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003401#if SQLITE_OMIT_SUBQUERY
3402 iResult = 0;
3403#else
drh85bcdce2018-12-23 21:27:29 +00003404 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003405#endif
drh12abf402016-08-22 14:30:05 +00003406 }else{
3407 int i;
3408 iResult = pParse->nMem+1;
3409 pParse->nMem += nResult;
3410 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003411 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003412 }
3413 }
3414 }
3415 return iResult;
3416}
3417
dan71c57db2016-07-09 20:23:55 +00003418
drha4c3c872013-09-12 17:29:25 +00003419/*
drhcce7d172000-05-31 15:34:51 +00003420** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003421** expression. Attempt to store the results in register "target".
3422** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003423**
drh8b213892008-08-29 02:14:02 +00003424** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003425** be stored in target. The result might be stored in some other
3426** register if it is convenient to do so. The calling function
3427** must check the return code and move the results to the desired
3428** register.
drhcce7d172000-05-31 15:34:51 +00003429*/
drh678ccce2008-03-31 18:19:54 +00003430int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003431 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3432 int op; /* The opcode being coded */
3433 int inReg = target; /* Results stored in register inReg */
3434 int regFree1 = 0; /* If non-zero free this temporary register */
3435 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003436 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003437 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003438 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003439
drh9cbf3422008-01-17 16:22:13 +00003440 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003441 if( v==0 ){
3442 assert( pParse->db->mallocFailed );
3443 return 0;
3444 }
drh389a1ad2008-01-03 23:44:53 +00003445
drh1efa8022018-04-28 04:16:43 +00003446expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003447 if( pExpr==0 ){
3448 op = TK_NULL;
3449 }else{
3450 op = pExpr->op;
3451 }
drhf2bc0132004-10-04 13:19:23 +00003452 switch( op ){
drh13449892005-09-07 21:22:45 +00003453 case TK_AGG_COLUMN: {
3454 AggInfo *pAggInfo = pExpr->pAggInfo;
3455 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3456 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003457 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003458 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003459 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003460 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003461 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003462 return target;
drh13449892005-09-07 21:22:45 +00003463 }
3464 /* Otherwise, fall thru into the TK_COLUMN case */
3465 }
drh967e8b72000-06-21 13:59:10 +00003466 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003467 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003468 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003469 /* This COLUMN expression is really a constant due to WHERE clause
3470 ** constraints, and that constant is coded by the pExpr->pLeft
3471 ** expresssion. However, make sure the constant has the correct
3472 ** datatype by applying the Affinity of the table column to the
3473 ** constant.
3474 */
3475 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003476 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003477 if( aff!=SQLITE_AFF_BLOB ){
3478 static const char zAff[] = "B\000C\000D\000E";
3479 assert( SQLITE_AFF_BLOB=='A' );
3480 assert( SQLITE_AFF_TEXT=='B' );
3481 if( iReg!=target ){
3482 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3483 iReg = target;
3484 }
3485 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3486 &zAff[(aff-'B')*2], P4_STATIC);
3487 }
3488 return iReg;
drhefad2e22018-07-27 16:57:11 +00003489 }
drhb2b9d3d2013-08-01 01:14:43 +00003490 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003491 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003492 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003493 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003494 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003495 /* Coding an expression that is part of an index where column names
3496 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003497 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003498 }
drh22827922000-06-06 17:27:05 +00003499 }
drheda079c2018-09-20 19:02:15 +00003500 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003501 pExpr->iColumn, iTab, target,
3502 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003503 }
3504 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003505 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003506 return target;
drhfec19aa2004-05-19 20:41:03 +00003507 }
drh8abed7b2018-02-26 18:49:05 +00003508 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003509 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003510 return target;
3511 }
drh13573c72010-01-12 17:04:07 +00003512#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003513 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003514 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3515 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003516 return target;
drh598f1342007-10-23 15:39:45 +00003517 }
drh13573c72010-01-12 17:04:07 +00003518#endif
drhfec19aa2004-05-19 20:41:03 +00003519 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003520 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003521 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003522 return target;
drhcce7d172000-05-31 15:34:51 +00003523 }
drhf0863fe2005-06-12 21:35:51 +00003524 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003525 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003526 return target;
drhf0863fe2005-06-12 21:35:51 +00003527 }
danielk19775338a5f2005-01-20 13:03:10 +00003528#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003529 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003530 int n;
3531 const char *z;
drhca48c902008-01-18 14:08:24 +00003532 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003533 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3534 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3535 assert( pExpr->u.zToken[1]=='\'' );
3536 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003537 n = sqlite3Strlen30(z) - 1;
3538 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003539 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3540 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003541 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003542 }
danielk19775338a5f2005-01-20 13:03:10 +00003543#endif
drh50457892003-09-06 01:10:47 +00003544 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003545 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3546 assert( pExpr->u.zToken!=0 );
3547 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003548 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3549 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003550 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003551 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003552 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003553 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003554 }
drhc332cc32016-09-19 10:24:19 +00003555 return target;
drh50457892003-09-06 01:10:47 +00003556 }
drh4e0cff62004-11-05 05:10:28 +00003557 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003558 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003559 }
drh487e2622005-06-25 18:42:14 +00003560#ifndef SQLITE_OMIT_CAST
3561 case TK_CAST: {
3562 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003563 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003564 if( inReg!=target ){
3565 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3566 inReg = target;
3567 }
drh4169e432014-08-25 20:11:52 +00003568 sqlite3VdbeAddOp2(v, OP_Cast, target,
3569 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003570 return inReg;
drh487e2622005-06-25 18:42:14 +00003571 }
3572#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003573 case TK_IS:
3574 case TK_ISNOT:
3575 op = (op==TK_IS) ? TK_EQ : TK_NE;
3576 p5 = SQLITE_NULLEQ;
3577 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003578 case TK_LT:
3579 case TK_LE:
3580 case TK_GT:
3581 case TK_GE:
3582 case TK_NE:
3583 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003584 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003585 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003586 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003587 }else{
3588 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3589 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3590 codeCompare(pParse, pLeft, pExpr->pRight, op,
3591 r1, r2, inReg, SQLITE_STOREP2 | p5);
3592 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3593 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3594 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3595 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3596 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3597 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3598 testcase( regFree1==0 );
3599 testcase( regFree2==0 );
3600 }
drh6a2fe092009-09-23 02:29:36 +00003601 break;
3602 }
drhcce7d172000-05-31 15:34:51 +00003603 case TK_AND:
3604 case TK_OR:
3605 case TK_PLUS:
3606 case TK_STAR:
3607 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003608 case TK_REM:
3609 case TK_BITAND:
3610 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003611 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003612 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003613 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003614 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003615 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3616 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3617 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3618 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3619 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3620 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3621 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3622 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3623 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3624 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3625 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003626 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3627 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003628 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003629 testcase( regFree1==0 );
3630 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003631 break;
3632 }
drhcce7d172000-05-31 15:34:51 +00003633 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003634 Expr *pLeft = pExpr->pLeft;
3635 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003636 if( pLeft->op==TK_INTEGER ){
3637 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003638 return target;
drh13573c72010-01-12 17:04:07 +00003639#ifndef SQLITE_OMIT_FLOATING_POINT
3640 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003641 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3642 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003643 return target;
drh13573c72010-01-12 17:04:07 +00003644#endif
drh3c84ddf2008-01-09 02:15:38 +00003645 }else{
drh10d1edf2013-11-15 15:52:39 +00003646 tempX.op = TK_INTEGER;
3647 tempX.flags = EP_IntValue|EP_TokenOnly;
3648 tempX.u.iValue = 0;
3649 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003650 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003651 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003652 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003653 }
drh3c84ddf2008-01-09 02:15:38 +00003654 break;
drh6e142f52000-06-08 13:36:40 +00003655 }
drhbf4133c2001-10-13 02:59:08 +00003656 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003657 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003658 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3659 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003660 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3661 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003662 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003663 break;
3664 }
drh8abed7b2018-02-26 18:49:05 +00003665 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003666 int isTrue; /* IS TRUE or IS NOT TRUE */
3667 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003668 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3669 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003670 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3671 bNormal = pExpr->op2==TK_IS;
3672 testcase( isTrue && bNormal);
3673 testcase( !isTrue && bNormal);
3674 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003675 break;
3676 }
drhcce7d172000-05-31 15:34:51 +00003677 case TK_ISNULL:
3678 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003679 int addr;
drh7d176102014-02-18 03:07:12 +00003680 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3681 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003682 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003683 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003684 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003685 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003686 VdbeCoverageIf(v, op==TK_ISNULL);
3687 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003688 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003689 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003690 break;
drhcce7d172000-05-31 15:34:51 +00003691 }
drh22827922000-06-06 17:27:05 +00003692 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003693 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003694 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003695 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3696 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003697 }else{
drhc332cc32016-09-19 10:24:19 +00003698 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003699 }
drh22827922000-06-06 17:27:05 +00003700 break;
3701 }
drhcce7d172000-05-31 15:34:51 +00003702 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003703 ExprList *pFarg; /* List of function arguments */
3704 int nFarg; /* Number of function arguments */
3705 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003706 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003707 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003708 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003709 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003710 u8 enc = ENC(db); /* The text encoding used by this database */
3711 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003712
dan67a9b8e2018-06-22 20:51:35 +00003713#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003714 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3715 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003716 }
dan67a9b8e2018-06-22 20:51:35 +00003717#endif
dan86fb6e12018-05-16 20:58:07 +00003718
drh1e9b53f2017-01-04 01:07:24 +00003719 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003720 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003721 ** out of the inner loop, even if that means an extra OP_Copy. */
3722 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003723 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003724 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003725 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003726 pFarg = 0;
3727 }else{
3728 pFarg = pExpr->x.pList;
3729 }
3730 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003731 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3732 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003733 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003734#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3735 if( pDef==0 && pParse->explain ){
3736 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3737 }
3738#endif
danb6e9f7a2018-05-19 14:15:29 +00003739 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003740 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003741 break;
3742 }
drhae6bb952009-11-11 00:24:31 +00003743
3744 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003745 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003746 ** arguments past the first non-NULL argument.
3747 */
drhd36e1042013-09-06 13:10:12 +00003748 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003749 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003750 assert( nFarg>=2 );
3751 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3752 for(i=1; i<nFarg; i++){
3753 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003754 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003755 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003756 }
3757 sqlite3VdbeResolveLabel(v, endCoalesce);
3758 break;
3759 }
3760
drhcca9f3d2013-09-06 15:23:29 +00003761 /* The UNLIKELY() function is a no-op. The result is the value
3762 ** of the first argument.
3763 */
3764 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3765 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003766 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003767 }
drhae6bb952009-11-11 00:24:31 +00003768
drh54240752017-01-03 14:39:30 +00003769#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003770 /* The AFFINITY() function evaluates to a string that describes
3771 ** the type affinity of the argument. This is used for testing of
3772 ** the SQLite type logic.
3773 */
3774 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3775 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3776 char aff;
3777 assert( nFarg==1 );
3778 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3779 sqlite3VdbeLoadString(v, target,
3780 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3781 return target;
3782 }
drh54240752017-01-03 14:39:30 +00003783#endif
drha1a523a2016-12-26 00:18:36 +00003784
drhd1a01ed2013-11-21 16:08:52 +00003785 for(i=0; i<nFarg; i++){
3786 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003787 testcase( i==31 );
3788 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003789 }
3790 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3791 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3792 }
3793 }
drh12ffee82009-04-08 13:51:51 +00003794 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003795 if( constMask ){
3796 r1 = pParse->nMem+1;
3797 pParse->nMem += nFarg;
3798 }else{
3799 r1 = sqlite3GetTempRange(pParse, nFarg);
3800 }
drha748fdc2012-03-28 01:34:47 +00003801
3802 /* For length() and typeof() functions with a column argument,
3803 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3804 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3805 ** loading.
3806 */
drhd36e1042013-09-06 13:10:12 +00003807 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003808 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003809 assert( nFarg==1 );
3810 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003811 exprOp = pFarg->a[0].pExpr->op;
3812 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003813 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3814 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003815 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3816 pFarg->a[0].pExpr->op2 =
3817 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003818 }
3819 }
3820
drh5579d592015-08-26 14:01:41 +00003821 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003822 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003823 }else{
drh12ffee82009-04-08 13:51:51 +00003824 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003825 }
drhb7f6f682006-07-08 17:06:43 +00003826#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003827 /* Possibly overload the function if the first argument is
3828 ** a virtual table column.
3829 **
3830 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3831 ** second argument, not the first, as the argument to test to
3832 ** see if it is a column in a virtual table. This is done because
3833 ** the left operand of infix functions (the operand we want to
3834 ** control overloading) ends up as the second argument to the
3835 ** function. The expression "A glob B" is equivalent to
3836 ** "glob(B,A). We want to use the A in "A glob B" to test
3837 ** for function overloading. But we use the B term in "glob(B,A)".
3838 */
drh59155062018-05-26 18:03:48 +00003839 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003840 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3841 }else if( nFarg>0 ){
3842 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003843 }
3844#endif
drhd36e1042013-09-06 13:10:12 +00003845 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003846 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003847 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003848 }
drh092457b2017-12-29 15:04:49 +00003849#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3850 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003851 Expr *pArg = pFarg->a[0].pExpr;
3852 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003853 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003854 }else{
3855 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3856 }
drh092457b2017-12-29 15:04:49 +00003857 }else
3858#endif
3859 {
drh2fc865c2017-12-16 20:20:37 +00003860 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3861 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3862 sqlite3VdbeChangeP5(v, (u8)nFarg);
3863 }
drhd1a01ed2013-11-21 16:08:52 +00003864 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003865 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003866 }
drhc332cc32016-09-19 10:24:19 +00003867 return target;
drhcce7d172000-05-31 15:34:51 +00003868 }
drhfe2093d2005-01-20 22:48:47 +00003869#ifndef SQLITE_OMIT_SUBQUERY
3870 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003871 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003872 int nCol;
drhc5499be2008-04-01 15:06:33 +00003873 testcase( op==TK_EXISTS );
3874 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003875 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3876 sqlite3SubselectError(pParse, nCol, 1);
3877 }else{
drh85bcdce2018-12-23 21:27:29 +00003878 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003879 }
drh19a775c2000-06-05 18:54:46 +00003880 break;
3881 }
drhfc7f27b2016-08-20 00:07:01 +00003882 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003883 int n;
drhfc7f27b2016-08-20 00:07:01 +00003884 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003885 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003886 }
drh966e2912017-01-03 02:58:01 +00003887 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3888 if( pExpr->iTable
3889 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3890 ){
3891 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3892 pExpr->iTable, n);
3893 }
drhc332cc32016-09-19 10:24:19 +00003894 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003895 }
drhfef52082000-06-06 01:50:43 +00003896 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003897 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3898 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003899 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3900 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3901 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3902 sqlite3VdbeResolveLabel(v, destIfFalse);
3903 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3904 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003905 return target;
drhfef52082000-06-06 01:50:43 +00003906 }
drhe3365e62009-11-12 17:52:24 +00003907#endif /* SQLITE_OMIT_SUBQUERY */
3908
3909
drh2dcef112008-01-12 19:03:48 +00003910 /*
3911 ** x BETWEEN y AND z
3912 **
3913 ** This is equivalent to
3914 **
3915 ** x>=y AND x<=z
3916 **
3917 ** X is stored in pExpr->pLeft.
3918 ** Y is stored in pExpr->pList->a[0].pExpr.
3919 ** Z is stored in pExpr->pList->a[1].pExpr.
3920 */
drhfef52082000-06-06 01:50:43 +00003921 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003922 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003923 return target;
drhfef52082000-06-06 01:50:43 +00003924 }
drh94fa9c42016-02-27 21:16:04 +00003925 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003926 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003927 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003928 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003929 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003930 }
drh2dcef112008-01-12 19:03:48 +00003931
dan165921a2009-08-28 18:53:45 +00003932 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003933 /* If the opcode is TK_TRIGGER, then the expression is a reference
3934 ** to a column in the new.* or old.* pseudo-tables available to
3935 ** trigger programs. In this case Expr.iTable is set to 1 for the
3936 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3937 ** is set to the column of the pseudo-table to read, or to -1 to
3938 ** read the rowid field.
3939 **
3940 ** The expression is implemented using an OP_Param opcode. The p1
3941 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3942 ** to reference another column of the old.* pseudo-table, where
3943 ** i is the index of the column. For a new.rowid reference, p1 is
3944 ** set to (n+1), where n is the number of columns in each pseudo-table.
3945 ** For a reference to any other column in the new.* pseudo-table, p1
3946 ** is set to (n+2+i), where n and i are as defined previously. For
3947 ** example, if the table on which triggers are being fired is
3948 ** declared as:
3949 **
3950 ** CREATE TABLE t1(a, b);
3951 **
3952 ** Then p1 is interpreted as follows:
3953 **
3954 ** p1==0 -> old.rowid p1==3 -> new.rowid
3955 ** p1==1 -> old.a p1==4 -> new.a
3956 ** p1==2 -> old.b p1==5 -> new.b
3957 */
drheda079c2018-09-20 19:02:15 +00003958 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003959 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3960
3961 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3962 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3963 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3964 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3965
3966 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003967 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003968 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003969 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003970 ));
dan65a7cd12009-09-01 12:16:01 +00003971
drh44dbca82010-01-13 04:22:20 +00003972#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003973 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003974 ** integer. Use OP_RealAffinity to make sure it is really real.
3975 **
3976 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3977 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003978 if( pExpr->iColumn>=0
3979 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3980 ){
3981 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3982 }
drh44dbca82010-01-13 04:22:20 +00003983#endif
dan165921a2009-08-28 18:53:45 +00003984 break;
3985 }
3986
dan71c57db2016-07-09 20:23:55 +00003987 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00003988 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00003989 break;
3990 }
3991
drh31d6fd52017-04-14 19:03:10 +00003992 case TK_IF_NULL_ROW: {
3993 int addrINR;
3994 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00003995 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00003996 sqlite3VdbeJumpHere(v, addrINR);
3997 sqlite3VdbeChangeP3(v, addrINR, inReg);
3998 break;
3999 }
4000
drh2dcef112008-01-12 19:03:48 +00004001 /*
4002 ** Form A:
4003 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4004 **
4005 ** Form B:
4006 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4007 **
4008 ** Form A is can be transformed into the equivalent form B as follows:
4009 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4010 ** WHEN x=eN THEN rN ELSE y END
4011 **
4012 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004013 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4014 ** odd. The Y is also optional. If the number of elements in x.pList
4015 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004016 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4017 **
4018 ** The result of the expression is the Ri for the first matching Ei,
4019 ** or if there is no matching Ei, the ELSE term Y, or if there is
4020 ** no ELSE term, NULL.
4021 */
drh33cd4902009-05-30 20:49:20 +00004022 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004023 int endLabel; /* GOTO label for end of CASE stmt */
4024 int nextCase; /* GOTO label for next WHEN clause */
4025 int nExpr; /* 2x number of WHEN terms */
4026 int i; /* Loop counter */
4027 ExprList *pEList; /* List of WHEN terms */
4028 struct ExprList_item *aListelem; /* Array of WHEN terms */
4029 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004030 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004031 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00004032
danielk19776ab3a2e2009-02-19 14:39:25 +00004033 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004034 assert(pExpr->x.pList->nExpr > 0);
4035 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004036 aListelem = pEList->a;
4037 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004038 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004039 if( (pX = pExpr->pLeft)!=0 ){
drha8e05762019-01-05 21:56:12 +00004040 exprNodeCopy(&tempX, pX);
drh33cd4902009-05-30 20:49:20 +00004041 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004042 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004043 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004044 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004045 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004046 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004047 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004048 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4049 ** The value in regFree1 might get SCopy-ed into the file result.
4050 ** So make sure that the regFree1 register is not reused for other
4051 ** purposes and possibly overwritten. */
4052 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004053 }
drhc5cd1242013-09-12 16:50:49 +00004054 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004055 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004056 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004057 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004058 }else{
drh2dcef112008-01-12 19:03:48 +00004059 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004060 }
drhec4ccdb2018-12-29 02:26:59 +00004061 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004062 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004063 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004064 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004065 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004066 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004067 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004068 }
drhc5cd1242013-09-12 16:50:49 +00004069 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004070 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004071 }else{
drh9de221d2008-01-05 06:51:30 +00004072 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004073 }
drh2dcef112008-01-12 19:03:48 +00004074 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004075 break;
4076 }
danielk19775338a5f2005-01-20 13:03:10 +00004077#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004078 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004079 assert( pExpr->affinity==OE_Rollback
4080 || pExpr->affinity==OE_Abort
4081 || pExpr->affinity==OE_Fail
4082 || pExpr->affinity==OE_Ignore
4083 );
dane0af83a2009-09-08 19:15:01 +00004084 if( !pParse->pTriggerTab ){
4085 sqlite3ErrorMsg(pParse,
4086 "RAISE() may only be used within a trigger-program");
4087 return 0;
4088 }
4089 if( pExpr->affinity==OE_Abort ){
4090 sqlite3MayAbort(pParse);
4091 }
dan165921a2009-08-28 18:53:45 +00004092 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004093 if( pExpr->affinity==OE_Ignore ){
4094 sqlite3VdbeAddOp4(
4095 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004096 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004097 }else{
drh433dccf2013-02-09 15:37:11 +00004098 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004099 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004100 }
4101
drhffe07b22005-11-03 00:41:17 +00004102 break;
drh17a7f8d2002-03-24 13:13:27 +00004103 }
danielk19775338a5f2005-01-20 13:03:10 +00004104#endif
drhffe07b22005-11-03 00:41:17 +00004105 }
drh2dcef112008-01-12 19:03:48 +00004106 sqlite3ReleaseTempReg(pParse, regFree1);
4107 sqlite3ReleaseTempReg(pParse, regFree2);
4108 return inReg;
4109}
4110
4111/*
drhd1a01ed2013-11-21 16:08:52 +00004112** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004113**
drhad879ff2017-01-04 04:10:02 +00004114** If regDest>=0 then the result is always stored in that register and the
4115** result is not reusable. If regDest<0 then this routine is free to
4116** store the value whereever it wants. The register where the expression
4117** is stored is returned. When regDest<0, two identical expressions will
4118** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004119*/
drh1e9b53f2017-01-04 01:07:24 +00004120int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004121 Parse *pParse, /* Parsing context */
4122 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004123 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004124){
drhd1a01ed2013-11-21 16:08:52 +00004125 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004126 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004127 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004128 if( regDest<0 && p ){
4129 struct ExprList_item *pItem;
4130 int i;
4131 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004132 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004133 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004134 }
4135 }
drh1e9b53f2017-01-04 01:07:24 +00004136 }
drhd1a01ed2013-11-21 16:08:52 +00004137 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4138 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004139 if( p ){
4140 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004141 pItem->reusable = regDest<0;
4142 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004143 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004144 }
drhd1a01ed2013-11-21 16:08:52 +00004145 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004146 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004147}
4148
4149/*
drh2dcef112008-01-12 19:03:48 +00004150** Generate code to evaluate an expression and store the results
4151** into a register. Return the register number where the results
4152** are stored.
4153**
4154** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004155** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004156** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004157**
4158** If pExpr is a constant, then this routine might generate this
4159** code to fill the register in the initialization section of the
4160** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004161*/
4162int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004163 int r2;
4164 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004165 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004166 && pExpr->op!=TK_REGISTER
4167 && sqlite3ExprIsConstantNotJoin(pExpr)
4168 ){
drhf30a9692013-11-15 01:10:18 +00004169 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004170 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004171 }else{
drhf30a9692013-11-15 01:10:18 +00004172 int r1 = sqlite3GetTempReg(pParse);
4173 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4174 if( r2==r1 ){
4175 *pReg = r1;
4176 }else{
4177 sqlite3ReleaseTempReg(pParse, r1);
4178 *pReg = 0;
4179 }
drh2dcef112008-01-12 19:03:48 +00004180 }
4181 return r2;
4182}
4183
4184/*
4185** Generate code that will evaluate expression pExpr and store the
4186** results in register target. The results are guaranteed to appear
4187** in register target.
4188*/
drh05a86c52014-02-16 01:55:49 +00004189void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004190 int inReg;
4191
4192 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004193 if( pExpr && pExpr->op==TK_REGISTER ){
4194 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4195 }else{
4196 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004197 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004198 if( inReg!=target && pParse->pVdbe ){
4199 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4200 }
drhcce7d172000-05-31 15:34:51 +00004201 }
drhcce7d172000-05-31 15:34:51 +00004202}
4203
4204/*
drh1c75c9d2015-12-21 15:22:13 +00004205** Make a transient copy of expression pExpr and then code it using
4206** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4207** except that the input expression is guaranteed to be unchanged.
4208*/
4209void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4210 sqlite3 *db = pParse->db;
4211 pExpr = sqlite3ExprDup(db, pExpr, 0);
4212 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4213 sqlite3ExprDelete(db, pExpr);
4214}
4215
4216/*
drh05a86c52014-02-16 01:55:49 +00004217** Generate code that will evaluate expression pExpr and store the
4218** results in register target. The results are guaranteed to appear
4219** in register target. If the expression is constant, then this routine
4220** might choose to code the expression at initialization time.
4221*/
4222void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004223 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004224 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004225 }else{
4226 sqlite3ExprCode(pParse, pExpr, target);
4227 }
drhcce7d172000-05-31 15:34:51 +00004228}
4229
4230/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004231** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004232** in register target.
drh25303782004-12-07 15:41:48 +00004233**
drh2dcef112008-01-12 19:03:48 +00004234** Also make a copy of the expression results into another "cache" register
4235** and modify the expression so that the next time it is evaluated,
4236** the result is a copy of the cache register.
4237**
4238** This routine is used for expressions that are used multiple
4239** times. They are evaluated once and the results of the expression
4240** are reused.
drh25303782004-12-07 15:41:48 +00004241*/
drh05a86c52014-02-16 01:55:49 +00004242void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004243 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004244 int iMem;
4245
drhde4fcfd2008-01-19 23:50:26 +00004246 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004247 assert( pExpr->op!=TK_REGISTER );
4248 sqlite3ExprCode(pParse, pExpr, target);
4249 iMem = ++pParse->nMem;
4250 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4251 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004252}
drh2dcef112008-01-12 19:03:48 +00004253
drh678ccce2008-03-31 18:19:54 +00004254/*
drh268380c2004-02-25 13:47:31 +00004255** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004256** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004257**
drh3df6c3b2017-09-15 15:38:01 +00004258** Return the number of elements evaluated. The number returned will
4259** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4260** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004261**
4262** The SQLITE_ECEL_DUP flag prevents the arguments from being
4263** filled using OP_SCopy. OP_Copy must be used instead.
4264**
4265** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4266** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004267**
4268** The SQLITE_ECEL_REF flag means that expressions in the list with
4269** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4270** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004271** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4272** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004273*/
danielk19774adee202004-05-08 08:23:19 +00004274int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004275 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004276 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004277 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004278 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004279 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004280){
4281 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004282 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004283 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004284 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004285 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004286 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004287 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004288 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004289 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004290 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004291 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004292#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4293 if( pItem->bSorterRef ){
4294 i--;
4295 n--;
4296 }else
4297#endif
dan257c13f2016-11-10 20:14:06 +00004298 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4299 if( flags & SQLITE_ECEL_OMITREF ){
4300 i--;
4301 n--;
4302 }else{
4303 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4304 }
drhb8b06692018-08-04 15:16:20 +00004305 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4306 && sqlite3ExprIsConstantNotJoin(pExpr)
4307 ){
drhad879ff2017-01-04 04:10:02 +00004308 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004309 }else{
4310 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4311 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004312 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004313 if( copyOp==OP_Copy
4314 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4315 && pOp->p1+pOp->p3+1==inReg
4316 && pOp->p2+pOp->p3+1==target+i
4317 ){
4318 pOp->p3++;
4319 }else{
4320 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4321 }
drhd1a01ed2013-11-21 16:08:52 +00004322 }
drhd1766112008-09-17 00:13:12 +00004323 }
drh268380c2004-02-25 13:47:31 +00004324 }
drhf9b596e2004-05-26 16:54:42 +00004325 return n;
drh268380c2004-02-25 13:47:31 +00004326}
4327
4328/*
drh36c563a2009-11-12 13:32:22 +00004329** Generate code for a BETWEEN operator.
4330**
4331** x BETWEEN y AND z
4332**
4333** The above is equivalent to
4334**
4335** x>=y AND x<=z
4336**
4337** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004338** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004339**
4340** The xJumpIf parameter determines details:
4341**
4342** NULL: Store the boolean result in reg[dest]
4343** sqlite3ExprIfTrue: Jump to dest if true
4344** sqlite3ExprIfFalse: Jump to dest if false
4345**
4346** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004347*/
4348static void exprCodeBetween(
4349 Parse *pParse, /* Parsing and code generating context */
4350 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004351 int dest, /* Jump destination or storage location */
4352 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004353 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4354){
drhdb45bd52016-08-22 00:48:58 +00004355 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004356 Expr compLeft; /* The x>=y term */
4357 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004358 Expr exprX; /* The x subexpression */
4359 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004360
dan71c57db2016-07-09 20:23:55 +00004361 memset(&compLeft, 0, sizeof(Expr));
4362 memset(&compRight, 0, sizeof(Expr));
4363 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004364
4365 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drha8e05762019-01-05 21:56:12 +00004366 exprNodeCopy(&exprX, pExpr->pLeft);
drh36c563a2009-11-12 13:32:22 +00004367 exprAnd.op = TK_AND;
4368 exprAnd.pLeft = &compLeft;
4369 exprAnd.pRight = &compRight;
4370 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004371 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004372 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4373 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004374 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004375 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004376 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004377 if( xJump ){
4378 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004379 }else{
drh36fd41e2016-11-25 14:30:42 +00004380 /* Mark the expression is being from the ON or USING clause of a join
4381 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4382 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4383 ** for clarity, but we are out of bits in the Expr.flags field so we
4384 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004385 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004386 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004387 }
drhdb45bd52016-08-22 00:48:58 +00004388 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004389
4390 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004391 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4392 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4393 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4394 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4395 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4396 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4397 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4398 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004399 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004400}
4401
4402/*
drhcce7d172000-05-31 15:34:51 +00004403** Generate code for a boolean expression such that a jump is made
4404** to the label "dest" if the expression is true but execution
4405** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004406**
4407** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004408** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004409**
4410** This code depends on the fact that certain token values (ex: TK_EQ)
4411** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4412** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4413** the make process cause these values to align. Assert()s in the code
4414** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004415*/
danielk19774adee202004-05-08 08:23:19 +00004416void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004417 Vdbe *v = pParse->pVdbe;
4418 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004419 int regFree1 = 0;
4420 int regFree2 = 0;
4421 int r1, r2;
4422
drh35573352008-01-08 23:54:25 +00004423 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004424 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004425 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004426 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004427 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004428 case TK_AND: {
drhec4ccdb2018-12-29 02:26:59 +00004429 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004430 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004431 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004432 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4433 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004434 break;
4435 }
4436 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004437 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004438 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4439 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004440 break;
4441 }
4442 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004443 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004444 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004445 break;
4446 }
drh8abed7b2018-02-26 18:49:05 +00004447 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004448 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4449 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004450 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004451 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004452 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004453 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004454 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004455 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004456 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4457 isNot ? SQLITE_JUMPIFNULL : 0);
4458 }else{
4459 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4460 isNot ? SQLITE_JUMPIFNULL : 0);
4461 }
drh007c8432018-02-26 03:20:18 +00004462 break;
4463 }
drhde845c22016-03-17 19:07:52 +00004464 case TK_IS:
4465 case TK_ISNOT:
4466 testcase( op==TK_IS );
4467 testcase( op==TK_ISNOT );
4468 op = (op==TK_IS) ? TK_EQ : TK_NE;
4469 jumpIfNull = SQLITE_NULLEQ;
4470 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004471 case TK_LT:
4472 case TK_LE:
4473 case TK_GT:
4474 case TK_GE:
4475 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004476 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004477 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004478 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004479 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4480 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004481 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004482 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004483 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4484 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4485 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4486 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004487 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4488 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4489 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4490 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4491 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4492 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004493 testcase( regFree1==0 );
4494 testcase( regFree2==0 );
4495 break;
4496 }
drhcce7d172000-05-31 15:34:51 +00004497 case TK_ISNULL:
4498 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004499 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4500 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004501 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4502 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004503 VdbeCoverageIf(v, op==TK_ISNULL);
4504 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004505 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004506 break;
4507 }
drhfef52082000-06-06 01:50:43 +00004508 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004509 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004510 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004511 break;
4512 }
drh84e30ca2011-02-10 17:46:14 +00004513#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004514 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004515 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004516 int destIfNull = jumpIfNull ? dest : destIfFalse;
4517 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004518 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004519 sqlite3VdbeResolveLabel(v, destIfFalse);
4520 break;
4521 }
shanehbb201342011-02-09 19:55:20 +00004522#endif
drhcce7d172000-05-31 15:34:51 +00004523 default: {
dan7b35a772016-07-28 19:47:15 +00004524 default_expr:
drh991a1982014-01-02 17:57:16 +00004525 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004526 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004527 }else if( exprAlwaysFalse(pExpr) ){
4528 /* No-op */
4529 }else{
4530 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4531 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004532 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004533 testcase( regFree1==0 );
4534 testcase( jumpIfNull==0 );
4535 }
drhcce7d172000-05-31 15:34:51 +00004536 break;
4537 }
4538 }
drh2dcef112008-01-12 19:03:48 +00004539 sqlite3ReleaseTempReg(pParse, regFree1);
4540 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004541}
4542
4543/*
drh66b89c82000-11-28 20:47:17 +00004544** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004545** to the label "dest" if the expression is false but execution
4546** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004547**
4548** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004549** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4550** is 0.
drhcce7d172000-05-31 15:34:51 +00004551*/
danielk19774adee202004-05-08 08:23:19 +00004552void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004553 Vdbe *v = pParse->pVdbe;
4554 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004555 int regFree1 = 0;
4556 int regFree2 = 0;
4557 int r1, r2;
4558
drh35573352008-01-08 23:54:25 +00004559 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004560 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004561 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004562
4563 /* The value of pExpr->op and op are related as follows:
4564 **
4565 ** pExpr->op op
4566 ** --------- ----------
4567 ** TK_ISNULL OP_NotNull
4568 ** TK_NOTNULL OP_IsNull
4569 ** TK_NE OP_Eq
4570 ** TK_EQ OP_Ne
4571 ** TK_GT OP_Le
4572 ** TK_LE OP_Gt
4573 ** TK_GE OP_Lt
4574 ** TK_LT OP_Ge
4575 **
4576 ** For other values of pExpr->op, op is undefined and unused.
4577 ** The value of TK_ and OP_ constants are arranged such that we
4578 ** can compute the mapping above using the following expression.
4579 ** Assert()s verify that the computation is correct.
4580 */
4581 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4582
4583 /* Verify correct alignment of TK_ and OP_ constants
4584 */
4585 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4586 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4587 assert( pExpr->op!=TK_NE || op==OP_Eq );
4588 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4589 assert( pExpr->op!=TK_LT || op==OP_Ge );
4590 assert( pExpr->op!=TK_LE || op==OP_Gt );
4591 assert( pExpr->op!=TK_GT || op==OP_Le );
4592 assert( pExpr->op!=TK_GE || op==OP_Lt );
4593
danba00e302016-07-23 20:24:06 +00004594 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004595 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004596 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004597 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4598 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004599 break;
4600 }
4601 case TK_OR: {
drhec4ccdb2018-12-29 02:26:59 +00004602 int d2 = sqlite3VdbeMakeLabel(pParse);
drhc5499be2008-04-01 15:06:33 +00004603 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004604 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004605 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4606 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004607 break;
4608 }
4609 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004610 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004611 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004612 break;
4613 }
drh8abed7b2018-02-26 18:49:05 +00004614 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004615 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4616 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004617 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004618 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004619 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004620 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004621 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004622 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004623 /* IS TRUE and IS NOT FALSE */
4624 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4625 isNot ? 0 : SQLITE_JUMPIFNULL);
4626
4627 }else{
4628 /* IS FALSE and IS NOT TRUE */
4629 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004630 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004631 }
drh007c8432018-02-26 03:20:18 +00004632 break;
4633 }
drhde845c22016-03-17 19:07:52 +00004634 case TK_IS:
4635 case TK_ISNOT:
4636 testcase( pExpr->op==TK_IS );
4637 testcase( pExpr->op==TK_ISNOT );
4638 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4639 jumpIfNull = SQLITE_NULLEQ;
4640 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004641 case TK_LT:
4642 case TK_LE:
4643 case TK_GT:
4644 case TK_GE:
4645 case TK_NE:
4646 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004647 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004648 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004649 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4650 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004651 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004652 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004653 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4654 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4655 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4656 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004657 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4658 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4659 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4660 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4661 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4662 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004663 testcase( regFree1==0 );
4664 testcase( regFree2==0 );
4665 break;
4666 }
drhcce7d172000-05-31 15:34:51 +00004667 case TK_ISNULL:
4668 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004669 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4670 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004671 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4672 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004673 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004674 break;
4675 }
drhfef52082000-06-06 01:50:43 +00004676 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004677 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004678 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004679 break;
4680 }
drh84e30ca2011-02-10 17:46:14 +00004681#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004682 case TK_IN: {
4683 if( jumpIfNull ){
4684 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4685 }else{
drhec4ccdb2018-12-29 02:26:59 +00004686 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004687 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4688 sqlite3VdbeResolveLabel(v, destIfNull);
4689 }
4690 break;
4691 }
shanehbb201342011-02-09 19:55:20 +00004692#endif
drhcce7d172000-05-31 15:34:51 +00004693 default: {
danba00e302016-07-23 20:24:06 +00004694 default_expr:
drh991a1982014-01-02 17:57:16 +00004695 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004696 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004697 }else if( exprAlwaysTrue(pExpr) ){
4698 /* no-op */
4699 }else{
4700 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4701 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004702 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004703 testcase( regFree1==0 );
4704 testcase( jumpIfNull==0 );
4705 }
drhcce7d172000-05-31 15:34:51 +00004706 break;
4707 }
4708 }
drh2dcef112008-01-12 19:03:48 +00004709 sqlite3ReleaseTempReg(pParse, regFree1);
4710 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004711}
drh22827922000-06-06 17:27:05 +00004712
4713/*
drh72bc8202015-06-11 13:58:35 +00004714** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4715** code generation, and that copy is deleted after code generation. This
4716** ensures that the original pExpr is unchanged.
4717*/
4718void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4719 sqlite3 *db = pParse->db;
4720 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4721 if( db->mallocFailed==0 ){
4722 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4723 }
4724 sqlite3ExprDelete(db, pCopy);
4725}
4726
dan5aa550c2017-06-24 18:10:29 +00004727/*
4728** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4729** type of expression.
4730**
4731** If pExpr is a simple SQL value - an integer, real, string, blob
4732** or NULL value - then the VDBE currently being prepared is configured
4733** to re-prepare each time a new value is bound to variable pVar.
4734**
4735** Additionally, if pExpr is a simple SQL value and the value is the
4736** same as that currently bound to variable pVar, non-zero is returned.
4737** Otherwise, if the values are not the same or if pExpr is not a simple
4738** SQL value, zero is returned.
4739*/
4740static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4741 int res = 0;
drhc0804222017-06-28 21:47:16 +00004742 int iVar;
4743 sqlite3_value *pL, *pR = 0;
4744
4745 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4746 if( pR ){
4747 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004748 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004749 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004750 if( pL ){
4751 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4752 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4753 }
4754 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004755 }
drhc0804222017-06-28 21:47:16 +00004756 sqlite3ValueFree(pR);
4757 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004758 }
4759
4760 return res;
4761}
drh72bc8202015-06-11 13:58:35 +00004762
4763/*
drh1d9da702010-01-07 15:17:02 +00004764** Do a deep comparison of two expression trees. Return 0 if the two
4765** expressions are completely identical. Return 1 if they differ only
4766** by a COLLATE operator at the top level. Return 2 if there are differences
4767** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004768**
drh619a1302013-08-01 13:04:46 +00004769** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4770** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4771**
drh66518ca2013-08-01 15:09:57 +00004772** The pA side might be using TK_REGISTER. If that is the case and pB is
4773** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4774**
drh1d9da702010-01-07 15:17:02 +00004775** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004776** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004777** identical, we return 2 just to be safe. So if this routine
4778** returns 2, then you do not really know for certain if the two
4779** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004780** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004781** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004782** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004783** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004784**
drhc0804222017-06-28 21:47:16 +00004785** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4786** pParse->pReprepare can be matched against literals in pB. The
4787** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4788** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4789** Argument pParse should normally be NULL. If it is not NULL and pA or
4790** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004791*/
dan5aa550c2017-06-24 18:10:29 +00004792int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004793 u32 combinedFlags;
4794 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004795 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004796 }
dan5aa550c2017-06-24 18:10:29 +00004797 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4798 return 0;
4799 }
drh10d1edf2013-11-15 15:52:39 +00004800 combinedFlags = pA->flags | pB->flags;
4801 if( combinedFlags & EP_IntValue ){
4802 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4803 return 0;
4804 }
drh1d9da702010-01-07 15:17:02 +00004805 return 2;
drh22827922000-06-06 17:27:05 +00004806 }
dan16dd3982018-12-20 15:04:38 +00004807 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004808 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004809 return 1;
4810 }
dan5aa550c2017-06-24 18:10:29 +00004811 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004812 return 1;
4813 }
4814 return 2;
4815 }
drh2edc5fd2015-11-24 02:10:52 +00004816 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004817 if( pA->op==TK_FUNCTION ){
4818 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004819#ifndef SQLITE_OMIT_WINDOWFUNC
4820 /* Justification for the assert():
4821 ** window functions have p->op==TK_FUNCTION but aggregate functions
4822 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4823 ** function and a window function should have failed before reaching
4824 ** this point. And, it is not possible to have a window function and
4825 ** a scalar function with the same name and number of arguments. So
4826 ** if we reach this point, either A and B both window functions or
4827 ** neither are a window functions. */
4828 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4829 if( ExprHasProperty(pA,EP_WinFunc) ){
4830 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4831 }
4832#endif
drhf20bbc52019-01-17 01:06:00 +00004833 }else if( pA->op==TK_NULL ){
4834 return 0;
drhd5af5422018-04-13 14:27:01 +00004835 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004836 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004837 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004838 return 2;
drh2646da72005-12-09 20:02:05 +00004839 }
drh22827922000-06-06 17:27:05 +00004840 }
drh10d1edf2013-11-15 15:52:39 +00004841 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004842 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004843 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004844 if( (combinedFlags & EP_FixedCol)==0
4845 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004846 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004847 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004848 if( pA->op!=TK_STRING
4849 && pA->op!=TK_TRUEFALSE
4850 && (combinedFlags & EP_Reduced)==0
4851 ){
drh10d1edf2013-11-15 15:52:39 +00004852 if( pA->iColumn!=pB->iColumn ) return 2;
4853 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004854 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004855 }
4856 }
drh1d9da702010-01-07 15:17:02 +00004857 return 0;
drh22827922000-06-06 17:27:05 +00004858}
4859
drh8c6f6662010-04-26 19:17:26 +00004860/*
4861** Compare two ExprList objects. Return 0 if they are identical and
4862** non-zero if they differ in any way.
4863**
drh619a1302013-08-01 13:04:46 +00004864** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4865** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4866**
drh8c6f6662010-04-26 19:17:26 +00004867** This routine might return non-zero for equivalent ExprLists. The
4868** only consequence will be disabled optimizations. But this routine
4869** must never return 0 if the two ExprList objects are different, or
4870** a malfunction will result.
4871**
4872** Two NULL pointers are considered to be the same. But a NULL pointer
4873** always differs from a non-NULL pointer.
4874*/
drh619a1302013-08-01 13:04:46 +00004875int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004876 int i;
4877 if( pA==0 && pB==0 ) return 0;
4878 if( pA==0 || pB==0 ) return 1;
4879 if( pA->nExpr!=pB->nExpr ) return 1;
4880 for(i=0; i<pA->nExpr; i++){
4881 Expr *pExprA = pA->a[i].pExpr;
4882 Expr *pExprB = pB->a[i].pExpr;
4883 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004884 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004885 }
4886 return 0;
4887}
drh13449892005-09-07 21:22:45 +00004888
drh22827922000-06-06 17:27:05 +00004889/*
drhf9463df2017-02-11 14:59:58 +00004890** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4891** are ignored.
4892*/
4893int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004894 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004895 sqlite3ExprSkipCollate(pA),
4896 sqlite3ExprSkipCollate(pB),
4897 iTab);
4898}
4899
4900/*
drh4bd5f732013-07-31 23:22:39 +00004901** Return true if we can prove the pE2 will always be true if pE1 is
4902** true. Return false if we cannot complete the proof or if pE2 might
4903** be false. Examples:
4904**
drh619a1302013-08-01 13:04:46 +00004905** pE1: x==5 pE2: x==5 Result: true
4906** pE1: x>0 pE2: x==5 Result: false
4907** pE1: x=21 pE2: x=21 OR y=43 Result: true
4908** pE1: x!=123 pE2: x IS NOT NULL Result: true
4909** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4910** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4911** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004912**
4913** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4914** Expr.iTable<0 then assume a table number given by iTab.
4915**
drhc0804222017-06-28 21:47:16 +00004916** If pParse is not NULL, then the values of bound variables in pE1 are
4917** compared against literal values in pE2 and pParse->pVdbe->expmask is
4918** modified to record which bound variables are referenced. If pParse
4919** is NULL, then false will be returned if pE1 contains any bound variables.
4920**
drh4bd5f732013-07-31 23:22:39 +00004921** When in doubt, return false. Returning true might give a performance
4922** improvement. Returning false might cause a performance reduction, but
4923** it will always give the correct answer and is hence always safe.
4924*/
dan5aa550c2017-06-24 18:10:29 +00004925int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4926 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004927 return 1;
4928 }
4929 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004930 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4931 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004932 ){
4933 return 1;
4934 }
drh1ad93a02016-11-02 02:17:52 +00004935 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4936 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4937 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004938 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004939 }
4940 return 0;
drh4bd5f732013-07-31 23:22:39 +00004941}
4942
4943/*
drh25897872018-03-20 21:16:15 +00004944** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4945** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004946** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4947**
4948** This routine controls an optimization. False positives (setting
4949** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4950** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004951*/
4952static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004953 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004954 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004955 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4956 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004957 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004958 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004959 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00004960 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00004961 case TK_IS:
4962 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004963 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004964 case TK_IN:
drh25897872018-03-20 21:16:15 +00004965 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004966 testcase( pExpr->op==TK_ISNOT );
4967 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004968 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00004969 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00004970 testcase( pExpr->op==TK_IS );
4971 testcase( pExpr->op==TK_OR );
4972 testcase( pExpr->op==TK_CASE );
4973 testcase( pExpr->op==TK_IN );
4974 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00004975 return WRC_Prune;
4976 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00004977 if( pWalker->u.iCur==pExpr->iTable ){
4978 pWalker->eCode = 1;
4979 return WRC_Abort;
4980 }
4981 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00004982
4983 /* Virtual tables are allowed to use constraints like x=NULL. So
4984 ** a term of the form x=y does not prove that y is not null if x
4985 ** is the column of a virtual table */
4986 case TK_EQ:
4987 case TK_NE:
4988 case TK_LT:
4989 case TK_LE:
4990 case TK_GT:
4991 case TK_GE:
4992 testcase( pExpr->op==TK_EQ );
4993 testcase( pExpr->op==TK_NE );
4994 testcase( pExpr->op==TK_LT );
4995 testcase( pExpr->op==TK_LE );
4996 testcase( pExpr->op==TK_GT );
4997 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00004998 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
4999 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005000 ){
5001 return WRC_Prune;
5002 }
drh25897872018-03-20 21:16:15 +00005003 default:
5004 return WRC_Continue;
5005 }
5006}
5007
5008/*
5009** Return true (non-zero) if expression p can only be true if at least
5010** one column of table iTab is non-null. In other words, return true
5011** if expression p will always be NULL or false if every column of iTab
5012** is NULL.
5013**
drh821b6102018-03-24 18:01:51 +00005014** False negatives are acceptable. In other words, it is ok to return
5015** zero even if expression p will never be true of every column of iTab
5016** is NULL. A false negative is merely a missed optimization opportunity.
5017**
5018** False positives are not allowed, however. A false positive may result
5019** in an incorrect answer.
5020**
drh25897872018-03-20 21:16:15 +00005021** Terms of p that are marked with EP_FromJoin (and hence that come from
5022** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5023**
5024** This routine is used to check if a LEFT JOIN can be converted into
5025** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5026** clause requires that some column of the right table of the LEFT JOIN
5027** be non-NULL, then the LEFT JOIN can be safely converted into an
5028** ordinary join.
5029*/
5030int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5031 Walker w;
drhd6db6592019-04-01 19:42:42 +00005032 p = sqlite3ExprSkipCollate(p);
5033 while( p ){
5034 if( p->op==TK_NOTNULL ){
5035 p = p->pLeft;
5036 }else if( p->op==TK_AND ){
5037 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5038 p = p->pRight;
5039 }else{
5040 break;
5041 }
5042 }
drh25897872018-03-20 21:16:15 +00005043 w.xExprCallback = impliesNotNullRow;
5044 w.xSelectCallback = 0;
5045 w.xSelectCallback2 = 0;
5046 w.eCode = 0;
5047 w.u.iCur = iTab;
5048 sqlite3WalkExpr(&w, p);
5049 return w.eCode;
5050}
5051
5052/*
drh030796d2012-08-23 16:18:10 +00005053** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005054** to determine if an expression can be evaluated by reference to the
5055** index only, without having to do a search for the corresponding
5056** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5057** is the cursor for the table.
5058*/
5059struct IdxCover {
5060 Index *pIdx; /* The index to be tested for coverage */
5061 int iCur; /* Cursor number for the table corresponding to the index */
5062};
5063
5064/*
5065** Check to see if there are references to columns in table
5066** pWalker->u.pIdxCover->iCur can be satisfied using the index
5067** pWalker->u.pIdxCover->pIdx.
5068*/
5069static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5070 if( pExpr->op==TK_COLUMN
5071 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5072 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5073 ){
5074 pWalker->eCode = 1;
5075 return WRC_Abort;
5076 }
5077 return WRC_Continue;
5078}
5079
5080/*
drhe604ec02016-07-27 19:20:58 +00005081** Determine if an index pIdx on table with cursor iCur contains will
5082** the expression pExpr. Return true if the index does cover the
5083** expression and false if the pExpr expression references table columns
5084** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005085**
5086** An index covering an expression means that the expression can be
5087** evaluated using only the index and without having to lookup the
5088** corresponding table entry.
5089*/
5090int sqlite3ExprCoveredByIndex(
5091 Expr *pExpr, /* The index to be tested */
5092 int iCur, /* The cursor number for the corresponding table */
5093 Index *pIdx /* The index that might be used for coverage */
5094){
5095 Walker w;
5096 struct IdxCover xcov;
5097 memset(&w, 0, sizeof(w));
5098 xcov.iCur = iCur;
5099 xcov.pIdx = pIdx;
5100 w.xExprCallback = exprIdxCover;
5101 w.u.pIdxCover = &xcov;
5102 sqlite3WalkExpr(&w, pExpr);
5103 return !w.eCode;
5104}
5105
5106
5107/*
5108** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005109** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005110** aggregate function, in order to implement the
5111** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005112*/
drh030796d2012-08-23 16:18:10 +00005113struct SrcCount {
5114 SrcList *pSrc; /* One particular FROM clause in a nested query */
5115 int nThis; /* Number of references to columns in pSrcList */
5116 int nOther; /* Number of references to columns in other FROM clauses */
5117};
5118
5119/*
5120** Count the number of references to columns.
5121*/
5122static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005123 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5124 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5125 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5126 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5127 ** NEVER() will need to be removed. */
5128 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005129 int i;
drh030796d2012-08-23 16:18:10 +00005130 struct SrcCount *p = pWalker->u.pSrcCount;
5131 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005132 int nSrc = pSrc ? pSrc->nSrc : 0;
5133 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005134 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005135 }
drh655814d2015-01-09 01:27:29 +00005136 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005137 p->nThis++;
5138 }else{
5139 p->nOther++;
5140 }
drh374fdce2012-04-17 16:38:53 +00005141 }
drh030796d2012-08-23 16:18:10 +00005142 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005143}
5144
5145/*
drh030796d2012-08-23 16:18:10 +00005146** Determine if any of the arguments to the pExpr Function reference
5147** pSrcList. Return true if they do. Also return true if the function
5148** has no arguments or has only constant arguments. Return false if pExpr
5149** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005150*/
drh030796d2012-08-23 16:18:10 +00005151int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005152 Walker w;
drh030796d2012-08-23 16:18:10 +00005153 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005154 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005155 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005156 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005157 w.u.pSrcCount = &cnt;
5158 cnt.pSrc = pSrcList;
5159 cnt.nThis = 0;
5160 cnt.nOther = 0;
5161 sqlite3WalkExprList(&w, pExpr->x.pList);
5162 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005163}
5164
5165/*
drh13449892005-09-07 21:22:45 +00005166** Add a new element to the pAggInfo->aCol[] array. Return the index of
5167** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005168*/
drh17435752007-08-16 04:30:38 +00005169static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005170 int i;
drhcf643722007-03-27 13:36:37 +00005171 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005172 db,
drhcf643722007-03-27 13:36:37 +00005173 pInfo->aCol,
5174 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005175 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005176 &i
5177 );
drh13449892005-09-07 21:22:45 +00005178 return i;
5179}
5180
5181/*
5182** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5183** the new element. Return a negative number if malloc fails.
5184*/
drh17435752007-08-16 04:30:38 +00005185static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005186 int i;
drhcf643722007-03-27 13:36:37 +00005187 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005188 db,
drhcf643722007-03-27 13:36:37 +00005189 pInfo->aFunc,
5190 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005191 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005192 &i
5193 );
drh13449892005-09-07 21:22:45 +00005194 return i;
5195}
drh22827922000-06-06 17:27:05 +00005196
5197/*
drh7d10d5a2008-08-20 16:35:10 +00005198** This is the xExprCallback for a tree walker. It is used to
5199** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005200** for additional information.
drh22827922000-06-06 17:27:05 +00005201*/
drh7d10d5a2008-08-20 16:35:10 +00005202static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005203 int i;
drh7d10d5a2008-08-20 16:35:10 +00005204 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005205 Parse *pParse = pNC->pParse;
5206 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005207 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005208
drh25c3b8c2018-04-16 10:34:13 +00005209 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005210 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005211 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005212 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005213 testcase( pExpr->op==TK_AGG_COLUMN );
5214 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005215 /* Check to see if the column is in one of the tables in the FROM
5216 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005217 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005218 struct SrcList_item *pItem = pSrcList->a;
5219 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5220 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005221 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005222 if( pExpr->iTable==pItem->iCursor ){
5223 /* If we reach this point, it means that pExpr refers to a table
5224 ** that is in the FROM clause of the aggregate query.
5225 **
5226 ** Make an entry for the column in pAggInfo->aCol[] if there
5227 ** is not an entry there already.
5228 */
drh7f906d62007-03-12 23:48:52 +00005229 int k;
drh13449892005-09-07 21:22:45 +00005230 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005231 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005232 if( pCol->iTable==pExpr->iTable &&
5233 pCol->iColumn==pExpr->iColumn ){
5234 break;
5235 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005236 }
danielk19771e536952007-08-16 10:09:01 +00005237 if( (k>=pAggInfo->nColumn)
5238 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5239 ){
drh7f906d62007-03-12 23:48:52 +00005240 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005241 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005242 pCol->iTable = pExpr->iTable;
5243 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005244 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005245 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005246 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005247 if( pAggInfo->pGroupBy ){
5248 int j, n;
5249 ExprList *pGB = pAggInfo->pGroupBy;
5250 struct ExprList_item *pTerm = pGB->a;
5251 n = pGB->nExpr;
5252 for(j=0; j<n; j++, pTerm++){
5253 Expr *pE = pTerm->pExpr;
5254 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5255 pE->iColumn==pExpr->iColumn ){
5256 pCol->iSorterColumn = j;
5257 break;
5258 }
5259 }
5260 }
5261 if( pCol->iSorterColumn<0 ){
5262 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5263 }
5264 }
5265 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5266 ** because it was there before or because we just created it).
5267 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5268 ** pAggInfo->aCol[] entry.
5269 */
drhebb6a652013-09-12 23:42:22 +00005270 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005271 pExpr->pAggInfo = pAggInfo;
5272 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005273 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005274 break;
5275 } /* endif pExpr->iTable==pItem->iCursor */
5276 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005277 }
drh7d10d5a2008-08-20 16:35:10 +00005278 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005279 }
5280 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005281 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005282 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005283 ){
drh13449892005-09-07 21:22:45 +00005284 /* Check to see if pExpr is a duplicate of another aggregate
5285 ** function that is already in the pAggInfo structure
5286 */
5287 struct AggInfo_func *pItem = pAggInfo->aFunc;
5288 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005289 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005290 break;
5291 }
drh22827922000-06-06 17:27:05 +00005292 }
drh13449892005-09-07 21:22:45 +00005293 if( i>=pAggInfo->nFunc ){
5294 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5295 */
danielk197714db2662006-01-09 16:12:04 +00005296 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005297 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005298 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005299 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005300 pItem = &pAggInfo->aFunc[i];
5301 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005302 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005303 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005304 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005305 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005306 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005307 if( pExpr->flags & EP_Distinct ){
5308 pItem->iDistinct = pParse->nTab++;
5309 }else{
5310 pItem->iDistinct = -1;
5311 }
drh13449892005-09-07 21:22:45 +00005312 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005313 }
drh13449892005-09-07 21:22:45 +00005314 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5315 */
drhc5cd1242013-09-12 16:50:49 +00005316 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005317 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005318 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005319 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005320 return WRC_Prune;
5321 }else{
5322 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005323 }
drh22827922000-06-06 17:27:05 +00005324 }
5325 }
drh7d10d5a2008-08-20 16:35:10 +00005326 return WRC_Continue;
5327}
5328static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005329 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005330 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005331 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005332}
drh979dd1b2017-05-29 14:26:07 +00005333static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5334 UNUSED_PARAMETER(pSelect);
5335 pWalker->walkerDepth--;
5336}
drh626a8792005-01-17 22:08:19 +00005337
5338/*
drhe8abb4c2012-11-02 18:24:57 +00005339** Analyze the pExpr expression looking for aggregate functions and
5340** for variables that need to be added to AggInfo object that pNC->pAggInfo
5341** points to. Additional entries are made on the AggInfo object as
5342** necessary.
drh626a8792005-01-17 22:08:19 +00005343**
5344** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005345** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005346*/
drhd2b3e232008-01-23 14:51:49 +00005347void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005348 Walker w;
5349 w.xExprCallback = analyzeAggregate;
5350 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005351 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5352 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005353 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005354 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005355 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005356 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005357}
drh5d9a4af2005-08-30 00:54:01 +00005358
5359/*
5360** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5361** expression list. Return the number of errors.
5362**
5363** If an error is found, the analysis is cut short.
5364*/
drhd2b3e232008-01-23 14:51:49 +00005365void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005366 struct ExprList_item *pItem;
5367 int i;
drh5d9a4af2005-08-30 00:54:01 +00005368 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005369 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5370 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005371 }
5372 }
drh5d9a4af2005-08-30 00:54:01 +00005373}
drh892d3172008-01-10 03:46:36 +00005374
5375/*
drhceea3322009-04-23 13:22:42 +00005376** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005377*/
5378int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005379 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005380 return ++pParse->nMem;
5381 }
danielk19772f425f62008-07-04 09:41:39 +00005382 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005383}
drhceea3322009-04-23 13:22:42 +00005384
5385/*
5386** Deallocate a register, making available for reuse for some other
5387** purpose.
drhceea3322009-04-23 13:22:42 +00005388*/
drh892d3172008-01-10 03:46:36 +00005389void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005390 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005391 pParse->aTempReg[pParse->nTempReg++] = iReg;
5392 }
5393}
5394
5395/*
drhed24da42016-09-06 14:37:05 +00005396** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005397*/
5398int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005399 int i, n;
drhed24da42016-09-06 14:37:05 +00005400 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005401 i = pParse->iRangeReg;
5402 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005403 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005404 pParse->iRangeReg += nReg;
5405 pParse->nRangeReg -= nReg;
5406 }else{
5407 i = pParse->nMem+1;
5408 pParse->nMem += nReg;
5409 }
5410 return i;
5411}
5412void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005413 if( nReg==1 ){
5414 sqlite3ReleaseTempReg(pParse, iReg);
5415 return;
5416 }
drh892d3172008-01-10 03:46:36 +00005417 if( nReg>pParse->nRangeReg ){
5418 pParse->nRangeReg = nReg;
5419 pParse->iRangeReg = iReg;
5420 }
5421}
drhcdc69552011-12-06 13:24:59 +00005422
5423/*
5424** Mark all temporary registers as being unavailable for reuse.
5425*/
5426void sqlite3ClearTempRegCache(Parse *pParse){
5427 pParse->nTempReg = 0;
5428 pParse->nRangeReg = 0;
5429}
drhbb9b5f22016-03-19 00:35:02 +00005430
5431/*
5432** Validate that no temporary register falls within the range of
5433** iFirst..iLast, inclusive. This routine is only call from within assert()
5434** statements.
5435*/
5436#ifdef SQLITE_DEBUG
5437int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5438 int i;
5439 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005440 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5441 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005442 ){
5443 return 0;
5444 }
5445 for(i=0; i<pParse->nTempReg; i++){
5446 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5447 return 0;
5448 }
5449 }
5450 return 1;
5451}
5452#endif /* SQLITE_DEBUG */