blob: 76299ffac5595a84d0a681392dbf87cc92557cf3 [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
danb8d29c22017-04-11 11:52:25 +000061 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
drh0dfa4f62016-08-26 13:19:49 +000062 return sqlite3TableColumnAffinity(pExpr->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;
drhae80dde2012-12-06 21:16:43 +0000144 if( op==TK_CAST || op==TK_UPLUS ){
145 p = p->pLeft;
146 continue;
147 }
dan36e78302013-08-21 12:04:32 +0000148 if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
drh6fdd3d82013-05-15 17:47:12 +0000149 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
drhae80dde2012-12-06 21:16:43 +0000150 break;
151 }
drha58d4a92015-01-27 13:17:05 +0000152 if( (op==TK_AGG_COLUMN || op==TK_COLUMN
drhae80dde2012-12-06 21:16:43 +0000153 || op==TK_REGISTER || op==TK_TRIGGER)
drha58d4a92015-01-27 13:17:05 +0000154 && p->pTab!=0
drhae80dde2012-12-06 21:16:43 +0000155 ){
drh7d10d5a2008-08-20 16:35:10 +0000156 /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
157 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000158 int j = p->iColumn;
159 if( j>=0 ){
drhae80dde2012-12-06 21:16:43 +0000160 const char *zColl = p->pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000161 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000162 }
163 break;
danielk19770202b292004-06-09 09:55:16 +0000164 }
drhae80dde2012-12-06 21:16:43 +0000165 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000166 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000167 p = p->pLeft;
168 }else{
drh2308ed32015-02-09 16:09:34 +0000169 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000170 /* The Expr.x union is never used at the same time as Expr.pRight */
171 assert( p->x.pList==0 || p->pRight==0 );
172 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
173 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
174 ** least one EP_Collate. Thus the following two ALWAYS. */
175 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000176 int i;
drh6728cd92015-02-09 18:28:03 +0000177 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000178 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
179 pNext = p->x.pList->a[i].pExpr;
180 break;
181 }
182 }
183 }
184 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000185 }
186 }else{
drh7d10d5a2008-08-20 16:35:10 +0000187 break;
188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
danielk19777cedc8d2004-06-10 10:50:08 +0000190 if( sqlite3CheckCollSeq(pParse, pColl) ){
191 pColl = 0;
192 }
193 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000194}
195
196/*
drh70efa842017-09-28 01:58:23 +0000197** Return the collation sequence for the expression pExpr. If
198** there is no defined collating sequence, return a pointer to the
199** defautl collation sequence.
200**
201** See also: sqlite3ExprCollSeq()
202**
203** The sqlite3ExprCollSeq() routine works the same except that it
204** returns NULL if there is no defined collation.
205*/
206CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
207 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
208 if( p==0 ) p = pParse->db->pDfltColl;
209 assert( p!=0 );
210 return p;
211}
212
213/*
214** Return TRUE if the two expressions have equivalent collating sequences.
215*/
216int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
217 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
218 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
219 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
220}
221
222/*
drh626a8792005-01-17 22:08:19 +0000223** pExpr is an operand of a comparison operator. aff2 is the
224** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000225** type affinity that should be used for the comparison operator.
226*/
danielk1977e014a832004-05-17 10:48:57 +0000227char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000228 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000229 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000230 /* Both sides of the comparison are columns. If one has numeric
231 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000232 */
drh8a512562005-11-14 22:29:05 +0000233 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000234 return SQLITE_AFF_NUMERIC;
235 }else{
drh05883a32015-06-02 15:32:08 +0000236 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000237 }
238 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000239 /* Neither side of the comparison is a column. Compare the
240 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000241 */
drh05883a32015-06-02 15:32:08 +0000242 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000243 }else{
244 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000245 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000246 return (aff1 + aff2);
247 }
248}
249
drh53db1452004-05-20 13:54:53 +0000250/*
251** pExpr is a comparison operator. Return the type affinity that should
252** be applied to both operands prior to doing the comparison.
253*/
danielk1977e014a832004-05-17 10:48:57 +0000254static char comparisonAffinity(Expr *pExpr){
255 char aff;
256 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000258 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000259 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000260 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000261 if( pExpr->pRight ){
262 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000263 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
264 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000265 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000266 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000267 }
268 return aff;
269}
270
271/*
272** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273** idx_affinity is the affinity of an indexed column. Return true
274** if the index with affinity idx_affinity may be used to implement
275** the comparison in pExpr.
276*/
277int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000279 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000280 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000281 return 1;
282 case SQLITE_AFF_TEXT:
283 return idx_affinity==SQLITE_AFF_TEXT;
284 default:
285 return sqlite3IsNumericAffinity(idx_affinity);
286 }
danielk1977e014a832004-05-17 10:48:57 +0000287}
288
danielk1977a37cdde2004-05-16 11:15:36 +0000289/*
drh35573352008-01-08 23:54:25 +0000290** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000291** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000292*/
drh35573352008-01-08 23:54:25 +0000293static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
294 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000295 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000296 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000297}
298
drha2e00042002-01-22 03:13:42 +0000299/*
danielk19770202b292004-06-09 09:55:16 +0000300** Return a pointer to the collation sequence that should be used by
301** a binary comparison operator comparing pLeft and pRight.
302**
303** If the left hand expression has a collating sequence type, then it is
304** used. Otherwise the collation sequence for the right hand expression
305** is used, or the default (BINARY) if neither expression has a collating
306** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000307**
308** Argument pRight (but not pLeft) may be a null pointer. In this case,
309** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000310*/
drh0a0e1312007-08-07 17:04:59 +0000311CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000312 Parse *pParse,
313 Expr *pLeft,
314 Expr *pRight
315){
drhec41dda2007-02-07 13:09:45 +0000316 CollSeq *pColl;
317 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000318 if( pLeft->flags & EP_Collate ){
319 pColl = sqlite3ExprCollSeq(pParse, pLeft);
320 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000322 }else{
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 if( !pColl ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
326 }
danielk19770202b292004-06-09 09:55:16 +0000327 }
328 return pColl;
329}
330
331/*
drhbe5c89a2004-07-26 00:31:09 +0000332** Generate code for a comparison operator.
333*/
334static int codeCompare(
335 Parse *pParse, /* The parsing (and code generating) context */
336 Expr *pLeft, /* The left operand */
337 Expr *pRight, /* The right operand */
338 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000339 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000340 int dest, /* Jump here if true. */
341 int jumpIfNull /* If true, jump if either operand is NULL */
342){
drh35573352008-01-08 23:54:25 +0000343 int p5;
344 int addr;
345 CollSeq *p4;
346
347 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
348 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
349 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
350 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000351 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000352 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000353}
354
dancfbb5e82016-07-13 19:48:13 +0000355/*
dan870a0702016-08-01 16:37:43 +0000356** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000357**
358** A vector is defined as any expression that results in two or more
359** columns of result. Every TK_VECTOR node is an vector because the
360** parser will not generate a TK_VECTOR with fewer than two entries.
361** But a TK_SELECT might be either a vector or a scalar. It is only
362** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000363*/
364int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000365 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000366}
367
368/*
dancfbb5e82016-07-13 19:48:13 +0000369** If the expression passed as the only argument is of type TK_VECTOR
370** return the number of expressions in the vector. Or, if the expression
371** is a sub-select, return the number of columns in the sub-select. For
372** any other type of expression, return 1.
373*/
dan71c57db2016-07-09 20:23:55 +0000374int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000375 u8 op = pExpr->op;
376 if( op==TK_REGISTER ) op = pExpr->op2;
377 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000378 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000379 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000380 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000381 }else{
382 return 1;
dan71c57db2016-07-09 20:23:55 +0000383 }
dan71c57db2016-07-09 20:23:55 +0000384}
385
danba00e302016-07-23 20:24:06 +0000386/*
drhfc7f27b2016-08-20 00:07:01 +0000387** Return a pointer to a subexpression of pVector that is the i-th
388** column of the vector (numbered starting with 0). The caller must
389** ensure that i is within range.
390**
drh76dbe7a2016-08-20 21:02:38 +0000391** If pVector is really a scalar (and "scalar" here includes subqueries
392** that return a single column!) then return pVector unmodified.
393**
drhfc7f27b2016-08-20 00:07:01 +0000394** pVector retains ownership of the returned subexpression.
395**
396** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000397** just the expression for the i-th term of the result set, and may
398** not be ready for evaluation because the table cursor has not yet
399** been positioned.
danba00e302016-07-23 20:24:06 +0000400*/
drhfc7f27b2016-08-20 00:07:01 +0000401Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000402 assert( i<sqlite3ExprVectorSize(pVector) );
403 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000404 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
405 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000406 return pVector->x.pSelect->pEList->a[i].pExpr;
407 }else{
408 return pVector->x.pList->a[i].pExpr;
409 }
dan71c57db2016-07-09 20:23:55 +0000410 }
dan870a0702016-08-01 16:37:43 +0000411 return pVector;
dan71c57db2016-07-09 20:23:55 +0000412}
drhfc7f27b2016-08-20 00:07:01 +0000413
drhfc7f27b2016-08-20 00:07:01 +0000414/*
415** Compute and return a new Expr object which when passed to
416** sqlite3ExprCode() will generate all necessary code to compute
417** the iField-th column of the vector expression pVector.
418**
drh8762ec12016-08-20 01:06:22 +0000419** It is ok for pVector to be a scalar (as long as iField==0).
420** In that case, this routine works like sqlite3ExprDup().
421**
drhfc7f27b2016-08-20 00:07:01 +0000422** The caller owns the returned Expr object and is responsible for
423** ensuring that the returned value eventually gets freed.
424**
drh8762ec12016-08-20 01:06:22 +0000425** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000426** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000427** valid for the life of the returned object. If pVector is a TK_VECTOR
428** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000429** returns.
drh8762ec12016-08-20 01:06:22 +0000430**
431** A trick to cause a TK_SELECT pVector to be deleted together with
432** the returned Expr object is to attach the pVector to the pRight field
433** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000434*/
435Expr *sqlite3ExprForVectorField(
436 Parse *pParse, /* Parsing context */
437 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000438 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000439){
440 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000441 if( pVector->op==TK_SELECT ){
442 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000443 /* The TK_SELECT_COLUMN Expr node:
444 **
drh966e2912017-01-03 02:58:01 +0000445 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000446 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000447 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000448 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000449 ** pLeft->iTable: First in an array of register holding result, or 0
450 ** if the result is not yet computed.
451 **
452 ** sqlite3ExprDelete() specifically skips the recursive delete of
453 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000454 ** can be attached to pRight to cause this node to take ownership of
455 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
456 ** with the same pLeft pointer to the pVector, but only one of them
457 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000458 */
drhabfd35e2016-12-06 22:47:23 +0000459 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000460 if( pRet ){
461 pRet->iColumn = iField;
462 pRet->pLeft = pVector;
463 }
drhfc7f27b2016-08-20 00:07:01 +0000464 assert( pRet==0 || pRet->iTable==0 );
465 }else{
drha1251bc2016-08-20 00:51:37 +0000466 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
drhfc7f27b2016-08-20 00:07:01 +0000468 }
469 return pRet;
470}
dan71c57db2016-07-09 20:23:55 +0000471
dan5c288b92016-07-30 21:02:33 +0000472/*
473** If expression pExpr is of type TK_SELECT, generate code to evaluate
474** it. Return the register in which the result is stored (or, if the
475** sub-select returns more than one column, the first in an array
476** of registers in which the result is stored).
477**
478** If pExpr is not a TK_SELECT expression, return 0.
479*/
480static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000481 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000482#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000483 if( pExpr->op==TK_SELECT ){
484 reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
dan8da209b2016-07-26 18:06:08 +0000485 }
danf9b2e052016-08-02 17:45:00 +0000486#endif
dan8da209b2016-07-26 18:06:08 +0000487 return reg;
488}
489
dan5c288b92016-07-30 21:02:33 +0000490/*
491** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000492** or TK_SELECT that returns more than one column. This function returns
493** the register number of a register that contains the value of
494** element iField of the vector.
495**
496** If pVector is a TK_SELECT expression, then code for it must have
497** already been generated using the exprCodeSubselect() routine. In this
498** case parameter regSelect should be the first in an array of registers
499** containing the results of the sub-select.
500**
501** If pVector is of type TK_VECTOR, then code for the requested field
502** is generated. In this case (*pRegFree) may be set to the number of
503** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000504**
505** Before returning, output parameter (*ppExpr) is set to point to the
506** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000507*/
508static int exprVectorRegister(
509 Parse *pParse, /* Parse context */
510 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000511 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000512 int regSelect, /* First in array of registers */
513 Expr **ppExpr, /* OUT: Expression element */
514 int *pRegFree /* OUT: Temp register to free */
515){
drh12abf402016-08-22 14:30:05 +0000516 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000517 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000518 if( op==TK_REGISTER ){
519 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
520 return pVector->iTable+iField;
521 }
522 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000523 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
524 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000525 }
dan870a0702016-08-01 16:37:43 +0000526 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000527 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
528}
529
530/*
531** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000532** the result of the comparison (1, 0, or NULL) and write that
533** result into register dest.
534**
535** The caller must satisfy the following preconditions:
536**
537** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
538** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
539** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000540*/
drh79752b62016-08-13 10:02:17 +0000541static void codeVectorCompare(
542 Parse *pParse, /* Code generator context */
543 Expr *pExpr, /* The comparison operation */
544 int dest, /* Write results into this register */
545 u8 op, /* Comparison operator */
546 u8 p5 /* SQLITE_NULLEQ or zero */
547){
dan71c57db2016-07-09 20:23:55 +0000548 Vdbe *v = pParse->pVdbe;
549 Expr *pLeft = pExpr->pLeft;
550 Expr *pRight = pExpr->pRight;
551 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000552 int i;
553 int regLeft = 0;
554 int regRight = 0;
555 u8 opx = op;
556 int addrDone = sqlite3VdbeMakeLabel(v);
dan71c57db2016-07-09 20:23:55 +0000557
drh245ce622017-01-01 12:44:07 +0000558 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
559 sqlite3ErrorMsg(pParse, "row value misused");
560 return;
561 }
drhb29e60c2016-09-05 12:02:34 +0000562 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
563 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
564 || pExpr->op==TK_LT || pExpr->op==TK_GT
565 || pExpr->op==TK_LE || pExpr->op==TK_GE
566 );
567 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
568 || (pExpr->op==TK_ISNOT && op==TK_NE) );
569 assert( p5==0 || pExpr->op!=op );
570 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000571
drhb29e60c2016-09-05 12:02:34 +0000572 p5 |= SQLITE_STOREP2;
573 if( opx==TK_LE ) opx = TK_LT;
574 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000575
drhb29e60c2016-09-05 12:02:34 +0000576 regLeft = exprCodeSubselect(pParse, pLeft);
577 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000578
drhb29e60c2016-09-05 12:02:34 +0000579 for(i=0; 1 /*Loop exits by "break"*/; i++){
580 int regFree1 = 0, regFree2 = 0;
581 Expr *pL, *pR;
582 int r1, r2;
583 assert( i>=0 && i<nLeft );
584 if( i>0 ) sqlite3ExprCachePush(pParse);
585 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);
596 if( i>0 ) sqlite3ExprCachePop(pParse);
597 if( i==nLeft-1 ){
598 break;
dan71c57db2016-07-09 20:23:55 +0000599 }
drhb29e60c2016-09-05 12:02:34 +0000600 if( opx==TK_EQ ){
601 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
602 p5 |= SQLITE_KEEPNULL;
603 }else if( opx==TK_NE ){
604 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
605 p5 |= SQLITE_KEEPNULL;
606 }else{
607 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
608 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
609 VdbeCoverageIf(v, op==TK_LT);
610 VdbeCoverageIf(v, op==TK_GT);
611 VdbeCoverageIf(v, op==TK_LE);
612 VdbeCoverageIf(v, op==TK_GE);
613 if( i==nLeft-2 ) opx = op;
614 }
dan71c57db2016-07-09 20:23:55 +0000615 }
drhb29e60c2016-09-05 12:02:34 +0000616 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000617}
618
danielk19774b5255a2008-06-05 16:47:39 +0000619#if SQLITE_MAX_EXPR_DEPTH>0
620/*
621** Check that argument nHeight is less than or equal to the maximum
622** expression depth allowed. If it is not, leave an error message in
623** pParse.
624*/
drh7d10d5a2008-08-20 16:35:10 +0000625int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000626 int rc = SQLITE_OK;
627 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
628 if( nHeight>mxHeight ){
629 sqlite3ErrorMsg(pParse,
630 "Expression tree is too large (maximum depth %d)", mxHeight
631 );
632 rc = SQLITE_ERROR;
633 }
634 return rc;
635}
636
637/* The following three functions, heightOfExpr(), heightOfExprList()
638** and heightOfSelect(), are used to determine the maximum height
639** of any expression tree referenced by the structure passed as the
640** first argument.
641**
642** If this maximum height is greater than the current value pointed
643** to by pnHeight, the second parameter, then set *pnHeight to that
644** value.
645*/
646static void heightOfExpr(Expr *p, int *pnHeight){
647 if( p ){
648 if( p->nHeight>*pnHeight ){
649 *pnHeight = p->nHeight;
650 }
651 }
652}
653static void heightOfExprList(ExprList *p, int *pnHeight){
654 if( p ){
655 int i;
656 for(i=0; i<p->nExpr; i++){
657 heightOfExpr(p->a[i].pExpr, pnHeight);
658 }
659 }
660}
dan1a3a3082018-01-18 19:00:54 +0000661static void heightOfSelect(Select *pSelect, int *pnHeight){
662 Select *p;
663 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000664 heightOfExpr(p->pWhere, pnHeight);
665 heightOfExpr(p->pHaving, pnHeight);
666 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000667 heightOfExprList(p->pEList, pnHeight);
668 heightOfExprList(p->pGroupBy, pnHeight);
669 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000670 }
671}
672
673/*
674** Set the Expr.nHeight variable in the structure passed as an
675** argument. An expression with no children, Expr.pList or
676** Expr.pSelect member has a height of 1. Any other expression
677** has a height equal to the maximum height of any other
678** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000679**
680** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
681** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000682*/
683static void exprSetHeight(Expr *p){
684 int nHeight = 0;
685 heightOfExpr(p->pLeft, &nHeight);
686 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000687 if( ExprHasProperty(p, EP_xIsSelect) ){
688 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000689 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000690 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000691 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000692 }
danielk19774b5255a2008-06-05 16:47:39 +0000693 p->nHeight = nHeight + 1;
694}
695
696/*
697** Set the Expr.nHeight variable using the exprSetHeight() function. If
698** the height is greater than the maximum allowed expression depth,
699** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000700**
701** Also propagate all EP_Propagate flags from the Expr.x.pList into
702** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000703*/
drh2308ed32015-02-09 16:09:34 +0000704void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000705 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000706 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000707 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000708}
709
710/*
711** Return the maximum height of any expression tree referenced
712** by the select statement passed as an argument.
713*/
714int sqlite3SelectExprHeight(Select *p){
715 int nHeight = 0;
716 heightOfSelect(p, &nHeight);
717 return nHeight;
718}
drh2308ed32015-02-09 16:09:34 +0000719#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
720/*
721** Propagate all EP_Propagate flags from the Expr.x.pList into
722** Expr.flags.
723*/
724void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
725 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
726 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
727 }
728}
729#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000730#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
731
drhbe5c89a2004-07-26 00:31:09 +0000732/*
drhb7916a72009-05-27 10:31:29 +0000733** This routine is the core allocator for Expr nodes.
734**
drha76b5df2002-02-23 02:32:10 +0000735** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000736** for this node and for the pToken argument is a single allocation
737** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000738** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000739**
740** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000741** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000742** parameter is ignored if pToken is NULL or if the token does not
743** appear to be quoted. If the quotes were of the form "..." (double-quotes)
744** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000745**
746** Special case: If op==TK_INTEGER and pToken points to a string that
747** can be translated into a 32-bit integer, then the token is not
748** stored in u.zToken. Instead, the integer values is written
749** into u.iValue and the EP_IntValue flag is set. No extra storage
750** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000751*/
drhb7916a72009-05-27 10:31:29 +0000752Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000753 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000754 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000755 const Token *pToken, /* Token argument. Might be NULL */
756 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000757){
drha76b5df2002-02-23 02:32:10 +0000758 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000759 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000760 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000761
drh575fad62016-02-05 13:38:36 +0000762 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000763 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000764 if( op!=TK_INTEGER || pToken->z==0
765 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
766 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000767 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000768 }
drhb7916a72009-05-27 10:31:29 +0000769 }
drh575fad62016-02-05 13:38:36 +0000770 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000771 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000772 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000773 pNew->op = (u8)op;
774 pNew->iAgg = -1;
775 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000776 if( nExtra==0 ){
drhb98a2e32017-07-07 12:43:57 +0000777 pNew->flags |= EP_IntValue|EP_Leaf;
drh33e619f2009-05-28 01:00:55 +0000778 pNew->u.iValue = iValue;
779 }else{
drh33e619f2009-05-28 01:00:55 +0000780 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000781 assert( pToken->z!=0 || pToken->n==0 );
782 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000783 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000784 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
785 if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
drh33e619f2009-05-28 01:00:55 +0000786 sqlite3Dequote(pNew->u.zToken);
drh33e619f2009-05-28 01:00:55 +0000787 }
drhb7916a72009-05-27 10:31:29 +0000788 }
789 }
790#if SQLITE_MAX_EXPR_DEPTH>0
791 pNew->nHeight = 1;
792#endif
793 }
drha76b5df2002-02-23 02:32:10 +0000794 return pNew;
795}
796
797/*
drhb7916a72009-05-27 10:31:29 +0000798** Allocate a new expression node from a zero-terminated token that has
799** already been dequoted.
800*/
801Expr *sqlite3Expr(
802 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
803 int op, /* Expression opcode */
804 const char *zToken /* Token argument. Might be NULL */
805){
806 Token x;
807 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000808 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000809 return sqlite3ExprAlloc(db, op, &x, 0);
810}
811
812/*
813** Attach subtrees pLeft and pRight to the Expr node pRoot.
814**
815** If pRoot==NULL that means that a memory allocation error has occurred.
816** In that case, delete the subtrees pLeft and pRight.
817*/
818void sqlite3ExprAttachSubtrees(
819 sqlite3 *db,
820 Expr *pRoot,
821 Expr *pLeft,
822 Expr *pRight
823){
824 if( pRoot==0 ){
825 assert( db->mallocFailed );
826 sqlite3ExprDelete(db, pLeft);
827 sqlite3ExprDelete(db, pRight);
828 }else{
829 if( pRight ){
830 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000831 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000832 }
833 if( pLeft ){
834 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000835 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000836 }
837 exprSetHeight(pRoot);
838 }
839}
840
841/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000842** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000843**
drhbf664462009-06-19 18:32:54 +0000844** One or both of the subtrees can be NULL. Return a pointer to the new
845** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
846** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000847*/
drh17435752007-08-16 04:30:38 +0000848Expr *sqlite3PExpr(
849 Parse *pParse, /* Parsing context */
850 int op, /* Expression opcode */
851 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000852 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000853){
drh5fb52ca2012-03-31 02:34:35 +0000854 Expr *p;
drh1167d322015-10-28 20:01:45 +0000855 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000856 /* Take advantage of short-circuit false optimization for AND */
857 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
858 }else{
drhabfd35e2016-12-06 22:47:23 +0000859 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
860 if( p ){
861 memset(p, 0, sizeof(Expr));
862 p->op = op & TKFLG_MASK;
863 p->iAgg = -1;
864 }
drh5fb52ca2012-03-31 02:34:35 +0000865 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
866 }
dan2b359bd2010-10-28 11:31:23 +0000867 if( p ) {
868 sqlite3ExprCheckHeight(pParse, p->nHeight);
869 }
drh4e0cff62004-11-05 05:10:28 +0000870 return p;
871}
872
873/*
drh08de4f72016-04-11 01:06:47 +0000874** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
875** do a memory allocation failure) then delete the pSelect object.
876*/
877void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
878 if( pExpr ){
879 pExpr->x.pSelect = pSelect;
880 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
881 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
882 }else{
883 assert( pParse->db->mallocFailed );
884 sqlite3SelectDelete(pParse->db, pSelect);
885 }
886}
887
888
889/*
drh991a1982014-01-02 17:57:16 +0000890** If the expression is always either TRUE or FALSE (respectively),
891** then return 1. If one cannot determine the truth value of the
892** expression at compile-time return 0.
893**
894** This is an optimization. If is OK to return 0 here even if
895** the expression really is always false or false (a false negative).
896** But it is a bug to return 1 if the expression might have different
897** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000898**
899** Note that if the expression is part of conditional for a
900** LEFT JOIN, then we cannot determine at compile-time whether or not
901** is it true or false, so always return 0.
902*/
drh991a1982014-01-02 17:57:16 +0000903static int exprAlwaysTrue(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}
drh5fb52ca2012-03-31 02:34:35 +0000909static int exprAlwaysFalse(Expr *p){
910 int v = 0;
911 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
912 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
913 return v==0;
914}
915
916/*
drh91bb0ee2004-09-01 03:06:34 +0000917** Join two expressions using an AND operator. If either expression is
918** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000919**
920** If one side or the other of the AND is known to be false, then instead
921** of returning an AND expression, just return a constant expression with
922** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000923*/
danielk19771e536952007-08-16 10:09:01 +0000924Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000925 if( pLeft==0 ){
926 return pRight;
927 }else if( pRight==0 ){
928 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000929 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
930 sqlite3ExprDelete(db, pLeft);
931 sqlite3ExprDelete(db, pRight);
932 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000933 }else{
drhb7916a72009-05-27 10:31:29 +0000934 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
935 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
936 return pNew;
drha76b5df2002-02-23 02:32:10 +0000937 }
938}
939
940/*
941** Construct a new expression node for a function with multiple
942** arguments.
943*/
drh17435752007-08-16 04:30:38 +0000944Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
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 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000953 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000954 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000955 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000956 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drha76b5df2002-02-23 02:32:10 +0000957 return pNew;
958}
959
960/*
drhfa6bc002004-09-07 16:19:52 +0000961** Assign a variable number to an expression that encodes a wildcard
962** in the original SQL statement.
963**
964** Wildcards consisting of a single "?" are assigned the next sequential
965** variable number.
966**
967** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000968** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000969** the SQL statement comes from an external source.
970**
drh51f49f12009-05-21 20:41:32 +0000971** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000972** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000973** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000974** assigned.
975*/
drhde25a882016-10-03 15:28:24 +0000976void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000977 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000978 const char *z;
drhf326d662016-12-23 13:30:53 +0000979 ynVar x;
drh17435752007-08-16 04:30:38 +0000980
drhfa6bc002004-09-07 16:19:52 +0000981 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000982 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000983 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000984 assert( z!=0 );
985 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000986 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000987 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000988 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000989 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000990 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000991 }else{
drhf326d662016-12-23 13:30:53 +0000992 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000993 if( z[0]=='?' ){
994 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
995 ** use it as the variable number */
996 i64 i;
drh18814df2017-01-31 03:52:34 +0000997 int bOk;
998 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
999 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1000 bOk = 1;
1001 }else{
1002 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1003 }
drh124c0b42011-06-01 18:15:55 +00001004 testcase( i==0 );
1005 testcase( i==1 );
1006 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1007 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1008 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1009 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1010 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001011 return;
drhfa6bc002004-09-07 16:19:52 +00001012 }
drh8e74e7b2017-01-31 12:41:48 +00001013 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001014 if( x>pParse->nVar ){
1015 pParse->nVar = (int)x;
1016 doAdd = 1;
1017 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1018 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001019 }
1020 }else{
1021 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1022 ** number as the prior appearance of the same name, or if the name
1023 ** has never appeared before, reuse the same variable number
1024 */
drh9bf755c2016-12-23 03:59:31 +00001025 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1026 if( x==0 ){
1027 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001028 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001029 }
drhfa6bc002004-09-07 16:19:52 +00001030 }
drhf326d662016-12-23 13:30:53 +00001031 if( doAdd ){
1032 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1033 }
1034 }
1035 pExpr->iColumn = x;
1036 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001037 sqlite3ErrorMsg(pParse, "too many SQL variables");
1038 }
drhfa6bc002004-09-07 16:19:52 +00001039}
1040
1041/*
danf6963f92009-11-23 14:39:14 +00001042** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001043*/
drh4f0010b2016-04-11 14:49:39 +00001044static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1045 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001046 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1047 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drh209bc522016-09-23 21:36:24 +00001048#ifdef SQLITE_DEBUG
1049 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1050 assert( p->pLeft==0 );
1051 assert( p->pRight==0 );
1052 assert( p->x.pSelect==0 );
1053 }
1054#endif
1055 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001056 /* The Expr.x union is never used at the same time as Expr.pRight */
1057 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001058 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001059 if( p->pRight ){
1060 sqlite3ExprDeleteNN(db, p->pRight);
1061 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001062 sqlite3SelectDelete(db, p->x.pSelect);
1063 }else{
1064 sqlite3ExprListDelete(db, p->x.pList);
1065 }
1066 }
drh209bc522016-09-23 21:36:24 +00001067 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001068 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001069 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001070 }
drha2e00042002-01-22 03:13:42 +00001071}
drh4f0010b2016-04-11 14:49:39 +00001072void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1073 if( p ) sqlite3ExprDeleteNN(db, p);
1074}
drha2e00042002-01-22 03:13:42 +00001075
drhd2687b72005-08-12 22:56:09 +00001076/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001077** Return the number of bytes allocated for the expression structure
1078** passed as the first argument. This is always one of EXPR_FULLSIZE,
1079** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1080*/
1081static int exprStructSize(Expr *p){
1082 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001083 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1084 return EXPR_FULLSIZE;
1085}
1086
1087/*
drh33e619f2009-05-28 01:00:55 +00001088** The dupedExpr*Size() routines each return the number of bytes required
1089** to store a copy of an expression or expression tree. They differ in
1090** how much of the tree is measured.
1091**
1092** dupedExprStructSize() Size of only the Expr structure
1093** dupedExprNodeSize() Size of Expr + space for token
1094** dupedExprSize() Expr + token + subtree components
1095**
1096***************************************************************************
1097**
1098** The dupedExprStructSize() function returns two values OR-ed together:
1099** (1) the space required for a copy of the Expr structure only and
1100** (2) the EP_xxx flags that indicate what the structure size should be.
1101** The return values is always one of:
1102**
1103** EXPR_FULLSIZE
1104** EXPR_REDUCEDSIZE | EP_Reduced
1105** EXPR_TOKENONLYSIZE | EP_TokenOnly
1106**
1107** The size of the structure can be found by masking the return value
1108** of this routine with 0xfff. The flags can be found by masking the
1109** return value with EP_Reduced|EP_TokenOnly.
1110**
1111** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1112** (unreduced) Expr objects as they or originally constructed by the parser.
1113** During expression analysis, extra information is computed and moved into
1114** later parts of teh Expr object and that extra information might get chopped
1115** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001116** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001117** to reduce a pristine expression tree from the parser. The implementation
1118** of dupedExprStructSize() contain multiple assert() statements that attempt
1119** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001120*/
1121static int dupedExprStructSize(Expr *p, int flags){
1122 int nSize;
drh33e619f2009-05-28 01:00:55 +00001123 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001124 assert( EXPR_FULLSIZE<=0xfff );
1125 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
drh43c4ac82018-02-26 21:26:27 +00001126 if( 0==flags || p->op==TK_SELECT_COLUMN ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 }else{
drhc5cd1242013-09-12 16:50:49 +00001129 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001130 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001131 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001132 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001133 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001134 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1135 }else{
drhaecd8022013-09-13 18:15:15 +00001136 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001137 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1138 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001139 }
1140 return nSize;
1141}
1142
1143/*
drh33e619f2009-05-28 01:00:55 +00001144** This function returns the space in bytes required to store the copy
1145** of the Expr structure and a copy of the Expr.u.zToken string (if that
1146** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001147*/
1148static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001149 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1150 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1151 nByte += sqlite3Strlen30(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001152 }
danielk1977bc739712009-03-23 04:33:32 +00001153 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001154}
1155
1156/*
1157** Return the number of bytes required to create a duplicate of the
1158** expression passed as the first argument. The second argument is a
1159** mask containing EXPRDUP_XXX flags.
1160**
1161** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001162** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001163**
1164** If the EXPRDUP_REDUCE flag is set, then the return value includes
1165** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1166** and Expr.pRight variables (but not for any structures pointed to or
1167** descended from the Expr.x.pList or Expr.x.pSelect variables).
1168*/
1169static int dupedExprSize(Expr *p, int flags){
1170 int nByte = 0;
1171 if( p ){
1172 nByte = dupedExprNodeSize(p, flags);
1173 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001174 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001175 }
1176 }
1177 return nByte;
1178}
1179
1180/*
1181** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1182** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001183** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001184** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001185** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001186** portion of the buffer copied into by this function.
1187*/
drh3c194692016-04-11 16:43:43 +00001188static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1189 Expr *pNew; /* Value to return */
1190 u8 *zAlloc; /* Memory space from which to build Expr object */
1191 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1192
drh575fad62016-02-05 13:38:36 +00001193 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001194 assert( p );
1195 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1196 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001197
drh3c194692016-04-11 16:43:43 +00001198 /* Figure out where to write the new Expr structure. */
1199 if( pzBuffer ){
1200 zAlloc = *pzBuffer;
1201 staticFlag = EP_Static;
1202 }else{
1203 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1204 staticFlag = 0;
1205 }
1206 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001207
drh3c194692016-04-11 16:43:43 +00001208 if( pNew ){
1209 /* Set nNewSize to the size allocated for the structure pointed to
1210 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1211 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1212 ** by the copy of the p->u.zToken string (if any).
1213 */
1214 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1215 const int nNewSize = nStructSize & 0xfff;
1216 int nToken;
1217 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1218 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001219 }else{
drh3c194692016-04-11 16:43:43 +00001220 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001221 }
drh3c194692016-04-11 16:43:43 +00001222 if( dupFlags ){
1223 assert( ExprHasProperty(p, EP_Reduced)==0 );
1224 memcpy(zAlloc, p, nNewSize);
1225 }else{
1226 u32 nSize = (u32)exprStructSize(p);
1227 memcpy(zAlloc, p, nSize);
1228 if( nSize<EXPR_FULLSIZE ){
1229 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1230 }
1231 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001232
drh3c194692016-04-11 16:43:43 +00001233 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1234 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1235 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1236 pNew->flags |= staticFlag;
1237
1238 /* Copy the p->u.zToken string, if any. */
1239 if( nToken ){
1240 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1241 memcpy(zToken, p->u.zToken, nToken);
1242 }
1243
drh209bc522016-09-23 21:36:24 +00001244 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001245 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1246 if( ExprHasProperty(p, EP_xIsSelect) ){
1247 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001248 }else{
drh3c194692016-04-11 16:43:43 +00001249 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001250 }
drh3c194692016-04-11 16:43:43 +00001251 }
1252
1253 /* Fill in pNew->pLeft and pNew->pRight. */
1254 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
1255 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001256 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001257 pNew->pLeft = p->pLeft ?
1258 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1259 pNew->pRight = p->pRight ?
1260 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001261 }
drh3c194692016-04-11 16:43:43 +00001262 if( pzBuffer ){
1263 *pzBuffer = zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001264 }
drh3c194692016-04-11 16:43:43 +00001265 }else{
drh209bc522016-09-23 21:36:24 +00001266 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001267 if( pNew->op==TK_SELECT_COLUMN ){
1268 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001269 assert( p->iColumn==0 || p->pRight==0 );
1270 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001271 }else{
1272 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1273 }
drh3c194692016-04-11 16:43:43 +00001274 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001275 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001276 }
1277 }
1278 return pNew;
1279}
1280
1281/*
danbfe31e72014-01-15 14:17:31 +00001282** Create and return a deep copy of the object passed as the second
1283** argument. If an OOM condition is encountered, NULL is returned
1284** and the db->mallocFailed flag set.
1285*/
daneede6a52014-01-15 19:42:23 +00001286#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001287static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001288 With *pRet = 0;
1289 if( p ){
1290 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
1291 pRet = sqlite3DbMallocZero(db, nByte);
1292 if( pRet ){
1293 int i;
1294 pRet->nCte = p->nCte;
1295 for(i=0; i<p->nCte; i++){
1296 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1297 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1298 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1299 }
1300 }
1301 }
1302 return pRet;
1303}
daneede6a52014-01-15 19:42:23 +00001304#else
1305# define withDup(x,y) 0
1306#endif
dan4e9119d2014-01-13 15:12:23 +00001307
drha76b5df2002-02-23 02:32:10 +00001308/*
drhff78bd22002-02-27 01:47:11 +00001309** The following group of routines make deep copies of expressions,
1310** expression lists, ID lists, and select statements. The copies can
1311** be deleted (by being passed to their respective ...Delete() routines)
1312** without effecting the originals.
1313**
danielk19774adee202004-05-08 08:23:19 +00001314** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1315** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001316** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001317**
drhad3cab52002-05-24 02:04:32 +00001318** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001319**
drhb7916a72009-05-27 10:31:29 +00001320** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001321** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1322** truncated version of the usual Expr structure that will be stored as
1323** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001324*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001325Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001326 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001327 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001328}
danielk19776ab3a2e2009-02-19 14:39:25 +00001329ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001330 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001331 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001332 int i;
drhb1637482017-01-03 00:27:16 +00001333 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001334 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001335 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001336 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001337 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001338 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001339 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001340 pOldItem = p->a;
1341 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001342 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001343 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001344 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001345 if( pOldExpr
1346 && pOldExpr->op==TK_SELECT_COLUMN
1347 && (pNewExpr = pItem->pExpr)!=0
1348 ){
1349 assert( pNewExpr->iColumn==0 || i>0 );
1350 if( pNewExpr->iColumn==0 ){
1351 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001352 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1353 }else{
1354 assert( i>0 );
1355 assert( pItem[-1].pExpr!=0 );
1356 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1357 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1358 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001359 }
1360 }
drh17435752007-08-16 04:30:38 +00001361 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001362 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001363 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001364 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001365 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
drhc2acc4e2013-11-15 18:15:19 +00001366 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001367 }
1368 return pNew;
1369}
danielk197793758c82005-01-21 08:13:14 +00001370
1371/*
1372** If cursors, triggers, views and subqueries are all omitted from
1373** the build, then none of the following routines, except for
1374** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1375** called with a NULL argument.
1376*/
danielk19776a67fe82005-02-04 04:07:16 +00001377#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1378 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001379SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001380 SrcList *pNew;
1381 int i;
drh113088e2003-03-20 01:16:58 +00001382 int nByte;
drh575fad62016-02-05 13:38:36 +00001383 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001384 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001385 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001386 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001387 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001388 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001389 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001390 struct SrcList_item *pNewItem = &pNew->a[i];
1391 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001392 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001393 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001394 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1395 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1396 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001397 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001398 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001399 pNewItem->addrFillSub = pOldItem->addrFillSub;
1400 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001401 if( pNewItem->fg.isIndexedBy ){
1402 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1403 }
1404 pNewItem->pIBIndex = pOldItem->pIBIndex;
1405 if( pNewItem->fg.isTabFunc ){
1406 pNewItem->u1.pFuncArg =
1407 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1408 }
drhed8a3bb2005-06-06 21:19:56 +00001409 pTab = pNewItem->pTab = pOldItem->pTab;
1410 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001411 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001412 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001413 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1414 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001415 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001416 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001417 }
1418 return pNew;
1419}
drh17435752007-08-16 04:30:38 +00001420IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001421 IdList *pNew;
1422 int i;
drh575fad62016-02-05 13:38:36 +00001423 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001424 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001425 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001426 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001427 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001428 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001429 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001430 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001431 return 0;
1432 }
drh6c535152012-02-02 03:38:30 +00001433 /* Note that because the size of the allocation for p->a[] is not
1434 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1435 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001436 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001437 struct IdList_item *pNewItem = &pNew->a[i];
1438 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001439 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001440 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001441 }
1442 return pNew;
1443}
dana7466202017-02-03 14:44:52 +00001444Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1445 Select *pRet = 0;
1446 Select *pNext = 0;
1447 Select **pp = &pRet;
1448 Select *p;
1449
drh575fad62016-02-05 13:38:36 +00001450 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001451 for(p=pDup; p; p=p->pPrior){
1452 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1453 if( pNew==0 ) break;
1454 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1455 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1456 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1457 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1458 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1459 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1460 pNew->op = p->op;
1461 pNew->pNext = pNext;
1462 pNew->pPrior = 0;
1463 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001464 pNew->iLimit = 0;
1465 pNew->iOffset = 0;
1466 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1467 pNew->addrOpenEphm[0] = -1;
1468 pNew->addrOpenEphm[1] = -1;
1469 pNew->nSelectRow = p->nSelectRow;
1470 pNew->pWith = withDup(db, p->pWith);
1471 sqlite3SelectSetName(pNew, p->zSelName);
1472 *pp = pNew;
1473 pp = &pNew->pPrior;
1474 pNext = pNew;
1475 }
1476
1477 return pRet;
drhff78bd22002-02-27 01:47:11 +00001478}
danielk197793758c82005-01-21 08:13:14 +00001479#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001480Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001481 assert( p==0 );
1482 return 0;
1483}
1484#endif
drhff78bd22002-02-27 01:47:11 +00001485
1486
1487/*
drha76b5df2002-02-23 02:32:10 +00001488** Add a new element to the end of an expression list. If pList is
1489** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001490**
drha19543f2017-09-15 15:17:48 +00001491** The pList argument must be either NULL or a pointer to an ExprList
1492** obtained from a prior call to sqlite3ExprListAppend(). This routine
1493** may not be used with an ExprList obtained from sqlite3ExprListDup().
1494** Reason: This routine assumes that the number of slots in pList->a[]
1495** is a power of two. That is true for sqlite3ExprListAppend() returns
1496** but is not necessarily true from the return value of sqlite3ExprListDup().
1497**
drhb7916a72009-05-27 10:31:29 +00001498** If a memory allocation error occurs, the entire list is freed and
1499** NULL is returned. If non-NULL is returned, then it is guaranteed
1500** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001501*/
drh17435752007-08-16 04:30:38 +00001502ExprList *sqlite3ExprListAppend(
1503 Parse *pParse, /* Parsing context */
1504 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001505 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001506){
drh43606172017-04-05 11:32:13 +00001507 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001508 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001509 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001510 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001511 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001512 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001513 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001514 }
drhc263f7c2016-01-18 13:18:54 +00001515 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001516 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001517 ExprList *pNew;
1518 pNew = sqlite3DbRealloc(db, pList,
drha19543f2017-09-15 15:17:48 +00001519 sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001520 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001521 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001522 }
drh43606172017-04-05 11:32:13 +00001523 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001524 }
drh43606172017-04-05 11:32:13 +00001525 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001526 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1527 assert( offsetof(struct ExprList_item,pExpr)==0 );
1528 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001529 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001530 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001531
1532no_mem:
1533 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001534 sqlite3ExprDelete(db, pExpr);
1535 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001536 return 0;
drha76b5df2002-02-23 02:32:10 +00001537}
1538
1539/*
drh8762ec12016-08-20 01:06:22 +00001540** pColumns and pExpr form a vector assignment which is part of the SET
1541** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001542**
1543** (a,b,c) = (expr1,expr2,expr3)
1544** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1545**
1546** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001547** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001548** TK_SELECT_COLUMN expressions.
1549*/
1550ExprList *sqlite3ExprListAppendVector(
1551 Parse *pParse, /* Parsing context */
1552 ExprList *pList, /* List to which to append. Might be NULL */
1553 IdList *pColumns, /* List of names of LHS of the assignment */
1554 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1555){
1556 sqlite3 *db = pParse->db;
1557 int n;
1558 int i;
drh66860af2016-08-23 18:30:10 +00001559 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001560 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1561 ** exit prior to this routine being invoked */
1562 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001563 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001564
1565 /* If the RHS is a vector, then we can immediately check to see that
1566 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1567 ** wildcards ("*") in the result set of the SELECT must be expanded before
1568 ** we can do the size check, so defer the size check until code generation.
1569 */
1570 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001571 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1572 pColumns->nId, n);
1573 goto vector_append_error;
1574 }
drh966e2912017-01-03 02:58:01 +00001575
1576 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001577 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1578 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1579 if( pList ){
drh66860af2016-08-23 18:30:10 +00001580 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001581 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1582 pColumns->a[i].zName = 0;
1583 }
1584 }
drh966e2912017-01-03 02:58:01 +00001585
drhffe28052017-05-06 18:09:36 +00001586 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001587 Expr *pFirst = pList->a[iFirst].pExpr;
1588 assert( pFirst!=0 );
1589 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001590
drhf4dd26c2017-04-05 11:49:06 +00001591 /* Store the SELECT statement in pRight so it will be deleted when
1592 ** sqlite3ExprListDelete() is called */
1593 pFirst->pRight = pExpr;
1594 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001595
drhf4dd26c2017-04-05 11:49:06 +00001596 /* Remember the size of the LHS in iTable so that we can check that
1597 ** the RHS and LHS sizes match during code generation. */
1598 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001599 }
1600
1601vector_append_error:
1602 sqlite3ExprDelete(db, pExpr);
1603 sqlite3IdListDelete(db, pColumns);
1604 return pList;
1605}
1606
1607/*
drhbc622bc2015-08-24 15:39:42 +00001608** Set the sort order for the last element on the given ExprList.
1609*/
1610void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1611 if( p==0 ) return;
1612 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1613 assert( p->nExpr>0 );
1614 if( iSortOrder<0 ){
1615 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1616 return;
1617 }
1618 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001619}
1620
1621/*
drhb7916a72009-05-27 10:31:29 +00001622** Set the ExprList.a[].zName element of the most recently added item
1623** on the expression list.
1624**
1625** pList might be NULL following an OOM error. But pName should never be
1626** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1627** is set.
1628*/
1629void sqlite3ExprListSetName(
1630 Parse *pParse, /* Parsing context */
1631 ExprList *pList, /* List to which to add the span. */
1632 Token *pName, /* Name to be added */
1633 int dequote /* True to cause the name to be dequoted */
1634){
1635 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1636 if( pList ){
1637 struct ExprList_item *pItem;
1638 assert( pList->nExpr>0 );
1639 pItem = &pList->a[pList->nExpr-1];
1640 assert( pItem->zName==0 );
1641 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001642 if( dequote ) sqlite3Dequote(pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001643 }
1644}
1645
1646/*
1647** Set the ExprList.a[].zSpan element of the most recently added item
1648** on the expression list.
1649**
1650** pList might be NULL following an OOM error. But pSpan should never be
1651** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1652** is set.
1653*/
1654void sqlite3ExprListSetSpan(
1655 Parse *pParse, /* Parsing context */
1656 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001657 const char *zStart, /* Start of the span */
1658 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001659){
1660 sqlite3 *db = pParse->db;
1661 assert( pList!=0 || db->mallocFailed!=0 );
1662 if( pList ){
1663 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1664 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001665 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001666 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001667 }
1668}
1669
1670/*
danielk19777a15a4b2007-05-08 17:54:43 +00001671** If the expression list pEList contains more than iLimit elements,
1672** leave an error message in pParse.
1673*/
1674void sqlite3ExprListCheckLength(
1675 Parse *pParse,
1676 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001677 const char *zObject
1678){
drhb1a6c3c2008-03-20 16:30:17 +00001679 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001680 testcase( pEList && pEList->nExpr==mx );
1681 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001682 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001683 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1684 }
1685}
1686
1687/*
drha76b5df2002-02-23 02:32:10 +00001688** Delete an entire expression list.
1689*/
drhaffa8552016-04-11 18:25:05 +00001690static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001691 int i = pList->nExpr;
1692 struct ExprList_item *pItem = pList->a;
1693 assert( pList->nExpr>0 );
1694 do{
drh633e6d52008-07-28 19:34:53 +00001695 sqlite3ExprDelete(db, pItem->pExpr);
1696 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001697 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001698 pItem++;
1699 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001700 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001701}
drhaffa8552016-04-11 18:25:05 +00001702void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1703 if( pList ) exprListDeleteNN(db, pList);
1704}
drha76b5df2002-02-23 02:32:10 +00001705
1706/*
drh2308ed32015-02-09 16:09:34 +00001707** Return the bitwise-OR of all Expr.flags fields in the given
1708** ExprList.
drh885a5b02015-02-09 15:21:36 +00001709*/
drh2308ed32015-02-09 16:09:34 +00001710u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001711 int i;
drh2308ed32015-02-09 16:09:34 +00001712 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001713 assert( pList!=0 );
1714 for(i=0; i<pList->nExpr; i++){
1715 Expr *pExpr = pList->a[i].pExpr;
1716 assert( pExpr!=0 );
1717 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001718 }
drh2308ed32015-02-09 16:09:34 +00001719 return m;
drh885a5b02015-02-09 15:21:36 +00001720}
1721
1722/*
drh7e6f9802017-09-04 00:33:04 +00001723** This is a SELECT-node callback for the expression walker that
1724** always "fails". By "fail" in this case, we mean set
1725** pWalker->eCode to zero and abort.
1726**
1727** This callback is used by multiple expression walkers.
1728*/
1729int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1730 UNUSED_PARAMETER(NotUsed);
1731 pWalker->eCode = 0;
1732 return WRC_Abort;
1733}
1734
1735/*
drh171d16b2018-02-26 20:15:54 +00001736** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001737** then convert it into an TK_TRUEFALSE term. Return non-zero if
1738** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001739*/
1740int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1741 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1742 if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1743 || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1744 ){
1745 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001746 return 1;
1747 }
1748 return 0;
1749}
1750
drh43c4ac82018-02-26 21:26:27 +00001751/*
drh96acafb2018-02-27 14:49:25 +00001752** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001753** and 0 if it is FALSE.
1754*/
drh96acafb2018-02-27 14:49:25 +00001755int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001756 assert( pExpr->op==TK_TRUEFALSE );
1757 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1758 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1759 return pExpr->u.zToken[4]==0;
1760}
1761
drh171d16b2018-02-26 20:15:54 +00001762
1763/*
drh059b2d52014-10-24 19:28:09 +00001764** These routines are Walker callbacks used to check expressions to
1765** see if they are "constant" for some definition of constant. The
1766** Walker.eCode value determines the type of "constant" we are looking
1767** for.
drh73b211a2005-01-18 04:00:42 +00001768**
drh7d10d5a2008-08-20 16:35:10 +00001769** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001770**
drh059b2d52014-10-24 19:28:09 +00001771** sqlite3ExprIsConstant() pWalker->eCode==1
1772** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001773** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001774** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001775**
drh059b2d52014-10-24 19:28:09 +00001776** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1777** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001778**
drhfeada2d2014-09-24 13:20:22 +00001779** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001780** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1781** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001782** parameter raises an error for new statements, but is silently converted
1783** to NULL for existing schemas. This allows sqlite_master tables that
1784** contain a bound parameter because they were generated by older versions
1785** of SQLite to be parsed by newer versions of SQLite without raising a
1786** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001787*/
drh7d10d5a2008-08-20 16:35:10 +00001788static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001789
drh059b2d52014-10-24 19:28:09 +00001790 /* If pWalker->eCode is 2 then any term of the expression that comes from
1791 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001792 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001793 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1794 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001795 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001796 }
1797
drh626a8792005-01-17 22:08:19 +00001798 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001799 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001800 ** and either pWalker->eCode==4 or 5 or the function has the
1801 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001802 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001803 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001804 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001805 }else{
1806 pWalker->eCode = 0;
1807 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001808 }
drh626a8792005-01-17 22:08:19 +00001809 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001810 /* Convert "true" or "false" in a DEFAULT clause into the
1811 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001812 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001813 return WRC_Prune;
1814 }
1815 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001816 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001817 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001818 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001819 testcase( pExpr->op==TK_ID );
1820 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001821 testcase( pExpr->op==TK_AGG_FUNCTION );
1822 testcase( pExpr->op==TK_AGG_COLUMN );
drh059b2d52014-10-24 19:28:09 +00001823 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1824 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001825 }
drhf43ce0b2017-05-25 00:08:48 +00001826 /* Fall through */
1827 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001828 case TK_REGISTER:
drhf43ce0b2017-05-25 00:08:48 +00001829 testcase( pExpr->op==TK_IF_NULL_ROW );
1830 pWalker->eCode = 0;
1831 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001832 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001833 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001834 /* Silently convert bound parameters that appear inside of CREATE
1835 ** statements into a NULL when parsing the CREATE statement text out
1836 ** of the sqlite_master table */
1837 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001838 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001839 /* A bound parameter in a CREATE statement that originates from
1840 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001841 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001842 return WRC_Abort;
1843 }
1844 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001845 default:
drh6e341b92018-04-17 18:50:40 +00001846 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1847 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001848 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001849 }
1850}
drh059b2d52014-10-24 19:28:09 +00001851static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001852 Walker w;
drh059b2d52014-10-24 19:28:09 +00001853 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001854 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001855 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001856#ifdef SQLITE_DEBUG
1857 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1858#endif
drh059b2d52014-10-24 19:28:09 +00001859 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001860 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001861 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001862}
drh626a8792005-01-17 22:08:19 +00001863
1864/*
drh059b2d52014-10-24 19:28:09 +00001865** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001866** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001867**
1868** For the purposes of this function, a double-quoted string (ex: "abc")
1869** is considered a variable but a single-quoted string (ex: 'abc') is
1870** a constant.
drhfef52082000-06-06 01:50:43 +00001871*/
danielk19774adee202004-05-08 08:23:19 +00001872int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001873 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001874}
1875
1876/*
drh059b2d52014-10-24 19:28:09 +00001877** Walk an expression tree. Return non-zero if the expression is constant
drh0a168372007-06-08 00:20:47 +00001878** that does no originate from the ON or USING clauses of a join.
1879** Return 0 if it involves variables or function calls or terms from
1880** an ON or USING clause.
1881*/
1882int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001883 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001884}
1885
1886/*
drhfcb9f4f2015-06-01 18:13:16 +00001887** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001888** for any single row of the table with cursor iCur. In other words, the
1889** expression must not refer to any non-deterministic function nor any
1890** table other than iCur.
1891*/
1892int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1893 return exprIsConst(p, 3, iCur);
1894}
1895
danab31a842017-04-29 20:53:09 +00001896
1897/*
1898** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1899*/
1900static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1901 ExprList *pGroupBy = pWalker->u.pGroupBy;
1902 int i;
1903
1904 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1905 ** it constant. */
1906 for(i=0; i<pGroupBy->nExpr; i++){
1907 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001908 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001909 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
1910 if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
danab31a842017-04-29 20:53:09 +00001911 return WRC_Prune;
1912 }
1913 }
1914 }
1915
1916 /* Check if pExpr is a sub-select. If so, consider it variable. */
1917 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1918 pWalker->eCode = 0;
1919 return WRC_Abort;
1920 }
1921
1922 return exprNodeIsConstant(pWalker, pExpr);
1923}
1924
1925/*
1926** Walk the expression tree passed as the first argument. Return non-zero
1927** if the expression consists entirely of constants or copies of terms
1928** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00001929**
1930** This routine is used to determine if a term of the HAVING clause can
1931** be promoted into the WHERE clause. In order for such a promotion to work,
1932** the value of the HAVING clause term must be the same for all members of
1933** a "group". The requirement that the GROUP BY term must be BINARY
1934** assumes that no other collating sequence will have a finer-grained
1935** grouping than binary. In other words (A=B COLLATE binary) implies
1936** A=B in every other collating sequence. The requirement that the
1937** GROUP BY be BINARY is stricter than necessary. It would also work
1938** to promote HAVING clauses that use the same alternative collating
1939** sequence as the GROUP BY term, but that is much harder to check,
1940** alternative collating sequences are uncommon, and this is only an
1941** optimization, so we take the easy way out and simply require the
1942** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00001943*/
1944int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1945 Walker w;
danab31a842017-04-29 20:53:09 +00001946 w.eCode = 1;
1947 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00001948 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00001949 w.u.pGroupBy = pGroupBy;
1950 w.pParse = pParse;
1951 sqlite3WalkExpr(&w, p);
1952 return w.eCode;
1953}
1954
drh059b2d52014-10-24 19:28:09 +00001955/*
1956** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001957** or a function call with constant arguments. Return and 0 if there
1958** are any variables.
1959**
1960** For the purposes of this function, a double-quoted string (ex: "abc")
1961** is considered a variable but a single-quoted string (ex: 'abc') is
1962** a constant.
1963*/
drhfeada2d2014-09-24 13:20:22 +00001964int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1965 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00001966 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00001967}
1968
drh5b88bc42013-12-07 23:35:21 +00001969#ifdef SQLITE_ENABLE_CURSOR_HINTS
1970/*
1971** Walk an expression tree. Return 1 if the expression contains a
1972** subquery of some kind. Return 0 if there are no subqueries.
1973*/
1974int sqlite3ExprContainsSubquery(Expr *p){
1975 Walker w;
drhbec24762015-08-13 20:07:13 +00001976 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00001977 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00001978 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001979#ifdef SQLITE_DEBUG
1980 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1981#endif
drh5b88bc42013-12-07 23:35:21 +00001982 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00001983 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00001984}
1985#endif
1986
drheb55bd22005-06-30 17:04:21 +00001987/*
drh73b211a2005-01-18 04:00:42 +00001988** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00001989** to fit in a 32-bit integer, return 1 and put the value of the integer
1990** in *pValue. If the expression is not an integer or if it is too big
1991** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00001992*/
danielk19774adee202004-05-08 08:23:19 +00001993int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00001994 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00001995 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00001996
1997 /* If an expression is an integer literal that fits in a signed 32-bit
1998 ** integer, then the EP_IntValue flag will have already been set */
1999 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2000 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2001
drh92b01d52008-06-24 00:32:35 +00002002 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002003 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002004 return 1;
2005 }
drhe4de1fe2002-06-02 16:09:01 +00002006 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002007 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002008 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002009 break;
drh4b59ab52002-08-24 18:24:51 +00002010 }
drhe4de1fe2002-06-02 16:09:01 +00002011 case TK_UMINUS: {
2012 int v;
danielk19774adee202004-05-08 08:23:19 +00002013 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002014 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002015 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002016 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002017 }
2018 break;
2019 }
2020 default: break;
2021 }
drh92b01d52008-06-24 00:32:35 +00002022 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002023}
2024
2025/*
drh039fc322009-11-17 18:31:47 +00002026** Return FALSE if there is no chance that the expression can be NULL.
2027**
2028** If the expression might be NULL or if the expression is too complex
2029** to tell return TRUE.
2030**
2031** This routine is used as an optimization, to skip OP_IsNull opcodes
2032** when we know that a value cannot be NULL. Hence, a false positive
2033** (returning TRUE when in fact the expression can never be NULL) might
2034** be a small performance hit but is otherwise harmless. On the other
2035** hand, a false negative (returning FALSE when the result could be NULL)
2036** will likely result in an incorrect answer. So when in doubt, return
2037** TRUE.
2038*/
2039int sqlite3ExprCanBeNull(const Expr *p){
2040 u8 op;
drhcd7f4572009-11-19 14:48:40 +00002041 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002042 op = p->op;
2043 if( op==TK_REGISTER ) op = p->op2;
2044 switch( op ){
2045 case TK_INTEGER:
2046 case TK_STRING:
2047 case TK_FLOAT:
2048 case TK_BLOB:
2049 return 0;
drh7248a8b2014-08-04 18:50:54 +00002050 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002051 return ExprHasProperty(p, EP_CanBeNull) ||
drh4dd89d52017-08-14 14:53:24 +00002052 p->pTab==0 || /* Reference to column of index on expression */
drh72673a22014-12-04 16:27:17 +00002053 (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002054 default:
2055 return 1;
2056 }
2057}
2058
2059/*
2060** Return TRUE if the given expression is a constant which would be
2061** unchanged by OP_Affinity with the affinity given in the second
2062** argument.
2063**
2064** This routine is used to determine if the OP_Affinity operation
2065** can be omitted. When in doubt return FALSE. A false negative
2066** is harmless. A false positive, however, can result in the wrong
2067** answer.
2068*/
2069int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2070 u8 op;
drh05883a32015-06-02 15:32:08 +00002071 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002072 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002073 op = p->op;
2074 if( op==TK_REGISTER ) op = p->op2;
2075 switch( op ){
2076 case TK_INTEGER: {
2077 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2078 }
2079 case TK_FLOAT: {
2080 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2081 }
2082 case TK_STRING: {
2083 return aff==SQLITE_AFF_TEXT;
2084 }
2085 case TK_BLOB: {
2086 return 1;
2087 }
drh2f2855b2009-11-18 01:25:26 +00002088 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002089 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2090 return p->iColumn<0
2091 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002092 }
drh039fc322009-11-17 18:31:47 +00002093 default: {
2094 return 0;
2095 }
2096 }
2097}
2098
2099/*
drhc4a3c772001-04-04 11:48:57 +00002100** Return TRUE if the given string is a row-id column name.
2101*/
danielk19774adee202004-05-08 08:23:19 +00002102int sqlite3IsRowid(const char *z){
2103 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2104 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2105 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002106 return 0;
2107}
2108
danielk19779a96b662007-11-29 17:05:18 +00002109/*
drh69c355b2016-03-09 15:34:51 +00002110** pX is the RHS of an IN operator. If pX is a SELECT statement
2111** that can be simplified to a direct table access, then return
2112** a pointer to the SELECT statement. If pX is not a SELECT statement,
2113** or if the SELECT statement needs to be manifested into a transient
2114** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002115*/
2116#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002117static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002118 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002119 SrcList *pSrc;
2120 ExprList *pEList;
2121 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002122 int i;
drh69c355b2016-03-09 15:34:51 +00002123 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2124 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2125 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002126 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002127 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002128 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2129 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2130 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002131 }
drhb74b1012009-05-28 21:04:37 +00002132 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002133 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002134 if( p->pWhere ) return 0; /* Has no WHERE clause */
2135 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002136 assert( pSrc!=0 );
2137 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002138 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002139 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002140 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002141 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002142 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2143 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002144 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002145 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002146 for(i=0; i<pEList->nExpr; i++){
2147 Expr *pRes = pEList->a[i].pExpr;
2148 if( pRes->op!=TK_COLUMN ) return 0;
2149 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002150 }
drh69c355b2016-03-09 15:34:51 +00002151 return p;
drhb287f4b2008-04-25 00:08:38 +00002152}
2153#endif /* SQLITE_OMIT_SUBQUERY */
2154
danf9b2e052016-08-02 17:45:00 +00002155#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002156/*
drh4c259e92014-08-01 21:12:35 +00002157** Generate code that checks the left-most column of index table iCur to see if
2158** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002159** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2160** to be set to NULL if iCur contains one or more NULL values.
2161*/
2162static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002163 int addr1;
drh6be515e2014-08-01 21:00:53 +00002164 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002165 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002166 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2167 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002168 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002169 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002170}
danf9b2e052016-08-02 17:45:00 +00002171#endif
drh6be515e2014-08-01 21:00:53 +00002172
drhbb53ecb2014-08-02 21:03:33 +00002173
2174#ifndef SQLITE_OMIT_SUBQUERY
2175/*
2176** The argument is an IN operator with a list (not a subquery) on the
2177** right-hand side. Return TRUE if that list is constant.
2178*/
2179static int sqlite3InRhsIsConstant(Expr *pIn){
2180 Expr *pLHS;
2181 int res;
2182 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2183 pLHS = pIn->pLeft;
2184 pIn->pLeft = 0;
2185 res = sqlite3ExprIsConstant(pIn);
2186 pIn->pLeft = pLHS;
2187 return res;
2188}
2189#endif
2190
drh6be515e2014-08-01 21:00:53 +00002191/*
danielk19779a96b662007-11-29 17:05:18 +00002192** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002193** The pX parameter is the expression on the RHS of the IN operator, which
2194** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002195**
drhd4305ca2012-09-18 17:08:33 +00002196** The job of this routine is to find or create a b-tree object that can
2197** be used either to test for membership in the RHS set or to iterate through
2198** all members of the RHS set, skipping duplicates.
2199**
drh3a856252014-08-01 14:46:57 +00002200** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002201** and pX->iTable is set to the index of that cursor.
2202**
drhb74b1012009-05-28 21:04:37 +00002203** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002204**
drh1ccce442013-03-12 20:38:51 +00002205** IN_INDEX_ROWID - The cursor was opened on a database table.
2206** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2207** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2208** IN_INDEX_EPH - The cursor was opened on a specially created and
2209** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002210** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2211** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002212**
drhd4305ca2012-09-18 17:08:33 +00002213** An existing b-tree might be used if the RHS expression pX is a simple
2214** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002215**
dan553168c2016-08-01 20:14:31 +00002216** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002217**
drhd4305ca2012-09-18 17:08:33 +00002218** If the RHS of the IN operator is a list or a more complex subquery, then
2219** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002220** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002221** existing table.
drhd4305ca2012-09-18 17:08:33 +00002222**
drh7fc0ba02017-11-17 15:02:00 +00002223** The inFlags parameter must contain, at a minimum, one of the bits
2224** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2225** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2226** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2227** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002228**
2229** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2230** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002231** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002232** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2233** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002234**
drh3a856252014-08-01 14:46:57 +00002235** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2236** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002237** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2238** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002239**
drhbb53ecb2014-08-02 21:03:33 +00002240** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2241** if the RHS of the IN operator is a list (not a subquery) then this
2242** routine might decide that creating an ephemeral b-tree for membership
2243** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2244** calling routine should implement the IN operator using a sequence
2245** of Eq or Ne comparison operations.
2246**
drhb74b1012009-05-28 21:04:37 +00002247** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002248** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002249** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002250** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002251** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002252** to *prRhsHasNull. If there is no chance that the (...) contains a
2253** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002254**
drhe21a6e12014-08-01 18:00:24 +00002255** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002256** the value in that register will be NULL if the b-tree contains one or more
2257** NULL values, and it will be some non-NULL value if the b-tree contains no
2258** NULL values.
dan553168c2016-08-01 20:14:31 +00002259**
2260** If the aiMap parameter is not NULL, it must point to an array containing
2261** one element for each column returned by the SELECT statement on the RHS
2262** of the IN(...) operator. The i'th entry of the array is populated with the
2263** offset of the index column that matches the i'th column returned by the
2264** SELECT. For example, if the expression and selected index are:
2265**
2266** (?,?,?) IN (SELECT a, b, c FROM t1)
2267** CREATE INDEX i1 ON t1(b, c, a);
2268**
2269** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002270*/
danielk1977284f4ac2007-12-10 05:03:46 +00002271#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002272int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002273 Parse *pParse, /* Parsing context */
2274 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2275 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2276 int *prRhsHasNull, /* Register holding NULL status. See notes */
2277 int *aiMap /* Mapping from Index fields to RHS fields */
danba00e302016-07-23 20:24:06 +00002278){
drhb74b1012009-05-28 21:04:37 +00002279 Select *p; /* SELECT to the right of IN operator */
2280 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2281 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002282 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002283 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002284
drh1450bc62009-10-30 13:25:56 +00002285 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002286 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002287
dan7b35a772016-07-28 19:47:15 +00002288 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2289 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002290 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002291 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002292 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002293 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2294 int i;
2295 ExprList *pEList = pX->x.pSelect->pEList;
2296 for(i=0; i<pEList->nExpr; i++){
2297 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2298 }
2299 if( i==pEList->nExpr ){
2300 prRhsHasNull = 0;
2301 }
2302 }
2303
drhb74b1012009-05-28 21:04:37 +00002304 /* Check to see if an existing table or index can be used to
2305 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002306 ** ephemeral table. */
2307 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002308 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002309 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002310 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002311 ExprList *pEList = p->pEList;
2312 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002313
drhb07028f2011-10-14 21:49:18 +00002314 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2315 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2316 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2317 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002318
drhb22f7c82014-02-06 23:56:27 +00002319 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002320 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2321 sqlite3CodeVerifySchema(pParse, iDb);
2322 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002323
drha84a2832016-08-26 21:15:35 +00002324 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002325 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002326 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002327 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002328 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002329
2330 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2331 eType = IN_INDEX_ROWID;
2332
2333 sqlite3VdbeJumpHere(v, iAddr);
2334 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002335 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002336 int affinity_ok = 1;
2337 int i;
2338
2339 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002340 ** comparison is the same as the affinity of each column in table
2341 ** on the RHS of the IN operator. If it not, it is not possible to
2342 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002343 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002344 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002345 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002346 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002347 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002348 testcase( cmpaff==SQLITE_AFF_BLOB );
2349 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002350 switch( cmpaff ){
2351 case SQLITE_AFF_BLOB:
2352 break;
2353 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002354 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2355 ** other has no affinity and the other side is TEXT. Hence,
2356 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2357 ** and for the term on the LHS of the IN to have no affinity. */
2358 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002359 break;
2360 default:
2361 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2362 }
2363 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002364
drha84a2832016-08-26 21:15:35 +00002365 if( affinity_ok ){
2366 /* Search for an existing index that will work for this IN operator */
2367 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2368 Bitmask colUsed; /* Columns of the index used */
2369 Bitmask mCol; /* Mask for the current column */
2370 if( pIdx->nColumn<nExpr ) continue;
2371 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2372 ** BITMASK(nExpr) without overflowing */
2373 testcase( pIdx->nColumn==BMS-2 );
2374 testcase( pIdx->nColumn==BMS-1 );
2375 if( pIdx->nColumn>=BMS-1 ) continue;
2376 if( mustBeUnique ){
2377 if( pIdx->nKeyCol>nExpr
2378 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2379 ){
2380 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002381 }
danielk19770cdc0222008-06-26 18:04:03 +00002382 }
drha84a2832016-08-26 21:15:35 +00002383
2384 colUsed = 0; /* Columns of index used so far */
2385 for(i=0; i<nExpr; i++){
2386 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2387 Expr *pRhs = pEList->a[i].pExpr;
2388 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2389 int j;
2390
2391 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2392 for(j=0; j<nExpr; j++){
2393 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2394 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002395 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2396 continue;
2397 }
drha84a2832016-08-26 21:15:35 +00002398 break;
2399 }
2400 if( j==nExpr ) break;
2401 mCol = MASKBIT(j);
2402 if( mCol & colUsed ) break; /* Each column used only once */
2403 colUsed |= mCol;
2404 if( aiMap ) aiMap[i] = j;
2405 }
2406
2407 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2408 if( colUsed==(MASKBIT(nExpr)-1) ){
2409 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002410 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhb80dbdc2016-09-09 15:12:41 +00002411#ifndef SQLITE_OMIT_EXPLAIN
drha84a2832016-08-26 21:15:35 +00002412 sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2413 sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2414 P4_DYNAMIC);
drhb80dbdc2016-09-09 15:12:41 +00002415#endif
drha84a2832016-08-26 21:15:35 +00002416 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2417 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2418 VdbeComment((v, "%s", pIdx->zName));
2419 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2420 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2421
2422 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002423#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002424 i64 mask = (1<<nExpr)-1;
2425 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2426 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002427#endif
2428 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002429 if( nExpr==1 ){
2430 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2431 }
2432 }
2433 sqlite3VdbeJumpHere(v, iAddr);
2434 }
2435 } /* End loop over indexes */
2436 } /* End if( affinity_ok ) */
2437 } /* End if not an rowid index */
2438 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002439
drhbb53ecb2014-08-02 21:03:33 +00002440 /* If no preexisting index is available for the IN clause
2441 ** and IN_INDEX_NOOP is an allowed reply
2442 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002443 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002444 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002445 ** the IN operator so return IN_INDEX_NOOP.
2446 */
2447 if( eType==0
2448 && (inFlags & IN_INDEX_NOOP_OK)
2449 && !ExprHasProperty(pX, EP_xIsSelect)
2450 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2451 ){
2452 eType = IN_INDEX_NOOP;
2453 }
drhbb53ecb2014-08-02 21:03:33 +00002454
danielk19779a96b662007-11-29 17:05:18 +00002455 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002456 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002457 ** We will have to generate an ephemeral table to do the job.
2458 */
drh8e23daf2013-06-11 13:30:04 +00002459 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002460 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002461 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002462 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002463 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00002464 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00002465 eType = IN_INDEX_ROWID;
2466 }
drhe21a6e12014-08-01 18:00:24 +00002467 }else if( prRhsHasNull ){
2468 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002469 }
danielk197741a05b72008-10-02 13:50:55 +00002470 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00002471 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002472 }else{
2473 pX->iTable = iTab;
2474 }
danba00e302016-07-23 20:24:06 +00002475
2476 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2477 int i, n;
2478 n = sqlite3ExprVectorSize(pX->pLeft);
2479 for(i=0; i<n; i++) aiMap[i] = i;
2480 }
danielk19779a96b662007-11-29 17:05:18 +00002481 return eType;
2482}
danielk1977284f4ac2007-12-10 05:03:46 +00002483#endif
drh626a8792005-01-17 22:08:19 +00002484
danf9b2e052016-08-02 17:45:00 +00002485#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002486/*
2487** Argument pExpr is an (?, ?...) IN(...) expression. This
2488** function allocates and returns a nul-terminated string containing
2489** the affinities to be used for each column of the comparison.
2490**
2491** It is the responsibility of the caller to ensure that the returned
2492** string is eventually freed using sqlite3DbFree().
2493*/
dan71c57db2016-07-09 20:23:55 +00002494static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2495 Expr *pLeft = pExpr->pLeft;
2496 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002497 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002498 char *zRet;
2499
dan553168c2016-08-01 20:14:31 +00002500 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002501 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002502 if( zRet ){
2503 int i;
2504 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002505 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002506 char a = sqlite3ExprAffinity(pA);
2507 if( pSelect ){
2508 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2509 }else{
2510 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002511 }
dan71c57db2016-07-09 20:23:55 +00002512 }
2513 zRet[nVal] = '\0';
2514 }
2515 return zRet;
2516}
danf9b2e052016-08-02 17:45:00 +00002517#endif
dan71c57db2016-07-09 20:23:55 +00002518
dan8da209b2016-07-26 18:06:08 +00002519#ifndef SQLITE_OMIT_SUBQUERY
2520/*
2521** Load the Parse object passed as the first argument with an error
2522** message of the form:
2523**
2524** "sub-select returns N columns - expected M"
2525*/
2526void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2527 const char *zFmt = "sub-select returns %d columns - expected %d";
2528 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2529}
2530#endif
2531
drh626a8792005-01-17 22:08:19 +00002532/*
dan44c56042016-12-07 15:38:37 +00002533** Expression pExpr is a vector that has been used in a context where
2534** it is not permitted. If pExpr is a sub-select vector, this routine
2535** loads the Parse object with a message of the form:
2536**
2537** "sub-select returns N columns - expected 1"
2538**
2539** Or, if it is a regular scalar vector:
2540**
2541** "row value misused"
2542*/
2543void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2544#ifndef SQLITE_OMIT_SUBQUERY
2545 if( pExpr->flags & EP_xIsSelect ){
2546 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2547 }else
2548#endif
2549 {
2550 sqlite3ErrorMsg(pParse, "row value misused");
2551 }
2552}
2553
2554/*
drhd4187c72010-08-30 22:15:45 +00002555** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2556** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00002557**
drh9cbe6352005-11-29 03:13:21 +00002558** (SELECT a FROM b) -- subquery
2559** EXISTS (SELECT a FROM b) -- EXISTS subquery
2560** x IN (4,5,11) -- IN operator with list on right-hand side
2561** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002562**
drh9cbe6352005-11-29 03:13:21 +00002563** The pExpr parameter describes the expression that contains the IN
2564** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00002565**
2566** If parameter isRowid is non-zero, then expression pExpr is guaranteed
2567** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
2568** to some integer key column of a table B-Tree. In this case, use an
2569** intkey B-Tree to store the set of IN(...) values instead of the usual
2570** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00002571**
2572** If rMayHaveNull is non-zero, that means that the operation is an IN
2573** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00002574** All this routine does is initialize the register given by rMayHaveNull
2575** to NULL. Calling routines will take care of changing this register
2576** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00002577**
2578** For a SELECT or EXISTS operator, return the register that holds the
drh39a11812016-08-19 19:12:58 +00002579** result. For a multi-column SELECT, the result is stored in a contiguous
2580** array of registers and the return value is the register of the left-most
2581** result column. Return 0 for IN operators or if an error occurs.
drhcce7d172000-05-31 15:34:51 +00002582*/
drh51522cd2005-01-20 13:36:19 +00002583#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00002584int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00002585 Parse *pParse, /* Parsing context */
2586 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00002587 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00002588 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00002589){
drh6be515e2014-08-01 21:00:53 +00002590 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00002591 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00002592 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00002593 if( NEVER(v==0) ) return 0;
drhceea3322009-04-23 13:22:42 +00002594 sqlite3ExprCachePush(pParse);
danielk1977fc976062007-05-10 10:46:56 +00002595
drh39a11812016-08-19 19:12:58 +00002596 /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
2597 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002598 **
2599 ** * The right-hand side is a correlated subquery
2600 ** * The right-hand side is an expression list containing variables
2601 ** * We are inside a trigger
2602 **
2603 ** If all of the above are false, then we can run this code just once
2604 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00002605 */
drhc5cd1242013-09-12 16:50:49 +00002606 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh511f9e82016-09-22 18:53:13 +00002607 jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002608 }
2609
dan4a07e3d2010-11-09 14:48:59 +00002610#ifndef SQLITE_OMIT_EXPLAIN
2611 if( pParse->explain==2 ){
drh62aaa6c2015-11-21 17:27:42 +00002612 char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
2613 jmpIfDynamic>=0?"":"CORRELATED ",
2614 pExpr->op==TK_IN?"LIST":"SCALAR",
2615 pParse->iNextSelectId
dan4a07e3d2010-11-09 14:48:59 +00002616 );
2617 sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
2618 }
2619#endif
2620
drhcce7d172000-05-31 15:34:51 +00002621 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00002622 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00002623 int addr; /* Address of OP_OpenEphemeral instruction */
2624 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00002625 KeyInfo *pKeyInfo = 0; /* Key information */
dan71c57db2016-07-09 20:23:55 +00002626 int nVal; /* Size of vector pLeft */
2627
2628 nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002629 assert( !isRowid || nVal==1 );
danielk1977e014a832004-05-17 10:48:57 +00002630
2631 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00002632 ** expression it is handled the same way. An ephemeral table is
dan553168c2016-08-01 20:14:31 +00002633 ** filled with index keys representing the results from the
2634 ** SELECT or the <exprlist>.
danielk1977e014a832004-05-17 10:48:57 +00002635 **
2636 ** If the 'x' expression is a column value, or the SELECT...
2637 ** statement returns a column value, then the affinity of that
2638 ** column is used to build the index keys. If both 'x' and the
2639 ** SELECT... statement are columns, then numeric affinity is used
2640 ** if either column has NUMERIC or INTEGER affinity. If neither
2641 ** 'x' nor the SELECT... statement are columns, then numeric affinity
2642 ** is used.
2643 */
2644 pExpr->iTable = pParse->nTab++;
dan71c57db2016-07-09 20:23:55 +00002645 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
2646 pExpr->iTable, (isRowid?0:nVal));
2647 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002648
danielk19776ab3a2e2009-02-19 14:39:25 +00002649 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00002650 /* Case 1: expr IN (SELECT ...)
2651 **
danielk1977e014a832004-05-17 10:48:57 +00002652 ** Generate code to write the results of the select into the temporary
2653 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00002654 */
drh43870062014-07-31 15:44:44 +00002655 Select *pSelect = pExpr->x.pSelect;
dan71c57db2016-07-09 20:23:55 +00002656 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002657
danielk197741a05b72008-10-02 13:50:55 +00002658 assert( !isRowid );
drh64bcb8c2016-08-26 03:42:57 +00002659 /* If the LHS and RHS of the IN operator do not match, that
2660 ** error will have been caught long before we reach this point. */
2661 if( ALWAYS(pEList->nExpr==nVal) ){
dan71c57db2016-07-09 20:23:55 +00002662 SelectDest dest;
2663 int i;
2664 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
2665 dest.zAffSdst = exprINAffinity(pParse, pExpr);
dan71c57db2016-07-09 20:23:55 +00002666 pSelect->iLimit = 0;
2667 testcase( pSelect->selFlags & SF_Distinct );
2668 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2669 if( sqlite3Select(pParse, pSelect, &dest) ){
2670 sqlite3DbFree(pParse->db, dest.zAffSdst);
2671 sqlite3KeyInfoUnref(pKeyInfo);
2672 return 0;
2673 }
2674 sqlite3DbFree(pParse->db, dest.zAffSdst);
2675 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2676 assert( pEList!=0 );
2677 assert( pEList->nExpr>0 );
2678 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2679 for(i=0; i<nVal; i++){
dan773d3af2016-09-06 17:21:17 +00002680 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
dan71c57db2016-07-09 20:23:55 +00002681 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2682 pParse, p, pEList->a[i].pExpr
2683 );
2684 }
drh94ccde52007-04-13 16:06:32 +00002685 }
drha7d2db12010-07-14 20:23:52 +00002686 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00002687 /* Case 2: expr IN (exprlist)
2688 **
drhfd131da2007-08-07 17:13:03 +00002689 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00002690 ** store it in the temporary table. If <expr> is a column, then use
2691 ** that columns affinity when building index keys. If <expr> is not
2692 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00002693 */
dan71c57db2016-07-09 20:23:55 +00002694 char affinity; /* Affinity of the LHS of the IN */
danielk1977e014a832004-05-17 10:48:57 +00002695 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00002696 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00002697 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00002698 int r1, r2, r3;
drh57dbd7b2005-07-08 18:25:26 +00002699
dan71c57db2016-07-09 20:23:55 +00002700 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002701 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00002702 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00002703 }
drh323df792013-08-05 19:11:29 +00002704 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002705 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00002706 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2707 }
danielk1977e014a832004-05-17 10:48:57 +00002708
2709 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00002710 r1 = sqlite3GetTempReg(pParse);
2711 r2 = sqlite3GetTempReg(pParse);
dan21cd29a2017-10-23 16:03:54 +00002712 if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
drh57dbd7b2005-07-08 18:25:26 +00002713 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2714 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00002715 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00002716
drh57dbd7b2005-07-08 18:25:26 +00002717 /* If the expression is not constant then we will need to
2718 ** disable the test that was generated above that makes sure
2719 ** this code only executes once. Because for a non-constant
2720 ** expression we need to rerun this code each time.
2721 */
drh6be515e2014-08-01 21:00:53 +00002722 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
2723 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
2724 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00002725 }
danielk1977e014a832004-05-17 10:48:57 +00002726
2727 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00002728 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2729 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002730 }else{
drhe05c9292009-10-29 13:48:10 +00002731 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2732 if( isRowid ){
2733 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2734 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002735 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002736 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2737 }else{
2738 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2739 sqlite3ExprCacheAffinityChange(pParse, r3, 1);
drh9b4eaeb2016-11-09 00:10:33 +00002740 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
drhe05c9292009-10-29 13:48:10 +00002741 }
danielk197741a05b72008-10-02 13:50:55 +00002742 }
drhfef52082000-06-06 01:50:43 +00002743 }
drh2d401ab2008-01-10 23:50:11 +00002744 sqlite3ReleaseTempReg(pParse, r1);
2745 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002746 }
drh323df792013-08-05 19:11:29 +00002747 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002748 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002749 }
danielk1977b3bce662005-01-29 08:32:43 +00002750 break;
drhfef52082000-06-06 01:50:43 +00002751 }
2752
drh51522cd2005-01-20 13:36:19 +00002753 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002754 case TK_SELECT:
2755 default: {
drh39a11812016-08-19 19:12:58 +00002756 /* Case 3: (SELECT ... FROM ...)
2757 ** or: EXISTS(SELECT ... FROM ...)
2758 **
2759 ** For a SELECT, generate code to put the values for all columns of
2760 ** the first row into an array of registers and return the index of
2761 ** the first register.
2762 **
2763 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2764 ** into a register and return that register number.
2765 **
2766 ** In both cases, the query is augmented with "LIMIT 1". Any
2767 ** preexisting limit is discarded in place of the new LIMIT 1.
drhfef52082000-06-06 01:50:43 +00002768 */
drhfd773cf2009-05-29 14:39:07 +00002769 Select *pSel; /* SELECT statement to encode */
drh39a11812016-08-19 19:12:58 +00002770 SelectDest dest; /* How to deal with SELECT result */
dan71c57db2016-07-09 20:23:55 +00002771 int nReg; /* Registers to allocate */
drh8c0833f2017-11-14 23:48:23 +00002772 Expr *pLimit; /* New limit expression */
drh1398ad32005-01-19 23:24:50 +00002773
shanecf697392009-06-01 16:53:09 +00002774 testcase( pExpr->op==TK_EXISTS );
2775 testcase( pExpr->op==TK_SELECT );
2776 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
danielk19776ab3a2e2009-02-19 14:39:25 +00002777 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
dan71c57db2016-07-09 20:23:55 +00002778
danielk19776ab3a2e2009-02-19 14:39:25 +00002779 pSel = pExpr->x.pSelect;
dan71c57db2016-07-09 20:23:55 +00002780 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2781 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2782 pParse->nMem += nReg;
drh51522cd2005-01-20 13:36:19 +00002783 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002784 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002785 dest.iSdst = dest.iSDParm;
dan71c57db2016-07-09 20:23:55 +00002786 dest.nSdst = nReg;
2787 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
drhd4e70eb2008-01-02 00:34:36 +00002788 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002789 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002790 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002791 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002792 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002793 }
drh8c0833f2017-11-14 23:48:23 +00002794 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2795 if( pSel->pLimit ){
2796 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2797 pSel->pLimit->pLeft = pLimit;
2798 }else{
2799 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2800 }
drh48b5b042010-12-06 18:50:32 +00002801 pSel->iLimit = 0;
drh7d10d5a2008-08-20 16:35:10 +00002802 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002803 return 0;
drh94ccde52007-04-13 16:06:32 +00002804 }
drh2b596da2012-07-23 21:43:19 +00002805 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002806 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002807 break;
drhcce7d172000-05-31 15:34:51 +00002808 }
2809 }
danielk1977b3bce662005-01-29 08:32:43 +00002810
drh6be515e2014-08-01 21:00:53 +00002811 if( rHasNullFlag ){
2812 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002813 }
drh6be515e2014-08-01 21:00:53 +00002814
2815 if( jmpIfDynamic>=0 ){
2816 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002817 }
drhd2490902014-04-13 19:28:15 +00002818 sqlite3ExprCachePop(pParse);
danielk1977fc976062007-05-10 10:46:56 +00002819
drh1450bc62009-10-30 13:25:56 +00002820 return rReg;
drhcce7d172000-05-31 15:34:51 +00002821}
drh51522cd2005-01-20 13:36:19 +00002822#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002823
drhe3365e62009-11-12 17:52:24 +00002824#ifndef SQLITE_OMIT_SUBQUERY
2825/*
dan7b35a772016-07-28 19:47:15 +00002826** Expr pIn is an IN(...) expression. This function checks that the
2827** sub-select on the RHS of the IN() operator has the same number of
2828** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2829** a sub-query, that the LHS is a vector of size 1.
2830*/
2831int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2832 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2833 if( (pIn->flags & EP_xIsSelect) ){
2834 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2835 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2836 return 1;
2837 }
2838 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002839 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002840 return 1;
2841 }
2842 return 0;
2843}
2844#endif
2845
2846#ifndef SQLITE_OMIT_SUBQUERY
2847/*
drhe3365e62009-11-12 17:52:24 +00002848** Generate code for an IN expression.
2849**
2850** x IN (SELECT ...)
2851** x IN (value, value, ...)
2852**
drhecb87ac2016-08-25 15:46:25 +00002853** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002854** right-hand side (RHS) is an array of zero or more scalar values, or a
2855** subquery. If the RHS is a subquery, the number of result columns must
2856** match the number of columns in the vector on the LHS. If the RHS is
2857** a list of values, the LHS must be a scalar.
2858**
2859** The IN operator is true if the LHS value is contained within the RHS.
2860** The result is false if the LHS is definitely not in the RHS. The
2861** result is NULL if the presence of the LHS in the RHS cannot be
2862** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002863**
drh6be515e2014-08-01 21:00:53 +00002864** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002865** contained within the RHS. If due to NULLs we cannot determine if the LHS
2866** is contained in the RHS then jump to destIfNull. If the LHS is contained
2867** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002868**
2869** See the separate in-operator.md documentation file in the canonical
2870** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002871*/
2872static void sqlite3ExprCodeIN(
2873 Parse *pParse, /* Parsing and code generating context */
2874 Expr *pExpr, /* The IN expression */
2875 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2876 int destIfNull /* Jump here if the results are unknown due to NULLs */
2877){
2878 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00002879 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00002880 int rLhs; /* Register(s) holding the LHS values */
2881 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00002882 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00002883 int *aiMap = 0; /* Map from vector field to index column */
2884 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00002885 int nVector; /* Size of vectors for this IN operator */
2886 int iDummy; /* Dummy parameter to exprCodeVector() */
2887 Expr *pLeft; /* The LHS of the IN operator */
2888 int i; /* loop counter */
2889 int destStep2; /* Where to jump when NULLs seen in step 2 */
2890 int destStep6 = 0; /* Start of code for Step 6 */
2891 int addrTruthOp; /* Address of opcode that determines the IN is true */
2892 int destNotNull; /* Jump here if a comparison is not true in step 6 */
2893 int addrTop; /* Top of the step-6 loop */
drhe3365e62009-11-12 17:52:24 +00002894
drhe347d3e2016-08-25 21:14:34 +00002895 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00002896 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00002897 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00002898 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2899 aiMap = (int*)sqlite3DbMallocZero(
2900 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2901 );
drhe347d3e2016-08-25 21:14:34 +00002902 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00002903
danba00e302016-07-23 20:24:06 +00002904 /* Attempt to compute the RHS. After this step, if anything other than
2905 ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2906 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2907 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00002908 v = pParse->pVdbe;
2909 assert( v!=0 ); /* OOM detected prior to this routine */
2910 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002911 eType = sqlite3FindInIndex(pParse, pExpr,
2912 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
danba00e302016-07-23 20:24:06 +00002913 destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
drhe3365e62009-11-12 17:52:24 +00002914
danba00e302016-07-23 20:24:06 +00002915 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2916 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2917 );
drhecb87ac2016-08-25 15:46:25 +00002918#ifdef SQLITE_DEBUG
2919 /* Confirm that aiMap[] contains nVector integer values between 0 and
2920 ** nVector-1. */
2921 for(i=0; i<nVector; i++){
2922 int j, cnt;
2923 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2924 assert( cnt==1 );
2925 }
2926#endif
drhe3365e62009-11-12 17:52:24 +00002927
danba00e302016-07-23 20:24:06 +00002928 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2929 ** vector, then it is stored in an array of nVector registers starting
2930 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00002931 **
2932 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2933 ** so that the fields are in the same order as an existing index. The
2934 ** aiMap[] array contains a mapping from the original LHS field order to
2935 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00002936 */
2937 sqlite3ExprCachePush(pParse);
drhe347d3e2016-08-25 21:14:34 +00002938 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2939 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00002940 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00002941 /* LHS fields are not reordered */
2942 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00002943 }else{
2944 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00002945 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00002946 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00002947 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00002948 }
danba00e302016-07-23 20:24:06 +00002949 }
drhe3365e62009-11-12 17:52:24 +00002950
drhbb53ecb2014-08-02 21:03:33 +00002951 /* If sqlite3FindInIndex() did not find or create an index that is
2952 ** suitable for evaluating the IN operator, then evaluate using a
2953 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00002954 **
2955 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00002956 */
drhbb53ecb2014-08-02 21:03:33 +00002957 if( eType==IN_INDEX_NOOP ){
2958 ExprList *pList = pExpr->x.pList;
2959 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2960 int labelOk = sqlite3VdbeMakeLabel(v);
2961 int r2, regToFree;
2962 int regCkNull = 0;
2963 int ii;
2964 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00002965 if( destIfNull!=destIfFalse ){
2966 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00002967 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00002968 }
2969 for(ii=0; ii<pList->nExpr; ii++){
2970 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00002971 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00002972 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2973 }
2974 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00002975 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00002976 (void*)pColl, P4_COLLSEQ);
2977 VdbeCoverageIf(v, ii<pList->nExpr-1);
2978 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00002979 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00002980 }else{
2981 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00002982 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00002983 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00002984 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00002985 }
2986 sqlite3ReleaseTempReg(pParse, regToFree);
2987 }
2988 if( regCkNull ){
2989 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00002990 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00002991 }
2992 sqlite3VdbeResolveLabel(v, labelOk);
2993 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00002994 goto sqlite3ExprCodeIN_finished;
2995 }
2996
2997 /* Step 2: Check to see if the LHS contains any NULL columns. If the
2998 ** LHS does contain NULLs then the result must be either FALSE or NULL.
2999 ** We will then skip the binary search of the RHS.
3000 */
3001 if( destIfNull==destIfFalse ){
3002 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003003 }else{
drhe347d3e2016-08-25 21:14:34 +00003004 destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3005 }
3006 for(i=0; i<nVector; i++){
3007 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3008 if( sqlite3ExprCanBeNull(p) ){
3009 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003010 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003011 }
drhe3365e62009-11-12 17:52:24 +00003012 }
drhe347d3e2016-08-25 21:14:34 +00003013
3014 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3015 ** of the RHS using the LHS as a probe. If found, the result is
3016 ** true.
3017 */
3018 if( eType==IN_INDEX_ROWID ){
3019 /* In this case, the RHS is the ROWID of table b-tree and so we also
3020 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3021 ** into a single opcode. */
3022 sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3023 VdbeCoverage(v);
3024 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3025 }else{
3026 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3027 if( destIfFalse==destIfNull ){
3028 /* Combine Step 3 and Step 5 into a single opcode */
3029 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3030 rLhs, nVector); VdbeCoverage(v);
3031 goto sqlite3ExprCodeIN_finished;
3032 }
3033 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3034 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3035 rLhs, nVector); VdbeCoverage(v);
3036 }
3037
3038 /* Step 4. If the RHS is known to be non-NULL and we did not find
3039 ** an match on the search above, then the result must be FALSE.
3040 */
3041 if( rRhsHasNull && nVector==1 ){
3042 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3043 VdbeCoverage(v);
3044 }
3045
3046 /* Step 5. If we do not care about the difference between NULL and
3047 ** FALSE, then just return false.
3048 */
3049 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3050
3051 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3052 ** If any comparison is NULL, then the result is NULL. If all
3053 ** comparisons are FALSE then the final result is FALSE.
3054 **
3055 ** For a scalar LHS, it is sufficient to check just the first row
3056 ** of the RHS.
3057 */
3058 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3059 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3060 VdbeCoverage(v);
3061 if( nVector>1 ){
3062 destNotNull = sqlite3VdbeMakeLabel(v);
3063 }else{
3064 /* For nVector==1, combine steps 6 and 7 by immediately returning
3065 ** FALSE if the first comparison is not NULL */
3066 destNotNull = destIfFalse;
3067 }
3068 for(i=0; i<nVector; i++){
3069 Expr *p;
3070 CollSeq *pColl;
3071 int r3 = sqlite3GetTempReg(pParse);
3072 p = sqlite3VectorFieldSubexpr(pLeft, i);
3073 pColl = sqlite3ExprCollSeq(pParse, p);
3074 sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3075 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3076 (void*)pColl, P4_COLLSEQ);
3077 VdbeCoverage(v);
3078 sqlite3ReleaseTempReg(pParse, r3);
3079 }
3080 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3081 if( nVector>1 ){
3082 sqlite3VdbeResolveLabel(v, destNotNull);
3083 sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
3084 VdbeCoverage(v);
3085
3086 /* Step 7: If we reach this point, we know that the result must
3087 ** be false. */
3088 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3089 }
3090
3091 /* Jumps here in order to return true. */
3092 sqlite3VdbeJumpHere(v, addrTruthOp);
3093
3094sqlite3ExprCodeIN_finished:
3095 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhd2490902014-04-13 19:28:15 +00003096 sqlite3ExprCachePop(pParse);
drhecb87ac2016-08-25 15:46:25 +00003097 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003098sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003099 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003100 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003101}
3102#endif /* SQLITE_OMIT_SUBQUERY */
3103
drh13573c72010-01-12 17:04:07 +00003104#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003105/*
3106** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003107** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003108**
3109** The z[] string will probably not be zero-terminated. But the
3110** z[n] character is guaranteed to be something that does not look
3111** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003112*/
drhb7916a72009-05-27 10:31:29 +00003113static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003114 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003115 double value;
drh9339da12010-09-30 00:50:49 +00003116 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003117 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3118 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003119 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003120 }
3121}
drh13573c72010-01-12 17:04:07 +00003122#endif
drh598f1342007-10-23 15:39:45 +00003123
3124
3125/*
drhfec19aa2004-05-19 20:41:03 +00003126** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003127** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003128**
shaneh5f1d6b62010-09-30 16:51:25 +00003129** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003130*/
drh13573c72010-01-12 17:04:07 +00003131static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3132 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003133 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003134 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003135 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003136 if( negFlag ) i = -i;
3137 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003138 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003139 int c;
3140 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003141 const char *z = pExpr->u.zToken;
3142 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003143 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003144 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003145#ifdef SQLITE_OMIT_FLOATING_POINT
3146 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3147#else
drh1b7ddc52014-07-23 14:52:05 +00003148#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003149 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003150 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003151 }else
3152#endif
3153 {
drh9296c182014-07-23 13:40:49 +00003154 codeReal(v, z, negFlag, iMem);
3155 }
drh13573c72010-01-12 17:04:07 +00003156#endif
drh77320ea2016-11-30 14:47:37 +00003157 }else{
drh84d4f1a2017-09-20 10:47:10 +00003158 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003159 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003160 }
drhfec19aa2004-05-19 20:41:03 +00003161 }
3162}
3163
drhbea119c2016-04-11 18:15:37 +00003164/*
drh9b40d132016-09-30 20:22:27 +00003165** Erase column-cache entry number i
drhbea119c2016-04-11 18:15:37 +00003166*/
drh9b40d132016-09-30 20:22:27 +00003167static void cacheEntryClear(Parse *pParse, int i){
3168 if( pParse->aColCache[i].tempReg ){
drhceea3322009-04-23 13:22:42 +00003169 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh9b40d132016-09-30 20:22:27 +00003170 pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
drhceea3322009-04-23 13:22:42 +00003171 }
drhceea3322009-04-23 13:22:42 +00003172 }
drhbea119c2016-04-11 18:15:37 +00003173 pParse->nColCache--;
drh9b40d132016-09-30 20:22:27 +00003174 if( i<pParse->nColCache ){
3175 pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
3176 }
drhceea3322009-04-23 13:22:42 +00003177}
3178
3179
3180/*
3181** Record in the column cache that a particular column from a
3182** particular table is stored in a particular register.
3183*/
3184void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3185 int i;
3186 int minLru;
3187 int idxLru;
3188 struct yColCache *p;
3189
dance8f53d2015-01-21 17:00:57 +00003190 /* Unless an error has occurred, register numbers are always positive. */
3191 assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00003192 assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
3193
drhb6da74e2009-12-24 16:00:28 +00003194 /* The SQLITE_ColumnCache flag disables the column cache. This is used
3195 ** for testing only - to verify that SQLite always gets the same answer
3196 ** with and without the column cache.
3197 */
drh7e5418e2012-09-27 15:05:54 +00003198 if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
drhb6da74e2009-12-24 16:00:28 +00003199
drh27ee4062009-12-30 01:13:11 +00003200 /* First replace any existing entry.
3201 **
3202 ** Actually, the way the column cache is currently used, we are guaranteed
3203 ** that the object will never already be in cache. Verify this guarantee.
3204 */
3205#ifndef NDEBUG
drh9b40d132016-09-30 20:22:27 +00003206 for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3207 assert( p->iTable!=iTab || p->iColumn!=iCol );
drhceea3322009-04-23 13:22:42 +00003208 }
drh27ee4062009-12-30 01:13:11 +00003209#endif
drhceea3322009-04-23 13:22:42 +00003210
drh9b40d132016-09-30 20:22:27 +00003211 /* If the cache is already full, delete the least recently used entry */
3212 if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3213 minLru = 0x7fffffff;
3214 idxLru = -1;
3215 for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3216 if( p->lru<minLru ){
3217 idxLru = i;
3218 minLru = p->lru;
3219 }
drhceea3322009-04-23 13:22:42 +00003220 }
drh9b40d132016-09-30 20:22:27 +00003221 p = &pParse->aColCache[idxLru];
3222 }else{
3223 p = &pParse->aColCache[pParse->nColCache++];
drhceea3322009-04-23 13:22:42 +00003224 }
3225
drh9b40d132016-09-30 20:22:27 +00003226 /* Add the new entry to the end of the cache */
3227 p->iLevel = pParse->iCacheLevel;
3228 p->iTable = iTab;
3229 p->iColumn = iCol;
3230 p->iReg = iReg;
3231 p->tempReg = 0;
3232 p->lru = pParse->iCacheCnt++;
drhceea3322009-04-23 13:22:42 +00003233}
3234
3235/*
drhf49f3522009-12-30 14:12:38 +00003236** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3237** Purge the range of registers from the column cache.
drhceea3322009-04-23 13:22:42 +00003238*/
drhf49f3522009-12-30 14:12:38 +00003239void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
drh9b40d132016-09-30 20:22:27 +00003240 int i = 0;
3241 while( i<pParse->nColCache ){
3242 struct yColCache *p = &pParse->aColCache[i];
3243 if( p->iReg >= iReg && p->iReg < iReg+nReg ){
3244 cacheEntryClear(pParse, i);
3245 }else{
3246 i++;
3247 }
drhceea3322009-04-23 13:22:42 +00003248 }
3249}
3250
3251/*
3252** Remember the current column cache context. Any new entries added
3253** added to the column cache after this call are removed when the
3254** corresponding pop occurs.
3255*/
3256void sqlite3ExprCachePush(Parse *pParse){
3257 pParse->iCacheLevel++;
drh9ac79622013-12-18 15:11:47 +00003258#ifdef SQLITE_DEBUG
3259 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
3260 printf("PUSH to %d\n", pParse->iCacheLevel);
3261 }
3262#endif
drhceea3322009-04-23 13:22:42 +00003263}
3264
3265/*
3266** Remove from the column cache any entries that were added since the
drhd2490902014-04-13 19:28:15 +00003267** the previous sqlite3ExprCachePush operation. In other words, restore
3268** the cache to the state it was in prior the most recent Push.
drhceea3322009-04-23 13:22:42 +00003269*/
drhd2490902014-04-13 19:28:15 +00003270void sqlite3ExprCachePop(Parse *pParse){
drh9b40d132016-09-30 20:22:27 +00003271 int i = 0;
drhd2490902014-04-13 19:28:15 +00003272 assert( pParse->iCacheLevel>=1 );
3273 pParse->iCacheLevel--;
drh9ac79622013-12-18 15:11:47 +00003274#ifdef SQLITE_DEBUG
3275 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
3276 printf("POP to %d\n", pParse->iCacheLevel);
3277 }
3278#endif
drh9b40d132016-09-30 20:22:27 +00003279 while( i<pParse->nColCache ){
3280 if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
3281 cacheEntryClear(pParse, i);
3282 }else{
3283 i++;
drhceea3322009-04-23 13:22:42 +00003284 }
3285 }
3286}
drh945498f2007-02-24 11:52:52 +00003287
3288/*
drh5cd79232009-05-25 11:46:29 +00003289** When a cached column is reused, make sure that its register is
3290** no longer available as a temp register. ticket #3879: that same
3291** register might be in the cache in multiple places, so be sure to
3292** get them all.
3293*/
3294static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
3295 int i;
3296 struct yColCache *p;
drh9b40d132016-09-30 20:22:27 +00003297 for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
drh5cd79232009-05-25 11:46:29 +00003298 if( p->iReg==iReg ){
3299 p->tempReg = 0;
3300 }
3301 }
3302}
3303
drh1f9ca2c2015-08-25 16:57:52 +00003304/* Generate code that will load into register regOut a value that is
3305** appropriate for the iIdxCol-th column of index pIdx.
3306*/
3307void sqlite3ExprCodeLoadIndexColumn(
3308 Parse *pParse, /* The parsing context */
3309 Index *pIdx, /* The index whose column is to be loaded */
3310 int iTabCur, /* Cursor pointing to a table row */
3311 int iIdxCol, /* The column of the index to be loaded */
3312 int regOut /* Store the index column value in this register */
3313){
3314 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003315 if( iTabCol==XN_EXPR ){
3316 assert( pIdx->aColExpr );
3317 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003318 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003319 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003320 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003321 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003322 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3323 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003324 }
drh1f9ca2c2015-08-25 16:57:52 +00003325}
3326
drh5cd79232009-05-25 11:46:29 +00003327/*
drh5c092e82010-05-14 19:24:02 +00003328** Generate code to extract the value of the iCol-th column of a table.
3329*/
3330void sqlite3ExprCodeGetColumnOfTable(
3331 Vdbe *v, /* The VDBE under construction */
3332 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003333 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003334 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003335 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003336){
drhaca19e12017-04-07 19:41:31 +00003337 if( pTab==0 ){
3338 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3339 return;
3340 }
drh5c092e82010-05-14 19:24:02 +00003341 if( iCol<0 || iCol==pTab->iPKey ){
3342 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3343 }else{
3344 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003345 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003346 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003347 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3348 }
3349 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003350 }
3351 if( iCol>=0 ){
3352 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3353 }
3354}
3355
3356/*
drh945498f2007-02-24 11:52:52 +00003357** Generate code that will extract the iColumn-th column from
drhce78bc62015-10-15 19:21:51 +00003358** table pTab and store the column value in a register.
3359**
3360** An effort is made to store the column value in register iReg. This
3361** is not garanteeed for GetColumn() - the result can be stored in
3362** any register. But the result is guaranteed to land in register iReg
3363** for GetColumnToReg().
drhe55cbd72008-03-31 23:48:03 +00003364**
3365** There must be an open cursor to pTab in iTable when this routine
3366** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003367*/
drhe55cbd72008-03-31 23:48:03 +00003368int sqlite3ExprCodeGetColumn(
3369 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003370 Table *pTab, /* Description of the table we are reading from */
3371 int iColumn, /* Index of the table column */
3372 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003373 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003374 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003375){
drhe55cbd72008-03-31 23:48:03 +00003376 Vdbe *v = pParse->pVdbe;
3377 int i;
drhda250ea2008-04-01 05:07:14 +00003378 struct yColCache *p;
drhe55cbd72008-03-31 23:48:03 +00003379
drh9b40d132016-09-30 20:22:27 +00003380 for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
drh94881d72016-09-30 21:20:37 +00003381 if( p->iTable==iTable && p->iColumn==iColumn ){
drhceea3322009-04-23 13:22:42 +00003382 p->lru = pParse->iCacheCnt++;
drh5cd79232009-05-25 11:46:29 +00003383 sqlite3ExprCachePinRegister(pParse, p->iReg);
drhda250ea2008-04-01 05:07:14 +00003384 return p->iReg;
drhe55cbd72008-03-31 23:48:03 +00003385 }
3386 }
3387 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003388 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003389 if( p5 ){
3390 sqlite3VdbeChangeP5(v, p5);
3391 }else{
3392 sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3393 }
drhe55cbd72008-03-31 23:48:03 +00003394 return iReg;
3395}
drhce78bc62015-10-15 19:21:51 +00003396void sqlite3ExprCodeGetColumnToReg(
3397 Parse *pParse, /* Parsing and code generating context */
3398 Table *pTab, /* Description of the table we are reading from */
3399 int iColumn, /* Index of the table column */
3400 int iTable, /* The cursor pointing to the table */
3401 int iReg /* Store results here */
3402){
3403 int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3404 if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3405}
3406
drhe55cbd72008-03-31 23:48:03 +00003407
3408/*
drhceea3322009-04-23 13:22:42 +00003409** Clear all column cache entries.
drhe55cbd72008-03-31 23:48:03 +00003410*/
drhceea3322009-04-23 13:22:42 +00003411void sqlite3ExprCacheClear(Parse *pParse){
3412 int i;
drhceea3322009-04-23 13:22:42 +00003413
drhd879e3e2017-02-13 13:35:55 +00003414#ifdef SQLITE_DEBUG
drh9ac79622013-12-18 15:11:47 +00003415 if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
3416 printf("CLEAR\n");
3417 }
3418#endif
drh9b40d132016-09-30 20:22:27 +00003419 for(i=0; i<pParse->nColCache; i++){
3420 if( pParse->aColCache[i].tempReg
3421 && pParse->nTempReg<ArraySize(pParse->aTempReg)
3422 ){
3423 pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
drhe55cbd72008-03-31 23:48:03 +00003424 }
drhe55cbd72008-03-31 23:48:03 +00003425 }
drh9b40d132016-09-30 20:22:27 +00003426 pParse->nColCache = 0;
drhe55cbd72008-03-31 23:48:03 +00003427}
3428
3429/*
drhda250ea2008-04-01 05:07:14 +00003430** Record the fact that an affinity change has occurred on iCount
3431** registers starting with iStart.
drhe55cbd72008-03-31 23:48:03 +00003432*/
drhda250ea2008-04-01 05:07:14 +00003433void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
drhf49f3522009-12-30 14:12:38 +00003434 sqlite3ExprCacheRemove(pParse, iStart, iCount);
drhe55cbd72008-03-31 23:48:03 +00003435}
3436
3437/*
drhb21e7c72008-06-22 12:37:57 +00003438** Generate code to move content from registers iFrom...iFrom+nReg-1
3439** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
drhe55cbd72008-03-31 23:48:03 +00003440*/
drhb21e7c72008-06-22 12:37:57 +00003441void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003442 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003443 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh236241a2014-09-12 17:41:30 +00003444 sqlite3ExprCacheRemove(pParse, iFrom, nReg);
drh945498f2007-02-24 11:52:52 +00003445}
3446
drhf49f3522009-12-30 14:12:38 +00003447#if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
drh92b01d52008-06-24 00:32:35 +00003448/*
drh652fbf52008-04-01 01:42:41 +00003449** Return true if any register in the range iFrom..iTo (inclusive)
3450** is used as part of the column cache.
drhf49f3522009-12-30 14:12:38 +00003451**
3452** This routine is used within assert() and testcase() macros only
3453** and does not appear in a normal build.
drh652fbf52008-04-01 01:42:41 +00003454*/
3455static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3456 int i;
drhceea3322009-04-23 13:22:42 +00003457 struct yColCache *p;
drh9b40d132016-09-30 20:22:27 +00003458 for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
drhceea3322009-04-23 13:22:42 +00003459 int r = p->iReg;
drhf49f3522009-12-30 14:12:38 +00003460 if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
drh652fbf52008-04-01 01:42:41 +00003461 }
3462 return 0;
3463}
drhf49f3522009-12-30 14:12:38 +00003464#endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
drh652fbf52008-04-01 01:42:41 +00003465
drhbea119c2016-04-11 18:15:37 +00003466
drh652fbf52008-04-01 01:42:41 +00003467/*
drh12abf402016-08-22 14:30:05 +00003468** Convert a scalar expression node to a TK_REGISTER referencing
3469** register iReg. The caller must ensure that iReg already contains
3470** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003471*/
3472static void exprToRegister(Expr *p, int iReg){
3473 p->op2 = p->op;
3474 p->op = TK_REGISTER;
3475 p->iTable = iReg;
3476 ExprClearProperty(p, EP_Skip);
3477}
3478
drh12abf402016-08-22 14:30:05 +00003479/*
3480** Evaluate an expression (either a vector or a scalar expression) and store
3481** the result in continguous temporary registers. Return the index of
3482** the first register used to store the result.
3483**
3484** If the returned result register is a temporary scalar, then also write
3485** that register number into *piFreeable. If the returned result register
3486** is not a temporary or if the expression is a vector set *piFreeable
3487** to 0.
3488*/
3489static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3490 int iResult;
3491 int nResult = sqlite3ExprVectorSize(p);
3492 if( nResult==1 ){
3493 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3494 }else{
3495 *piFreeable = 0;
3496 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003497#if SQLITE_OMIT_SUBQUERY
3498 iResult = 0;
3499#else
drh12abf402016-08-22 14:30:05 +00003500 iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
drhdd1bb432017-05-15 15:12:24 +00003501#endif
drh12abf402016-08-22 14:30:05 +00003502 }else{
3503 int i;
3504 iResult = pParse->nMem+1;
3505 pParse->nMem += nResult;
3506 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003507 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003508 }
3509 }
3510 }
3511 return iResult;
3512}
3513
dan71c57db2016-07-09 20:23:55 +00003514
drha4c3c872013-09-12 17:29:25 +00003515/*
drhcce7d172000-05-31 15:34:51 +00003516** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003517** expression. Attempt to store the results in register "target".
3518** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003519**
drh8b213892008-08-29 02:14:02 +00003520** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003521** be stored in target. The result might be stored in some other
3522** register if it is convenient to do so. The calling function
3523** must check the return code and move the results to the desired
3524** register.
drhcce7d172000-05-31 15:34:51 +00003525*/
drh678ccce2008-03-31 18:19:54 +00003526int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003527 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3528 int op; /* The opcode being coded */
3529 int inReg = target; /* Results stored in register inReg */
3530 int regFree1 = 0; /* If non-zero free this temporary register */
3531 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003532 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003533 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003534 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003535
drh9cbf3422008-01-17 16:22:13 +00003536 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003537 if( v==0 ){
3538 assert( pParse->db->mallocFailed );
3539 return 0;
3540 }
drh389a1ad2008-01-03 23:44:53 +00003541
3542 if( pExpr==0 ){
3543 op = TK_NULL;
3544 }else{
3545 op = pExpr->op;
3546 }
drhf2bc0132004-10-04 13:19:23 +00003547 switch( op ){
drh13449892005-09-07 21:22:45 +00003548 case TK_AGG_COLUMN: {
3549 AggInfo *pAggInfo = pExpr->pAggInfo;
3550 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3551 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003552 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003553 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003554 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003555 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003556 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003557 return target;
drh13449892005-09-07 21:22:45 +00003558 }
3559 /* Otherwise, fall thru into the TK_COLUMN case */
3560 }
drh967e8b72000-06-21 13:59:10 +00003561 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003562 int iTab = pExpr->iTable;
3563 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003564 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003565 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003566 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003567 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003568 /* Coding an expression that is part of an index where column names
3569 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003570 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003571 }
drh22827922000-06-06 17:27:05 +00003572 }
drhc332cc32016-09-19 10:24:19 +00003573 return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003574 pExpr->iColumn, iTab, target,
3575 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003576 }
3577 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003578 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003579 return target;
drhfec19aa2004-05-19 20:41:03 +00003580 }
drh8abed7b2018-02-26 18:49:05 +00003581 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003582 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003583 return target;
3584 }
drh13573c72010-01-12 17:04:07 +00003585#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003586 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003587 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3588 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003589 return target;
drh598f1342007-10-23 15:39:45 +00003590 }
drh13573c72010-01-12 17:04:07 +00003591#endif
drhfec19aa2004-05-19 20:41:03 +00003592 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003593 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003594 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003595 return target;
drhcce7d172000-05-31 15:34:51 +00003596 }
drhf0863fe2005-06-12 21:35:51 +00003597 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003598 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003599 return target;
drhf0863fe2005-06-12 21:35:51 +00003600 }
danielk19775338a5f2005-01-20 13:03:10 +00003601#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003602 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003603 int n;
3604 const char *z;
drhca48c902008-01-18 14:08:24 +00003605 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003606 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3607 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3608 assert( pExpr->u.zToken[1]=='\'' );
3609 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003610 n = sqlite3Strlen30(z) - 1;
3611 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003612 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3613 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003614 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003615 }
danielk19775338a5f2005-01-20 13:03:10 +00003616#endif
drh50457892003-09-06 01:10:47 +00003617 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003618 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3619 assert( pExpr->u.zToken!=0 );
3620 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003621 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3622 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003623 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003624 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003625 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003626 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003627 }
drhc332cc32016-09-19 10:24:19 +00003628 return target;
drh50457892003-09-06 01:10:47 +00003629 }
drh4e0cff62004-11-05 05:10:28 +00003630 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003631 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003632 }
drh487e2622005-06-25 18:42:14 +00003633#ifndef SQLITE_OMIT_CAST
3634 case TK_CAST: {
3635 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003636 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003637 if( inReg!=target ){
3638 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3639 inReg = target;
3640 }
drh4169e432014-08-25 20:11:52 +00003641 sqlite3VdbeAddOp2(v, OP_Cast, target,
3642 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc5499be2008-04-01 15:06:33 +00003643 testcase( usedAsColumnCache(pParse, inReg, inReg) );
drhb3843a82008-04-01 12:24:11 +00003644 sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
drhc332cc32016-09-19 10:24:19 +00003645 return inReg;
drh487e2622005-06-25 18:42:14 +00003646 }
3647#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003648 case TK_IS:
3649 case TK_ISNOT:
3650 op = (op==TK_IS) ? TK_EQ : TK_NE;
3651 p5 = SQLITE_NULLEQ;
3652 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003653 case TK_LT:
3654 case TK_LE:
3655 case TK_GT:
3656 case TK_GE:
3657 case TK_NE:
3658 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003659 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003660 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003661 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003662 }else{
3663 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3664 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3665 codeCompare(pParse, pLeft, pExpr->pRight, op,
3666 r1, r2, inReg, SQLITE_STOREP2 | p5);
3667 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3668 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3669 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3670 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3671 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3672 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3673 testcase( regFree1==0 );
3674 testcase( regFree2==0 );
3675 }
drh6a2fe092009-09-23 02:29:36 +00003676 break;
3677 }
drhcce7d172000-05-31 15:34:51 +00003678 case TK_AND:
3679 case TK_OR:
3680 case TK_PLUS:
3681 case TK_STAR:
3682 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003683 case TK_REM:
3684 case TK_BITAND:
3685 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003686 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003687 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003688 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003689 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003690 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3691 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3692 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3693 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3694 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3695 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3696 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3697 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3698 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3699 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3700 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003701 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3702 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003703 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003704 testcase( regFree1==0 );
3705 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003706 break;
3707 }
drhcce7d172000-05-31 15:34:51 +00003708 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003709 Expr *pLeft = pExpr->pLeft;
3710 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003711 if( pLeft->op==TK_INTEGER ){
3712 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003713 return target;
drh13573c72010-01-12 17:04:07 +00003714#ifndef SQLITE_OMIT_FLOATING_POINT
3715 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003716 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3717 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003718 return target;
drh13573c72010-01-12 17:04:07 +00003719#endif
drh3c84ddf2008-01-09 02:15:38 +00003720 }else{
drh10d1edf2013-11-15 15:52:39 +00003721 tempX.op = TK_INTEGER;
3722 tempX.flags = EP_IntValue|EP_TokenOnly;
3723 tempX.u.iValue = 0;
3724 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003725 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003726 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003727 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003728 }
drh3c84ddf2008-01-09 02:15:38 +00003729 break;
drh6e142f52000-06-08 13:36:40 +00003730 }
drhbf4133c2001-10-13 02:59:08 +00003731 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003732 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003733 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3734 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003735 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3736 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003737 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003738 break;
3739 }
drh8abed7b2018-02-26 18:49:05 +00003740 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003741 int isTrue; /* IS TRUE or IS NOT TRUE */
3742 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003743 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3744 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003745 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3746 bNormal = pExpr->op2==TK_IS;
3747 testcase( isTrue && bNormal);
3748 testcase( !isTrue && bNormal);
3749 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003750 break;
3751 }
drhcce7d172000-05-31 15:34:51 +00003752 case TK_ISNULL:
3753 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003754 int addr;
drh7d176102014-02-18 03:07:12 +00003755 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3756 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003757 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003758 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003759 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003760 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003761 VdbeCoverageIf(v, op==TK_ISNULL);
3762 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003763 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003764 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003765 break;
drhcce7d172000-05-31 15:34:51 +00003766 }
drh22827922000-06-06 17:27:05 +00003767 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003768 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003769 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003770 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3771 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003772 }else{
drhc332cc32016-09-19 10:24:19 +00003773 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003774 }
drh22827922000-06-06 17:27:05 +00003775 break;
3776 }
drhcce7d172000-05-31 15:34:51 +00003777 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003778 ExprList *pFarg; /* List of function arguments */
3779 int nFarg; /* Number of function arguments */
3780 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003781 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003782 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003783 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003784 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003785 u8 enc = ENC(db); /* The text encoding used by this database */
3786 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003787
drh1e9b53f2017-01-04 01:07:24 +00003788 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003789 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003790 ** out of the inner loop, even if that means an extra OP_Copy. */
3791 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003792 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003793 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003794 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003795 pFarg = 0;
3796 }else{
3797 pFarg = pExpr->x.pList;
3798 }
3799 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003800 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3801 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003802 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003803#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3804 if( pDef==0 && pParse->explain ){
3805 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3806 }
3807#endif
drh2d801512016-01-14 22:19:58 +00003808 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003809 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003810 break;
3811 }
drhae6bb952009-11-11 00:24:31 +00003812
3813 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003814 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003815 ** arguments past the first non-NULL argument.
3816 */
drhd36e1042013-09-06 13:10:12 +00003817 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00003818 int endCoalesce = sqlite3VdbeMakeLabel(v);
3819 assert( nFarg>=2 );
3820 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3821 for(i=1; i<nFarg; i++){
3822 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003823 VdbeCoverage(v);
drhf49f3522009-12-30 14:12:38 +00003824 sqlite3ExprCacheRemove(pParse, target, 1);
drhae6bb952009-11-11 00:24:31 +00003825 sqlite3ExprCachePush(pParse);
3826 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhd2490902014-04-13 19:28:15 +00003827 sqlite3ExprCachePop(pParse);
drhae6bb952009-11-11 00:24:31 +00003828 }
3829 sqlite3VdbeResolveLabel(v, endCoalesce);
3830 break;
3831 }
3832
drhcca9f3d2013-09-06 15:23:29 +00003833 /* The UNLIKELY() function is a no-op. The result is the value
3834 ** of the first argument.
3835 */
3836 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3837 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003838 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003839 }
drhae6bb952009-11-11 00:24:31 +00003840
drh54240752017-01-03 14:39:30 +00003841#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003842 /* The AFFINITY() function evaluates to a string that describes
3843 ** the type affinity of the argument. This is used for testing of
3844 ** the SQLite type logic.
3845 */
3846 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3847 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3848 char aff;
3849 assert( nFarg==1 );
3850 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3851 sqlite3VdbeLoadString(v, target,
3852 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3853 return target;
3854 }
drh54240752017-01-03 14:39:30 +00003855#endif
drha1a523a2016-12-26 00:18:36 +00003856
drhd1a01ed2013-11-21 16:08:52 +00003857 for(i=0; i<nFarg; i++){
3858 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003859 testcase( i==31 );
3860 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003861 }
3862 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3863 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3864 }
3865 }
drh12ffee82009-04-08 13:51:51 +00003866 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003867 if( constMask ){
3868 r1 = pParse->nMem+1;
3869 pParse->nMem += nFarg;
3870 }else{
3871 r1 = sqlite3GetTempRange(pParse, nFarg);
3872 }
drha748fdc2012-03-28 01:34:47 +00003873
3874 /* For length() and typeof() functions with a column argument,
3875 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3876 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3877 ** loading.
3878 */
drhd36e1042013-09-06 13:10:12 +00003879 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003880 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003881 assert( nFarg==1 );
3882 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003883 exprOp = pFarg->a[0].pExpr->op;
3884 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003885 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3886 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003887 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3888 pFarg->a[0].pExpr->op2 =
3889 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003890 }
3891 }
3892
drhd7d385d2009-09-03 01:18:00 +00003893 sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
drh5579d592015-08-26 14:01:41 +00003894 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003895 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drhd2490902014-04-13 19:28:15 +00003896 sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
drh892d3172008-01-10 03:46:36 +00003897 }else{
drh12ffee82009-04-08 13:51:51 +00003898 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003899 }
drhb7f6f682006-07-08 17:06:43 +00003900#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003901 /* Possibly overload the function if the first argument is
3902 ** a virtual table column.
3903 **
3904 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3905 ** second argument, not the first, as the argument to test to
3906 ** see if it is a column in a virtual table. This is done because
3907 ** the left operand of infix functions (the operand we want to
3908 ** control overloading) ends up as the second argument to the
3909 ** function. The expression "A glob B" is equivalent to
3910 ** "glob(B,A). We want to use the A in "A glob B" to test
3911 ** for function overloading. But we use the B term in "glob(B,A)".
3912 */
drh12ffee82009-04-08 13:51:51 +00003913 if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
3914 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3915 }else if( nFarg>0 ){
3916 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003917 }
3918#endif
drhd36e1042013-09-06 13:10:12 +00003919 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003920 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003921 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003922 }
drh092457b2017-12-29 15:04:49 +00003923#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3924 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003925 Expr *pArg = pFarg->a[0].pExpr;
3926 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003927 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003928 }else{
3929 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3930 }
drh092457b2017-12-29 15:04:49 +00003931 }else
3932#endif
3933 {
drh2fc865c2017-12-16 20:20:37 +00003934 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3935 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3936 sqlite3VdbeChangeP5(v, (u8)nFarg);
3937 }
drhd1a01ed2013-11-21 16:08:52 +00003938 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003939 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003940 }
drhc332cc32016-09-19 10:24:19 +00003941 return target;
drhcce7d172000-05-31 15:34:51 +00003942 }
drhfe2093d2005-01-20 22:48:47 +00003943#ifndef SQLITE_OMIT_SUBQUERY
3944 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003945 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003946 int nCol;
drhc5499be2008-04-01 15:06:33 +00003947 testcase( op==TK_EXISTS );
3948 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003949 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3950 sqlite3SubselectError(pParse, nCol, 1);
3951 }else{
drhc332cc32016-09-19 10:24:19 +00003952 return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
dan8da209b2016-07-26 18:06:08 +00003953 }
drh19a775c2000-06-05 18:54:46 +00003954 break;
3955 }
drhfc7f27b2016-08-20 00:07:01 +00003956 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003957 int n;
drhfc7f27b2016-08-20 00:07:01 +00003958 if( pExpr->pLeft->iTable==0 ){
3959 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3960 }
drh966e2912017-01-03 02:58:01 +00003961 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3962 if( pExpr->iTable
3963 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3964 ){
3965 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3966 pExpr->iTable, n);
3967 }
drhc332cc32016-09-19 10:24:19 +00003968 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003969 }
drhfef52082000-06-06 01:50:43 +00003970 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003971 int destIfFalse = sqlite3VdbeMakeLabel(v);
3972 int destIfNull = sqlite3VdbeMakeLabel(v);
3973 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3974 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3975 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3976 sqlite3VdbeResolveLabel(v, destIfFalse);
3977 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3978 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003979 return target;
drhfef52082000-06-06 01:50:43 +00003980 }
drhe3365e62009-11-12 17:52:24 +00003981#endif /* SQLITE_OMIT_SUBQUERY */
3982
3983
drh2dcef112008-01-12 19:03:48 +00003984 /*
3985 ** x BETWEEN y AND z
3986 **
3987 ** This is equivalent to
3988 **
3989 ** x>=y AND x<=z
3990 **
3991 ** X is stored in pExpr->pLeft.
3992 ** Y is stored in pExpr->pList->a[0].pExpr.
3993 ** Z is stored in pExpr->pList->a[1].pExpr.
3994 */
drhfef52082000-06-06 01:50:43 +00003995 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003996 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003997 return target;
drhfef52082000-06-06 01:50:43 +00003998 }
drh94fa9c42016-02-27 21:16:04 +00003999 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004000 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004001 case TK_UPLUS: {
drhc332cc32016-09-19 10:24:19 +00004002 return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drha2e00042002-01-22 03:13:42 +00004003 }
drh2dcef112008-01-12 19:03:48 +00004004
dan165921a2009-08-28 18:53:45 +00004005 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004006 /* If the opcode is TK_TRIGGER, then the expression is a reference
4007 ** to a column in the new.* or old.* pseudo-tables available to
4008 ** trigger programs. In this case Expr.iTable is set to 1 for the
4009 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4010 ** is set to the column of the pseudo-table to read, or to -1 to
4011 ** read the rowid field.
4012 **
4013 ** The expression is implemented using an OP_Param opcode. The p1
4014 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4015 ** to reference another column of the old.* pseudo-table, where
4016 ** i is the index of the column. For a new.rowid reference, p1 is
4017 ** set to (n+1), where n is the number of columns in each pseudo-table.
4018 ** For a reference to any other column in the new.* pseudo-table, p1
4019 ** is set to (n+2+i), where n and i are as defined previously. For
4020 ** example, if the table on which triggers are being fired is
4021 ** declared as:
4022 **
4023 ** CREATE TABLE t1(a, b);
4024 **
4025 ** Then p1 is interpreted as follows:
4026 **
4027 ** p1==0 -> old.rowid p1==3 -> new.rowid
4028 ** p1==1 -> old.a p1==4 -> new.a
4029 ** p1==2 -> old.b p1==5 -> new.b
4030 */
dan2832ad42009-08-31 15:27:27 +00004031 Table *pTab = pExpr->pTab;
dan65a7cd12009-09-01 12:16:01 +00004032 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
4033
4034 assert( pExpr->iTable==0 || pExpr->iTable==1 );
4035 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
4036 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
4037 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4038
4039 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
dan2bd93512009-08-31 08:22:46 +00004040 VdbeComment((v, "%s.%s -> $%d",
4041 (pExpr->iTable ? "new" : "old"),
dan76d462e2009-08-30 11:42:51 +00004042 (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
dan2bd93512009-08-31 08:22:46 +00004043 target
dan165921a2009-08-28 18:53:45 +00004044 ));
dan65a7cd12009-09-01 12:16:01 +00004045
drh44dbca82010-01-13 04:22:20 +00004046#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004047 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004048 ** integer. Use OP_RealAffinity to make sure it is really real.
4049 **
4050 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4051 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004052 if( pExpr->iColumn>=0
4053 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4054 ){
4055 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4056 }
drh44dbca82010-01-13 04:22:20 +00004057#endif
dan165921a2009-08-28 18:53:45 +00004058 break;
4059 }
4060
dan71c57db2016-07-09 20:23:55 +00004061 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004062 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004063 break;
4064 }
4065
drh31d6fd52017-04-14 19:03:10 +00004066 case TK_IF_NULL_ROW: {
4067 int addrINR;
4068 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
4069 sqlite3ExprCachePush(pParse);
4070 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
4071 sqlite3ExprCachePop(pParse);
4072 sqlite3VdbeJumpHere(v, addrINR);
4073 sqlite3VdbeChangeP3(v, addrINR, inReg);
4074 break;
4075 }
4076
drh2dcef112008-01-12 19:03:48 +00004077 /*
4078 ** Form A:
4079 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4080 **
4081 ** Form B:
4082 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4083 **
4084 ** Form A is can be transformed into the equivalent form B as follows:
4085 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4086 ** WHEN x=eN THEN rN ELSE y END
4087 **
4088 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004089 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4090 ** odd. The Y is also optional. If the number of elements in x.pList
4091 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004092 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4093 **
4094 ** The result of the expression is the Ri for the first matching Ei,
4095 ** or if there is no matching Ei, the ELSE term Y, or if there is
4096 ** no ELSE term, NULL.
4097 */
drh33cd4902009-05-30 20:49:20 +00004098 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004099 int endLabel; /* GOTO label for end of CASE stmt */
4100 int nextCase; /* GOTO label for next WHEN clause */
4101 int nExpr; /* 2x number of WHEN terms */
4102 int i; /* Loop counter */
4103 ExprList *pEList; /* List of WHEN terms */
4104 struct ExprList_item *aListelem; /* Array of WHEN terms */
4105 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004106 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004107 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drhceea3322009-04-23 13:22:42 +00004108 VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
drh17a7f8d2002-03-24 13:13:27 +00004109
danielk19776ab3a2e2009-02-19 14:39:25 +00004110 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004111 assert(pExpr->x.pList->nExpr > 0);
4112 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004113 aListelem = pEList->a;
4114 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00004115 endLabel = sqlite3VdbeMakeLabel(v);
4116 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00004117 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00004118 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004119 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004120 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004121 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004122 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004123 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004124 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004125 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4126 ** The value in regFree1 might get SCopy-ed into the file result.
4127 ** So make sure that the regFree1 register is not reused for other
4128 ** purposes and possibly overwritten. */
4129 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004130 }
drhc5cd1242013-09-12 16:50:49 +00004131 for(i=0; i<nExpr-1; i=i+2){
drhceea3322009-04-23 13:22:42 +00004132 sqlite3ExprCachePush(pParse);
drh2dcef112008-01-12 19:03:48 +00004133 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004134 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004135 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004136 }else{
drh2dcef112008-01-12 19:03:48 +00004137 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004138 }
drh2dcef112008-01-12 19:03:48 +00004139 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00004140 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004141 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004142 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004143 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004144 sqlite3VdbeGoto(v, endLabel);
drhd2490902014-04-13 19:28:15 +00004145 sqlite3ExprCachePop(pParse);
drh2dcef112008-01-12 19:03:48 +00004146 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004147 }
drhc5cd1242013-09-12 16:50:49 +00004148 if( (nExpr&1)!=0 ){
drhceea3322009-04-23 13:22:42 +00004149 sqlite3ExprCachePush(pParse);
drhc5cd1242013-09-12 16:50:49 +00004150 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drhd2490902014-04-13 19:28:15 +00004151 sqlite3ExprCachePop(pParse);
drh17a7f8d2002-03-24 13:13:27 +00004152 }else{
drh9de221d2008-01-05 06:51:30 +00004153 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004154 }
drhc332cc32016-09-19 10:24:19 +00004155 assert( pParse->db->mallocFailed || pParse->nErr>0
danielk1977c1f4a192009-04-28 12:08:15 +00004156 || pParse->iCacheLevel==iCacheLevel );
drh2dcef112008-01-12 19:03:48 +00004157 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004158 break;
4159 }
danielk19775338a5f2005-01-20 13:03:10 +00004160#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004161 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004162 assert( pExpr->affinity==OE_Rollback
4163 || pExpr->affinity==OE_Abort
4164 || pExpr->affinity==OE_Fail
4165 || pExpr->affinity==OE_Ignore
4166 );
dane0af83a2009-09-08 19:15:01 +00004167 if( !pParse->pTriggerTab ){
4168 sqlite3ErrorMsg(pParse,
4169 "RAISE() may only be used within a trigger-program");
4170 return 0;
4171 }
4172 if( pExpr->affinity==OE_Abort ){
4173 sqlite3MayAbort(pParse);
4174 }
dan165921a2009-08-28 18:53:45 +00004175 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004176 if( pExpr->affinity==OE_Ignore ){
4177 sqlite3VdbeAddOp4(
4178 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004179 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004180 }else{
drh433dccf2013-02-09 15:37:11 +00004181 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004182 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004183 }
4184
drhffe07b22005-11-03 00:41:17 +00004185 break;
drh17a7f8d2002-03-24 13:13:27 +00004186 }
danielk19775338a5f2005-01-20 13:03:10 +00004187#endif
drhffe07b22005-11-03 00:41:17 +00004188 }
drh2dcef112008-01-12 19:03:48 +00004189 sqlite3ReleaseTempReg(pParse, regFree1);
4190 sqlite3ReleaseTempReg(pParse, regFree2);
4191 return inReg;
4192}
4193
4194/*
drhd1a01ed2013-11-21 16:08:52 +00004195** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004196**
drhad879ff2017-01-04 04:10:02 +00004197** If regDest>=0 then the result is always stored in that register and the
4198** result is not reusable. If regDest<0 then this routine is free to
4199** store the value whereever it wants. The register where the expression
4200** is stored is returned. When regDest<0, two identical expressions will
4201** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004202*/
drh1e9b53f2017-01-04 01:07:24 +00004203int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004204 Parse *pParse, /* Parsing context */
4205 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004206 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004207){
drhd1a01ed2013-11-21 16:08:52 +00004208 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004209 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004210 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004211 if( regDest<0 && p ){
4212 struct ExprList_item *pItem;
4213 int i;
4214 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004215 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004216 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004217 }
4218 }
drh1e9b53f2017-01-04 01:07:24 +00004219 }
drhd1a01ed2013-11-21 16:08:52 +00004220 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4221 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004222 if( p ){
4223 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004224 pItem->reusable = regDest<0;
4225 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004226 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004227 }
drhd1a01ed2013-11-21 16:08:52 +00004228 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004229 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004230}
4231
4232/*
drh2dcef112008-01-12 19:03:48 +00004233** Generate code to evaluate an expression and store the results
4234** into a register. Return the register number where the results
4235** are stored.
4236**
4237** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004238** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004239** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004240**
4241** If pExpr is a constant, then this routine might generate this
4242** code to fill the register in the initialization section of the
4243** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004244*/
4245int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004246 int r2;
4247 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004248 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004249 && pExpr->op!=TK_REGISTER
4250 && sqlite3ExprIsConstantNotJoin(pExpr)
4251 ){
drhf30a9692013-11-15 01:10:18 +00004252 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004253 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004254 }else{
drhf30a9692013-11-15 01:10:18 +00004255 int r1 = sqlite3GetTempReg(pParse);
4256 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4257 if( r2==r1 ){
4258 *pReg = r1;
4259 }else{
4260 sqlite3ReleaseTempReg(pParse, r1);
4261 *pReg = 0;
4262 }
drh2dcef112008-01-12 19:03:48 +00004263 }
4264 return r2;
4265}
4266
4267/*
4268** Generate code that will evaluate expression pExpr and store the
4269** results in register target. The results are guaranteed to appear
4270** in register target.
4271*/
drh05a86c52014-02-16 01:55:49 +00004272void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004273 int inReg;
4274
4275 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004276 if( pExpr && pExpr->op==TK_REGISTER ){
4277 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4278 }else{
4279 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004280 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004281 if( inReg!=target && pParse->pVdbe ){
4282 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4283 }
drhcce7d172000-05-31 15:34:51 +00004284 }
drhcce7d172000-05-31 15:34:51 +00004285}
4286
4287/*
drh1c75c9d2015-12-21 15:22:13 +00004288** Make a transient copy of expression pExpr and then code it using
4289** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4290** except that the input expression is guaranteed to be unchanged.
4291*/
4292void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4293 sqlite3 *db = pParse->db;
4294 pExpr = sqlite3ExprDup(db, pExpr, 0);
4295 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4296 sqlite3ExprDelete(db, pExpr);
4297}
4298
4299/*
drh05a86c52014-02-16 01:55:49 +00004300** Generate code that will evaluate expression pExpr and store the
4301** results in register target. The results are guaranteed to appear
4302** in register target. If the expression is constant, then this routine
4303** might choose to code the expression at initialization time.
4304*/
4305void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4306 if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004307 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004308 }else{
4309 sqlite3ExprCode(pParse, pExpr, target);
4310 }
drhcce7d172000-05-31 15:34:51 +00004311}
4312
4313/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004314** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004315** in register target.
drh25303782004-12-07 15:41:48 +00004316**
drh2dcef112008-01-12 19:03:48 +00004317** Also make a copy of the expression results into another "cache" register
4318** and modify the expression so that the next time it is evaluated,
4319** the result is a copy of the cache register.
4320**
4321** This routine is used for expressions that are used multiple
4322** times. They are evaluated once and the results of the expression
4323** are reused.
drh25303782004-12-07 15:41:48 +00004324*/
drh05a86c52014-02-16 01:55:49 +00004325void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004326 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004327 int iMem;
4328
drhde4fcfd2008-01-19 23:50:26 +00004329 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004330 assert( pExpr->op!=TK_REGISTER );
4331 sqlite3ExprCode(pParse, pExpr, target);
4332 iMem = ++pParse->nMem;
4333 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4334 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004335}
drh2dcef112008-01-12 19:03:48 +00004336
drh678ccce2008-03-31 18:19:54 +00004337/*
drh268380c2004-02-25 13:47:31 +00004338** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004339** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004340**
drh3df6c3b2017-09-15 15:38:01 +00004341** Return the number of elements evaluated. The number returned will
4342** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4343** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004344**
4345** The SQLITE_ECEL_DUP flag prevents the arguments from being
4346** filled using OP_SCopy. OP_Copy must be used instead.
4347**
4348** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4349** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004350**
4351** The SQLITE_ECEL_REF flag means that expressions in the list with
4352** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4353** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004354** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4355** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004356*/
danielk19774adee202004-05-08 08:23:19 +00004357int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004358 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004359 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004360 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004361 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004362 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004363){
4364 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004365 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004366 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004367 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004368 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004369 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004370 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004371 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004372 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004373 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004374 Expr *pExpr = pItem->pExpr;
dan257c13f2016-11-10 20:14:06 +00004375 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4376 if( flags & SQLITE_ECEL_OMITREF ){
4377 i--;
4378 n--;
4379 }else{
4380 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4381 }
drh5579d592015-08-26 14:01:41 +00004382 }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004383 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004384 }else{
4385 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4386 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004387 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004388 if( copyOp==OP_Copy
4389 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4390 && pOp->p1+pOp->p3+1==inReg
4391 && pOp->p2+pOp->p3+1==target+i
4392 ){
4393 pOp->p3++;
4394 }else{
4395 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4396 }
drhd1a01ed2013-11-21 16:08:52 +00004397 }
drhd1766112008-09-17 00:13:12 +00004398 }
drh268380c2004-02-25 13:47:31 +00004399 }
drhf9b596e2004-05-26 16:54:42 +00004400 return n;
drh268380c2004-02-25 13:47:31 +00004401}
4402
4403/*
drh36c563a2009-11-12 13:32:22 +00004404** Generate code for a BETWEEN operator.
4405**
4406** x BETWEEN y AND z
4407**
4408** The above is equivalent to
4409**
4410** x>=y AND x<=z
4411**
4412** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004413** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004414**
4415** The xJumpIf parameter determines details:
4416**
4417** NULL: Store the boolean result in reg[dest]
4418** sqlite3ExprIfTrue: Jump to dest if true
4419** sqlite3ExprIfFalse: Jump to dest if false
4420**
4421** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004422*/
4423static void exprCodeBetween(
4424 Parse *pParse, /* Parsing and code generating context */
4425 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004426 int dest, /* Jump destination or storage location */
4427 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004428 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4429){
drhdb45bd52016-08-22 00:48:58 +00004430 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004431 Expr compLeft; /* The x>=y term */
4432 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004433 Expr exprX; /* The x subexpression */
4434 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004435
drh36c563a2009-11-12 13:32:22 +00004436
dan71c57db2016-07-09 20:23:55 +00004437 memset(&compLeft, 0, sizeof(Expr));
4438 memset(&compRight, 0, sizeof(Expr));
4439 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004440
4441 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4442 exprX = *pExpr->pLeft;
drh36c563a2009-11-12 13:32:22 +00004443 exprAnd.op = TK_AND;
4444 exprAnd.pLeft = &compLeft;
4445 exprAnd.pRight = &compRight;
4446 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004447 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004448 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4449 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004450 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004451 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004452 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004453 if( xJump ){
4454 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004455 }else{
drh36fd41e2016-11-25 14:30:42 +00004456 /* Mark the expression is being from the ON or USING clause of a join
4457 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4458 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4459 ** for clarity, but we are out of bits in the Expr.flags field so we
4460 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004461 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004462 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004463 }
drhdb45bd52016-08-22 00:48:58 +00004464 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004465
4466 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004467 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4468 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4469 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4470 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4471 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4472 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4473 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4474 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004475 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004476}
4477
4478/*
drhcce7d172000-05-31 15:34:51 +00004479** Generate code for a boolean expression such that a jump is made
4480** to the label "dest" if the expression is true but execution
4481** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004482**
4483** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004484** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004485**
4486** This code depends on the fact that certain token values (ex: TK_EQ)
4487** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4488** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4489** the make process cause these values to align. Assert()s in the code
4490** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004491*/
danielk19774adee202004-05-08 08:23:19 +00004492void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004493 Vdbe *v = pParse->pVdbe;
4494 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004495 int regFree1 = 0;
4496 int regFree2 = 0;
4497 int r1, r2;
4498
drh35573352008-01-08 23:54:25 +00004499 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004500 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004501 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004502 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004503 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004504 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00004505 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004506 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004507 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00004508 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00004509 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4510 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00004511 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00004512 break;
4513 }
4514 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004515 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004516 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00004517 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00004518 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00004519 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00004520 break;
4521 }
4522 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004523 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004524 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004525 break;
4526 }
drh8abed7b2018-02-26 18:49:05 +00004527 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004528 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4529 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004530 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004531 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004532 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004533 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004534 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004535 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004536 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4537 isNot ? SQLITE_JUMPIFNULL : 0);
4538 }else{
4539 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4540 isNot ? SQLITE_JUMPIFNULL : 0);
4541 }
drh007c8432018-02-26 03:20:18 +00004542 break;
4543 }
drhde845c22016-03-17 19:07:52 +00004544 case TK_IS:
4545 case TK_ISNOT:
4546 testcase( op==TK_IS );
4547 testcase( op==TK_ISNOT );
4548 op = (op==TK_IS) ? TK_EQ : TK_NE;
4549 jumpIfNull = SQLITE_NULLEQ;
4550 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004551 case TK_LT:
4552 case TK_LE:
4553 case TK_GT:
4554 case TK_GE:
4555 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004556 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004557 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004558 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004559 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4560 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004561 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004562 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004563 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4564 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4565 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4566 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004567 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4568 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4569 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4570 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4571 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4572 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004573 testcase( regFree1==0 );
4574 testcase( regFree2==0 );
4575 break;
4576 }
drhcce7d172000-05-31 15:34:51 +00004577 case TK_ISNULL:
4578 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004579 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4580 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004581 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4582 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004583 VdbeCoverageIf(v, op==TK_ISNULL);
4584 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004585 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004586 break;
4587 }
drhfef52082000-06-06 01:50:43 +00004588 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004589 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004590 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004591 break;
4592 }
drh84e30ca2011-02-10 17:46:14 +00004593#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004594 case TK_IN: {
4595 int destIfFalse = sqlite3VdbeMakeLabel(v);
4596 int destIfNull = jumpIfNull ? dest : destIfFalse;
4597 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004598 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004599 sqlite3VdbeResolveLabel(v, destIfFalse);
4600 break;
4601 }
shanehbb201342011-02-09 19:55:20 +00004602#endif
drhcce7d172000-05-31 15:34:51 +00004603 default: {
dan7b35a772016-07-28 19:47:15 +00004604 default_expr:
drh991a1982014-01-02 17:57:16 +00004605 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004606 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004607 }else if( exprAlwaysFalse(pExpr) ){
4608 /* No-op */
4609 }else{
4610 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4611 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004612 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004613 testcase( regFree1==0 );
4614 testcase( jumpIfNull==0 );
4615 }
drhcce7d172000-05-31 15:34:51 +00004616 break;
4617 }
4618 }
drh2dcef112008-01-12 19:03:48 +00004619 sqlite3ReleaseTempReg(pParse, regFree1);
4620 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004621}
4622
4623/*
drh66b89c82000-11-28 20:47:17 +00004624** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004625** to the label "dest" if the expression is false but execution
4626** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004627**
4628** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004629** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4630** is 0.
drhcce7d172000-05-31 15:34:51 +00004631*/
danielk19774adee202004-05-08 08:23:19 +00004632void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004633 Vdbe *v = pParse->pVdbe;
4634 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004635 int regFree1 = 0;
4636 int regFree2 = 0;
4637 int r1, r2;
4638
drh35573352008-01-08 23:54:25 +00004639 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004640 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004641 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004642
4643 /* The value of pExpr->op and op are related as follows:
4644 **
4645 ** pExpr->op op
4646 ** --------- ----------
4647 ** TK_ISNULL OP_NotNull
4648 ** TK_NOTNULL OP_IsNull
4649 ** TK_NE OP_Eq
4650 ** TK_EQ OP_Ne
4651 ** TK_GT OP_Le
4652 ** TK_LE OP_Gt
4653 ** TK_GE OP_Lt
4654 ** TK_LT OP_Ge
4655 **
4656 ** For other values of pExpr->op, op is undefined and unused.
4657 ** The value of TK_ and OP_ constants are arranged such that we
4658 ** can compute the mapping above using the following expression.
4659 ** Assert()s verify that the computation is correct.
4660 */
4661 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4662
4663 /* Verify correct alignment of TK_ and OP_ constants
4664 */
4665 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4666 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4667 assert( pExpr->op!=TK_NE || op==OP_Eq );
4668 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4669 assert( pExpr->op!=TK_LT || op==OP_Ge );
4670 assert( pExpr->op!=TK_LE || op==OP_Gt );
4671 assert( pExpr->op!=TK_GT || op==OP_Le );
4672 assert( pExpr->op!=TK_GE || op==OP_Lt );
4673
danba00e302016-07-23 20:24:06 +00004674 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004675 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004676 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004677 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drh54e2adb2014-01-04 15:17:04 +00004678 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00004679 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhd2490902014-04-13 19:28:15 +00004680 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00004681 break;
4682 }
4683 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00004684 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004685 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004686 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
drh54e2adb2014-01-04 15:17:04 +00004687 sqlite3ExprCachePush(pParse);
danielk19774adee202004-05-08 08:23:19 +00004688 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4689 sqlite3VdbeResolveLabel(v, d2);
drhd2490902014-04-13 19:28:15 +00004690 sqlite3ExprCachePop(pParse);
drhcce7d172000-05-31 15:34:51 +00004691 break;
4692 }
4693 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004694 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004695 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004696 break;
4697 }
drh8abed7b2018-02-26 18:49:05 +00004698 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004699 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4700 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004701 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004702 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004703 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004704 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004705 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004706 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004707 /* IS TRUE and IS NOT FALSE */
4708 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4709 isNot ? 0 : SQLITE_JUMPIFNULL);
4710
4711 }else{
4712 /* IS FALSE and IS NOT TRUE */
4713 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004714 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004715 }
drh007c8432018-02-26 03:20:18 +00004716 break;
4717 }
drhde845c22016-03-17 19:07:52 +00004718 case TK_IS:
4719 case TK_ISNOT:
4720 testcase( pExpr->op==TK_IS );
4721 testcase( pExpr->op==TK_ISNOT );
4722 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4723 jumpIfNull = SQLITE_NULLEQ;
4724 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004725 case TK_LT:
4726 case TK_LE:
4727 case TK_GT:
4728 case TK_GE:
4729 case TK_NE:
4730 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004731 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004732 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004733 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4734 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004735 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004736 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004737 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4738 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4739 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4740 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004741 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4742 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4743 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4744 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4745 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4746 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004747 testcase( regFree1==0 );
4748 testcase( regFree2==0 );
4749 break;
4750 }
drhcce7d172000-05-31 15:34:51 +00004751 case TK_ISNULL:
4752 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004753 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4754 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004755 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4756 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004757 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004758 break;
4759 }
drhfef52082000-06-06 01:50:43 +00004760 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004761 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004762 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004763 break;
4764 }
drh84e30ca2011-02-10 17:46:14 +00004765#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004766 case TK_IN: {
4767 if( jumpIfNull ){
4768 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4769 }else{
4770 int destIfNull = sqlite3VdbeMakeLabel(v);
4771 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4772 sqlite3VdbeResolveLabel(v, destIfNull);
4773 }
4774 break;
4775 }
shanehbb201342011-02-09 19:55:20 +00004776#endif
drhcce7d172000-05-31 15:34:51 +00004777 default: {
danba00e302016-07-23 20:24:06 +00004778 default_expr:
drh991a1982014-01-02 17:57:16 +00004779 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004780 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004781 }else if( exprAlwaysTrue(pExpr) ){
4782 /* no-op */
4783 }else{
4784 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4785 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004786 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004787 testcase( regFree1==0 );
4788 testcase( jumpIfNull==0 );
4789 }
drhcce7d172000-05-31 15:34:51 +00004790 break;
4791 }
4792 }
drh2dcef112008-01-12 19:03:48 +00004793 sqlite3ReleaseTempReg(pParse, regFree1);
4794 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004795}
drh22827922000-06-06 17:27:05 +00004796
4797/*
drh72bc8202015-06-11 13:58:35 +00004798** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4799** code generation, and that copy is deleted after code generation. This
4800** ensures that the original pExpr is unchanged.
4801*/
4802void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4803 sqlite3 *db = pParse->db;
4804 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4805 if( db->mallocFailed==0 ){
4806 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4807 }
4808 sqlite3ExprDelete(db, pCopy);
4809}
4810
dan5aa550c2017-06-24 18:10:29 +00004811/*
4812** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4813** type of expression.
4814**
4815** If pExpr is a simple SQL value - an integer, real, string, blob
4816** or NULL value - then the VDBE currently being prepared is configured
4817** to re-prepare each time a new value is bound to variable pVar.
4818**
4819** Additionally, if pExpr is a simple SQL value and the value is the
4820** same as that currently bound to variable pVar, non-zero is returned.
4821** Otherwise, if the values are not the same or if pExpr is not a simple
4822** SQL value, zero is returned.
4823*/
4824static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4825 int res = 0;
drhc0804222017-06-28 21:47:16 +00004826 int iVar;
4827 sqlite3_value *pL, *pR = 0;
4828
4829 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4830 if( pR ){
4831 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004832 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004833 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004834 if( pL ){
4835 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4836 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4837 }
4838 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004839 }
drhc0804222017-06-28 21:47:16 +00004840 sqlite3ValueFree(pR);
4841 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004842 }
4843
4844 return res;
4845}
drh72bc8202015-06-11 13:58:35 +00004846
4847/*
drh1d9da702010-01-07 15:17:02 +00004848** Do a deep comparison of two expression trees. Return 0 if the two
4849** expressions are completely identical. Return 1 if they differ only
4850** by a COLLATE operator at the top level. Return 2 if there are differences
4851** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004852**
drh619a1302013-08-01 13:04:46 +00004853** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4854** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4855**
drh66518ca2013-08-01 15:09:57 +00004856** The pA side might be using TK_REGISTER. If that is the case and pB is
4857** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4858**
drh1d9da702010-01-07 15:17:02 +00004859** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004860** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004861** identical, we return 2 just to be safe. So if this routine
4862** returns 2, then you do not really know for certain if the two
4863** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004864** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004865** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004866** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004867** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004868**
drhc0804222017-06-28 21:47:16 +00004869** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4870** pParse->pReprepare can be matched against literals in pB. The
4871** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4872** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4873** Argument pParse should normally be NULL. If it is not NULL and pA or
4874** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004875*/
dan5aa550c2017-06-24 18:10:29 +00004876int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004877 u32 combinedFlags;
4878 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004879 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004880 }
dan5aa550c2017-06-24 18:10:29 +00004881 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4882 return 0;
4883 }
drh10d1edf2013-11-15 15:52:39 +00004884 combinedFlags = pA->flags | pB->flags;
4885 if( combinedFlags & EP_IntValue ){
4886 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4887 return 0;
4888 }
drh1d9da702010-01-07 15:17:02 +00004889 return 2;
drh22827922000-06-06 17:27:05 +00004890 }
drhc2acc4e2013-11-15 18:15:19 +00004891 if( pA->op!=pB->op ){
dan5aa550c2017-06-24 18:10:29 +00004892 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004893 return 1;
4894 }
dan5aa550c2017-06-24 18:10:29 +00004895 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004896 return 1;
4897 }
4898 return 2;
4899 }
drh2edc5fd2015-11-24 02:10:52 +00004900 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004901 if( pA->op==TK_FUNCTION ){
4902 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhd5af5422018-04-13 14:27:01 +00004903 }else if( pA->op==TK_COLLATE ){
4904 return sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ? 2 : 0;
drh390b88a2015-08-31 18:13:01 +00004905 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004906 return 2;
drh2646da72005-12-09 20:02:05 +00004907 }
drh22827922000-06-06 17:27:05 +00004908 }
drh10d1edf2013-11-15 15:52:39 +00004909 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00004910 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00004911 if( combinedFlags & EP_xIsSelect ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004912 if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
4913 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004914 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh7693c422015-04-17 19:41:37 +00004915 if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
drh10d1edf2013-11-15 15:52:39 +00004916 if( pA->iColumn!=pB->iColumn ) return 2;
4917 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004918 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004919 }
4920 }
drh1d9da702010-01-07 15:17:02 +00004921 return 0;
drh22827922000-06-06 17:27:05 +00004922}
4923
drh8c6f6662010-04-26 19:17:26 +00004924/*
4925** Compare two ExprList objects. Return 0 if they are identical and
4926** non-zero if they differ in any way.
4927**
drh619a1302013-08-01 13:04:46 +00004928** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4929** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4930**
drh8c6f6662010-04-26 19:17:26 +00004931** This routine might return non-zero for equivalent ExprLists. The
4932** only consequence will be disabled optimizations. But this routine
4933** must never return 0 if the two ExprList objects are different, or
4934** a malfunction will result.
4935**
4936** Two NULL pointers are considered to be the same. But a NULL pointer
4937** always differs from a non-NULL pointer.
4938*/
drh619a1302013-08-01 13:04:46 +00004939int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004940 int i;
4941 if( pA==0 && pB==0 ) return 0;
4942 if( pA==0 || pB==0 ) return 1;
4943 if( pA->nExpr!=pB->nExpr ) return 1;
4944 for(i=0; i<pA->nExpr; i++){
4945 Expr *pExprA = pA->a[i].pExpr;
4946 Expr *pExprB = pB->a[i].pExpr;
4947 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004948 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004949 }
4950 return 0;
4951}
drh13449892005-09-07 21:22:45 +00004952
drh22827922000-06-06 17:27:05 +00004953/*
drhf9463df2017-02-11 14:59:58 +00004954** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4955** are ignored.
4956*/
4957int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004958 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004959 sqlite3ExprSkipCollate(pA),
4960 sqlite3ExprSkipCollate(pB),
4961 iTab);
4962}
4963
4964/*
drh4bd5f732013-07-31 23:22:39 +00004965** Return true if we can prove the pE2 will always be true if pE1 is
4966** true. Return false if we cannot complete the proof or if pE2 might
4967** be false. Examples:
4968**
drh619a1302013-08-01 13:04:46 +00004969** pE1: x==5 pE2: x==5 Result: true
4970** pE1: x>0 pE2: x==5 Result: false
4971** pE1: x=21 pE2: x=21 OR y=43 Result: true
4972** pE1: x!=123 pE2: x IS NOT NULL Result: true
4973** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4974** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4975** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004976**
4977** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4978** Expr.iTable<0 then assume a table number given by iTab.
4979**
drhc0804222017-06-28 21:47:16 +00004980** If pParse is not NULL, then the values of bound variables in pE1 are
4981** compared against literal values in pE2 and pParse->pVdbe->expmask is
4982** modified to record which bound variables are referenced. If pParse
4983** is NULL, then false will be returned if pE1 contains any bound variables.
4984**
drh4bd5f732013-07-31 23:22:39 +00004985** When in doubt, return false. Returning true might give a performance
4986** improvement. Returning false might cause a performance reduction, but
4987** it will always give the correct answer and is hence always safe.
4988*/
dan5aa550c2017-06-24 18:10:29 +00004989int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4990 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004991 return 1;
4992 }
4993 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004994 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4995 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004996 ){
4997 return 1;
4998 }
drh1ad93a02016-11-02 02:17:52 +00004999 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
5000 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
5001 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00005002 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00005003 }
5004 return 0;
drh4bd5f732013-07-31 23:22:39 +00005005}
5006
5007/*
drh25897872018-03-20 21:16:15 +00005008** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5009** If the expression node requires that the table at pWalker->iCur
5010** have a non-NULL column, then set pWalker->eCode to 1 and abort.
5011*/
5012static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drh821b6102018-03-24 18:01:51 +00005013 /* This routine is only called for WHERE clause expressions and so it
5014 ** cannot have any TK_AGG_COLUMN entries because those are only found
5015 ** in HAVING clauses. We can get a TK_AGG_FUNCTION in a WHERE clause,
5016 ** but that is an illegal construct and the query will be rejected at
5017 ** a later stage of processing, so the TK_AGG_FUNCTION case does not
5018 ** need to be considered here. */
5019 assert( pExpr->op!=TK_AGG_COLUMN );
5020 testcase( pExpr->op==TK_AGG_FUNCTION );
5021
drh25897872018-03-20 21:16:15 +00005022 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5023 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005024 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00005025 case TK_NOT:
drh25897872018-03-20 21:16:15 +00005026 case TK_ISNULL:
5027 case TK_IS:
5028 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005029 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005030 case TK_IN:
drh25897872018-03-20 21:16:15 +00005031 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00005032 testcase( pExpr->op==TK_ISNOT );
5033 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00005034 testcase( pExpr->op==TK_ISNULL );
5035 testcase( pExpr->op==TK_IS );
5036 testcase( pExpr->op==TK_OR );
5037 testcase( pExpr->op==TK_CASE );
5038 testcase( pExpr->op==TK_IN );
5039 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005040 return WRC_Prune;
5041 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005042 if( pWalker->u.iCur==pExpr->iTable ){
5043 pWalker->eCode = 1;
5044 return WRC_Abort;
5045 }
5046 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005047
5048 /* Virtual tables are allowed to use constraints like x=NULL. So
5049 ** a term of the form x=y does not prove that y is not null if x
5050 ** is the column of a virtual table */
5051 case TK_EQ:
5052 case TK_NE:
5053 case TK_LT:
5054 case TK_LE:
5055 case TK_GT:
5056 case TK_GE:
5057 testcase( pExpr->op==TK_EQ );
5058 testcase( pExpr->op==TK_NE );
5059 testcase( pExpr->op==TK_LT );
5060 testcase( pExpr->op==TK_LE );
5061 testcase( pExpr->op==TK_GT );
5062 testcase( pExpr->op==TK_GE );
5063 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
5064 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
5065 ){
5066 return WRC_Prune;
5067 }
drh25897872018-03-20 21:16:15 +00005068 default:
5069 return WRC_Continue;
5070 }
5071}
5072
5073/*
5074** Return true (non-zero) if expression p can only be true if at least
5075** one column of table iTab is non-null. In other words, return true
5076** if expression p will always be NULL or false if every column of iTab
5077** is NULL.
5078**
drh821b6102018-03-24 18:01:51 +00005079** False negatives are acceptable. In other words, it is ok to return
5080** zero even if expression p will never be true of every column of iTab
5081** is NULL. A false negative is merely a missed optimization opportunity.
5082**
5083** False positives are not allowed, however. A false positive may result
5084** in an incorrect answer.
5085**
drh25897872018-03-20 21:16:15 +00005086** Terms of p that are marked with EP_FromJoin (and hence that come from
5087** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5088**
5089** This routine is used to check if a LEFT JOIN can be converted into
5090** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5091** clause requires that some column of the right table of the LEFT JOIN
5092** be non-NULL, then the LEFT JOIN can be safely converted into an
5093** ordinary join.
5094*/
5095int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5096 Walker w;
5097 w.xExprCallback = impliesNotNullRow;
5098 w.xSelectCallback = 0;
5099 w.xSelectCallback2 = 0;
5100 w.eCode = 0;
5101 w.u.iCur = iTab;
5102 sqlite3WalkExpr(&w, p);
5103 return w.eCode;
5104}
5105
5106/*
drh030796d2012-08-23 16:18:10 +00005107** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005108** to determine if an expression can be evaluated by reference to the
5109** index only, without having to do a search for the corresponding
5110** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5111** is the cursor for the table.
5112*/
5113struct IdxCover {
5114 Index *pIdx; /* The index to be tested for coverage */
5115 int iCur; /* Cursor number for the table corresponding to the index */
5116};
5117
5118/*
5119** Check to see if there are references to columns in table
5120** pWalker->u.pIdxCover->iCur can be satisfied using the index
5121** pWalker->u.pIdxCover->pIdx.
5122*/
5123static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5124 if( pExpr->op==TK_COLUMN
5125 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5126 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5127 ){
5128 pWalker->eCode = 1;
5129 return WRC_Abort;
5130 }
5131 return WRC_Continue;
5132}
5133
5134/*
drhe604ec02016-07-27 19:20:58 +00005135** Determine if an index pIdx on table with cursor iCur contains will
5136** the expression pExpr. Return true if the index does cover the
5137** expression and false if the pExpr expression references table columns
5138** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005139**
5140** An index covering an expression means that the expression can be
5141** evaluated using only the index and without having to lookup the
5142** corresponding table entry.
5143*/
5144int sqlite3ExprCoveredByIndex(
5145 Expr *pExpr, /* The index to be tested */
5146 int iCur, /* The cursor number for the corresponding table */
5147 Index *pIdx /* The index that might be used for coverage */
5148){
5149 Walker w;
5150 struct IdxCover xcov;
5151 memset(&w, 0, sizeof(w));
5152 xcov.iCur = iCur;
5153 xcov.pIdx = pIdx;
5154 w.xExprCallback = exprIdxCover;
5155 w.u.pIdxCover = &xcov;
5156 sqlite3WalkExpr(&w, pExpr);
5157 return !w.eCode;
5158}
5159
5160
5161/*
5162** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005163** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005164** aggregate function, in order to implement the
5165** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005166*/
drh030796d2012-08-23 16:18:10 +00005167struct SrcCount {
5168 SrcList *pSrc; /* One particular FROM clause in a nested query */
5169 int nThis; /* Number of references to columns in pSrcList */
5170 int nOther; /* Number of references to columns in other FROM clauses */
5171};
5172
5173/*
5174** Count the number of references to columns.
5175*/
5176static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005177 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5178 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5179 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5180 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5181 ** NEVER() will need to be removed. */
5182 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005183 int i;
drh030796d2012-08-23 16:18:10 +00005184 struct SrcCount *p = pWalker->u.pSrcCount;
5185 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005186 int nSrc = pSrc ? pSrc->nSrc : 0;
5187 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005188 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005189 }
drh655814d2015-01-09 01:27:29 +00005190 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005191 p->nThis++;
5192 }else{
5193 p->nOther++;
5194 }
drh374fdce2012-04-17 16:38:53 +00005195 }
drh030796d2012-08-23 16:18:10 +00005196 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005197}
5198
5199/*
drh030796d2012-08-23 16:18:10 +00005200** Determine if any of the arguments to the pExpr Function reference
5201** pSrcList. Return true if they do. Also return true if the function
5202** has no arguments or has only constant arguments. Return false if pExpr
5203** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005204*/
drh030796d2012-08-23 16:18:10 +00005205int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005206 Walker w;
drh030796d2012-08-23 16:18:10 +00005207 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005208 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005209 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005210 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005211 w.u.pSrcCount = &cnt;
5212 cnt.pSrc = pSrcList;
5213 cnt.nThis = 0;
5214 cnt.nOther = 0;
5215 sqlite3WalkExprList(&w, pExpr->x.pList);
5216 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005217}
5218
5219/*
drh13449892005-09-07 21:22:45 +00005220** Add a new element to the pAggInfo->aCol[] array. Return the index of
5221** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005222*/
drh17435752007-08-16 04:30:38 +00005223static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005224 int i;
drhcf643722007-03-27 13:36:37 +00005225 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005226 db,
drhcf643722007-03-27 13:36:37 +00005227 pInfo->aCol,
5228 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005229 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005230 &i
5231 );
drh13449892005-09-07 21:22:45 +00005232 return i;
5233}
5234
5235/*
5236** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5237** the new element. Return a negative number if malloc fails.
5238*/
drh17435752007-08-16 04:30:38 +00005239static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005240 int i;
drhcf643722007-03-27 13:36:37 +00005241 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005242 db,
drhcf643722007-03-27 13:36:37 +00005243 pInfo->aFunc,
5244 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005245 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005246 &i
5247 );
drh13449892005-09-07 21:22:45 +00005248 return i;
5249}
drh22827922000-06-06 17:27:05 +00005250
5251/*
drh7d10d5a2008-08-20 16:35:10 +00005252** This is the xExprCallback for a tree walker. It is used to
5253** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005254** for additional information.
drh22827922000-06-06 17:27:05 +00005255*/
drh7d10d5a2008-08-20 16:35:10 +00005256static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005257 int i;
drh7d10d5a2008-08-20 16:35:10 +00005258 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005259 Parse *pParse = pNC->pParse;
5260 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005261 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005262
drh25c3b8c2018-04-16 10:34:13 +00005263 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005264 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005265 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005266 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005267 testcase( pExpr->op==TK_AGG_COLUMN );
5268 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005269 /* Check to see if the column is in one of the tables in the FROM
5270 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005271 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005272 struct SrcList_item *pItem = pSrcList->a;
5273 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5274 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005275 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005276 if( pExpr->iTable==pItem->iCursor ){
5277 /* If we reach this point, it means that pExpr refers to a table
5278 ** that is in the FROM clause of the aggregate query.
5279 **
5280 ** Make an entry for the column in pAggInfo->aCol[] if there
5281 ** is not an entry there already.
5282 */
drh7f906d62007-03-12 23:48:52 +00005283 int k;
drh13449892005-09-07 21:22:45 +00005284 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005285 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005286 if( pCol->iTable==pExpr->iTable &&
5287 pCol->iColumn==pExpr->iColumn ){
5288 break;
5289 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005290 }
danielk19771e536952007-08-16 10:09:01 +00005291 if( (k>=pAggInfo->nColumn)
5292 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5293 ){
drh7f906d62007-03-12 23:48:52 +00005294 pCol = &pAggInfo->aCol[k];
danielk19770817d0d2007-02-14 09:19:36 +00005295 pCol->pTab = pExpr->pTab;
drh13449892005-09-07 21:22:45 +00005296 pCol->iTable = pExpr->iTable;
5297 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005298 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005299 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005300 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005301 if( pAggInfo->pGroupBy ){
5302 int j, n;
5303 ExprList *pGB = pAggInfo->pGroupBy;
5304 struct ExprList_item *pTerm = pGB->a;
5305 n = pGB->nExpr;
5306 for(j=0; j<n; j++, pTerm++){
5307 Expr *pE = pTerm->pExpr;
5308 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5309 pE->iColumn==pExpr->iColumn ){
5310 pCol->iSorterColumn = j;
5311 break;
5312 }
5313 }
5314 }
5315 if( pCol->iSorterColumn<0 ){
5316 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5317 }
5318 }
5319 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5320 ** because it was there before or because we just created it).
5321 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5322 ** pAggInfo->aCol[] entry.
5323 */
drhebb6a652013-09-12 23:42:22 +00005324 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005325 pExpr->pAggInfo = pAggInfo;
5326 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005327 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005328 break;
5329 } /* endif pExpr->iTable==pItem->iCursor */
5330 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005331 }
drh7d10d5a2008-08-20 16:35:10 +00005332 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005333 }
5334 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005335 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005336 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005337 ){
drh13449892005-09-07 21:22:45 +00005338 /* Check to see if pExpr is a duplicate of another aggregate
5339 ** function that is already in the pAggInfo structure
5340 */
5341 struct AggInfo_func *pItem = pAggInfo->aFunc;
5342 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005343 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005344 break;
5345 }
drh22827922000-06-06 17:27:05 +00005346 }
drh13449892005-09-07 21:22:45 +00005347 if( i>=pAggInfo->nFunc ){
5348 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5349 */
danielk197714db2662006-01-09 16:12:04 +00005350 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005351 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005352 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005353 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005354 pItem = &pAggInfo->aFunc[i];
5355 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005356 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005357 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005358 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005359 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005360 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005361 if( pExpr->flags & EP_Distinct ){
5362 pItem->iDistinct = pParse->nTab++;
5363 }else{
5364 pItem->iDistinct = -1;
5365 }
drh13449892005-09-07 21:22:45 +00005366 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005367 }
drh13449892005-09-07 21:22:45 +00005368 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5369 */
drhc5cd1242013-09-12 16:50:49 +00005370 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005371 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005372 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005373 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005374 return WRC_Prune;
5375 }else{
5376 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005377 }
drh22827922000-06-06 17:27:05 +00005378 }
5379 }
drh7d10d5a2008-08-20 16:35:10 +00005380 return WRC_Continue;
5381}
5382static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005383 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005384 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005385 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005386}
drh979dd1b2017-05-29 14:26:07 +00005387static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5388 UNUSED_PARAMETER(pSelect);
5389 pWalker->walkerDepth--;
5390}
drh626a8792005-01-17 22:08:19 +00005391
5392/*
drhe8abb4c2012-11-02 18:24:57 +00005393** Analyze the pExpr expression looking for aggregate functions and
5394** for variables that need to be added to AggInfo object that pNC->pAggInfo
5395** points to. Additional entries are made on the AggInfo object as
5396** necessary.
drh626a8792005-01-17 22:08:19 +00005397**
5398** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005399** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005400*/
drhd2b3e232008-01-23 14:51:49 +00005401void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005402 Walker w;
5403 w.xExprCallback = analyzeAggregate;
5404 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005405 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5406 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005407 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00005408 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005409 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005410}
drh5d9a4af2005-08-30 00:54:01 +00005411
5412/*
5413** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5414** expression list. Return the number of errors.
5415**
5416** If an error is found, the analysis is cut short.
5417*/
drhd2b3e232008-01-23 14:51:49 +00005418void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005419 struct ExprList_item *pItem;
5420 int i;
drh5d9a4af2005-08-30 00:54:01 +00005421 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005422 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5423 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005424 }
5425 }
drh5d9a4af2005-08-30 00:54:01 +00005426}
drh892d3172008-01-10 03:46:36 +00005427
5428/*
drhceea3322009-04-23 13:22:42 +00005429** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005430*/
5431int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005432 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005433 return ++pParse->nMem;
5434 }
danielk19772f425f62008-07-04 09:41:39 +00005435 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005436}
drhceea3322009-04-23 13:22:42 +00005437
5438/*
5439** Deallocate a register, making available for reuse for some other
5440** purpose.
5441**
5442** If a register is currently being used by the column cache, then
peter.d.reid60ec9142014-09-06 16:39:46 +00005443** the deallocation is deferred until the column cache line that uses
drhceea3322009-04-23 13:22:42 +00005444** the register becomes stale.
5445*/
drh892d3172008-01-10 03:46:36 +00005446void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005447 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drhceea3322009-04-23 13:22:42 +00005448 int i;
5449 struct yColCache *p;
drh9b40d132016-09-30 20:22:27 +00005450 for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
drhceea3322009-04-23 13:22:42 +00005451 if( p->iReg==iReg ){
5452 p->tempReg = 1;
5453 return;
5454 }
5455 }
drh892d3172008-01-10 03:46:36 +00005456 pParse->aTempReg[pParse->nTempReg++] = iReg;
5457 }
5458}
5459
5460/*
drhed24da42016-09-06 14:37:05 +00005461** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005462*/
5463int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005464 int i, n;
drhed24da42016-09-06 14:37:05 +00005465 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005466 i = pParse->iRangeReg;
5467 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005468 if( nReg<=n ){
5469 assert( !usedAsColumnCache(pParse, i, i+n-1) );
drh892d3172008-01-10 03:46:36 +00005470 pParse->iRangeReg += nReg;
5471 pParse->nRangeReg -= nReg;
5472 }else{
5473 i = pParse->nMem+1;
5474 pParse->nMem += nReg;
5475 }
5476 return i;
5477}
5478void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005479 if( nReg==1 ){
5480 sqlite3ReleaseTempReg(pParse, iReg);
5481 return;
5482 }
drhf49f3522009-12-30 14:12:38 +00005483 sqlite3ExprCacheRemove(pParse, iReg, nReg);
drh892d3172008-01-10 03:46:36 +00005484 if( nReg>pParse->nRangeReg ){
5485 pParse->nRangeReg = nReg;
5486 pParse->iRangeReg = iReg;
5487 }
5488}
drhcdc69552011-12-06 13:24:59 +00005489
5490/*
5491** Mark all temporary registers as being unavailable for reuse.
5492*/
5493void sqlite3ClearTempRegCache(Parse *pParse){
5494 pParse->nTempReg = 0;
5495 pParse->nRangeReg = 0;
5496}
drhbb9b5f22016-03-19 00:35:02 +00005497
5498/*
5499** Validate that no temporary register falls within the range of
5500** iFirst..iLast, inclusive. This routine is only call from within assert()
5501** statements.
5502*/
5503#ifdef SQLITE_DEBUG
5504int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5505 int i;
5506 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005507 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5508 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005509 ){
5510 return 0;
5511 }
5512 for(i=0; i<pParse->nTempReg; i++){
5513 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5514 return 0;
5515 }
5516 }
5517 return 1;
5518}
5519#endif /* SQLITE_DEBUG */