blob: 9c0ce1f87d5b06159316ade0651eaaa434c52fd8 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
47 pExpr = sqlite3ExprSkipCollate(pExpr);
mistachkin9bec6fb2014-06-26 21:28:21 +000048 if( pExpr->flags & EP_Generic ) return 0;
drh580c8c12012-12-08 03:34:04 +000049 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000050 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000051 assert( pExpr->flags&EP_xIsSelect );
52 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000053 }
drhdb45bd52016-08-22 00:48:58 +000054 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000055#ifndef SQLITE_OMIT_CAST
56 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000057 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000058 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000059 }
60#endif
drheda079c2018-09-20 19:02:15 +000061 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000063 }
dan80aa5452016-09-03 19:52:12 +000064 if( op==TK_SELECT_COLUMN ){
65 assert( pExpr->pLeft->flags&EP_xIsSelect );
66 return sqlite3ExprAffinity(
67 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
68 );
69 }
danielk1977a37cdde2004-05-16 11:15:36 +000070 return pExpr->affinity;
71}
72
drh53db1452004-05-20 13:54:53 +000073/*
drh8b4c40d2007-02-01 23:02:45 +000074** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000075** sequence named by pToken. Return a pointer to a new Expr node that
76** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000077**
78** If a memory allocation error occurs, that fact is recorded in pParse->db
79** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000080*/
drh4ef7efa2014-03-20 15:14:08 +000081Expr *sqlite3ExprAddCollateToken(
82 Parse *pParse, /* Parsing context */
83 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000084 const Token *pCollName, /* Name of collating sequence */
85 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000086){
drh0a8a4062012-12-07 18:38:16 +000087 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000088 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000089 if( pNew ){
90 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000091 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000092 pExpr = pNew;
93 }
drhae80dde2012-12-06 21:16:43 +000094 }
drh0a8a4062012-12-07 18:38:16 +000095 return pExpr;
96}
97Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +000098 Token s;
99 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000100 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000101 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000102}
103
104/*
drh0b8d2552015-09-05 22:36:07 +0000105** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000106** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000107*/
108Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha4c3c872013-09-12 17:29:25 +0000109 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000111 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000113 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000114 pExpr = pExpr->x.pList->a[0].pExpr;
115 }else{
drh0b8d2552015-09-05 22:36:07 +0000116 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000117 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000118 }
drha4c3c872013-09-12 17:29:25 +0000119 }
drh0a8a4062012-12-07 18:38:16 +0000120 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000121}
122
123/*
drhae80dde2012-12-06 21:16:43 +0000124** Return the collation sequence for the expression pExpr. If
125** there is no defined collating sequence, return NULL.
126**
drh70efa842017-09-28 01:58:23 +0000127** See also: sqlite3ExprNNCollSeq()
128**
129** The sqlite3ExprNNCollSeq() works the same exact that it returns the
130** default collation if pExpr has no defined collation.
131**
drhae80dde2012-12-06 21:16:43 +0000132** The collating sequence might be determined by a COLLATE operator
133** or by the presence of a column with a defined collating sequence.
134** COLLATE operators take first precedence. Left operands take
135** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000136*/
danielk19777cedc8d2004-06-10 10:50:08 +0000137CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000138 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000139 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000140 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000141 while( p ){
drhae80dde2012-12-06 21:16:43 +0000142 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000143 if( p->flags & EP_Generic ) break;
drha58d4a92015-01-27 13:17:05 +0000144 if( (op==TK_AGG_COLUMN || op==TK_COLUMN
drhae80dde2012-12-06 21:16:43 +0000145 || op==TK_REGISTER || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000146 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000147 ){
drheda079c2018-09-20 19:02:15 +0000148 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000149 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000150 int j = p->iColumn;
151 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000152 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000153 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000154 }
155 break;
danielk19770202b292004-06-09 09:55:16 +0000156 }
drhe081d732018-07-27 18:19:12 +0000157 if( op==TK_CAST || op==TK_UPLUS ){
158 p = p->pLeft;
159 continue;
160 }
161 if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
162 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163 break;
164 }
drhae80dde2012-12-06 21:16:43 +0000165 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000166 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000167 p = p->pLeft;
168 }else{
drh2308ed32015-02-09 16:09:34 +0000169 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000170 /* The Expr.x union is never used at the same time as Expr.pRight */
171 assert( p->x.pList==0 || p->pRight==0 );
172 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
173 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
174 ** least one EP_Collate. Thus the following two ALWAYS. */
175 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000176 int i;
drh6728cd92015-02-09 18:28:03 +0000177 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000178 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
179 pNext = p->x.pList->a[i].pExpr;
180 break;
181 }
182 }
183 }
184 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000185 }
186 }else{
drh7d10d5a2008-08-20 16:35:10 +0000187 break;
188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
danielk19777cedc8d2004-06-10 10:50:08 +0000190 if( sqlite3CheckCollSeq(pParse, pColl) ){
191 pColl = 0;
192 }
193 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000194}
195
196/*
drh70efa842017-09-28 01:58:23 +0000197** Return the collation sequence for the expression pExpr. If
198** there is no defined collating sequence, return a pointer to the
199** defautl collation sequence.
200**
201** See also: sqlite3ExprCollSeq()
202**
203** The sqlite3ExprCollSeq() routine works the same except that it
204** returns NULL if there is no defined collation.
205*/
206CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
207 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
208 if( p==0 ) p = pParse->db->pDfltColl;
209 assert( p!=0 );
210 return p;
211}
212
213/*
214** Return TRUE if the two expressions have equivalent collating sequences.
215*/
216int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
217 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
218 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
219 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
220}
221
222/*
drh626a8792005-01-17 22:08:19 +0000223** pExpr is an operand of a comparison operator. aff2 is the
224** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000225** type affinity that should be used for the comparison operator.
226*/
danielk1977e014a832004-05-17 10:48:57 +0000227char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000228 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000229 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000230 /* Both sides of the comparison are columns. If one has numeric
231 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000232 */
drh8a512562005-11-14 22:29:05 +0000233 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000234 return SQLITE_AFF_NUMERIC;
235 }else{
drh05883a32015-06-02 15:32:08 +0000236 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000237 }
238 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000239 /* Neither side of the comparison is a column. Compare the
240 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000241 */
drh05883a32015-06-02 15:32:08 +0000242 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000243 }else{
244 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000245 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000246 return (aff1 + aff2);
247 }
248}
249
drh53db1452004-05-20 13:54:53 +0000250/*
251** pExpr is a comparison operator. Return the type affinity that should
252** be applied to both operands prior to doing the comparison.
253*/
danielk1977e014a832004-05-17 10:48:57 +0000254static char comparisonAffinity(Expr *pExpr){
255 char aff;
256 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000258 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000259 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000260 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000261 if( pExpr->pRight ){
262 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000263 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
264 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000265 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000266 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000267 }
268 return aff;
269}
270
271/*
272** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273** idx_affinity is the affinity of an indexed column. Return true
274** if the index with affinity idx_affinity may be used to implement
275** the comparison in pExpr.
276*/
277int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000279 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000280 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000281 return 1;
282 case SQLITE_AFF_TEXT:
283 return idx_affinity==SQLITE_AFF_TEXT;
284 default:
285 return sqlite3IsNumericAffinity(idx_affinity);
286 }
danielk1977e014a832004-05-17 10:48:57 +0000287}
288
danielk1977a37cdde2004-05-16 11:15:36 +0000289/*
drh35573352008-01-08 23:54:25 +0000290** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000291** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000292*/
drh35573352008-01-08 23:54:25 +0000293static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
294 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000295 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000296 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000297}
298
drha2e00042002-01-22 03:13:42 +0000299/*
danielk19770202b292004-06-09 09:55:16 +0000300** Return a pointer to the collation sequence that should be used by
301** a binary comparison operator comparing pLeft and pRight.
302**
303** If the left hand expression has a collating sequence type, then it is
304** used. Otherwise the collation sequence for the right hand expression
305** is used, or the default (BINARY) if neither expression has a collating
306** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000307**
308** Argument pRight (but not pLeft) may be a null pointer. In this case,
309** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000310*/
drh0a0e1312007-08-07 17:04:59 +0000311CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000312 Parse *pParse,
313 Expr *pLeft,
314 Expr *pRight
315){
drhec41dda2007-02-07 13:09:45 +0000316 CollSeq *pColl;
317 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000318 if( pLeft->flags & EP_Collate ){
319 pColl = sqlite3ExprCollSeq(pParse, pLeft);
320 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000322 }else{
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 if( !pColl ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
326 }
danielk19770202b292004-06-09 09:55:16 +0000327 }
328 return pColl;
329}
330
331/*
drhbe5c89a2004-07-26 00:31:09 +0000332** Generate code for a comparison operator.
333*/
334static int codeCompare(
335 Parse *pParse, /* The parsing (and code generating) context */
336 Expr *pLeft, /* The left operand */
337 Expr *pRight, /* The right operand */
338 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000339 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000340 int dest, /* Jump here if true. */
341 int jumpIfNull /* If true, jump if either operand is NULL */
342){
drh35573352008-01-08 23:54:25 +0000343 int p5;
344 int addr;
345 CollSeq *p4;
346
347 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
348 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
349 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
350 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000351 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000352 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000353}
354
dancfbb5e82016-07-13 19:48:13 +0000355/*
dan870a0702016-08-01 16:37:43 +0000356** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000357**
358** A vector is defined as any expression that results in two or more
359** columns of result. Every TK_VECTOR node is an vector because the
360** parser will not generate a TK_VECTOR with fewer than two entries.
361** But a TK_SELECT might be either a vector or a scalar. It is only
362** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000363*/
364int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000365 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000366}
367
368/*
dancfbb5e82016-07-13 19:48:13 +0000369** If the expression passed as the only argument is of type TK_VECTOR
370** return the number of expressions in the vector. Or, if the expression
371** is a sub-select, return the number of columns in the sub-select. For
372** any other type of expression, return 1.
373*/
dan71c57db2016-07-09 20:23:55 +0000374int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000375 u8 op = pExpr->op;
376 if( op==TK_REGISTER ) op = pExpr->op2;
377 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000378 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000379 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000380 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000381 }else{
382 return 1;
dan71c57db2016-07-09 20:23:55 +0000383 }
dan71c57db2016-07-09 20:23:55 +0000384}
385
danba00e302016-07-23 20:24:06 +0000386/*
drhfc7f27b2016-08-20 00:07:01 +0000387** Return a pointer to a subexpression of pVector that is the i-th
388** column of the vector (numbered starting with 0). The caller must
389** ensure that i is within range.
390**
drh76dbe7a2016-08-20 21:02:38 +0000391** If pVector is really a scalar (and "scalar" here includes subqueries
392** that return a single column!) then return pVector unmodified.
393**
drhfc7f27b2016-08-20 00:07:01 +0000394** pVector retains ownership of the returned subexpression.
395**
396** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000397** just the expression for the i-th term of the result set, and may
398** not be ready for evaluation because the table cursor has not yet
399** been positioned.
danba00e302016-07-23 20:24:06 +0000400*/
drhfc7f27b2016-08-20 00:07:01 +0000401Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000402 assert( i<sqlite3ExprVectorSize(pVector) );
403 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000404 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
405 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000406 return pVector->x.pSelect->pEList->a[i].pExpr;
407 }else{
408 return pVector->x.pList->a[i].pExpr;
409 }
dan71c57db2016-07-09 20:23:55 +0000410 }
dan870a0702016-08-01 16:37:43 +0000411 return pVector;
dan71c57db2016-07-09 20:23:55 +0000412}
drhfc7f27b2016-08-20 00:07:01 +0000413
drhfc7f27b2016-08-20 00:07:01 +0000414/*
415** Compute and return a new Expr object which when passed to
416** sqlite3ExprCode() will generate all necessary code to compute
417** the iField-th column of the vector expression pVector.
418**
drh8762ec12016-08-20 01:06:22 +0000419** It is ok for pVector to be a scalar (as long as iField==0).
420** In that case, this routine works like sqlite3ExprDup().
421**
drhfc7f27b2016-08-20 00:07:01 +0000422** The caller owns the returned Expr object and is responsible for
423** ensuring that the returned value eventually gets freed.
424**
drh8762ec12016-08-20 01:06:22 +0000425** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000426** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000427** valid for the life of the returned object. If pVector is a TK_VECTOR
428** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000429** returns.
drh8762ec12016-08-20 01:06:22 +0000430**
431** A trick to cause a TK_SELECT pVector to be deleted together with
432** the returned Expr object is to attach the pVector to the pRight field
433** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000434*/
435Expr *sqlite3ExprForVectorField(
436 Parse *pParse, /* Parsing context */
437 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000438 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000439){
440 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000441 if( pVector->op==TK_SELECT ){
442 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000443 /* The TK_SELECT_COLUMN Expr node:
444 **
drh966e2912017-01-03 02:58:01 +0000445 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000446 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000447 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000448 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000449 ** pLeft->iTable: First in an array of register holding result, or 0
450 ** if the result is not yet computed.
451 **
452 ** sqlite3ExprDelete() specifically skips the recursive delete of
453 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000454 ** can be attached to pRight to cause this node to take ownership of
455 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
456 ** with the same pLeft pointer to the pVector, but only one of them
457 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000458 */
drhabfd35e2016-12-06 22:47:23 +0000459 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000460 if( pRet ){
461 pRet->iColumn = iField;
462 pRet->pLeft = pVector;
463 }
drhfc7f27b2016-08-20 00:07:01 +0000464 assert( pRet==0 || pRet->iTable==0 );
465 }else{
drha1251bc2016-08-20 00:51:37 +0000466 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
drhfc7f27b2016-08-20 00:07:01 +0000468 }
469 return pRet;
470}
dan71c57db2016-07-09 20:23:55 +0000471
dan5c288b92016-07-30 21:02:33 +0000472/*
473** If expression pExpr is of type TK_SELECT, generate code to evaluate
474** it. Return the register in which the result is stored (or, if the
475** sub-select returns more than one column, the first in an array
476** of registers in which the result is stored).
477**
478** If pExpr is not a TK_SELECT expression, return 0.
479*/
480static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000481 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000482#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000483 if( pExpr->op==TK_SELECT ){
484 reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
dan8da209b2016-07-26 18:06:08 +0000485 }
danf9b2e052016-08-02 17:45:00 +0000486#endif
dan8da209b2016-07-26 18:06:08 +0000487 return reg;
488}
489
dan5c288b92016-07-30 21:02:33 +0000490/*
491** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000492** or TK_SELECT that returns more than one column. This function returns
493** the register number of a register that contains the value of
494** element iField of the vector.
495**
496** If pVector is a TK_SELECT expression, then code for it must have
497** already been generated using the exprCodeSubselect() routine. In this
498** case parameter regSelect should be the first in an array of registers
499** containing the results of the sub-select.
500**
501** If pVector is of type TK_VECTOR, then code for the requested field
502** is generated. In this case (*pRegFree) may be set to the number of
503** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000504**
505** Before returning, output parameter (*ppExpr) is set to point to the
506** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000507*/
508static int exprVectorRegister(
509 Parse *pParse, /* Parse context */
510 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000511 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000512 int regSelect, /* First in array of registers */
513 Expr **ppExpr, /* OUT: Expression element */
514 int *pRegFree /* OUT: Temp register to free */
515){
drh12abf402016-08-22 14:30:05 +0000516 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000517 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000518 if( op==TK_REGISTER ){
519 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
520 return pVector->iTable+iField;
521 }
522 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000523 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
524 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000525 }
dan870a0702016-08-01 16:37:43 +0000526 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000527 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
528}
529
530/*
531** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000532** the result of the comparison (1, 0, or NULL) and write that
533** result into register dest.
534**
535** The caller must satisfy the following preconditions:
536**
537** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
538** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
539** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000540*/
drh79752b62016-08-13 10:02:17 +0000541static void codeVectorCompare(
542 Parse *pParse, /* Code generator context */
543 Expr *pExpr, /* The comparison operation */
544 int dest, /* Write results into this register */
545 u8 op, /* Comparison operator */
546 u8 p5 /* SQLITE_NULLEQ or zero */
547){
dan71c57db2016-07-09 20:23:55 +0000548 Vdbe *v = pParse->pVdbe;
549 Expr *pLeft = pExpr->pLeft;
550 Expr *pRight = pExpr->pRight;
551 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000552 int i;
553 int regLeft = 0;
554 int regRight = 0;
555 u8 opx = op;
556 int addrDone = sqlite3VdbeMakeLabel(v);
dan71c57db2016-07-09 20:23:55 +0000557
drh245ce622017-01-01 12:44:07 +0000558 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
559 sqlite3ErrorMsg(pParse, "row value misused");
560 return;
561 }
drhb29e60c2016-09-05 12:02:34 +0000562 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
563 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
564 || pExpr->op==TK_LT || pExpr->op==TK_GT
565 || pExpr->op==TK_LE || pExpr->op==TK_GE
566 );
567 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
568 || (pExpr->op==TK_ISNOT && op==TK_NE) );
569 assert( p5==0 || pExpr->op!=op );
570 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000571
drhb29e60c2016-09-05 12:02:34 +0000572 p5 |= SQLITE_STOREP2;
573 if( opx==TK_LE ) opx = TK_LT;
574 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000575
drhb29e60c2016-09-05 12:02:34 +0000576 regLeft = exprCodeSubselect(pParse, pLeft);
577 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000578
drhb29e60c2016-09-05 12:02:34 +0000579 for(i=0; 1 /*Loop exits by "break"*/; i++){
580 int regFree1 = 0, regFree2 = 0;
581 Expr *pL, *pR;
582 int r1, r2;
583 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000584 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
585 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
586 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
587 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
588 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
589 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
590 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
591 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
592 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
593 sqlite3ReleaseTempReg(pParse, regFree1);
594 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000595 if( i==nLeft-1 ){
596 break;
dan71c57db2016-07-09 20:23:55 +0000597 }
drhb29e60c2016-09-05 12:02:34 +0000598 if( opx==TK_EQ ){
599 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
600 p5 |= SQLITE_KEEPNULL;
601 }else if( opx==TK_NE ){
602 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
603 p5 |= SQLITE_KEEPNULL;
604 }else{
605 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
606 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
607 VdbeCoverageIf(v, op==TK_LT);
608 VdbeCoverageIf(v, op==TK_GT);
609 VdbeCoverageIf(v, op==TK_LE);
610 VdbeCoverageIf(v, op==TK_GE);
611 if( i==nLeft-2 ) opx = op;
612 }
dan71c57db2016-07-09 20:23:55 +0000613 }
drhb29e60c2016-09-05 12:02:34 +0000614 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000615}
616
danielk19774b5255a2008-06-05 16:47:39 +0000617#if SQLITE_MAX_EXPR_DEPTH>0
618/*
619** Check that argument nHeight is less than or equal to the maximum
620** expression depth allowed. If it is not, leave an error message in
621** pParse.
622*/
drh7d10d5a2008-08-20 16:35:10 +0000623int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000624 int rc = SQLITE_OK;
625 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
626 if( nHeight>mxHeight ){
627 sqlite3ErrorMsg(pParse,
628 "Expression tree is too large (maximum depth %d)", mxHeight
629 );
630 rc = SQLITE_ERROR;
631 }
632 return rc;
633}
634
635/* The following three functions, heightOfExpr(), heightOfExprList()
636** and heightOfSelect(), are used to determine the maximum height
637** of any expression tree referenced by the structure passed as the
638** first argument.
639**
640** If this maximum height is greater than the current value pointed
641** to by pnHeight, the second parameter, then set *pnHeight to that
642** value.
643*/
644static void heightOfExpr(Expr *p, int *pnHeight){
645 if( p ){
646 if( p->nHeight>*pnHeight ){
647 *pnHeight = p->nHeight;
648 }
649 }
650}
651static void heightOfExprList(ExprList *p, int *pnHeight){
652 if( p ){
653 int i;
654 for(i=0; i<p->nExpr; i++){
655 heightOfExpr(p->a[i].pExpr, pnHeight);
656 }
657 }
658}
dan1a3a3082018-01-18 19:00:54 +0000659static void heightOfSelect(Select *pSelect, int *pnHeight){
660 Select *p;
661 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000662 heightOfExpr(p->pWhere, pnHeight);
663 heightOfExpr(p->pHaving, pnHeight);
664 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000665 heightOfExprList(p->pEList, pnHeight);
666 heightOfExprList(p->pGroupBy, pnHeight);
667 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000668 }
669}
670
671/*
672** Set the Expr.nHeight variable in the structure passed as an
673** argument. An expression with no children, Expr.pList or
674** Expr.pSelect member has a height of 1. Any other expression
675** has a height equal to the maximum height of any other
676** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000677**
678** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
679** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000680*/
681static void exprSetHeight(Expr *p){
682 int nHeight = 0;
683 heightOfExpr(p->pLeft, &nHeight);
684 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000685 if( ExprHasProperty(p, EP_xIsSelect) ){
686 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000687 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000688 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000689 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000690 }
danielk19774b5255a2008-06-05 16:47:39 +0000691 p->nHeight = nHeight + 1;
692}
693
694/*
695** Set the Expr.nHeight variable using the exprSetHeight() function. If
696** the height is greater than the maximum allowed expression depth,
697** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000698**
699** Also propagate all EP_Propagate flags from the Expr.x.pList into
700** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000701*/
drh2308ed32015-02-09 16:09:34 +0000702void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000703 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000704 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000705 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000706}
707
708/*
709** Return the maximum height of any expression tree referenced
710** by the select statement passed as an argument.
711*/
712int sqlite3SelectExprHeight(Select *p){
713 int nHeight = 0;
714 heightOfSelect(p, &nHeight);
715 return nHeight;
716}
drh2308ed32015-02-09 16:09:34 +0000717#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
718/*
719** Propagate all EP_Propagate flags from the Expr.x.pList into
720** Expr.flags.
721*/
722void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
723 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
724 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
725 }
726}
727#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000728#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
729
drhbe5c89a2004-07-26 00:31:09 +0000730/*
drhb7916a72009-05-27 10:31:29 +0000731** This routine is the core allocator for Expr nodes.
732**
drha76b5df2002-02-23 02:32:10 +0000733** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000734** for this node and for the pToken argument is a single allocation
735** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000736** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000737**
738** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000739** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000740** parameter is ignored if pToken is NULL or if the token does not
741** appear to be quoted. If the quotes were of the form "..." (double-quotes)
742** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000743**
744** Special case: If op==TK_INTEGER and pToken points to a string that
745** can be translated into a 32-bit integer, then the token is not
746** stored in u.zToken. Instead, the integer values is written
747** into u.iValue and the EP_IntValue flag is set. No extra storage
748** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000749*/
drhb7916a72009-05-27 10:31:29 +0000750Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000751 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000752 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000753 const Token *pToken, /* Token argument. Might be NULL */
754 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000755){
drha76b5df2002-02-23 02:32:10 +0000756 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000757 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000758 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000759
drh575fad62016-02-05 13:38:36 +0000760 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000761 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000762 if( op!=TK_INTEGER || pToken->z==0
763 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
764 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000765 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000766 }
drhb7916a72009-05-27 10:31:29 +0000767 }
drh575fad62016-02-05 13:38:36 +0000768 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000769 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000770 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000771 pNew->op = (u8)op;
772 pNew->iAgg = -1;
773 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000774 if( nExtra==0 ){
drhb98a2e32017-07-07 12:43:57 +0000775 pNew->flags |= EP_IntValue|EP_Leaf;
drh33e619f2009-05-28 01:00:55 +0000776 pNew->u.iValue = iValue;
777 }else{
drh33e619f2009-05-28 01:00:55 +0000778 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000779 assert( pToken->z!=0 || pToken->n==0 );
780 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000781 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000782 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
783 if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
drh33e619f2009-05-28 01:00:55 +0000784 sqlite3Dequote(pNew->u.zToken);
drh33e619f2009-05-28 01:00:55 +0000785 }
drhb7916a72009-05-27 10:31:29 +0000786 }
787 }
788#if SQLITE_MAX_EXPR_DEPTH>0
789 pNew->nHeight = 1;
790#endif
791 }
drha76b5df2002-02-23 02:32:10 +0000792 return pNew;
793}
794
795/*
drhb7916a72009-05-27 10:31:29 +0000796** Allocate a new expression node from a zero-terminated token that has
797** already been dequoted.
798*/
799Expr *sqlite3Expr(
800 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
801 int op, /* Expression opcode */
802 const char *zToken /* Token argument. Might be NULL */
803){
804 Token x;
805 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000806 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000807 return sqlite3ExprAlloc(db, op, &x, 0);
808}
809
810/*
811** Attach subtrees pLeft and pRight to the Expr node pRoot.
812**
813** If pRoot==NULL that means that a memory allocation error has occurred.
814** In that case, delete the subtrees pLeft and pRight.
815*/
816void sqlite3ExprAttachSubtrees(
817 sqlite3 *db,
818 Expr *pRoot,
819 Expr *pLeft,
820 Expr *pRight
821){
822 if( pRoot==0 ){
823 assert( db->mallocFailed );
824 sqlite3ExprDelete(db, pLeft);
825 sqlite3ExprDelete(db, pRight);
826 }else{
827 if( pRight ){
828 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000829 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000830 }
831 if( pLeft ){
832 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 exprSetHeight(pRoot);
836 }
837}
838
839/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000840** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000841**
drhbf664462009-06-19 18:32:54 +0000842** One or both of the subtrees can be NULL. Return a pointer to the new
843** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
844** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000845*/
drh17435752007-08-16 04:30:38 +0000846Expr *sqlite3PExpr(
847 Parse *pParse, /* Parsing context */
848 int op, /* Expression opcode */
849 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000850 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000851){
drh5fb52ca2012-03-31 02:34:35 +0000852 Expr *p;
drh1167d322015-10-28 20:01:45 +0000853 if( op==TK_AND && pParse->nErr==0 ){
drh5fb52ca2012-03-31 02:34:35 +0000854 /* Take advantage of short-circuit false optimization for AND */
855 p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
856 }else{
drhabfd35e2016-12-06 22:47:23 +0000857 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858 if( p ){
859 memset(p, 0, sizeof(Expr));
860 p->op = op & TKFLG_MASK;
861 p->iAgg = -1;
862 }
drh5fb52ca2012-03-31 02:34:35 +0000863 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
864 }
dan2b359bd2010-10-28 11:31:23 +0000865 if( p ) {
866 sqlite3ExprCheckHeight(pParse, p->nHeight);
867 }
drh4e0cff62004-11-05 05:10:28 +0000868 return p;
869}
870
871/*
drh08de4f72016-04-11 01:06:47 +0000872** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
873** do a memory allocation failure) then delete the pSelect object.
874*/
875void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
876 if( pExpr ){
877 pExpr->x.pSelect = pSelect;
878 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
879 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
880 }else{
881 assert( pParse->db->mallocFailed );
882 sqlite3SelectDelete(pParse->db, pSelect);
883 }
884}
885
886
887/*
drh991a1982014-01-02 17:57:16 +0000888** If the expression is always either TRUE or FALSE (respectively),
889** then return 1. If one cannot determine the truth value of the
890** expression at compile-time return 0.
891**
892** This is an optimization. If is OK to return 0 here even if
893** the expression really is always false or false (a false negative).
894** But it is a bug to return 1 if the expression might have different
895** boolean values in different circumstances (a false positive.)
drh5fb52ca2012-03-31 02:34:35 +0000896**
897** Note that if the expression is part of conditional for a
898** LEFT JOIN, then we cannot determine at compile-time whether or not
899** is it true or false, so always return 0.
900*/
drh991a1982014-01-02 17:57:16 +0000901static int exprAlwaysTrue(Expr *p){
902 int v = 0;
903 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
904 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
905 return v!=0;
906}
drh5fb52ca2012-03-31 02:34:35 +0000907static int exprAlwaysFalse(Expr *p){
908 int v = 0;
909 if( ExprHasProperty(p, EP_FromJoin) ) return 0;
910 if( !sqlite3ExprIsInteger(p, &v) ) return 0;
911 return v==0;
912}
913
914/*
drh91bb0ee2004-09-01 03:06:34 +0000915** Join two expressions using an AND operator. If either expression is
916** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000917**
918** If one side or the other of the AND is known to be false, then instead
919** of returning an AND expression, just return a constant expression with
920** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000921*/
danielk19771e536952007-08-16 10:09:01 +0000922Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
drh91bb0ee2004-09-01 03:06:34 +0000923 if( pLeft==0 ){
924 return pRight;
925 }else if( pRight==0 ){
926 return pLeft;
drh5fb52ca2012-03-31 02:34:35 +0000927 }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
928 sqlite3ExprDelete(db, pLeft);
929 sqlite3ExprDelete(db, pRight);
930 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000931 }else{
drhb7916a72009-05-27 10:31:29 +0000932 Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
933 sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
934 return pNew;
drha76b5df2002-02-23 02:32:10 +0000935 }
936}
937
938/*
939** Construct a new expression node for a function with multiple
940** arguments.
941*/
drh954733b2018-07-27 23:33:16 +0000942Expr *sqlite3ExprFunction(
943 Parse *pParse, /* Parsing context */
944 ExprList *pList, /* Argument list */
945 Token *pToken, /* Name of the function */
946 int eDistinct /* SF_Distinct or SF_ALL or 0 */
947){
drha76b5df2002-02-23 02:32:10 +0000948 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000949 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000950 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000951 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000952 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000953 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000954 return 0;
955 }
drh954733b2018-07-27 23:33:16 +0000956 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
957 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
958 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000959 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000960 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000961 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000962 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000963 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000964 return pNew;
965}
966
967/*
drhfa6bc002004-09-07 16:19:52 +0000968** Assign a variable number to an expression that encodes a wildcard
969** in the original SQL statement.
970**
971** Wildcards consisting of a single "?" are assigned the next sequential
972** variable number.
973**
974** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000975** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000976** the SQL statement comes from an external source.
977**
drh51f49f12009-05-21 20:41:32 +0000978** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000979** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000980** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000981** assigned.
982*/
drhde25a882016-10-03 15:28:24 +0000983void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000984 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000985 const char *z;
drhf326d662016-12-23 13:30:53 +0000986 ynVar x;
drh17435752007-08-16 04:30:38 +0000987
drhfa6bc002004-09-07 16:19:52 +0000988 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000989 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000990 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000991 assert( z!=0 );
992 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000993 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000994 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000995 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000996 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000997 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000998 }else{
drhf326d662016-12-23 13:30:53 +0000999 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001000 if( z[0]=='?' ){
1001 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1002 ** use it as the variable number */
1003 i64 i;
drh18814df2017-01-31 03:52:34 +00001004 int bOk;
1005 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1006 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1007 bOk = 1;
1008 }else{
1009 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1010 }
drh124c0b42011-06-01 18:15:55 +00001011 testcase( i==0 );
1012 testcase( i==1 );
1013 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1014 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1015 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1017 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001018 return;
drhfa6bc002004-09-07 16:19:52 +00001019 }
drh8e74e7b2017-01-31 12:41:48 +00001020 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001021 if( x>pParse->nVar ){
1022 pParse->nVar = (int)x;
1023 doAdd = 1;
1024 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1025 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001026 }
1027 }else{
1028 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1029 ** number as the prior appearance of the same name, or if the name
1030 ** has never appeared before, reuse the same variable number
1031 */
drh9bf755c2016-12-23 03:59:31 +00001032 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1033 if( x==0 ){
1034 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001035 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001036 }
drhfa6bc002004-09-07 16:19:52 +00001037 }
drhf326d662016-12-23 13:30:53 +00001038 if( doAdd ){
1039 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1040 }
1041 }
1042 pExpr->iColumn = x;
1043 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001044 sqlite3ErrorMsg(pParse, "too many SQL variables");
1045 }
drhfa6bc002004-09-07 16:19:52 +00001046}
1047
1048/*
danf6963f92009-11-23 14:39:14 +00001049** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001050*/
drh4f0010b2016-04-11 14:49:39 +00001051static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1052 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001053 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1054 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001055
1056 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1057 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1058 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001059#ifdef SQLITE_DEBUG
1060 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1061 assert( p->pLeft==0 );
1062 assert( p->pRight==0 );
1063 assert( p->x.pSelect==0 );
1064 }
1065#endif
1066 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001067 /* The Expr.x union is never used at the same time as Expr.pRight */
1068 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001069 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001070 if( p->pRight ){
1071 sqlite3ExprDeleteNN(db, p->pRight);
1072 }else if( ExprHasProperty(p, EP_xIsSelect) ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001073 sqlite3SelectDelete(db, p->x.pSelect);
1074 }else{
1075 sqlite3ExprListDelete(db, p->x.pList);
1076 }
drheda079c2018-09-20 19:02:15 +00001077 if( ExprHasProperty(p, EP_WinFunc) ){
1078 assert( p->op==TK_FUNCTION );
1079 sqlite3WindowDelete(db, p->y.pWin);
dan86fb6e12018-05-16 20:58:07 +00001080 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001081 }
drh209bc522016-09-23 21:36:24 +00001082 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001083 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001084 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001085 }
drha2e00042002-01-22 03:13:42 +00001086}
drh4f0010b2016-04-11 14:49:39 +00001087void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1088 if( p ) sqlite3ExprDeleteNN(db, p);
1089}
drha2e00042002-01-22 03:13:42 +00001090
drhd2687b72005-08-12 22:56:09 +00001091/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001092** Return the number of bytes allocated for the expression structure
1093** passed as the first argument. This is always one of EXPR_FULLSIZE,
1094** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1095*/
1096static int exprStructSize(Expr *p){
1097 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001098 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1099 return EXPR_FULLSIZE;
1100}
1101
1102/*
drh33e619f2009-05-28 01:00:55 +00001103** The dupedExpr*Size() routines each return the number of bytes required
1104** to store a copy of an expression or expression tree. They differ in
1105** how much of the tree is measured.
1106**
1107** dupedExprStructSize() Size of only the Expr structure
1108** dupedExprNodeSize() Size of Expr + space for token
1109** dupedExprSize() Expr + token + subtree components
1110**
1111***************************************************************************
1112**
1113** The dupedExprStructSize() function returns two values OR-ed together:
1114** (1) the space required for a copy of the Expr structure only and
1115** (2) the EP_xxx flags that indicate what the structure size should be.
1116** The return values is always one of:
1117**
1118** EXPR_FULLSIZE
1119** EXPR_REDUCEDSIZE | EP_Reduced
1120** EXPR_TOKENONLYSIZE | EP_TokenOnly
1121**
1122** The size of the structure can be found by masking the return value
1123** of this routine with 0xfff. The flags can be found by masking the
1124** return value with EP_Reduced|EP_TokenOnly.
1125**
1126** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1127** (unreduced) Expr objects as they or originally constructed by the parser.
1128** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001129** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001130** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001131** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001132** to reduce a pristine expression tree from the parser. The implementation
1133** of dupedExprStructSize() contain multiple assert() statements that attempt
1134** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001135*/
1136static int dupedExprStructSize(Expr *p, int flags){
1137 int nSize;
drh33e619f2009-05-28 01:00:55 +00001138 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001139 assert( EXPR_FULLSIZE<=0xfff );
1140 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001141 if( 0==flags || p->op==TK_SELECT_COLUMN
1142#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001143 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001144#endif
1145 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001146 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001147 }else{
drhc5cd1242013-09-12 16:50:49 +00001148 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001149 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001150 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001151 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001152 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001153 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1154 }else{
drhaecd8022013-09-13 18:15:15 +00001155 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001156 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1157 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001158 }
1159 return nSize;
1160}
1161
1162/*
drh33e619f2009-05-28 01:00:55 +00001163** This function returns the space in bytes required to store the copy
1164** of the Expr structure and a copy of the Expr.u.zToken string (if that
1165** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001166*/
1167static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001168 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1169 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1170 nByte += sqlite3Strlen30(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001171 }
danielk1977bc739712009-03-23 04:33:32 +00001172 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001173}
1174
1175/*
1176** Return the number of bytes required to create a duplicate of the
1177** expression passed as the first argument. The second argument is a
1178** mask containing EXPRDUP_XXX flags.
1179**
1180** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001181** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001182**
1183** If the EXPRDUP_REDUCE flag is set, then the return value includes
1184** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1185** and Expr.pRight variables (but not for any structures pointed to or
1186** descended from the Expr.x.pList or Expr.x.pSelect variables).
1187*/
1188static int dupedExprSize(Expr *p, int flags){
1189 int nByte = 0;
1190 if( p ){
1191 nByte = dupedExprNodeSize(p, flags);
1192 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001193 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001194 }
1195 }
1196 return nByte;
1197}
1198
1199/*
1200** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1201** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001202** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001203** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001204** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001205** portion of the buffer copied into by this function.
1206*/
drh3c194692016-04-11 16:43:43 +00001207static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1208 Expr *pNew; /* Value to return */
1209 u8 *zAlloc; /* Memory space from which to build Expr object */
1210 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1211
drh575fad62016-02-05 13:38:36 +00001212 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001213 assert( p );
1214 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1215 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001216
drh3c194692016-04-11 16:43:43 +00001217 /* Figure out where to write the new Expr structure. */
1218 if( pzBuffer ){
1219 zAlloc = *pzBuffer;
1220 staticFlag = EP_Static;
1221 }else{
1222 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1223 staticFlag = 0;
1224 }
1225 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001226
drh3c194692016-04-11 16:43:43 +00001227 if( pNew ){
1228 /* Set nNewSize to the size allocated for the structure pointed to
1229 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1230 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1231 ** by the copy of the p->u.zToken string (if any).
1232 */
1233 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1234 const int nNewSize = nStructSize & 0xfff;
1235 int nToken;
1236 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1237 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001238 }else{
drh3c194692016-04-11 16:43:43 +00001239 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001240 }
drh3c194692016-04-11 16:43:43 +00001241 if( dupFlags ){
1242 assert( ExprHasProperty(p, EP_Reduced)==0 );
1243 memcpy(zAlloc, p, nNewSize);
1244 }else{
1245 u32 nSize = (u32)exprStructSize(p);
1246 memcpy(zAlloc, p, nSize);
1247 if( nSize<EXPR_FULLSIZE ){
1248 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1249 }
1250 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001251
drh3c194692016-04-11 16:43:43 +00001252 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1253 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1254 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1255 pNew->flags |= staticFlag;
1256
1257 /* Copy the p->u.zToken string, if any. */
1258 if( nToken ){
1259 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1260 memcpy(zToken, p->u.zToken, nToken);
1261 }
1262
drh209bc522016-09-23 21:36:24 +00001263 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001264 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1265 if( ExprHasProperty(p, EP_xIsSelect) ){
1266 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001267 }else{
drh3c194692016-04-11 16:43:43 +00001268 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001269 }
drh3c194692016-04-11 16:43:43 +00001270 }
1271
1272 /* Fill in pNew->pLeft and pNew->pRight. */
drh53988062018-09-24 15:39:30 +00001273 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
1274 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001275 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001276 pNew->pLeft = p->pLeft ?
1277 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1278 pNew->pRight = p->pRight ?
1279 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001280 }
dan67a9b8e2018-06-22 20:51:35 +00001281#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001282 if( ExprHasProperty(p, EP_WinFunc) ){
1283 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1284 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001285 }
dan67a9b8e2018-06-22 20:51:35 +00001286#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001287 if( pzBuffer ){
1288 *pzBuffer = zAlloc;
1289 }
1290 }else{
drh209bc522016-09-23 21:36:24 +00001291 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001292 if( pNew->op==TK_SELECT_COLUMN ){
1293 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001294 assert( p->iColumn==0 || p->pRight==0 );
1295 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001296 }else{
1297 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1298 }
drh3c194692016-04-11 16:43:43 +00001299 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001300 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001301 }
1302 }
1303 return pNew;
1304}
1305
1306/*
danbfe31e72014-01-15 14:17:31 +00001307** Create and return a deep copy of the object passed as the second
1308** argument. If an OOM condition is encountered, NULL is returned
1309** and the db->mallocFailed flag set.
1310*/
daneede6a52014-01-15 19:42:23 +00001311#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001312static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001313 With *pRet = 0;
1314 if( p ){
1315 int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
1316 pRet = sqlite3DbMallocZero(db, nByte);
1317 if( pRet ){
1318 int i;
1319 pRet->nCte = p->nCte;
1320 for(i=0; i<p->nCte; i++){
1321 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1322 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1323 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1324 }
1325 }
1326 }
1327 return pRet;
1328}
daneede6a52014-01-15 19:42:23 +00001329#else
1330# define withDup(x,y) 0
1331#endif
dan4e9119d2014-01-13 15:12:23 +00001332
drha76b5df2002-02-23 02:32:10 +00001333/*
drhff78bd22002-02-27 01:47:11 +00001334** The following group of routines make deep copies of expressions,
1335** expression lists, ID lists, and select statements. The copies can
1336** be deleted (by being passed to their respective ...Delete() routines)
1337** without effecting the originals.
1338**
danielk19774adee202004-05-08 08:23:19 +00001339** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1340** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001341** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001342**
drhad3cab52002-05-24 02:04:32 +00001343** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001344**
drhb7916a72009-05-27 10:31:29 +00001345** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001346** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1347** truncated version of the usual Expr structure that will be stored as
1348** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001349*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001350Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001351 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001352 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001353}
danielk19776ab3a2e2009-02-19 14:39:25 +00001354ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001355 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001356 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001357 int i;
drhb1637482017-01-03 00:27:16 +00001358 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001359 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001360 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001361 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001362 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001363 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001364 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001365 pOldItem = p->a;
1366 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001367 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001368 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001369 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001370 if( pOldExpr
1371 && pOldExpr->op==TK_SELECT_COLUMN
1372 && (pNewExpr = pItem->pExpr)!=0
1373 ){
1374 assert( pNewExpr->iColumn==0 || i>0 );
1375 if( pNewExpr->iColumn==0 ){
1376 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001377 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1378 }else{
1379 assert( i>0 );
1380 assert( pItem[-1].pExpr!=0 );
1381 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1382 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1383 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001384 }
1385 }
drh17435752007-08-16 04:30:38 +00001386 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001387 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001388 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001389 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001390 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001391 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001392 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001393 }
1394 return pNew;
1395}
danielk197793758c82005-01-21 08:13:14 +00001396
1397/*
1398** If cursors, triggers, views and subqueries are all omitted from
1399** the build, then none of the following routines, except for
1400** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1401** called with a NULL argument.
1402*/
danielk19776a67fe82005-02-04 04:07:16 +00001403#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1404 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001405SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001406 SrcList *pNew;
1407 int i;
drh113088e2003-03-20 01:16:58 +00001408 int nByte;
drh575fad62016-02-05 13:38:36 +00001409 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001410 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001411 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001412 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001413 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001414 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001415 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001416 struct SrcList_item *pNewItem = &pNew->a[i];
1417 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001418 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001419 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001420 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1421 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1422 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001423 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001424 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001425 pNewItem->addrFillSub = pOldItem->addrFillSub;
1426 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001427 if( pNewItem->fg.isIndexedBy ){
1428 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1429 }
1430 pNewItem->pIBIndex = pOldItem->pIBIndex;
1431 if( pNewItem->fg.isTabFunc ){
1432 pNewItem->u1.pFuncArg =
1433 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1434 }
drhed8a3bb2005-06-06 21:19:56 +00001435 pTab = pNewItem->pTab = pOldItem->pTab;
1436 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001437 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001438 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001439 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1440 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001441 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001442 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001443 }
1444 return pNew;
1445}
drh17435752007-08-16 04:30:38 +00001446IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001447 IdList *pNew;
1448 int i;
drh575fad62016-02-05 13:38:36 +00001449 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001450 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001451 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001452 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001453 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001454 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001455 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001456 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001457 return 0;
1458 }
drh6c535152012-02-02 03:38:30 +00001459 /* Note that because the size of the allocation for p->a[] is not
1460 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1461 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001462 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001463 struct IdList_item *pNewItem = &pNew->a[i];
1464 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001465 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001466 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001467 }
1468 return pNew;
1469}
dana7466202017-02-03 14:44:52 +00001470Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1471 Select *pRet = 0;
1472 Select *pNext = 0;
1473 Select **pp = &pRet;
1474 Select *p;
1475
drh575fad62016-02-05 13:38:36 +00001476 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001477 for(p=pDup; p; p=p->pPrior){
1478 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1479 if( pNew==0 ) break;
1480 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1481 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1482 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1483 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1484 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1485 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1486 pNew->op = p->op;
1487 pNew->pNext = pNext;
1488 pNew->pPrior = 0;
1489 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001490 pNew->iLimit = 0;
1491 pNew->iOffset = 0;
1492 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1493 pNew->addrOpenEphm[0] = -1;
1494 pNew->addrOpenEphm[1] = -1;
1495 pNew->nSelectRow = p->nSelectRow;
1496 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001497#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001498 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001499 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan67a9b8e2018-06-22 20:51:35 +00001500#endif
drhfef37762018-07-10 19:48:35 +00001501 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001502 *pp = pNew;
1503 pp = &pNew->pPrior;
1504 pNext = pNew;
1505 }
1506
1507 return pRet;
drhff78bd22002-02-27 01:47:11 +00001508}
danielk197793758c82005-01-21 08:13:14 +00001509#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001510Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001511 assert( p==0 );
1512 return 0;
1513}
1514#endif
drhff78bd22002-02-27 01:47:11 +00001515
1516
1517/*
drha76b5df2002-02-23 02:32:10 +00001518** Add a new element to the end of an expression list. If pList is
1519** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001520**
drha19543f2017-09-15 15:17:48 +00001521** The pList argument must be either NULL or a pointer to an ExprList
1522** obtained from a prior call to sqlite3ExprListAppend(). This routine
1523** may not be used with an ExprList obtained from sqlite3ExprListDup().
1524** Reason: This routine assumes that the number of slots in pList->a[]
1525** is a power of two. That is true for sqlite3ExprListAppend() returns
1526** but is not necessarily true from the return value of sqlite3ExprListDup().
1527**
drhb7916a72009-05-27 10:31:29 +00001528** If a memory allocation error occurs, the entire list is freed and
1529** NULL is returned. If non-NULL is returned, then it is guaranteed
1530** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001531*/
drh17435752007-08-16 04:30:38 +00001532ExprList *sqlite3ExprListAppend(
1533 Parse *pParse, /* Parsing context */
1534 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001535 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001536){
drh43606172017-04-05 11:32:13 +00001537 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001538 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001539 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001540 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001541 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001542 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001543 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001544 }
drhc263f7c2016-01-18 13:18:54 +00001545 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001546 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001547 ExprList *pNew;
1548 pNew = sqlite3DbRealloc(db, pList,
drha19543f2017-09-15 15:17:48 +00001549 sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001550 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001551 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001552 }
drh43606172017-04-05 11:32:13 +00001553 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001554 }
drh43606172017-04-05 11:32:13 +00001555 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001556 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1557 assert( offsetof(struct ExprList_item,pExpr)==0 );
1558 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001559 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001560 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001561
1562no_mem:
1563 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001564 sqlite3ExprDelete(db, pExpr);
1565 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001566 return 0;
drha76b5df2002-02-23 02:32:10 +00001567}
1568
1569/*
drh8762ec12016-08-20 01:06:22 +00001570** pColumns and pExpr form a vector assignment which is part of the SET
1571** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001572**
1573** (a,b,c) = (expr1,expr2,expr3)
1574** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1575**
1576** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001577** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001578** TK_SELECT_COLUMN expressions.
1579*/
1580ExprList *sqlite3ExprListAppendVector(
1581 Parse *pParse, /* Parsing context */
1582 ExprList *pList, /* List to which to append. Might be NULL */
1583 IdList *pColumns, /* List of names of LHS of the assignment */
1584 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1585){
1586 sqlite3 *db = pParse->db;
1587 int n;
1588 int i;
drh66860af2016-08-23 18:30:10 +00001589 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001590 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1591 ** exit prior to this routine being invoked */
1592 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001593 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001594
1595 /* If the RHS is a vector, then we can immediately check to see that
1596 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1597 ** wildcards ("*") in the result set of the SELECT must be expanded before
1598 ** we can do the size check, so defer the size check until code generation.
1599 */
1600 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001601 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1602 pColumns->nId, n);
1603 goto vector_append_error;
1604 }
drh966e2912017-01-03 02:58:01 +00001605
1606 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001607 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1608 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1609 if( pList ){
drh66860af2016-08-23 18:30:10 +00001610 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001611 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1612 pColumns->a[i].zName = 0;
1613 }
1614 }
drh966e2912017-01-03 02:58:01 +00001615
drhffe28052017-05-06 18:09:36 +00001616 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001617 Expr *pFirst = pList->a[iFirst].pExpr;
1618 assert( pFirst!=0 );
1619 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001620
drhf4dd26c2017-04-05 11:49:06 +00001621 /* Store the SELECT statement in pRight so it will be deleted when
1622 ** sqlite3ExprListDelete() is called */
1623 pFirst->pRight = pExpr;
1624 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001625
drhf4dd26c2017-04-05 11:49:06 +00001626 /* Remember the size of the LHS in iTable so that we can check that
1627 ** the RHS and LHS sizes match during code generation. */
1628 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001629 }
1630
1631vector_append_error:
1632 sqlite3ExprDelete(db, pExpr);
1633 sqlite3IdListDelete(db, pColumns);
1634 return pList;
1635}
1636
1637/*
drhbc622bc2015-08-24 15:39:42 +00001638** Set the sort order for the last element on the given ExprList.
1639*/
1640void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1641 if( p==0 ) return;
1642 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1643 assert( p->nExpr>0 );
1644 if( iSortOrder<0 ){
1645 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1646 return;
1647 }
1648 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001649}
1650
1651/*
drhb7916a72009-05-27 10:31:29 +00001652** Set the ExprList.a[].zName element of the most recently added item
1653** on the expression list.
1654**
1655** pList might be NULL following an OOM error. But pName should never be
1656** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1657** is set.
1658*/
1659void sqlite3ExprListSetName(
1660 Parse *pParse, /* Parsing context */
1661 ExprList *pList, /* List to which to add the span. */
1662 Token *pName, /* Name to be added */
1663 int dequote /* True to cause the name to be dequoted */
1664){
1665 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1666 if( pList ){
1667 struct ExprList_item *pItem;
1668 assert( pList->nExpr>0 );
1669 pItem = &pList->a[pList->nExpr-1];
1670 assert( pItem->zName==0 );
1671 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001672 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001673 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001674 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001675 }
drhb7916a72009-05-27 10:31:29 +00001676 }
1677}
1678
1679/*
1680** Set the ExprList.a[].zSpan element of the most recently added item
1681** on the expression list.
1682**
1683** pList might be NULL following an OOM error. But pSpan should never be
1684** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1685** is set.
1686*/
1687void sqlite3ExprListSetSpan(
1688 Parse *pParse, /* Parsing context */
1689 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001690 const char *zStart, /* Start of the span */
1691 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001692){
1693 sqlite3 *db = pParse->db;
1694 assert( pList!=0 || db->mallocFailed!=0 );
1695 if( pList ){
1696 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1697 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001698 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001699 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001700 }
1701}
1702
1703/*
danielk19777a15a4b2007-05-08 17:54:43 +00001704** If the expression list pEList contains more than iLimit elements,
1705** leave an error message in pParse.
1706*/
1707void sqlite3ExprListCheckLength(
1708 Parse *pParse,
1709 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001710 const char *zObject
1711){
drhb1a6c3c2008-03-20 16:30:17 +00001712 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001713 testcase( pEList && pEList->nExpr==mx );
1714 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001715 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001716 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1717 }
1718}
1719
1720/*
drha76b5df2002-02-23 02:32:10 +00001721** Delete an entire expression list.
1722*/
drhaffa8552016-04-11 18:25:05 +00001723static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001724 int i = pList->nExpr;
1725 struct ExprList_item *pItem = pList->a;
1726 assert( pList->nExpr>0 );
1727 do{
drh633e6d52008-07-28 19:34:53 +00001728 sqlite3ExprDelete(db, pItem->pExpr);
1729 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001730 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001731 pItem++;
1732 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001733 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001734}
drhaffa8552016-04-11 18:25:05 +00001735void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1736 if( pList ) exprListDeleteNN(db, pList);
1737}
drha76b5df2002-02-23 02:32:10 +00001738
1739/*
drh2308ed32015-02-09 16:09:34 +00001740** Return the bitwise-OR of all Expr.flags fields in the given
1741** ExprList.
drh885a5b02015-02-09 15:21:36 +00001742*/
drh2308ed32015-02-09 16:09:34 +00001743u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001744 int i;
drh2308ed32015-02-09 16:09:34 +00001745 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001746 assert( pList!=0 );
1747 for(i=0; i<pList->nExpr; i++){
1748 Expr *pExpr = pList->a[i].pExpr;
1749 assert( pExpr!=0 );
1750 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001751 }
drh2308ed32015-02-09 16:09:34 +00001752 return m;
drh885a5b02015-02-09 15:21:36 +00001753}
1754
1755/*
drh7e6f9802017-09-04 00:33:04 +00001756** This is a SELECT-node callback for the expression walker that
1757** always "fails". By "fail" in this case, we mean set
1758** pWalker->eCode to zero and abort.
1759**
1760** This callback is used by multiple expression walkers.
1761*/
1762int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1763 UNUSED_PARAMETER(NotUsed);
1764 pWalker->eCode = 0;
1765 return WRC_Abort;
1766}
1767
1768/*
drh171d16b2018-02-26 20:15:54 +00001769** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001770** then convert it into an TK_TRUEFALSE term. Return non-zero if
1771** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001772*/
1773int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1774 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1775 if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1776 || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1777 ){
1778 pExpr->op = TK_TRUEFALSE;
drh171d16b2018-02-26 20:15:54 +00001779 return 1;
1780 }
1781 return 0;
1782}
1783
drh43c4ac82018-02-26 21:26:27 +00001784/*
drh96acafb2018-02-27 14:49:25 +00001785** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001786** and 0 if it is FALSE.
1787*/
drh96acafb2018-02-27 14:49:25 +00001788int sqlite3ExprTruthValue(const Expr *pExpr){
drh43c4ac82018-02-26 21:26:27 +00001789 assert( pExpr->op==TK_TRUEFALSE );
1790 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1791 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1792 return pExpr->u.zToken[4]==0;
1793}
1794
drh171d16b2018-02-26 20:15:54 +00001795
1796/*
drh059b2d52014-10-24 19:28:09 +00001797** These routines are Walker callbacks used to check expressions to
1798** see if they are "constant" for some definition of constant. The
1799** Walker.eCode value determines the type of "constant" we are looking
1800** for.
drh73b211a2005-01-18 04:00:42 +00001801**
drh7d10d5a2008-08-20 16:35:10 +00001802** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001803**
drh059b2d52014-10-24 19:28:09 +00001804** sqlite3ExprIsConstant() pWalker->eCode==1
1805** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001806** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001807** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001808**
drh059b2d52014-10-24 19:28:09 +00001809** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1810** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001811**
drhfeada2d2014-09-24 13:20:22 +00001812** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001813** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1814** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001815** parameter raises an error for new statements, but is silently converted
1816** to NULL for existing schemas. This allows sqlite_master tables that
1817** contain a bound parameter because they were generated by older versions
1818** of SQLite to be parsed by newer versions of SQLite without raising a
1819** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001820*/
drh7d10d5a2008-08-20 16:35:10 +00001821static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001822
drh059b2d52014-10-24 19:28:09 +00001823 /* If pWalker->eCode is 2 then any term of the expression that comes from
1824 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001825 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001826 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1827 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001828 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001829 }
1830
drh626a8792005-01-17 22:08:19 +00001831 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001832 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001833 ** and either pWalker->eCode==4 or 5 or the function has the
1834 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001835 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001836 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001837 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001838 }else{
1839 pWalker->eCode = 0;
1840 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001841 }
drh626a8792005-01-17 22:08:19 +00001842 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001843 /* Convert "true" or "false" in a DEFAULT clause into the
1844 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001845 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001846 return WRC_Prune;
1847 }
1848 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001849 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001850 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001851 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001852 testcase( pExpr->op==TK_ID );
1853 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001854 testcase( pExpr->op==TK_AGG_FUNCTION );
1855 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001856 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001857 return WRC_Continue;
1858 }
drh059b2d52014-10-24 19:28:09 +00001859 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1860 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001861 }
drhf43ce0b2017-05-25 00:08:48 +00001862 /* Fall through */
1863 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001864 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001865 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001866 testcase( pExpr->op==TK_IF_NULL_ROW );
1867 pWalker->eCode = 0;
1868 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001869 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001870 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001871 /* Silently convert bound parameters that appear inside of CREATE
1872 ** statements into a NULL when parsing the CREATE statement text out
1873 ** of the sqlite_master table */
1874 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001875 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001876 /* A bound parameter in a CREATE statement that originates from
1877 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001878 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001879 return WRC_Abort;
1880 }
1881 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001882 default:
drh6e341b92018-04-17 18:50:40 +00001883 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1884 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001885 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001886 }
1887}
drh059b2d52014-10-24 19:28:09 +00001888static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001889 Walker w;
drh059b2d52014-10-24 19:28:09 +00001890 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001891 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001892 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001893#ifdef SQLITE_DEBUG
1894 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1895#endif
drh059b2d52014-10-24 19:28:09 +00001896 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001897 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001898 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001899}
drh626a8792005-01-17 22:08:19 +00001900
1901/*
drh059b2d52014-10-24 19:28:09 +00001902** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001903** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001904**
1905** For the purposes of this function, a double-quoted string (ex: "abc")
1906** is considered a variable but a single-quoted string (ex: 'abc') is
1907** a constant.
drhfef52082000-06-06 01:50:43 +00001908*/
danielk19774adee202004-05-08 08:23:19 +00001909int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001910 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001911}
1912
1913/*
drh07aded62018-07-28 16:24:08 +00001914** Walk an expression tree. Return non-zero if
1915**
1916** (1) the expression is constant, and
1917** (2) the expression does originate in the ON or USING clause
1918** of a LEFT JOIN, and
1919** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1920** operands created by the constant propagation optimization.
1921**
1922** When this routine returns true, it indicates that the expression
1923** can be added to the pParse->pConstExpr list and evaluated once when
1924** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001925*/
1926int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001927 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001928}
1929
1930/*
drhfcb9f4f2015-06-01 18:13:16 +00001931** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001932** for any single row of the table with cursor iCur. In other words, the
1933** expression must not refer to any non-deterministic function nor any
1934** table other than iCur.
1935*/
1936int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1937 return exprIsConst(p, 3, iCur);
1938}
1939
danab31a842017-04-29 20:53:09 +00001940
1941/*
1942** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1943*/
1944static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1945 ExprList *pGroupBy = pWalker->u.pGroupBy;
1946 int i;
1947
1948 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1949 ** it constant. */
1950 for(i=0; i<pGroupBy->nExpr; i++){
1951 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001952 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001953 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001954 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00001955 return WRC_Prune;
1956 }
1957 }
1958 }
1959
1960 /* Check if pExpr is a sub-select. If so, consider it variable. */
1961 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1962 pWalker->eCode = 0;
1963 return WRC_Abort;
1964 }
1965
1966 return exprNodeIsConstant(pWalker, pExpr);
1967}
1968
1969/*
1970** Walk the expression tree passed as the first argument. Return non-zero
1971** if the expression consists entirely of constants or copies of terms
1972** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00001973**
1974** This routine is used to determine if a term of the HAVING clause can
1975** be promoted into the WHERE clause. In order for such a promotion to work,
1976** the value of the HAVING clause term must be the same for all members of
1977** a "group". The requirement that the GROUP BY term must be BINARY
1978** assumes that no other collating sequence will have a finer-grained
1979** grouping than binary. In other words (A=B COLLATE binary) implies
1980** A=B in every other collating sequence. The requirement that the
1981** GROUP BY be BINARY is stricter than necessary. It would also work
1982** to promote HAVING clauses that use the same alternative collating
1983** sequence as the GROUP BY term, but that is much harder to check,
1984** alternative collating sequences are uncommon, and this is only an
1985** optimization, so we take the easy way out and simply require the
1986** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00001987*/
1988int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1989 Walker w;
danab31a842017-04-29 20:53:09 +00001990 w.eCode = 1;
1991 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00001992 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00001993 w.u.pGroupBy = pGroupBy;
1994 w.pParse = pParse;
1995 sqlite3WalkExpr(&w, p);
1996 return w.eCode;
1997}
1998
drh059b2d52014-10-24 19:28:09 +00001999/*
2000** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002001** or a function call with constant arguments. Return and 0 if there
2002** are any variables.
2003**
2004** For the purposes of this function, a double-quoted string (ex: "abc")
2005** is considered a variable but a single-quoted string (ex: 'abc') is
2006** a constant.
2007*/
drhfeada2d2014-09-24 13:20:22 +00002008int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2009 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002010 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002011}
2012
drh5b88bc42013-12-07 23:35:21 +00002013#ifdef SQLITE_ENABLE_CURSOR_HINTS
2014/*
2015** Walk an expression tree. Return 1 if the expression contains a
2016** subquery of some kind. Return 0 if there are no subqueries.
2017*/
2018int sqlite3ExprContainsSubquery(Expr *p){
2019 Walker w;
drhbec24762015-08-13 20:07:13 +00002020 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002021 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002022 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002023#ifdef SQLITE_DEBUG
2024 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2025#endif
drh5b88bc42013-12-07 23:35:21 +00002026 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002027 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002028}
2029#endif
2030
drheb55bd22005-06-30 17:04:21 +00002031/*
drh73b211a2005-01-18 04:00:42 +00002032** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002033** to fit in a 32-bit integer, return 1 and put the value of the integer
2034** in *pValue. If the expression is not an integer or if it is too big
2035** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002036*/
danielk19774adee202004-05-08 08:23:19 +00002037int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002038 int rc = 0;
drhba28b5a2017-03-12 20:28:44 +00002039 if( p==0 ) return 0; /* Can only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002040
2041 /* If an expression is an integer literal that fits in a signed 32-bit
2042 ** integer, then the EP_IntValue flag will have already been set */
2043 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2044 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2045
drh92b01d52008-06-24 00:32:35 +00002046 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002047 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002048 return 1;
2049 }
drhe4de1fe2002-06-02 16:09:01 +00002050 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002051 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002052 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002053 break;
drh4b59ab52002-08-24 18:24:51 +00002054 }
drhe4de1fe2002-06-02 16:09:01 +00002055 case TK_UMINUS: {
2056 int v;
danielk19774adee202004-05-08 08:23:19 +00002057 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002058 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002059 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002060 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002061 }
2062 break;
2063 }
2064 default: break;
2065 }
drh92b01d52008-06-24 00:32:35 +00002066 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002067}
2068
2069/*
drh039fc322009-11-17 18:31:47 +00002070** Return FALSE if there is no chance that the expression can be NULL.
2071**
2072** If the expression might be NULL or if the expression is too complex
2073** to tell return TRUE.
2074**
2075** This routine is used as an optimization, to skip OP_IsNull opcodes
2076** when we know that a value cannot be NULL. Hence, a false positive
2077** (returning TRUE when in fact the expression can never be NULL) might
2078** be a small performance hit but is otherwise harmless. On the other
2079** hand, a false negative (returning FALSE when the result could be NULL)
2080** will likely result in an incorrect answer. So when in doubt, return
2081** TRUE.
2082*/
2083int sqlite3ExprCanBeNull(const Expr *p){
2084 u8 op;
drhcd7f4572009-11-19 14:48:40 +00002085 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002086 op = p->op;
2087 if( op==TK_REGISTER ) op = p->op2;
2088 switch( op ){
2089 case TK_INTEGER:
2090 case TK_STRING:
2091 case TK_FLOAT:
2092 case TK_BLOB:
2093 return 0;
drh7248a8b2014-08-04 18:50:54 +00002094 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002095 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002096 p->y.pTab==0 || /* Reference to column of index on expression */
2097 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002098 default:
2099 return 1;
2100 }
2101}
2102
2103/*
2104** Return TRUE if the given expression is a constant which would be
2105** unchanged by OP_Affinity with the affinity given in the second
2106** argument.
2107**
2108** This routine is used to determine if the OP_Affinity operation
2109** can be omitted. When in doubt return FALSE. A false negative
2110** is harmless. A false positive, however, can result in the wrong
2111** answer.
2112*/
2113int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2114 u8 op;
drh05883a32015-06-02 15:32:08 +00002115 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002116 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002117 op = p->op;
2118 if( op==TK_REGISTER ) op = p->op2;
2119 switch( op ){
2120 case TK_INTEGER: {
2121 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2122 }
2123 case TK_FLOAT: {
2124 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2125 }
2126 case TK_STRING: {
2127 return aff==SQLITE_AFF_TEXT;
2128 }
2129 case TK_BLOB: {
2130 return 1;
2131 }
drh2f2855b2009-11-18 01:25:26 +00002132 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002133 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2134 return p->iColumn<0
2135 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002136 }
drh039fc322009-11-17 18:31:47 +00002137 default: {
2138 return 0;
2139 }
2140 }
2141}
2142
2143/*
drhc4a3c772001-04-04 11:48:57 +00002144** Return TRUE if the given string is a row-id column name.
2145*/
danielk19774adee202004-05-08 08:23:19 +00002146int sqlite3IsRowid(const char *z){
2147 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2148 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2149 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002150 return 0;
2151}
mistachkin8bee11a2018-10-29 17:53:23 +00002152#ifdef SQLITE_ENABLE_NORMALIZE
2153int sqlite3IsRowidN(const char *z, int n){
2154 if( sqlite3StrNICmp(z, "_ROWID_", n)==0 ) return 1;
2155 if( sqlite3StrNICmp(z, "ROWID", n)==0 ) return 1;
2156 if( sqlite3StrNICmp(z, "OID", n)==0 ) return 1;
2157 return 0;
2158}
2159#endif
drhc4a3c772001-04-04 11:48:57 +00002160
danielk19779a96b662007-11-29 17:05:18 +00002161/*
drh69c355b2016-03-09 15:34:51 +00002162** pX is the RHS of an IN operator. If pX is a SELECT statement
2163** that can be simplified to a direct table access, then return
2164** a pointer to the SELECT statement. If pX is not a SELECT statement,
2165** or if the SELECT statement needs to be manifested into a transient
2166** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002167*/
2168#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002169static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002170 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002171 SrcList *pSrc;
2172 ExprList *pEList;
2173 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002174 int i;
drh69c355b2016-03-09 15:34:51 +00002175 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2176 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2177 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002178 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002179 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002180 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2181 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2182 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002183 }
drhb74b1012009-05-28 21:04:37 +00002184 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002185 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002186 if( p->pWhere ) return 0; /* Has no WHERE clause */
2187 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002188 assert( pSrc!=0 );
2189 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002190 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002191 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002192 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002193 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002194 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2195 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002196 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002197 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002198 for(i=0; i<pEList->nExpr; i++){
2199 Expr *pRes = pEList->a[i].pExpr;
2200 if( pRes->op!=TK_COLUMN ) return 0;
2201 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002202 }
drh69c355b2016-03-09 15:34:51 +00002203 return p;
drhb287f4b2008-04-25 00:08:38 +00002204}
2205#endif /* SQLITE_OMIT_SUBQUERY */
2206
danf9b2e052016-08-02 17:45:00 +00002207#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002208/*
drh4c259e92014-08-01 21:12:35 +00002209** Generate code that checks the left-most column of index table iCur to see if
2210** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002211** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2212** to be set to NULL if iCur contains one or more NULL values.
2213*/
2214static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002215 int addr1;
drh6be515e2014-08-01 21:00:53 +00002216 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002217 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002218 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2219 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002220 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002221 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002222}
danf9b2e052016-08-02 17:45:00 +00002223#endif
drh6be515e2014-08-01 21:00:53 +00002224
drhbb53ecb2014-08-02 21:03:33 +00002225
2226#ifndef SQLITE_OMIT_SUBQUERY
2227/*
2228** The argument is an IN operator with a list (not a subquery) on the
2229** right-hand side. Return TRUE if that list is constant.
2230*/
2231static int sqlite3InRhsIsConstant(Expr *pIn){
2232 Expr *pLHS;
2233 int res;
2234 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2235 pLHS = pIn->pLeft;
2236 pIn->pLeft = 0;
2237 res = sqlite3ExprIsConstant(pIn);
2238 pIn->pLeft = pLHS;
2239 return res;
2240}
2241#endif
2242
drh6be515e2014-08-01 21:00:53 +00002243/*
danielk19779a96b662007-11-29 17:05:18 +00002244** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002245** The pX parameter is the expression on the RHS of the IN operator, which
2246** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002247**
drhd4305ca2012-09-18 17:08:33 +00002248** The job of this routine is to find or create a b-tree object that can
2249** be used either to test for membership in the RHS set or to iterate through
2250** all members of the RHS set, skipping duplicates.
2251**
drh3a856252014-08-01 14:46:57 +00002252** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002253** and pX->iTable is set to the index of that cursor.
2254**
drhb74b1012009-05-28 21:04:37 +00002255** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002256**
drh1ccce442013-03-12 20:38:51 +00002257** IN_INDEX_ROWID - The cursor was opened on a database table.
2258** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2259** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2260** IN_INDEX_EPH - The cursor was opened on a specially created and
2261** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002262** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2263** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002264**
drhd4305ca2012-09-18 17:08:33 +00002265** An existing b-tree might be used if the RHS expression pX is a simple
2266** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002267**
dan553168c2016-08-01 20:14:31 +00002268** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002269**
drhd4305ca2012-09-18 17:08:33 +00002270** If the RHS of the IN operator is a list or a more complex subquery, then
2271** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002272** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002273** existing table.
drhd4305ca2012-09-18 17:08:33 +00002274**
drh7fc0ba02017-11-17 15:02:00 +00002275** The inFlags parameter must contain, at a minimum, one of the bits
2276** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2277** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2278** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2279** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002280**
2281** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2282** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002283** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002284** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2285** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002286**
drh3a856252014-08-01 14:46:57 +00002287** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2288** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002289** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2290** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002291**
drhbb53ecb2014-08-02 21:03:33 +00002292** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2293** if the RHS of the IN operator is a list (not a subquery) then this
2294** routine might decide that creating an ephemeral b-tree for membership
2295** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2296** calling routine should implement the IN operator using a sequence
2297** of Eq or Ne comparison operations.
2298**
drhb74b1012009-05-28 21:04:37 +00002299** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002300** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002301** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002302** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002303** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002304** to *prRhsHasNull. If there is no chance that the (...) contains a
2305** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002306**
drhe21a6e12014-08-01 18:00:24 +00002307** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002308** the value in that register will be NULL if the b-tree contains one or more
2309** NULL values, and it will be some non-NULL value if the b-tree contains no
2310** NULL values.
dan553168c2016-08-01 20:14:31 +00002311**
2312** If the aiMap parameter is not NULL, it must point to an array containing
2313** one element for each column returned by the SELECT statement on the RHS
2314** of the IN(...) operator. The i'th entry of the array is populated with the
2315** offset of the index column that matches the i'th column returned by the
2316** SELECT. For example, if the expression and selected index are:
2317**
2318** (?,?,?) IN (SELECT a, b, c FROM t1)
2319** CREATE INDEX i1 ON t1(b, c, a);
2320**
2321** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002322*/
danielk1977284f4ac2007-12-10 05:03:46 +00002323#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002324int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002325 Parse *pParse, /* Parsing context */
2326 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2327 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2328 int *prRhsHasNull, /* Register holding NULL status. See notes */
2329 int *aiMap /* Mapping from Index fields to RHS fields */
danba00e302016-07-23 20:24:06 +00002330){
drhb74b1012009-05-28 21:04:37 +00002331 Select *p; /* SELECT to the right of IN operator */
2332 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2333 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002334 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002335 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002336
drh1450bc62009-10-30 13:25:56 +00002337 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002338 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002339
dan7b35a772016-07-28 19:47:15 +00002340 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2341 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002342 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002343 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002344 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002345 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2346 int i;
2347 ExprList *pEList = pX->x.pSelect->pEList;
2348 for(i=0; i<pEList->nExpr; i++){
2349 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2350 }
2351 if( i==pEList->nExpr ){
2352 prRhsHasNull = 0;
2353 }
2354 }
2355
drhb74b1012009-05-28 21:04:37 +00002356 /* Check to see if an existing table or index can be used to
2357 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002358 ** ephemeral table. */
2359 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002360 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002361 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002362 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002363 ExprList *pEList = p->pEList;
2364 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002365
drhb07028f2011-10-14 21:49:18 +00002366 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2367 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2368 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2369 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002370
drhb22f7c82014-02-06 23:56:27 +00002371 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002372 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2373 sqlite3CodeVerifySchema(pParse, iDb);
2374 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002375
drha84a2832016-08-26 21:15:35 +00002376 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002377 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002378 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002379 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002380 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002381
2382 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2383 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002384 ExplainQueryPlan((pParse, 0,
2385 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002386 sqlite3VdbeJumpHere(v, iAddr);
2387 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002388 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002389 int affinity_ok = 1;
2390 int i;
2391
2392 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002393 ** comparison is the same as the affinity of each column in table
2394 ** on the RHS of the IN operator. If it not, it is not possible to
2395 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002396 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002397 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002398 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002399 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002400 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002401 testcase( cmpaff==SQLITE_AFF_BLOB );
2402 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002403 switch( cmpaff ){
2404 case SQLITE_AFF_BLOB:
2405 break;
2406 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002407 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2408 ** other has no affinity and the other side is TEXT. Hence,
2409 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2410 ** and for the term on the LHS of the IN to have no affinity. */
2411 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002412 break;
2413 default:
2414 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2415 }
2416 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002417
drha84a2832016-08-26 21:15:35 +00002418 if( affinity_ok ){
2419 /* Search for an existing index that will work for this IN operator */
2420 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2421 Bitmask colUsed; /* Columns of the index used */
2422 Bitmask mCol; /* Mask for the current column */
2423 if( pIdx->nColumn<nExpr ) continue;
2424 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2425 ** BITMASK(nExpr) without overflowing */
2426 testcase( pIdx->nColumn==BMS-2 );
2427 testcase( pIdx->nColumn==BMS-1 );
2428 if( pIdx->nColumn>=BMS-1 ) continue;
2429 if( mustBeUnique ){
2430 if( pIdx->nKeyCol>nExpr
2431 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2432 ){
2433 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002434 }
danielk19770cdc0222008-06-26 18:04:03 +00002435 }
drha84a2832016-08-26 21:15:35 +00002436
2437 colUsed = 0; /* Columns of index used so far */
2438 for(i=0; i<nExpr; i++){
2439 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2440 Expr *pRhs = pEList->a[i].pExpr;
2441 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2442 int j;
2443
2444 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2445 for(j=0; j<nExpr; j++){
2446 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2447 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002448 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2449 continue;
2450 }
drha84a2832016-08-26 21:15:35 +00002451 break;
2452 }
2453 if( j==nExpr ) break;
2454 mCol = MASKBIT(j);
2455 if( mCol & colUsed ) break; /* Each column used only once */
2456 colUsed |= mCol;
2457 if( aiMap ) aiMap[i] = j;
2458 }
2459
2460 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2461 if( colUsed==(MASKBIT(nExpr)-1) ){
2462 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002463 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002464 ExplainQueryPlan((pParse, 0,
2465 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002466 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2467 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2468 VdbeComment((v, "%s", pIdx->zName));
2469 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2470 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2471
2472 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002473#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002474 i64 mask = (1<<nExpr)-1;
2475 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2476 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002477#endif
2478 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002479 if( nExpr==1 ){
2480 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2481 }
2482 }
2483 sqlite3VdbeJumpHere(v, iAddr);
2484 }
2485 } /* End loop over indexes */
2486 } /* End if( affinity_ok ) */
2487 } /* End if not an rowid index */
2488 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002489
drhbb53ecb2014-08-02 21:03:33 +00002490 /* If no preexisting index is available for the IN clause
2491 ** and IN_INDEX_NOOP is an allowed reply
2492 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002493 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002494 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002495 ** the IN operator so return IN_INDEX_NOOP.
2496 */
2497 if( eType==0
2498 && (inFlags & IN_INDEX_NOOP_OK)
2499 && !ExprHasProperty(pX, EP_xIsSelect)
2500 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2501 ){
2502 eType = IN_INDEX_NOOP;
2503 }
drhbb53ecb2014-08-02 21:03:33 +00002504
danielk19779a96b662007-11-29 17:05:18 +00002505 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002506 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002507 ** We will have to generate an ephemeral table to do the job.
2508 */
drh8e23daf2013-06-11 13:30:04 +00002509 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002510 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002511 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002512 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002513 pParse->nQueryLoop = 0;
drhc5cd1242013-09-12 16:50:49 +00002514 if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
drhcf4d38a2010-07-28 02:53:36 +00002515 eType = IN_INDEX_ROWID;
2516 }
drhe21a6e12014-08-01 18:00:24 +00002517 }else if( prRhsHasNull ){
2518 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002519 }
danielk197741a05b72008-10-02 13:50:55 +00002520 sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
drhcf4d38a2010-07-28 02:53:36 +00002521 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002522 }else{
2523 pX->iTable = iTab;
2524 }
danba00e302016-07-23 20:24:06 +00002525
2526 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2527 int i, n;
2528 n = sqlite3ExprVectorSize(pX->pLeft);
2529 for(i=0; i<n; i++) aiMap[i] = i;
2530 }
danielk19779a96b662007-11-29 17:05:18 +00002531 return eType;
2532}
danielk1977284f4ac2007-12-10 05:03:46 +00002533#endif
drh626a8792005-01-17 22:08:19 +00002534
danf9b2e052016-08-02 17:45:00 +00002535#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002536/*
2537** Argument pExpr is an (?, ?...) IN(...) expression. This
2538** function allocates and returns a nul-terminated string containing
2539** the affinities to be used for each column of the comparison.
2540**
2541** It is the responsibility of the caller to ensure that the returned
2542** string is eventually freed using sqlite3DbFree().
2543*/
dan71c57db2016-07-09 20:23:55 +00002544static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2545 Expr *pLeft = pExpr->pLeft;
2546 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002547 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002548 char *zRet;
2549
dan553168c2016-08-01 20:14:31 +00002550 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002551 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002552 if( zRet ){
2553 int i;
2554 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002555 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002556 char a = sqlite3ExprAffinity(pA);
2557 if( pSelect ){
2558 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2559 }else{
2560 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002561 }
dan71c57db2016-07-09 20:23:55 +00002562 }
2563 zRet[nVal] = '\0';
2564 }
2565 return zRet;
2566}
danf9b2e052016-08-02 17:45:00 +00002567#endif
dan71c57db2016-07-09 20:23:55 +00002568
dan8da209b2016-07-26 18:06:08 +00002569#ifndef SQLITE_OMIT_SUBQUERY
2570/*
2571** Load the Parse object passed as the first argument with an error
2572** message of the form:
2573**
2574** "sub-select returns N columns - expected M"
2575*/
2576void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2577 const char *zFmt = "sub-select returns %d columns - expected %d";
2578 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2579}
2580#endif
2581
drh626a8792005-01-17 22:08:19 +00002582/*
dan44c56042016-12-07 15:38:37 +00002583** Expression pExpr is a vector that has been used in a context where
2584** it is not permitted. If pExpr is a sub-select vector, this routine
2585** loads the Parse object with a message of the form:
2586**
2587** "sub-select returns N columns - expected 1"
2588**
2589** Or, if it is a regular scalar vector:
2590**
2591** "row value misused"
2592*/
2593void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2594#ifndef SQLITE_OMIT_SUBQUERY
2595 if( pExpr->flags & EP_xIsSelect ){
2596 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2597 }else
2598#endif
2599 {
2600 sqlite3ErrorMsg(pParse, "row value misused");
2601 }
2602}
2603
2604/*
drhd4187c72010-08-30 22:15:45 +00002605** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2606** or IN operators. Examples:
drh626a8792005-01-17 22:08:19 +00002607**
drh9cbe6352005-11-29 03:13:21 +00002608** (SELECT a FROM b) -- subquery
2609** EXISTS (SELECT a FROM b) -- EXISTS subquery
2610** x IN (4,5,11) -- IN operator with list on right-hand side
2611** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002612**
drh9cbe6352005-11-29 03:13:21 +00002613** The pExpr parameter describes the expression that contains the IN
2614** operator or subquery.
danielk197741a05b72008-10-02 13:50:55 +00002615**
2616** If parameter isRowid is non-zero, then expression pExpr is guaranteed
2617** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
2618** to some integer key column of a table B-Tree. In this case, use an
2619** intkey B-Tree to store the set of IN(...) values instead of the usual
2620** (slower) variable length keys B-Tree.
drhfd773cf2009-05-29 14:39:07 +00002621**
2622** If rMayHaveNull is non-zero, that means that the operation is an IN
2623** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
drh3a856252014-08-01 14:46:57 +00002624** All this routine does is initialize the register given by rMayHaveNull
2625** to NULL. Calling routines will take care of changing this register
2626** value to non-NULL if the RHS is NULL-free.
drh1450bc62009-10-30 13:25:56 +00002627**
2628** For a SELECT or EXISTS operator, return the register that holds the
drh39a11812016-08-19 19:12:58 +00002629** result. For a multi-column SELECT, the result is stored in a contiguous
2630** array of registers and the return value is the register of the left-most
2631** result column. Return 0 for IN operators or if an error occurs.
drhcce7d172000-05-31 15:34:51 +00002632*/
drh51522cd2005-01-20 13:36:19 +00002633#ifndef SQLITE_OMIT_SUBQUERY
drh1450bc62009-10-30 13:25:56 +00002634int sqlite3CodeSubselect(
drhfd773cf2009-05-29 14:39:07 +00002635 Parse *pParse, /* Parsing context */
2636 Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
drh6be515e2014-08-01 21:00:53 +00002637 int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
drhfd773cf2009-05-29 14:39:07 +00002638 int isRowid /* If true, LHS of IN operator is a rowid */
danielk197741a05b72008-10-02 13:50:55 +00002639){
drh6be515e2014-08-01 21:00:53 +00002640 int jmpIfDynamic = -1; /* One-time test address */
drh1450bc62009-10-30 13:25:56 +00002641 int rReg = 0; /* Register storing resulting */
danielk1977b3bce662005-01-29 08:32:43 +00002642 Vdbe *v = sqlite3GetVdbe(pParse);
drh1450bc62009-10-30 13:25:56 +00002643 if( NEVER(v==0) ) return 0;
danielk1977fc976062007-05-10 10:46:56 +00002644
drh39a11812016-08-19 19:12:58 +00002645 /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
2646 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002647 **
2648 ** * The right-hand side is a correlated subquery
2649 ** * The right-hand side is an expression list containing variables
2650 ** * We are inside a trigger
2651 **
2652 ** If all of the above are false, then we can run this code just once
2653 ** save the results, and reuse the same result on subsequent invocations.
danielk1977b3bce662005-01-29 08:32:43 +00002654 */
drhc5cd1242013-09-12 16:50:49 +00002655 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh511f9e82016-09-22 18:53:13 +00002656 jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002657 }
2658
drhcce7d172000-05-31 15:34:51 +00002659 switch( pExpr->op ){
drhfef52082000-06-06 01:50:43 +00002660 case TK_IN: {
drhd4187c72010-08-30 22:15:45 +00002661 int addr; /* Address of OP_OpenEphemeral instruction */
2662 Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
drh323df792013-08-05 19:11:29 +00002663 KeyInfo *pKeyInfo = 0; /* Key information */
dan71c57db2016-07-09 20:23:55 +00002664 int nVal; /* Size of vector pLeft */
2665
2666 nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002667 assert( !isRowid || nVal==1 );
danielk1977e014a832004-05-17 10:48:57 +00002668
2669 /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
drh8cff69d2009-11-12 19:59:44 +00002670 ** expression it is handled the same way. An ephemeral table is
dan553168c2016-08-01 20:14:31 +00002671 ** filled with index keys representing the results from the
2672 ** SELECT or the <exprlist>.
danielk1977e014a832004-05-17 10:48:57 +00002673 **
2674 ** If the 'x' expression is a column value, or the SELECT...
2675 ** statement returns a column value, then the affinity of that
2676 ** column is used to build the index keys. If both 'x' and the
2677 ** SELECT... statement are columns, then numeric affinity is used
2678 ** if either column has NUMERIC or INTEGER affinity. If neither
2679 ** 'x' nor the SELECT... statement are columns, then numeric affinity
2680 ** is used.
2681 */
2682 pExpr->iTable = pParse->nTab++;
dan71c57db2016-07-09 20:23:55 +00002683 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
2684 pExpr->iTable, (isRowid?0:nVal));
2685 pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002686
danielk19776ab3a2e2009-02-19 14:39:25 +00002687 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhfef52082000-06-06 01:50:43 +00002688 /* Case 1: expr IN (SELECT ...)
2689 **
danielk1977e014a832004-05-17 10:48:57 +00002690 ** Generate code to write the results of the select into the temporary
2691 ** table allocated and opened above.
drhfef52082000-06-06 01:50:43 +00002692 */
drh43870062014-07-31 15:44:44 +00002693 Select *pSelect = pExpr->x.pSelect;
dan71c57db2016-07-09 20:23:55 +00002694 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002695
drhe2ca99c2018-05-02 00:33:43 +00002696 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2697 jmpIfDynamic>=0?"":"CORRELATED "
2698 ));
danielk197741a05b72008-10-02 13:50:55 +00002699 assert( !isRowid );
drh64bcb8c2016-08-26 03:42:57 +00002700 /* If the LHS and RHS of the IN operator do not match, that
2701 ** error will have been caught long before we reach this point. */
2702 if( ALWAYS(pEList->nExpr==nVal) ){
dan71c57db2016-07-09 20:23:55 +00002703 SelectDest dest;
2704 int i;
2705 sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
2706 dest.zAffSdst = exprINAffinity(pParse, pExpr);
dan71c57db2016-07-09 20:23:55 +00002707 pSelect->iLimit = 0;
2708 testcase( pSelect->selFlags & SF_Distinct );
2709 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2710 if( sqlite3Select(pParse, pSelect, &dest) ){
2711 sqlite3DbFree(pParse->db, dest.zAffSdst);
2712 sqlite3KeyInfoUnref(pKeyInfo);
2713 return 0;
2714 }
2715 sqlite3DbFree(pParse->db, dest.zAffSdst);
2716 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2717 assert( pEList!=0 );
2718 assert( pEList->nExpr>0 );
2719 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2720 for(i=0; i<nVal; i++){
dan773d3af2016-09-06 17:21:17 +00002721 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
dan71c57db2016-07-09 20:23:55 +00002722 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2723 pParse, p, pEList->a[i].pExpr
2724 );
2725 }
drh94ccde52007-04-13 16:06:32 +00002726 }
drha7d2db12010-07-14 20:23:52 +00002727 }else if( ALWAYS(pExpr->x.pList!=0) ){
drhfef52082000-06-06 01:50:43 +00002728 /* Case 2: expr IN (exprlist)
2729 **
drhfd131da2007-08-07 17:13:03 +00002730 ** For each expression, build an index key from the evaluation and
danielk1977e014a832004-05-17 10:48:57 +00002731 ** store it in the temporary table. If <expr> is a column, then use
2732 ** that columns affinity when building index keys. If <expr> is not
2733 ** a column, use numeric affinity.
drhfef52082000-06-06 01:50:43 +00002734 */
dan71c57db2016-07-09 20:23:55 +00002735 char affinity; /* Affinity of the LHS of the IN */
danielk1977e014a832004-05-17 10:48:57 +00002736 int i;
danielk19776ab3a2e2009-02-19 14:39:25 +00002737 ExprList *pList = pExpr->x.pList;
drh57dbd7b2005-07-08 18:25:26 +00002738 struct ExprList_item *pItem;
drhecc31802008-06-26 20:06:06 +00002739 int r1, r2, r3;
dan71c57db2016-07-09 20:23:55 +00002740 affinity = sqlite3ExprAffinity(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002741 if( !affinity ){
drh05883a32015-06-02 15:32:08 +00002742 affinity = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +00002743 }
drh323df792013-08-05 19:11:29 +00002744 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002745 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
drh323df792013-08-05 19:11:29 +00002746 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2747 }
danielk1977e014a832004-05-17 10:48:57 +00002748
2749 /* Loop through each expression in <exprlist>. */
drh2d401ab2008-01-10 23:50:11 +00002750 r1 = sqlite3GetTempReg(pParse);
2751 r2 = sqlite3GetTempReg(pParse);
dan21cd29a2017-10-23 16:03:54 +00002752 if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
drh57dbd7b2005-07-08 18:25:26 +00002753 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2754 Expr *pE2 = pItem->pExpr;
drhe05c9292009-10-29 13:48:10 +00002755 int iValToIns;
danielk1977e014a832004-05-17 10:48:57 +00002756
drh57dbd7b2005-07-08 18:25:26 +00002757 /* If the expression is not constant then we will need to
2758 ** disable the test that was generated above that makes sure
2759 ** this code only executes once. Because for a non-constant
2760 ** expression we need to rerun this code each time.
2761 */
drh6be515e2014-08-01 21:00:53 +00002762 if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
2763 sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
2764 jmpIfDynamic = -1;
drh4794b982000-06-06 13:54:14 +00002765 }
danielk1977e014a832004-05-17 10:48:57 +00002766
2767 /* Evaluate the expression and insert it into the temp table */
drhe05c9292009-10-29 13:48:10 +00002768 if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2769 sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
danielk197741a05b72008-10-02 13:50:55 +00002770 }else{
drhe05c9292009-10-29 13:48:10 +00002771 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2772 if( isRowid ){
2773 sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2774 sqlite3VdbeCurrentAddr(v)+2);
drh688852a2014-02-17 22:40:43 +00002775 VdbeCoverage(v);
drhe05c9292009-10-29 13:48:10 +00002776 sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
2777 }else{
2778 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
drh9b4eaeb2016-11-09 00:10:33 +00002779 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
drhe05c9292009-10-29 13:48:10 +00002780 }
danielk197741a05b72008-10-02 13:50:55 +00002781 }
drhfef52082000-06-06 01:50:43 +00002782 }
drh2d401ab2008-01-10 23:50:11 +00002783 sqlite3ReleaseTempReg(pParse, r1);
2784 sqlite3ReleaseTempReg(pParse, r2);
drhfef52082000-06-06 01:50:43 +00002785 }
drh323df792013-08-05 19:11:29 +00002786 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00002787 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
danielk197741a05b72008-10-02 13:50:55 +00002788 }
danielk1977b3bce662005-01-29 08:32:43 +00002789 break;
drhfef52082000-06-06 01:50:43 +00002790 }
2791
drh51522cd2005-01-20 13:36:19 +00002792 case TK_EXISTS:
drhfd773cf2009-05-29 14:39:07 +00002793 case TK_SELECT:
2794 default: {
drh39a11812016-08-19 19:12:58 +00002795 /* Case 3: (SELECT ... FROM ...)
2796 ** or: EXISTS(SELECT ... FROM ...)
2797 **
2798 ** For a SELECT, generate code to put the values for all columns of
2799 ** the first row into an array of registers and return the index of
2800 ** the first register.
2801 **
2802 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2803 ** into a register and return that register number.
2804 **
2805 ** In both cases, the query is augmented with "LIMIT 1". Any
2806 ** preexisting limit is discarded in place of the new LIMIT 1.
drhfef52082000-06-06 01:50:43 +00002807 */
drhfd773cf2009-05-29 14:39:07 +00002808 Select *pSel; /* SELECT statement to encode */
drh39a11812016-08-19 19:12:58 +00002809 SelectDest dest; /* How to deal with SELECT result */
dan71c57db2016-07-09 20:23:55 +00002810 int nReg; /* Registers to allocate */
drh8c0833f2017-11-14 23:48:23 +00002811 Expr *pLimit; /* New limit expression */
drh1398ad32005-01-19 23:24:50 +00002812
shanecf697392009-06-01 16:53:09 +00002813 testcase( pExpr->op==TK_EXISTS );
2814 testcase( pExpr->op==TK_SELECT );
2815 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
danielk19776ab3a2e2009-02-19 14:39:25 +00002816 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
dan71c57db2016-07-09 20:23:55 +00002817
danielk19776ab3a2e2009-02-19 14:39:25 +00002818 pSel = pExpr->x.pSelect;
drhe2ca99c2018-05-02 00:33:43 +00002819 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2820 jmpIfDynamic>=0?"":"CORRELATED "));
dan71c57db2016-07-09 20:23:55 +00002821 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2822 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2823 pParse->nMem += nReg;
drh51522cd2005-01-20 13:36:19 +00002824 if( pExpr->op==TK_SELECT ){
danielk19776c8c8ce2008-01-02 16:27:09 +00002825 dest.eDest = SRT_Mem;
drh53932ce2014-08-29 12:29:39 +00002826 dest.iSdst = dest.iSDParm;
dan71c57db2016-07-09 20:23:55 +00002827 dest.nSdst = nReg;
2828 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
drhd4e70eb2008-01-02 00:34:36 +00002829 VdbeComment((v, "Init subquery result"));
drh51522cd2005-01-20 13:36:19 +00002830 }else{
danielk19776c8c8ce2008-01-02 16:27:09 +00002831 dest.eDest = SRT_Exists;
drh2b596da2012-07-23 21:43:19 +00002832 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
drhd4e70eb2008-01-02 00:34:36 +00002833 VdbeComment((v, "Init EXISTS result"));
drh51522cd2005-01-20 13:36:19 +00002834 }
drh8c0833f2017-11-14 23:48:23 +00002835 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2836 if( pSel->pLimit ){
2837 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2838 pSel->pLimit->pLeft = pLimit;
2839 }else{
2840 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2841 }
drh48b5b042010-12-06 18:50:32 +00002842 pSel->iLimit = 0;
drh7d10d5a2008-08-20 16:35:10 +00002843 if( sqlite3Select(pParse, pSel, &dest) ){
drh1450bc62009-10-30 13:25:56 +00002844 return 0;
drh94ccde52007-04-13 16:06:32 +00002845 }
drh2b596da2012-07-23 21:43:19 +00002846 rReg = dest.iSDParm;
drhebb6a652013-09-12 23:42:22 +00002847 ExprSetVVAProperty(pExpr, EP_NoReduce);
danielk1977b3bce662005-01-29 08:32:43 +00002848 break;
drhcce7d172000-05-31 15:34:51 +00002849 }
2850 }
danielk1977b3bce662005-01-29 08:32:43 +00002851
drh6be515e2014-08-01 21:00:53 +00002852 if( rHasNullFlag ){
2853 sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
danielk1977b3bce662005-01-29 08:32:43 +00002854 }
drh6be515e2014-08-01 21:00:53 +00002855
2856 if( jmpIfDynamic>=0 ){
2857 sqlite3VdbeJumpHere(v, jmpIfDynamic);
danielk1977b3bce662005-01-29 08:32:43 +00002858 }
danielk1977fc976062007-05-10 10:46:56 +00002859
drh1450bc62009-10-30 13:25:56 +00002860 return rReg;
drhcce7d172000-05-31 15:34:51 +00002861}
drh51522cd2005-01-20 13:36:19 +00002862#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002863
drhe3365e62009-11-12 17:52:24 +00002864#ifndef SQLITE_OMIT_SUBQUERY
2865/*
dan7b35a772016-07-28 19:47:15 +00002866** Expr pIn is an IN(...) expression. This function checks that the
2867** sub-select on the RHS of the IN() operator has the same number of
2868** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2869** a sub-query, that the LHS is a vector of size 1.
2870*/
2871int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2872 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2873 if( (pIn->flags & EP_xIsSelect) ){
2874 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2875 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2876 return 1;
2877 }
2878 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002879 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002880 return 1;
2881 }
2882 return 0;
2883}
2884#endif
2885
2886#ifndef SQLITE_OMIT_SUBQUERY
2887/*
drhe3365e62009-11-12 17:52:24 +00002888** Generate code for an IN expression.
2889**
2890** x IN (SELECT ...)
2891** x IN (value, value, ...)
2892**
drhecb87ac2016-08-25 15:46:25 +00002893** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002894** right-hand side (RHS) is an array of zero or more scalar values, or a
2895** subquery. If the RHS is a subquery, the number of result columns must
2896** match the number of columns in the vector on the LHS. If the RHS is
2897** a list of values, the LHS must be a scalar.
2898**
2899** The IN operator is true if the LHS value is contained within the RHS.
2900** The result is false if the LHS is definitely not in the RHS. The
2901** result is NULL if the presence of the LHS in the RHS cannot be
2902** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002903**
drh6be515e2014-08-01 21:00:53 +00002904** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002905** contained within the RHS. If due to NULLs we cannot determine if the LHS
2906** is contained in the RHS then jump to destIfNull. If the LHS is contained
2907** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002908**
2909** See the separate in-operator.md documentation file in the canonical
2910** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002911*/
2912static void sqlite3ExprCodeIN(
2913 Parse *pParse, /* Parsing and code generating context */
2914 Expr *pExpr, /* The IN expression */
2915 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
2916 int destIfNull /* Jump here if the results are unknown due to NULLs */
2917){
2918 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00002919 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00002920 int rLhs; /* Register(s) holding the LHS values */
2921 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00002922 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00002923 int *aiMap = 0; /* Map from vector field to index column */
2924 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00002925 int nVector; /* Size of vectors for this IN operator */
2926 int iDummy; /* Dummy parameter to exprCodeVector() */
2927 Expr *pLeft; /* The LHS of the IN operator */
2928 int i; /* loop counter */
2929 int destStep2; /* Where to jump when NULLs seen in step 2 */
2930 int destStep6 = 0; /* Start of code for Step 6 */
2931 int addrTruthOp; /* Address of opcode that determines the IN is true */
2932 int destNotNull; /* Jump here if a comparison is not true in step 6 */
2933 int addrTop; /* Top of the step-6 loop */
drhe3365e62009-11-12 17:52:24 +00002934
drhe347d3e2016-08-25 21:14:34 +00002935 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00002936 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00002937 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00002938 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2939 aiMap = (int*)sqlite3DbMallocZero(
2940 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2941 );
drhe347d3e2016-08-25 21:14:34 +00002942 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00002943
danba00e302016-07-23 20:24:06 +00002944 /* Attempt to compute the RHS. After this step, if anything other than
2945 ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2946 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2947 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00002948 v = pParse->pVdbe;
2949 assert( v!=0 ); /* OOM detected prior to this routine */
2950 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00002951 eType = sqlite3FindInIndex(pParse, pExpr,
2952 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
danba00e302016-07-23 20:24:06 +00002953 destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
drhe3365e62009-11-12 17:52:24 +00002954
danba00e302016-07-23 20:24:06 +00002955 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2956 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2957 );
drhecb87ac2016-08-25 15:46:25 +00002958#ifdef SQLITE_DEBUG
2959 /* Confirm that aiMap[] contains nVector integer values between 0 and
2960 ** nVector-1. */
2961 for(i=0; i<nVector; i++){
2962 int j, cnt;
2963 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2964 assert( cnt==1 );
2965 }
2966#endif
drhe3365e62009-11-12 17:52:24 +00002967
danba00e302016-07-23 20:24:06 +00002968 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2969 ** vector, then it is stored in an array of nVector registers starting
2970 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00002971 **
2972 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2973 ** so that the fields are in the same order as an existing index. The
2974 ** aiMap[] array contains a mapping from the original LHS field order to
2975 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00002976 */
drhe347d3e2016-08-25 21:14:34 +00002977 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2978 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00002979 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00002980 /* LHS fields are not reordered */
2981 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00002982 }else{
2983 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00002984 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00002985 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00002986 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00002987 }
danba00e302016-07-23 20:24:06 +00002988 }
drhe3365e62009-11-12 17:52:24 +00002989
drhbb53ecb2014-08-02 21:03:33 +00002990 /* If sqlite3FindInIndex() did not find or create an index that is
2991 ** suitable for evaluating the IN operator, then evaluate using a
2992 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00002993 **
2994 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00002995 */
drhbb53ecb2014-08-02 21:03:33 +00002996 if( eType==IN_INDEX_NOOP ){
2997 ExprList *pList = pExpr->x.pList;
2998 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2999 int labelOk = sqlite3VdbeMakeLabel(v);
3000 int r2, regToFree;
3001 int regCkNull = 0;
3002 int ii;
3003 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003004 if( destIfNull!=destIfFalse ){
3005 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003006 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003007 }
3008 for(ii=0; ii<pList->nExpr; ii++){
3009 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003010 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003011 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3012 }
3013 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003014 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003015 (void*)pColl, P4_COLLSEQ);
3016 VdbeCoverageIf(v, ii<pList->nExpr-1);
3017 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003018 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003019 }else{
3020 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003021 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003022 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003023 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003024 }
3025 sqlite3ReleaseTempReg(pParse, regToFree);
3026 }
3027 if( regCkNull ){
3028 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003029 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003030 }
3031 sqlite3VdbeResolveLabel(v, labelOk);
3032 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003033 goto sqlite3ExprCodeIN_finished;
3034 }
3035
3036 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3037 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3038 ** We will then skip the binary search of the RHS.
3039 */
3040 if( destIfNull==destIfFalse ){
3041 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003042 }else{
drhe347d3e2016-08-25 21:14:34 +00003043 destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3044 }
3045 for(i=0; i<nVector; i++){
3046 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3047 if( sqlite3ExprCanBeNull(p) ){
3048 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003049 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003050 }
drhe3365e62009-11-12 17:52:24 +00003051 }
drhe347d3e2016-08-25 21:14:34 +00003052
3053 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3054 ** of the RHS using the LHS as a probe. If found, the result is
3055 ** true.
3056 */
3057 if( eType==IN_INDEX_ROWID ){
3058 /* In this case, the RHS is the ROWID of table b-tree and so we also
3059 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3060 ** into a single opcode. */
3061 sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3062 VdbeCoverage(v);
3063 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3064 }else{
3065 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3066 if( destIfFalse==destIfNull ){
3067 /* Combine Step 3 and Step 5 into a single opcode */
3068 sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3069 rLhs, nVector); VdbeCoverage(v);
3070 goto sqlite3ExprCodeIN_finished;
3071 }
3072 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3073 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3074 rLhs, nVector); VdbeCoverage(v);
3075 }
3076
3077 /* Step 4. If the RHS is known to be non-NULL and we did not find
3078 ** an match on the search above, then the result must be FALSE.
3079 */
3080 if( rRhsHasNull && nVector==1 ){
3081 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3082 VdbeCoverage(v);
3083 }
3084
3085 /* Step 5. If we do not care about the difference between NULL and
3086 ** FALSE, then just return false.
3087 */
3088 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3089
3090 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3091 ** If any comparison is NULL, then the result is NULL. If all
3092 ** comparisons are FALSE then the final result is FALSE.
3093 **
3094 ** For a scalar LHS, it is sufficient to check just the first row
3095 ** of the RHS.
3096 */
3097 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3098 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3099 VdbeCoverage(v);
3100 if( nVector>1 ){
3101 destNotNull = sqlite3VdbeMakeLabel(v);
3102 }else{
3103 /* For nVector==1, combine steps 6 and 7 by immediately returning
3104 ** FALSE if the first comparison is not NULL */
3105 destNotNull = destIfFalse;
3106 }
3107 for(i=0; i<nVector; i++){
3108 Expr *p;
3109 CollSeq *pColl;
3110 int r3 = sqlite3GetTempReg(pParse);
3111 p = sqlite3VectorFieldSubexpr(pLeft, i);
3112 pColl = sqlite3ExprCollSeq(pParse, p);
3113 sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3114 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3115 (void*)pColl, P4_COLLSEQ);
3116 VdbeCoverage(v);
3117 sqlite3ReleaseTempReg(pParse, r3);
3118 }
3119 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3120 if( nVector>1 ){
3121 sqlite3VdbeResolveLabel(v, destNotNull);
3122 sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
3123 VdbeCoverage(v);
3124
3125 /* Step 7: If we reach this point, we know that the result must
3126 ** be false. */
3127 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3128 }
3129
3130 /* Jumps here in order to return true. */
3131 sqlite3VdbeJumpHere(v, addrTruthOp);
3132
3133sqlite3ExprCodeIN_finished:
3134 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003135 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003136sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003137 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003138 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003139}
3140#endif /* SQLITE_OMIT_SUBQUERY */
3141
drh13573c72010-01-12 17:04:07 +00003142#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003143/*
3144** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003145** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003146**
3147** The z[] string will probably not be zero-terminated. But the
3148** z[n] character is guaranteed to be something that does not look
3149** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003150*/
drhb7916a72009-05-27 10:31:29 +00003151static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003152 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003153 double value;
drh9339da12010-09-30 00:50:49 +00003154 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003155 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3156 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003157 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003158 }
3159}
drh13573c72010-01-12 17:04:07 +00003160#endif
drh598f1342007-10-23 15:39:45 +00003161
3162
3163/*
drhfec19aa2004-05-19 20:41:03 +00003164** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003165** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003166**
shaneh5f1d6b62010-09-30 16:51:25 +00003167** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003168*/
drh13573c72010-01-12 17:04:07 +00003169static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3170 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003171 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003172 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003173 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003174 if( negFlag ) i = -i;
3175 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003176 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003177 int c;
3178 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003179 const char *z = pExpr->u.zToken;
3180 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003181 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003182 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003183#ifdef SQLITE_OMIT_FLOATING_POINT
3184 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3185#else
drh1b7ddc52014-07-23 14:52:05 +00003186#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003187 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003188 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003189 }else
3190#endif
3191 {
drh9296c182014-07-23 13:40:49 +00003192 codeReal(v, z, negFlag, iMem);
3193 }
drh13573c72010-01-12 17:04:07 +00003194#endif
drh77320ea2016-11-30 14:47:37 +00003195 }else{
drh84d4f1a2017-09-20 10:47:10 +00003196 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003197 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003198 }
drhfec19aa2004-05-19 20:41:03 +00003199 }
3200}
3201
drh5cd79232009-05-25 11:46:29 +00003202
drh1f9ca2c2015-08-25 16:57:52 +00003203/* Generate code that will load into register regOut a value that is
3204** appropriate for the iIdxCol-th column of index pIdx.
3205*/
3206void sqlite3ExprCodeLoadIndexColumn(
3207 Parse *pParse, /* The parsing context */
3208 Index *pIdx, /* The index whose column is to be loaded */
3209 int iTabCur, /* Cursor pointing to a table row */
3210 int iIdxCol, /* The column of the index to be loaded */
3211 int regOut /* Store the index column value in this register */
3212){
3213 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003214 if( iTabCol==XN_EXPR ){
3215 assert( pIdx->aColExpr );
3216 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003217 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003218 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003219 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003220 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003221 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3222 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003223 }
drh1f9ca2c2015-08-25 16:57:52 +00003224}
3225
drh5cd79232009-05-25 11:46:29 +00003226/*
drh5c092e82010-05-14 19:24:02 +00003227** Generate code to extract the value of the iCol-th column of a table.
3228*/
3229void sqlite3ExprCodeGetColumnOfTable(
3230 Vdbe *v, /* The VDBE under construction */
3231 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003232 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003233 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003234 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003235){
drhaca19e12017-04-07 19:41:31 +00003236 if( pTab==0 ){
3237 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3238 return;
3239 }
drh5c092e82010-05-14 19:24:02 +00003240 if( iCol<0 || iCol==pTab->iPKey ){
3241 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3242 }else{
3243 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003244 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003245 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003246 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3247 }
3248 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003249 }
3250 if( iCol>=0 ){
3251 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3252 }
3253}
3254
3255/*
drh945498f2007-02-24 11:52:52 +00003256** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003257** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003258**
3259** There must be an open cursor to pTab in iTable when this routine
3260** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003261*/
drhe55cbd72008-03-31 23:48:03 +00003262int sqlite3ExprCodeGetColumn(
3263 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003264 Table *pTab, /* Description of the table we are reading from */
3265 int iColumn, /* Index of the table column */
3266 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003267 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003268 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003269){
drhe55cbd72008-03-31 23:48:03 +00003270 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003271 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003272 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003273 if( p5 ){
3274 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003275 }
drhe55cbd72008-03-31 23:48:03 +00003276 return iReg;
3277}
drhe55cbd72008-03-31 23:48:03 +00003278
3279/*
drhb21e7c72008-06-22 12:37:57 +00003280** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003281** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003282*/
drhb21e7c72008-06-22 12:37:57 +00003283void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003284 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003285 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003286}
3287
drh652fbf52008-04-01 01:42:41 +00003288/*
drh12abf402016-08-22 14:30:05 +00003289** Convert a scalar expression node to a TK_REGISTER referencing
3290** register iReg. The caller must ensure that iReg already contains
3291** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003292*/
3293static void exprToRegister(Expr *p, int iReg){
3294 p->op2 = p->op;
3295 p->op = TK_REGISTER;
3296 p->iTable = iReg;
3297 ExprClearProperty(p, EP_Skip);
3298}
3299
drh12abf402016-08-22 14:30:05 +00003300/*
3301** Evaluate an expression (either a vector or a scalar expression) and store
3302** the result in continguous temporary registers. Return the index of
3303** the first register used to store the result.
3304**
3305** If the returned result register is a temporary scalar, then also write
3306** that register number into *piFreeable. If the returned result register
3307** is not a temporary or if the expression is a vector set *piFreeable
3308** to 0.
3309*/
3310static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3311 int iResult;
3312 int nResult = sqlite3ExprVectorSize(p);
3313 if( nResult==1 ){
3314 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3315 }else{
3316 *piFreeable = 0;
3317 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003318#if SQLITE_OMIT_SUBQUERY
3319 iResult = 0;
3320#else
drh12abf402016-08-22 14:30:05 +00003321 iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
drhdd1bb432017-05-15 15:12:24 +00003322#endif
drh12abf402016-08-22 14:30:05 +00003323 }else{
3324 int i;
3325 iResult = pParse->nMem+1;
3326 pParse->nMem += nResult;
3327 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003328 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003329 }
3330 }
3331 }
3332 return iResult;
3333}
3334
dan71c57db2016-07-09 20:23:55 +00003335
drha4c3c872013-09-12 17:29:25 +00003336/*
drhcce7d172000-05-31 15:34:51 +00003337** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003338** expression. Attempt to store the results in register "target".
3339** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003340**
drh8b213892008-08-29 02:14:02 +00003341** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003342** be stored in target. The result might be stored in some other
3343** register if it is convenient to do so. The calling function
3344** must check the return code and move the results to the desired
3345** register.
drhcce7d172000-05-31 15:34:51 +00003346*/
drh678ccce2008-03-31 18:19:54 +00003347int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003348 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3349 int op; /* The opcode being coded */
3350 int inReg = target; /* Results stored in register inReg */
3351 int regFree1 = 0; /* If non-zero free this temporary register */
3352 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003353 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003354 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003355 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003356
drh9cbf3422008-01-17 16:22:13 +00003357 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003358 if( v==0 ){
3359 assert( pParse->db->mallocFailed );
3360 return 0;
3361 }
drh389a1ad2008-01-03 23:44:53 +00003362
drh1efa8022018-04-28 04:16:43 +00003363expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003364 if( pExpr==0 ){
3365 op = TK_NULL;
3366 }else{
3367 op = pExpr->op;
3368 }
drhf2bc0132004-10-04 13:19:23 +00003369 switch( op ){
drh13449892005-09-07 21:22:45 +00003370 case TK_AGG_COLUMN: {
3371 AggInfo *pAggInfo = pExpr->pAggInfo;
3372 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3373 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003374 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003375 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003376 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003377 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003378 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003379 return target;
drh13449892005-09-07 21:22:45 +00003380 }
3381 /* Otherwise, fall thru into the TK_COLUMN case */
3382 }
drh967e8b72000-06-21 13:59:10 +00003383 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003384 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003385 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003386 /* This COLUMN expression is really a constant due to WHERE clause
3387 ** constraints, and that constant is coded by the pExpr->pLeft
3388 ** expresssion. However, make sure the constant has the correct
3389 ** datatype by applying the Affinity of the table column to the
3390 ** constant.
3391 */
3392 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003393 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003394 if( aff!=SQLITE_AFF_BLOB ){
3395 static const char zAff[] = "B\000C\000D\000E";
3396 assert( SQLITE_AFF_BLOB=='A' );
3397 assert( SQLITE_AFF_TEXT=='B' );
3398 if( iReg!=target ){
3399 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3400 iReg = target;
3401 }
3402 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3403 &zAff[(aff-'B')*2], P4_STATIC);
3404 }
3405 return iReg;
drhefad2e22018-07-27 16:57:11 +00003406 }
drhb2b9d3d2013-08-01 01:14:43 +00003407 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003408 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003409 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003410 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003411 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003412 /* Coding an expression that is part of an index where column names
3413 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003414 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003415 }
drh22827922000-06-06 17:27:05 +00003416 }
drheda079c2018-09-20 19:02:15 +00003417 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003418 pExpr->iColumn, iTab, target,
3419 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003420 }
3421 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003422 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003423 return target;
drhfec19aa2004-05-19 20:41:03 +00003424 }
drh8abed7b2018-02-26 18:49:05 +00003425 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003426 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003427 return target;
3428 }
drh13573c72010-01-12 17:04:07 +00003429#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003430 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003431 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3432 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003433 return target;
drh598f1342007-10-23 15:39:45 +00003434 }
drh13573c72010-01-12 17:04:07 +00003435#endif
drhfec19aa2004-05-19 20:41:03 +00003436 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003437 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003438 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003439 return target;
drhcce7d172000-05-31 15:34:51 +00003440 }
drhf0863fe2005-06-12 21:35:51 +00003441 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003442 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003443 return target;
drhf0863fe2005-06-12 21:35:51 +00003444 }
danielk19775338a5f2005-01-20 13:03:10 +00003445#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003446 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003447 int n;
3448 const char *z;
drhca48c902008-01-18 14:08:24 +00003449 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003450 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3451 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3452 assert( pExpr->u.zToken[1]=='\'' );
3453 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003454 n = sqlite3Strlen30(z) - 1;
3455 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003456 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3457 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003458 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003459 }
danielk19775338a5f2005-01-20 13:03:10 +00003460#endif
drh50457892003-09-06 01:10:47 +00003461 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003462 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3463 assert( pExpr->u.zToken!=0 );
3464 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003465 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3466 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003467 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003468 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003469 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003470 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003471 }
drhc332cc32016-09-19 10:24:19 +00003472 return target;
drh50457892003-09-06 01:10:47 +00003473 }
drh4e0cff62004-11-05 05:10:28 +00003474 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003475 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003476 }
drh487e2622005-06-25 18:42:14 +00003477#ifndef SQLITE_OMIT_CAST
3478 case TK_CAST: {
3479 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003480 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003481 if( inReg!=target ){
3482 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3483 inReg = target;
3484 }
drh4169e432014-08-25 20:11:52 +00003485 sqlite3VdbeAddOp2(v, OP_Cast, target,
3486 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003487 return inReg;
drh487e2622005-06-25 18:42:14 +00003488 }
3489#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003490 case TK_IS:
3491 case TK_ISNOT:
3492 op = (op==TK_IS) ? TK_EQ : TK_NE;
3493 p5 = SQLITE_NULLEQ;
3494 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003495 case TK_LT:
3496 case TK_LE:
3497 case TK_GT:
3498 case TK_GE:
3499 case TK_NE:
3500 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003501 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003502 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003503 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003504 }else{
3505 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3506 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3507 codeCompare(pParse, pLeft, pExpr->pRight, op,
3508 r1, r2, inReg, SQLITE_STOREP2 | p5);
3509 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3510 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3511 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3512 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3513 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3514 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3515 testcase( regFree1==0 );
3516 testcase( regFree2==0 );
3517 }
drh6a2fe092009-09-23 02:29:36 +00003518 break;
3519 }
drhcce7d172000-05-31 15:34:51 +00003520 case TK_AND:
3521 case TK_OR:
3522 case TK_PLUS:
3523 case TK_STAR:
3524 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003525 case TK_REM:
3526 case TK_BITAND:
3527 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003528 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003529 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003530 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003531 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003532 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3533 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3534 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3535 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3536 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3537 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3538 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3539 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3540 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3541 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3542 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003543 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3544 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003545 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003546 testcase( regFree1==0 );
3547 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003548 break;
3549 }
drhcce7d172000-05-31 15:34:51 +00003550 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003551 Expr *pLeft = pExpr->pLeft;
3552 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003553 if( pLeft->op==TK_INTEGER ){
3554 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003555 return target;
drh13573c72010-01-12 17:04:07 +00003556#ifndef SQLITE_OMIT_FLOATING_POINT
3557 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003558 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3559 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003560 return target;
drh13573c72010-01-12 17:04:07 +00003561#endif
drh3c84ddf2008-01-09 02:15:38 +00003562 }else{
drh10d1edf2013-11-15 15:52:39 +00003563 tempX.op = TK_INTEGER;
3564 tempX.flags = EP_IntValue|EP_TokenOnly;
3565 tempX.u.iValue = 0;
3566 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003567 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003568 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003569 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003570 }
drh3c84ddf2008-01-09 02:15:38 +00003571 break;
drh6e142f52000-06-08 13:36:40 +00003572 }
drhbf4133c2001-10-13 02:59:08 +00003573 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003574 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003575 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3576 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003577 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3578 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003579 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003580 break;
3581 }
drh8abed7b2018-02-26 18:49:05 +00003582 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003583 int isTrue; /* IS TRUE or IS NOT TRUE */
3584 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003585 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3586 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003587 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3588 bNormal = pExpr->op2==TK_IS;
3589 testcase( isTrue && bNormal);
3590 testcase( !isTrue && bNormal);
3591 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003592 break;
3593 }
drhcce7d172000-05-31 15:34:51 +00003594 case TK_ISNULL:
3595 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003596 int addr;
drh7d176102014-02-18 03:07:12 +00003597 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3598 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003599 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003600 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003601 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003602 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003603 VdbeCoverageIf(v, op==TK_ISNULL);
3604 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003605 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003606 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003607 break;
drhcce7d172000-05-31 15:34:51 +00003608 }
drh22827922000-06-06 17:27:05 +00003609 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003610 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003611 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003612 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3613 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003614 }else{
drhc332cc32016-09-19 10:24:19 +00003615 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003616 }
drh22827922000-06-06 17:27:05 +00003617 break;
3618 }
drhcce7d172000-05-31 15:34:51 +00003619 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003620 ExprList *pFarg; /* List of function arguments */
3621 int nFarg; /* Number of function arguments */
3622 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003623 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003624 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003625 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003626 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003627 u8 enc = ENC(db); /* The text encoding used by this database */
3628 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003629
dan67a9b8e2018-06-22 20:51:35 +00003630#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003631 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3632 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003633 }
dan67a9b8e2018-06-22 20:51:35 +00003634#endif
dan86fb6e12018-05-16 20:58:07 +00003635
drh1e9b53f2017-01-04 01:07:24 +00003636 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003637 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003638 ** out of the inner loop, even if that means an extra OP_Copy. */
3639 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003640 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003641 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003642 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003643 pFarg = 0;
3644 }else{
3645 pFarg = pExpr->x.pList;
3646 }
3647 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003648 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3649 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003650 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003651#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3652 if( pDef==0 && pParse->explain ){
3653 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3654 }
3655#endif
danb6e9f7a2018-05-19 14:15:29 +00003656 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003657 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003658 break;
3659 }
drhae6bb952009-11-11 00:24:31 +00003660
3661 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003662 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003663 ** arguments past the first non-NULL argument.
3664 */
drhd36e1042013-09-06 13:10:12 +00003665 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhae6bb952009-11-11 00:24:31 +00003666 int endCoalesce = sqlite3VdbeMakeLabel(v);
3667 assert( nFarg>=2 );
3668 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3669 for(i=1; i<nFarg; i++){
3670 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003671 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003672 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003673 }
3674 sqlite3VdbeResolveLabel(v, endCoalesce);
3675 break;
3676 }
3677
drhcca9f3d2013-09-06 15:23:29 +00003678 /* The UNLIKELY() function is a no-op. The result is the value
3679 ** of the first argument.
3680 */
3681 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3682 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003683 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003684 }
drhae6bb952009-11-11 00:24:31 +00003685
drh54240752017-01-03 14:39:30 +00003686#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003687 /* The AFFINITY() function evaluates to a string that describes
3688 ** the type affinity of the argument. This is used for testing of
3689 ** the SQLite type logic.
3690 */
3691 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3692 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3693 char aff;
3694 assert( nFarg==1 );
3695 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3696 sqlite3VdbeLoadString(v, target,
3697 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3698 return target;
3699 }
drh54240752017-01-03 14:39:30 +00003700#endif
drha1a523a2016-12-26 00:18:36 +00003701
drhd1a01ed2013-11-21 16:08:52 +00003702 for(i=0; i<nFarg; i++){
3703 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003704 testcase( i==31 );
3705 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003706 }
3707 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3708 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3709 }
3710 }
drh12ffee82009-04-08 13:51:51 +00003711 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003712 if( constMask ){
3713 r1 = pParse->nMem+1;
3714 pParse->nMem += nFarg;
3715 }else{
3716 r1 = sqlite3GetTempRange(pParse, nFarg);
3717 }
drha748fdc2012-03-28 01:34:47 +00003718
3719 /* For length() and typeof() functions with a column argument,
3720 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3721 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3722 ** loading.
3723 */
drhd36e1042013-09-06 13:10:12 +00003724 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003725 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003726 assert( nFarg==1 );
3727 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003728 exprOp = pFarg->a[0].pExpr->op;
3729 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003730 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3731 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003732 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3733 pFarg->a[0].pExpr->op2 =
3734 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003735 }
3736 }
3737
drh5579d592015-08-26 14:01:41 +00003738 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003739 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003740 }else{
drh12ffee82009-04-08 13:51:51 +00003741 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003742 }
drhb7f6f682006-07-08 17:06:43 +00003743#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003744 /* Possibly overload the function if the first argument is
3745 ** a virtual table column.
3746 **
3747 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3748 ** second argument, not the first, as the argument to test to
3749 ** see if it is a column in a virtual table. This is done because
3750 ** the left operand of infix functions (the operand we want to
3751 ** control overloading) ends up as the second argument to the
3752 ** function. The expression "A glob B" is equivalent to
3753 ** "glob(B,A). We want to use the A in "A glob B" to test
3754 ** for function overloading. But we use the B term in "glob(B,A)".
3755 */
drh59155062018-05-26 18:03:48 +00003756 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003757 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3758 }else if( nFarg>0 ){
3759 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003760 }
3761#endif
drhd36e1042013-09-06 13:10:12 +00003762 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003763 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003764 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003765 }
drh092457b2017-12-29 15:04:49 +00003766#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3767 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003768 Expr *pArg = pFarg->a[0].pExpr;
3769 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003770 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003771 }else{
3772 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3773 }
drh092457b2017-12-29 15:04:49 +00003774 }else
3775#endif
3776 {
drh2fc865c2017-12-16 20:20:37 +00003777 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3778 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3779 sqlite3VdbeChangeP5(v, (u8)nFarg);
3780 }
drhd1a01ed2013-11-21 16:08:52 +00003781 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003782 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003783 }
drhc332cc32016-09-19 10:24:19 +00003784 return target;
drhcce7d172000-05-31 15:34:51 +00003785 }
drhfe2093d2005-01-20 22:48:47 +00003786#ifndef SQLITE_OMIT_SUBQUERY
3787 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003788 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003789 int nCol;
drhc5499be2008-04-01 15:06:33 +00003790 testcase( op==TK_EXISTS );
3791 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003792 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3793 sqlite3SubselectError(pParse, nCol, 1);
3794 }else{
drhc332cc32016-09-19 10:24:19 +00003795 return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
dan8da209b2016-07-26 18:06:08 +00003796 }
drh19a775c2000-06-05 18:54:46 +00003797 break;
3798 }
drhfc7f27b2016-08-20 00:07:01 +00003799 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003800 int n;
drhfc7f27b2016-08-20 00:07:01 +00003801 if( pExpr->pLeft->iTable==0 ){
3802 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3803 }
drh966e2912017-01-03 02:58:01 +00003804 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3805 if( pExpr->iTable
3806 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3807 ){
3808 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3809 pExpr->iTable, n);
3810 }
drhc332cc32016-09-19 10:24:19 +00003811 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003812 }
drhfef52082000-06-06 01:50:43 +00003813 case TK_IN: {
drhe3365e62009-11-12 17:52:24 +00003814 int destIfFalse = sqlite3VdbeMakeLabel(v);
3815 int destIfNull = sqlite3VdbeMakeLabel(v);
3816 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3817 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3818 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3819 sqlite3VdbeResolveLabel(v, destIfFalse);
3820 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3821 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003822 return target;
drhfef52082000-06-06 01:50:43 +00003823 }
drhe3365e62009-11-12 17:52:24 +00003824#endif /* SQLITE_OMIT_SUBQUERY */
3825
3826
drh2dcef112008-01-12 19:03:48 +00003827 /*
3828 ** x BETWEEN y AND z
3829 **
3830 ** This is equivalent to
3831 **
3832 ** x>=y AND x<=z
3833 **
3834 ** X is stored in pExpr->pLeft.
3835 ** Y is stored in pExpr->pList->a[0].pExpr.
3836 ** Z is stored in pExpr->pList->a[1].pExpr.
3837 */
drhfef52082000-06-06 01:50:43 +00003838 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003839 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003840 return target;
drhfef52082000-06-06 01:50:43 +00003841 }
drh94fa9c42016-02-27 21:16:04 +00003842 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003843 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003844 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003845 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003846 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003847 }
drh2dcef112008-01-12 19:03:48 +00003848
dan165921a2009-08-28 18:53:45 +00003849 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003850 /* If the opcode is TK_TRIGGER, then the expression is a reference
3851 ** to a column in the new.* or old.* pseudo-tables available to
3852 ** trigger programs. In this case Expr.iTable is set to 1 for the
3853 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3854 ** is set to the column of the pseudo-table to read, or to -1 to
3855 ** read the rowid field.
3856 **
3857 ** The expression is implemented using an OP_Param opcode. The p1
3858 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3859 ** to reference another column of the old.* pseudo-table, where
3860 ** i is the index of the column. For a new.rowid reference, p1 is
3861 ** set to (n+1), where n is the number of columns in each pseudo-table.
3862 ** For a reference to any other column in the new.* pseudo-table, p1
3863 ** is set to (n+2+i), where n and i are as defined previously. For
3864 ** example, if the table on which triggers are being fired is
3865 ** declared as:
3866 **
3867 ** CREATE TABLE t1(a, b);
3868 **
3869 ** Then p1 is interpreted as follows:
3870 **
3871 ** p1==0 -> old.rowid p1==3 -> new.rowid
3872 ** p1==1 -> old.a p1==4 -> new.a
3873 ** p1==2 -> old.b p1==5 -> new.b
3874 */
drheda079c2018-09-20 19:02:15 +00003875 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003876 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3877
3878 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3879 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3880 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3881 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3882
3883 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003884 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003885 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003886 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003887 ));
dan65a7cd12009-09-01 12:16:01 +00003888
drh44dbca82010-01-13 04:22:20 +00003889#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003890 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003891 ** integer. Use OP_RealAffinity to make sure it is really real.
3892 **
3893 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3894 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003895 if( pExpr->iColumn>=0
3896 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3897 ){
3898 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3899 }
drh44dbca82010-01-13 04:22:20 +00003900#endif
dan165921a2009-08-28 18:53:45 +00003901 break;
3902 }
3903
dan71c57db2016-07-09 20:23:55 +00003904 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00003905 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00003906 break;
3907 }
3908
drh31d6fd52017-04-14 19:03:10 +00003909 case TK_IF_NULL_ROW: {
3910 int addrINR;
3911 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00003912 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00003913 sqlite3VdbeJumpHere(v, addrINR);
3914 sqlite3VdbeChangeP3(v, addrINR, inReg);
3915 break;
3916 }
3917
drh2dcef112008-01-12 19:03:48 +00003918 /*
3919 ** Form A:
3920 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3921 **
3922 ** Form B:
3923 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
3924 **
3925 ** Form A is can be transformed into the equivalent form B as follows:
3926 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
3927 ** WHEN x=eN THEN rN ELSE y END
3928 **
3929 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00003930 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3931 ** odd. The Y is also optional. If the number of elements in x.pList
3932 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00003933 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
3934 **
3935 ** The result of the expression is the Ri for the first matching Ei,
3936 ** or if there is no matching Ei, the ELSE term Y, or if there is
3937 ** no ELSE term, NULL.
3938 */
drh33cd4902009-05-30 20:49:20 +00003939 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00003940 int endLabel; /* GOTO label for end of CASE stmt */
3941 int nextCase; /* GOTO label for next WHEN clause */
3942 int nExpr; /* 2x number of WHEN terms */
3943 int i; /* Loop counter */
3944 ExprList *pEList; /* List of WHEN terms */
3945 struct ExprList_item *aListelem; /* Array of WHEN terms */
3946 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00003947 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00003948 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00003949
danielk19776ab3a2e2009-02-19 14:39:25 +00003950 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00003951 assert(pExpr->x.pList->nExpr > 0);
3952 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00003953 aListelem = pEList->a;
3954 nExpr = pEList->nExpr;
drh2dcef112008-01-12 19:03:48 +00003955 endLabel = sqlite3VdbeMakeLabel(v);
3956 if( (pX = pExpr->pLeft)!=0 ){
drh10d1edf2013-11-15 15:52:39 +00003957 tempX = *pX;
drh33cd4902009-05-30 20:49:20 +00003958 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00003959 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00003960 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00003961 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00003962 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00003963 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00003964 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00003965 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
3966 ** The value in regFree1 might get SCopy-ed into the file result.
3967 ** So make sure that the regFree1 register is not reused for other
3968 ** purposes and possibly overwritten. */
3969 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00003970 }
drhc5cd1242013-09-12 16:50:49 +00003971 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00003972 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00003973 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00003974 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003975 }else{
drh2dcef112008-01-12 19:03:48 +00003976 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00003977 }
drh2dcef112008-01-12 19:03:48 +00003978 nextCase = sqlite3VdbeMakeLabel(v);
drh33cd4902009-05-30 20:49:20 +00003979 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00003980 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00003981 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00003982 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00003983 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00003984 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00003985 }
drhc5cd1242013-09-12 16:50:49 +00003986 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00003987 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00003988 }else{
drh9de221d2008-01-05 06:51:30 +00003989 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00003990 }
drh2dcef112008-01-12 19:03:48 +00003991 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00003992 break;
3993 }
danielk19775338a5f2005-01-20 13:03:10 +00003994#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00003995 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00003996 assert( pExpr->affinity==OE_Rollback
3997 || pExpr->affinity==OE_Abort
3998 || pExpr->affinity==OE_Fail
3999 || pExpr->affinity==OE_Ignore
4000 );
dane0af83a2009-09-08 19:15:01 +00004001 if( !pParse->pTriggerTab ){
4002 sqlite3ErrorMsg(pParse,
4003 "RAISE() may only be used within a trigger-program");
4004 return 0;
4005 }
4006 if( pExpr->affinity==OE_Abort ){
4007 sqlite3MayAbort(pParse);
4008 }
dan165921a2009-08-28 18:53:45 +00004009 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004010 if( pExpr->affinity==OE_Ignore ){
4011 sqlite3VdbeAddOp4(
4012 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004013 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004014 }else{
drh433dccf2013-02-09 15:37:11 +00004015 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004016 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004017 }
4018
drhffe07b22005-11-03 00:41:17 +00004019 break;
drh17a7f8d2002-03-24 13:13:27 +00004020 }
danielk19775338a5f2005-01-20 13:03:10 +00004021#endif
drhffe07b22005-11-03 00:41:17 +00004022 }
drh2dcef112008-01-12 19:03:48 +00004023 sqlite3ReleaseTempReg(pParse, regFree1);
4024 sqlite3ReleaseTempReg(pParse, regFree2);
4025 return inReg;
4026}
4027
4028/*
drhd1a01ed2013-11-21 16:08:52 +00004029** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004030**
drhad879ff2017-01-04 04:10:02 +00004031** If regDest>=0 then the result is always stored in that register and the
4032** result is not reusable. If regDest<0 then this routine is free to
4033** store the value whereever it wants. The register where the expression
4034** is stored is returned. When regDest<0, two identical expressions will
4035** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004036*/
drh1e9b53f2017-01-04 01:07:24 +00004037int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004038 Parse *pParse, /* Parsing context */
4039 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004040 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004041){
drhd1a01ed2013-11-21 16:08:52 +00004042 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004043 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004044 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004045 if( regDest<0 && p ){
4046 struct ExprList_item *pItem;
4047 int i;
4048 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004049 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004050 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004051 }
4052 }
drh1e9b53f2017-01-04 01:07:24 +00004053 }
drhd1a01ed2013-11-21 16:08:52 +00004054 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4055 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004056 if( p ){
4057 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004058 pItem->reusable = regDest<0;
4059 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004060 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004061 }
drhd1a01ed2013-11-21 16:08:52 +00004062 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004063 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004064}
4065
4066/*
drh2dcef112008-01-12 19:03:48 +00004067** Generate code to evaluate an expression and store the results
4068** into a register. Return the register number where the results
4069** are stored.
4070**
4071** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004072** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004073** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004074**
4075** If pExpr is a constant, then this routine might generate this
4076** code to fill the register in the initialization section of the
4077** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004078*/
4079int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004080 int r2;
4081 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004082 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004083 && pExpr->op!=TK_REGISTER
4084 && sqlite3ExprIsConstantNotJoin(pExpr)
4085 ){
drhf30a9692013-11-15 01:10:18 +00004086 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004087 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004088 }else{
drhf30a9692013-11-15 01:10:18 +00004089 int r1 = sqlite3GetTempReg(pParse);
4090 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4091 if( r2==r1 ){
4092 *pReg = r1;
4093 }else{
4094 sqlite3ReleaseTempReg(pParse, r1);
4095 *pReg = 0;
4096 }
drh2dcef112008-01-12 19:03:48 +00004097 }
4098 return r2;
4099}
4100
4101/*
4102** Generate code that will evaluate expression pExpr and store the
4103** results in register target. The results are guaranteed to appear
4104** in register target.
4105*/
drh05a86c52014-02-16 01:55:49 +00004106void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004107 int inReg;
4108
4109 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004110 if( pExpr && pExpr->op==TK_REGISTER ){
4111 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4112 }else{
4113 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004114 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004115 if( inReg!=target && pParse->pVdbe ){
4116 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4117 }
drhcce7d172000-05-31 15:34:51 +00004118 }
drhcce7d172000-05-31 15:34:51 +00004119}
4120
4121/*
drh1c75c9d2015-12-21 15:22:13 +00004122** Make a transient copy of expression pExpr and then code it using
4123** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4124** except that the input expression is guaranteed to be unchanged.
4125*/
4126void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4127 sqlite3 *db = pParse->db;
4128 pExpr = sqlite3ExprDup(db, pExpr, 0);
4129 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4130 sqlite3ExprDelete(db, pExpr);
4131}
4132
4133/*
drh05a86c52014-02-16 01:55:49 +00004134** Generate code that will evaluate expression pExpr and store the
4135** results in register target. The results are guaranteed to appear
4136** in register target. If the expression is constant, then this routine
4137** might choose to code the expression at initialization time.
4138*/
4139void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004140 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004141 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004142 }else{
4143 sqlite3ExprCode(pParse, pExpr, target);
4144 }
drhcce7d172000-05-31 15:34:51 +00004145}
4146
4147/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004148** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004149** in register target.
drh25303782004-12-07 15:41:48 +00004150**
drh2dcef112008-01-12 19:03:48 +00004151** Also make a copy of the expression results into another "cache" register
4152** and modify the expression so that the next time it is evaluated,
4153** the result is a copy of the cache register.
4154**
4155** This routine is used for expressions that are used multiple
4156** times. They are evaluated once and the results of the expression
4157** are reused.
drh25303782004-12-07 15:41:48 +00004158*/
drh05a86c52014-02-16 01:55:49 +00004159void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004160 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004161 int iMem;
4162
drhde4fcfd2008-01-19 23:50:26 +00004163 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004164 assert( pExpr->op!=TK_REGISTER );
4165 sqlite3ExprCode(pParse, pExpr, target);
4166 iMem = ++pParse->nMem;
4167 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4168 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004169}
drh2dcef112008-01-12 19:03:48 +00004170
drh678ccce2008-03-31 18:19:54 +00004171/*
drh268380c2004-02-25 13:47:31 +00004172** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004173** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004174**
drh3df6c3b2017-09-15 15:38:01 +00004175** Return the number of elements evaluated. The number returned will
4176** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4177** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004178**
4179** The SQLITE_ECEL_DUP flag prevents the arguments from being
4180** filled using OP_SCopy. OP_Copy must be used instead.
4181**
4182** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4183** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004184**
4185** The SQLITE_ECEL_REF flag means that expressions in the list with
4186** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4187** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004188** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4189** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004190*/
danielk19774adee202004-05-08 08:23:19 +00004191int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004192 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004193 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004194 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004195 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004196 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004197){
4198 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004199 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004200 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004201 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004202 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004203 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004204 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004205 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004206 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004207 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004208 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004209#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4210 if( pItem->bSorterRef ){
4211 i--;
4212 n--;
4213 }else
4214#endif
dan257c13f2016-11-10 20:14:06 +00004215 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4216 if( flags & SQLITE_ECEL_OMITREF ){
4217 i--;
4218 n--;
4219 }else{
4220 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4221 }
drhb8b06692018-08-04 15:16:20 +00004222 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4223 && sqlite3ExprIsConstantNotJoin(pExpr)
4224 ){
drhad879ff2017-01-04 04:10:02 +00004225 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004226 }else{
4227 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4228 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004229 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004230 if( copyOp==OP_Copy
4231 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4232 && pOp->p1+pOp->p3+1==inReg
4233 && pOp->p2+pOp->p3+1==target+i
4234 ){
4235 pOp->p3++;
4236 }else{
4237 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4238 }
drhd1a01ed2013-11-21 16:08:52 +00004239 }
drhd1766112008-09-17 00:13:12 +00004240 }
drh268380c2004-02-25 13:47:31 +00004241 }
drhf9b596e2004-05-26 16:54:42 +00004242 return n;
drh268380c2004-02-25 13:47:31 +00004243}
4244
4245/*
drh36c563a2009-11-12 13:32:22 +00004246** Generate code for a BETWEEN operator.
4247**
4248** x BETWEEN y AND z
4249**
4250** The above is equivalent to
4251**
4252** x>=y AND x<=z
4253**
4254** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004255** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004256**
4257** The xJumpIf parameter determines details:
4258**
4259** NULL: Store the boolean result in reg[dest]
4260** sqlite3ExprIfTrue: Jump to dest if true
4261** sqlite3ExprIfFalse: Jump to dest if false
4262**
4263** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004264*/
4265static void exprCodeBetween(
4266 Parse *pParse, /* Parsing and code generating context */
4267 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004268 int dest, /* Jump destination or storage location */
4269 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004270 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4271){
drhdb45bd52016-08-22 00:48:58 +00004272 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004273 Expr compLeft; /* The x>=y term */
4274 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004275 Expr exprX; /* The x subexpression */
4276 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004277
drh36c563a2009-11-12 13:32:22 +00004278
dan71c57db2016-07-09 20:23:55 +00004279 memset(&compLeft, 0, sizeof(Expr));
4280 memset(&compRight, 0, sizeof(Expr));
4281 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004282
4283 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4284 exprX = *pExpr->pLeft;
drh36c563a2009-11-12 13:32:22 +00004285 exprAnd.op = TK_AND;
4286 exprAnd.pLeft = &compLeft;
4287 exprAnd.pRight = &compRight;
4288 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004289 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004290 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4291 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004292 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004293 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004294 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004295 if( xJump ){
4296 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004297 }else{
drh36fd41e2016-11-25 14:30:42 +00004298 /* Mark the expression is being from the ON or USING clause of a join
4299 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4300 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4301 ** for clarity, but we are out of bits in the Expr.flags field so we
4302 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004303 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004304 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004305 }
drhdb45bd52016-08-22 00:48:58 +00004306 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004307
4308 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004309 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4310 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4311 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4312 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4313 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4314 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4315 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4316 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004317 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004318}
4319
4320/*
drhcce7d172000-05-31 15:34:51 +00004321** Generate code for a boolean expression such that a jump is made
4322** to the label "dest" if the expression is true but execution
4323** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004324**
4325** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004326** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004327**
4328** This code depends on the fact that certain token values (ex: TK_EQ)
4329** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4330** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4331** the make process cause these values to align. Assert()s in the code
4332** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004333*/
danielk19774adee202004-05-08 08:23:19 +00004334void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004335 Vdbe *v = pParse->pVdbe;
4336 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004337 int regFree1 = 0;
4338 int regFree2 = 0;
4339 int r1, r2;
4340
drh35573352008-01-08 23:54:25 +00004341 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004342 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004343 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004344 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004345 switch( op ){
drhcce7d172000-05-31 15:34:51 +00004346 case TK_AND: {
danielk19774adee202004-05-08 08:23:19 +00004347 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004348 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004349 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004350 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4351 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004352 break;
4353 }
4354 case TK_OR: {
drhc5499be2008-04-01 15:06:33 +00004355 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004356 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4357 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004358 break;
4359 }
4360 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004361 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004362 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004363 break;
4364 }
drh8abed7b2018-02-26 18:49:05 +00004365 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004366 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4367 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004368 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004369 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004370 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004371 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004372 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004373 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004374 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4375 isNot ? SQLITE_JUMPIFNULL : 0);
4376 }else{
4377 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4378 isNot ? SQLITE_JUMPIFNULL : 0);
4379 }
drh007c8432018-02-26 03:20:18 +00004380 break;
4381 }
drhde845c22016-03-17 19:07:52 +00004382 case TK_IS:
4383 case TK_ISNOT:
4384 testcase( op==TK_IS );
4385 testcase( op==TK_ISNOT );
4386 op = (op==TK_IS) ? TK_EQ : TK_NE;
4387 jumpIfNull = SQLITE_NULLEQ;
4388 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004389 case TK_LT:
4390 case TK_LE:
4391 case TK_GT:
4392 case TK_GE:
4393 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004394 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004395 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004396 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004397 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4398 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004399 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004400 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004401 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4402 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4403 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4404 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004405 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4406 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4407 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4408 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4409 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4410 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004411 testcase( regFree1==0 );
4412 testcase( regFree2==0 );
4413 break;
4414 }
drhcce7d172000-05-31 15:34:51 +00004415 case TK_ISNULL:
4416 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004417 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4418 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004419 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4420 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004421 VdbeCoverageIf(v, op==TK_ISNULL);
4422 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004423 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004424 break;
4425 }
drhfef52082000-06-06 01:50:43 +00004426 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004427 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004428 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004429 break;
4430 }
drh84e30ca2011-02-10 17:46:14 +00004431#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004432 case TK_IN: {
4433 int destIfFalse = sqlite3VdbeMakeLabel(v);
4434 int destIfNull = jumpIfNull ? dest : destIfFalse;
4435 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004436 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004437 sqlite3VdbeResolveLabel(v, destIfFalse);
4438 break;
4439 }
shanehbb201342011-02-09 19:55:20 +00004440#endif
drhcce7d172000-05-31 15:34:51 +00004441 default: {
dan7b35a772016-07-28 19:47:15 +00004442 default_expr:
drh991a1982014-01-02 17:57:16 +00004443 if( exprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004444 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004445 }else if( exprAlwaysFalse(pExpr) ){
4446 /* No-op */
4447 }else{
4448 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4449 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004450 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004451 testcase( regFree1==0 );
4452 testcase( jumpIfNull==0 );
4453 }
drhcce7d172000-05-31 15:34:51 +00004454 break;
4455 }
4456 }
drh2dcef112008-01-12 19:03:48 +00004457 sqlite3ReleaseTempReg(pParse, regFree1);
4458 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004459}
4460
4461/*
drh66b89c82000-11-28 20:47:17 +00004462** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004463** to the label "dest" if the expression is false but execution
4464** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004465**
4466** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004467** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4468** is 0.
drhcce7d172000-05-31 15:34:51 +00004469*/
danielk19774adee202004-05-08 08:23:19 +00004470void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004471 Vdbe *v = pParse->pVdbe;
4472 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004473 int regFree1 = 0;
4474 int regFree2 = 0;
4475 int r1, r2;
4476
drh35573352008-01-08 23:54:25 +00004477 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004478 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004479 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004480
4481 /* The value of pExpr->op and op are related as follows:
4482 **
4483 ** pExpr->op op
4484 ** --------- ----------
4485 ** TK_ISNULL OP_NotNull
4486 ** TK_NOTNULL OP_IsNull
4487 ** TK_NE OP_Eq
4488 ** TK_EQ OP_Ne
4489 ** TK_GT OP_Le
4490 ** TK_LE OP_Gt
4491 ** TK_GE OP_Lt
4492 ** TK_LT OP_Ge
4493 **
4494 ** For other values of pExpr->op, op is undefined and unused.
4495 ** The value of TK_ and OP_ constants are arranged such that we
4496 ** can compute the mapping above using the following expression.
4497 ** Assert()s verify that the computation is correct.
4498 */
4499 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4500
4501 /* Verify correct alignment of TK_ and OP_ constants
4502 */
4503 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4504 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4505 assert( pExpr->op!=TK_NE || op==OP_Eq );
4506 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4507 assert( pExpr->op!=TK_LT || op==OP_Ge );
4508 assert( pExpr->op!=TK_LE || op==OP_Gt );
4509 assert( pExpr->op!=TK_GT || op==OP_Le );
4510 assert( pExpr->op!=TK_GE || op==OP_Lt );
4511
danba00e302016-07-23 20:24:06 +00004512 switch( pExpr->op ){
drhcce7d172000-05-31 15:34:51 +00004513 case TK_AND: {
drhc5499be2008-04-01 15:06:33 +00004514 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004515 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4516 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004517 break;
4518 }
4519 case TK_OR: {
danielk19774adee202004-05-08 08:23:19 +00004520 int d2 = sqlite3VdbeMakeLabel(v);
drhc5499be2008-04-01 15:06:33 +00004521 testcase( jumpIfNull==0 );
drh35573352008-01-08 23:54:25 +00004522 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
danielk19774adee202004-05-08 08:23:19 +00004523 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4524 sqlite3VdbeResolveLabel(v, d2);
drhcce7d172000-05-31 15:34:51 +00004525 break;
4526 }
4527 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004528 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004529 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004530 break;
4531 }
drh8abed7b2018-02-26 18:49:05 +00004532 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004533 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4534 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004535 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004536 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004537 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004538 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004539 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004540 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004541 /* IS TRUE and IS NOT FALSE */
4542 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4543 isNot ? 0 : SQLITE_JUMPIFNULL);
4544
4545 }else{
4546 /* IS FALSE and IS NOT TRUE */
4547 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004548 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004549 }
drh007c8432018-02-26 03:20:18 +00004550 break;
4551 }
drhde845c22016-03-17 19:07:52 +00004552 case TK_IS:
4553 case TK_ISNOT:
4554 testcase( pExpr->op==TK_IS );
4555 testcase( pExpr->op==TK_ISNOT );
4556 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4557 jumpIfNull = SQLITE_NULLEQ;
4558 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004559 case TK_LT:
4560 case TK_LE:
4561 case TK_GT:
4562 case TK_GE:
4563 case TK_NE:
4564 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004565 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004566 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004567 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4568 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004569 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004570 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004571 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4572 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4573 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4574 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004575 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4576 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4577 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4578 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4579 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4580 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004581 testcase( regFree1==0 );
4582 testcase( regFree2==0 );
4583 break;
4584 }
drhcce7d172000-05-31 15:34:51 +00004585 case TK_ISNULL:
4586 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004587 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4588 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004589 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4590 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004591 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004592 break;
4593 }
drhfef52082000-06-06 01:50:43 +00004594 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004595 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004596 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004597 break;
4598 }
drh84e30ca2011-02-10 17:46:14 +00004599#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004600 case TK_IN: {
4601 if( jumpIfNull ){
4602 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4603 }else{
4604 int destIfNull = sqlite3VdbeMakeLabel(v);
4605 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4606 sqlite3VdbeResolveLabel(v, destIfNull);
4607 }
4608 break;
4609 }
shanehbb201342011-02-09 19:55:20 +00004610#endif
drhcce7d172000-05-31 15:34:51 +00004611 default: {
danba00e302016-07-23 20:24:06 +00004612 default_expr:
drh991a1982014-01-02 17:57:16 +00004613 if( exprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004614 sqlite3VdbeGoto(v, dest);
drh991a1982014-01-02 17:57:16 +00004615 }else if( exprAlwaysTrue(pExpr) ){
4616 /* no-op */
4617 }else{
4618 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4619 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004620 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004621 testcase( regFree1==0 );
4622 testcase( jumpIfNull==0 );
4623 }
drhcce7d172000-05-31 15:34:51 +00004624 break;
4625 }
4626 }
drh2dcef112008-01-12 19:03:48 +00004627 sqlite3ReleaseTempReg(pParse, regFree1);
4628 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004629}
drh22827922000-06-06 17:27:05 +00004630
4631/*
drh72bc8202015-06-11 13:58:35 +00004632** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4633** code generation, and that copy is deleted after code generation. This
4634** ensures that the original pExpr is unchanged.
4635*/
4636void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4637 sqlite3 *db = pParse->db;
4638 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4639 if( db->mallocFailed==0 ){
4640 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4641 }
4642 sqlite3ExprDelete(db, pCopy);
4643}
4644
dan5aa550c2017-06-24 18:10:29 +00004645/*
4646** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4647** type of expression.
4648**
4649** If pExpr is a simple SQL value - an integer, real, string, blob
4650** or NULL value - then the VDBE currently being prepared is configured
4651** to re-prepare each time a new value is bound to variable pVar.
4652**
4653** Additionally, if pExpr is a simple SQL value and the value is the
4654** same as that currently bound to variable pVar, non-zero is returned.
4655** Otherwise, if the values are not the same or if pExpr is not a simple
4656** SQL value, zero is returned.
4657*/
4658static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4659 int res = 0;
drhc0804222017-06-28 21:47:16 +00004660 int iVar;
4661 sqlite3_value *pL, *pR = 0;
4662
4663 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4664 if( pR ){
4665 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004666 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004667 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004668 if( pL ){
4669 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4670 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4671 }
4672 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004673 }
drhc0804222017-06-28 21:47:16 +00004674 sqlite3ValueFree(pR);
4675 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004676 }
4677
4678 return res;
4679}
drh72bc8202015-06-11 13:58:35 +00004680
4681/*
drh1d9da702010-01-07 15:17:02 +00004682** Do a deep comparison of two expression trees. Return 0 if the two
4683** expressions are completely identical. Return 1 if they differ only
4684** by a COLLATE operator at the top level. Return 2 if there are differences
4685** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004686**
drh619a1302013-08-01 13:04:46 +00004687** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4688** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4689**
drh66518ca2013-08-01 15:09:57 +00004690** The pA side might be using TK_REGISTER. If that is the case and pB is
4691** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4692**
drh1d9da702010-01-07 15:17:02 +00004693** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004694** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004695** identical, we return 2 just to be safe. So if this routine
4696** returns 2, then you do not really know for certain if the two
4697** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004698** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004699** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004700** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004701** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004702**
drhc0804222017-06-28 21:47:16 +00004703** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4704** pParse->pReprepare can be matched against literals in pB. The
4705** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4706** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4707** Argument pParse should normally be NULL. If it is not NULL and pA or
4708** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004709*/
dan5aa550c2017-06-24 18:10:29 +00004710int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004711 u32 combinedFlags;
4712 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004713 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004714 }
dan5aa550c2017-06-24 18:10:29 +00004715 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4716 return 0;
4717 }
drh10d1edf2013-11-15 15:52:39 +00004718 combinedFlags = pA->flags | pB->flags;
4719 if( combinedFlags & EP_IntValue ){
4720 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4721 return 0;
4722 }
drh1d9da702010-01-07 15:17:02 +00004723 return 2;
drh22827922000-06-06 17:27:05 +00004724 }
drhc2acc4e2013-11-15 18:15:19 +00004725 if( pA->op!=pB->op ){
dan5aa550c2017-06-24 18:10:29 +00004726 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004727 return 1;
4728 }
dan5aa550c2017-06-24 18:10:29 +00004729 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004730 return 1;
4731 }
4732 return 2;
4733 }
drh2edc5fd2015-11-24 02:10:52 +00004734 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004735 if( pA->op==TK_FUNCTION ){
4736 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004737#ifndef SQLITE_OMIT_WINDOWFUNC
4738 /* Justification for the assert():
4739 ** window functions have p->op==TK_FUNCTION but aggregate functions
4740 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4741 ** function and a window function should have failed before reaching
4742 ** this point. And, it is not possible to have a window function and
4743 ** a scalar function with the same name and number of arguments. So
4744 ** if we reach this point, either A and B both window functions or
4745 ** neither are a window functions. */
4746 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4747 if( ExprHasProperty(pA,EP_WinFunc) ){
4748 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4749 }
4750#endif
drhd5af5422018-04-13 14:27:01 +00004751 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004752 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhefad2e22018-07-27 16:57:11 +00004753 }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004754 return 2;
drh2646da72005-12-09 20:02:05 +00004755 }
drh22827922000-06-06 17:27:05 +00004756 }
drh10d1edf2013-11-15 15:52:39 +00004757 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh85f8aa72013-11-15 20:06:26 +00004758 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00004759 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004760 if( (combinedFlags & EP_FixedCol)==0
4761 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004762 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004763 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drhf49ff6f2018-04-23 20:38:40 +00004764 assert( (combinedFlags & EP_Reduced)==0 );
4765 if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
drh10d1edf2013-11-15 15:52:39 +00004766 if( pA->iColumn!=pB->iColumn ) return 2;
4767 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004768 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004769 }
4770 }
drh1d9da702010-01-07 15:17:02 +00004771 return 0;
drh22827922000-06-06 17:27:05 +00004772}
4773
drh8c6f6662010-04-26 19:17:26 +00004774/*
4775** Compare two ExprList objects. Return 0 if they are identical and
4776** non-zero if they differ in any way.
4777**
drh619a1302013-08-01 13:04:46 +00004778** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4779** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4780**
drh8c6f6662010-04-26 19:17:26 +00004781** This routine might return non-zero for equivalent ExprLists. The
4782** only consequence will be disabled optimizations. But this routine
4783** must never return 0 if the two ExprList objects are different, or
4784** a malfunction will result.
4785**
4786** Two NULL pointers are considered to be the same. But a NULL pointer
4787** always differs from a non-NULL pointer.
4788*/
drh619a1302013-08-01 13:04:46 +00004789int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004790 int i;
4791 if( pA==0 && pB==0 ) return 0;
4792 if( pA==0 || pB==0 ) return 1;
4793 if( pA->nExpr!=pB->nExpr ) return 1;
4794 for(i=0; i<pA->nExpr; i++){
4795 Expr *pExprA = pA->a[i].pExpr;
4796 Expr *pExprB = pB->a[i].pExpr;
4797 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004798 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004799 }
4800 return 0;
4801}
drh13449892005-09-07 21:22:45 +00004802
drh22827922000-06-06 17:27:05 +00004803/*
drhf9463df2017-02-11 14:59:58 +00004804** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4805** are ignored.
4806*/
4807int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004808 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004809 sqlite3ExprSkipCollate(pA),
4810 sqlite3ExprSkipCollate(pB),
4811 iTab);
4812}
4813
4814/*
drh4bd5f732013-07-31 23:22:39 +00004815** Return true if we can prove the pE2 will always be true if pE1 is
4816** true. Return false if we cannot complete the proof or if pE2 might
4817** be false. Examples:
4818**
drh619a1302013-08-01 13:04:46 +00004819** pE1: x==5 pE2: x==5 Result: true
4820** pE1: x>0 pE2: x==5 Result: false
4821** pE1: x=21 pE2: x=21 OR y=43 Result: true
4822** pE1: x!=123 pE2: x IS NOT NULL Result: true
4823** pE1: x!=?1 pE2: x IS NOT NULL Result: true
4824** pE1: x IS NULL pE2: x IS NOT NULL Result: false
4825** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00004826**
4827** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
4828** Expr.iTable<0 then assume a table number given by iTab.
4829**
drhc0804222017-06-28 21:47:16 +00004830** If pParse is not NULL, then the values of bound variables in pE1 are
4831** compared against literal values in pE2 and pParse->pVdbe->expmask is
4832** modified to record which bound variables are referenced. If pParse
4833** is NULL, then false will be returned if pE1 contains any bound variables.
4834**
drh4bd5f732013-07-31 23:22:39 +00004835** When in doubt, return false. Returning true might give a performance
4836** improvement. Returning false might cause a performance reduction, but
4837** it will always give the correct answer and is hence always safe.
4838*/
dan5aa550c2017-06-24 18:10:29 +00004839int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
4840 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00004841 return 1;
4842 }
4843 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00004844 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
4845 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00004846 ){
4847 return 1;
4848 }
drh1ad93a02016-11-02 02:17:52 +00004849 if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
4850 Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
4851 testcase( pX!=pE1->pLeft );
dan5aa550c2017-06-24 18:10:29 +00004852 if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
drh619a1302013-08-01 13:04:46 +00004853 }
4854 return 0;
drh4bd5f732013-07-31 23:22:39 +00004855}
4856
4857/*
drh25897872018-03-20 21:16:15 +00004858** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
4859** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00004860** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4861**
4862** This routine controls an optimization. False positives (setting
4863** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4864** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00004865*/
4866static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00004867 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00004868 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00004869 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
4870 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00004871 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00004872 case TK_NOT:
drh25897872018-03-20 21:16:15 +00004873 case TK_ISNULL:
4874 case TK_IS:
4875 case TK_OR:
drh2c492062018-03-24 13:24:02 +00004876 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00004877 case TK_IN:
drh25897872018-03-20 21:16:15 +00004878 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00004879 testcase( pExpr->op==TK_ISNOT );
4880 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00004881 testcase( pExpr->op==TK_ISNULL );
4882 testcase( pExpr->op==TK_IS );
4883 testcase( pExpr->op==TK_OR );
4884 testcase( pExpr->op==TK_CASE );
4885 testcase( pExpr->op==TK_IN );
4886 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00004887 return WRC_Prune;
4888 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00004889 if( pWalker->u.iCur==pExpr->iTable ){
4890 pWalker->eCode = 1;
4891 return WRC_Abort;
4892 }
4893 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00004894
4895 /* Virtual tables are allowed to use constraints like x=NULL. So
4896 ** a term of the form x=y does not prove that y is not null if x
4897 ** is the column of a virtual table */
4898 case TK_EQ:
4899 case TK_NE:
4900 case TK_LT:
4901 case TK_LE:
4902 case TK_GT:
4903 case TK_GE:
4904 testcase( pExpr->op==TK_EQ );
4905 testcase( pExpr->op==TK_NE );
4906 testcase( pExpr->op==TK_LT );
4907 testcase( pExpr->op==TK_LE );
4908 testcase( pExpr->op==TK_GT );
4909 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00004910 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
4911 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00004912 ){
4913 return WRC_Prune;
4914 }
drh25897872018-03-20 21:16:15 +00004915 default:
4916 return WRC_Continue;
4917 }
4918}
4919
4920/*
4921** Return true (non-zero) if expression p can only be true if at least
4922** one column of table iTab is non-null. In other words, return true
4923** if expression p will always be NULL or false if every column of iTab
4924** is NULL.
4925**
drh821b6102018-03-24 18:01:51 +00004926** False negatives are acceptable. In other words, it is ok to return
4927** zero even if expression p will never be true of every column of iTab
4928** is NULL. A false negative is merely a missed optimization opportunity.
4929**
4930** False positives are not allowed, however. A false positive may result
4931** in an incorrect answer.
4932**
drh25897872018-03-20 21:16:15 +00004933** Terms of p that are marked with EP_FromJoin (and hence that come from
4934** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
4935**
4936** This routine is used to check if a LEFT JOIN can be converted into
4937** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
4938** clause requires that some column of the right table of the LEFT JOIN
4939** be non-NULL, then the LEFT JOIN can be safely converted into an
4940** ordinary join.
4941*/
4942int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
4943 Walker w;
4944 w.xExprCallback = impliesNotNullRow;
4945 w.xSelectCallback = 0;
4946 w.xSelectCallback2 = 0;
4947 w.eCode = 0;
4948 w.u.iCur = iTab;
4949 sqlite3WalkExpr(&w, p);
4950 return w.eCode;
4951}
4952
4953/*
drh030796d2012-08-23 16:18:10 +00004954** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00004955** to determine if an expression can be evaluated by reference to the
4956** index only, without having to do a search for the corresponding
4957** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
4958** is the cursor for the table.
4959*/
4960struct IdxCover {
4961 Index *pIdx; /* The index to be tested for coverage */
4962 int iCur; /* Cursor number for the table corresponding to the index */
4963};
4964
4965/*
4966** Check to see if there are references to columns in table
4967** pWalker->u.pIdxCover->iCur can be satisfied using the index
4968** pWalker->u.pIdxCover->pIdx.
4969*/
4970static int exprIdxCover(Walker *pWalker, Expr *pExpr){
4971 if( pExpr->op==TK_COLUMN
4972 && pExpr->iTable==pWalker->u.pIdxCover->iCur
4973 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
4974 ){
4975 pWalker->eCode = 1;
4976 return WRC_Abort;
4977 }
4978 return WRC_Continue;
4979}
4980
4981/*
drhe604ec02016-07-27 19:20:58 +00004982** Determine if an index pIdx on table with cursor iCur contains will
4983** the expression pExpr. Return true if the index does cover the
4984** expression and false if the pExpr expression references table columns
4985** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00004986**
4987** An index covering an expression means that the expression can be
4988** evaluated using only the index and without having to lookup the
4989** corresponding table entry.
4990*/
4991int sqlite3ExprCoveredByIndex(
4992 Expr *pExpr, /* The index to be tested */
4993 int iCur, /* The cursor number for the corresponding table */
4994 Index *pIdx /* The index that might be used for coverage */
4995){
4996 Walker w;
4997 struct IdxCover xcov;
4998 memset(&w, 0, sizeof(w));
4999 xcov.iCur = iCur;
5000 xcov.pIdx = pIdx;
5001 w.xExprCallback = exprIdxCover;
5002 w.u.pIdxCover = &xcov;
5003 sqlite3WalkExpr(&w, pExpr);
5004 return !w.eCode;
5005}
5006
5007
5008/*
5009** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005010** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005011** aggregate function, in order to implement the
5012** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005013*/
drh030796d2012-08-23 16:18:10 +00005014struct SrcCount {
5015 SrcList *pSrc; /* One particular FROM clause in a nested query */
5016 int nThis; /* Number of references to columns in pSrcList */
5017 int nOther; /* Number of references to columns in other FROM clauses */
5018};
5019
5020/*
5021** Count the number of references to columns.
5022*/
5023static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005024 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5025 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5026 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5027 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5028 ** NEVER() will need to be removed. */
5029 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005030 int i;
drh030796d2012-08-23 16:18:10 +00005031 struct SrcCount *p = pWalker->u.pSrcCount;
5032 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005033 int nSrc = pSrc ? pSrc->nSrc : 0;
5034 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005035 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005036 }
drh655814d2015-01-09 01:27:29 +00005037 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005038 p->nThis++;
5039 }else{
5040 p->nOther++;
5041 }
drh374fdce2012-04-17 16:38:53 +00005042 }
drh030796d2012-08-23 16:18:10 +00005043 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005044}
5045
5046/*
drh030796d2012-08-23 16:18:10 +00005047** Determine if any of the arguments to the pExpr Function reference
5048** pSrcList. Return true if they do. Also return true if the function
5049** has no arguments or has only constant arguments. Return false if pExpr
5050** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005051*/
drh030796d2012-08-23 16:18:10 +00005052int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005053 Walker w;
drh030796d2012-08-23 16:18:10 +00005054 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005055 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005056 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005057 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005058 w.u.pSrcCount = &cnt;
5059 cnt.pSrc = pSrcList;
5060 cnt.nThis = 0;
5061 cnt.nOther = 0;
5062 sqlite3WalkExprList(&w, pExpr->x.pList);
5063 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005064}
5065
5066/*
drh13449892005-09-07 21:22:45 +00005067** Add a new element to the pAggInfo->aCol[] array. Return the index of
5068** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005069*/
drh17435752007-08-16 04:30:38 +00005070static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005071 int i;
drhcf643722007-03-27 13:36:37 +00005072 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005073 db,
drhcf643722007-03-27 13:36:37 +00005074 pInfo->aCol,
5075 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005076 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005077 &i
5078 );
drh13449892005-09-07 21:22:45 +00005079 return i;
5080}
5081
5082/*
5083** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5084** the new element. Return a negative number if malloc fails.
5085*/
drh17435752007-08-16 04:30:38 +00005086static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005087 int i;
drhcf643722007-03-27 13:36:37 +00005088 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005089 db,
drhcf643722007-03-27 13:36:37 +00005090 pInfo->aFunc,
5091 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005092 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005093 &i
5094 );
drh13449892005-09-07 21:22:45 +00005095 return i;
5096}
drh22827922000-06-06 17:27:05 +00005097
5098/*
drh7d10d5a2008-08-20 16:35:10 +00005099** This is the xExprCallback for a tree walker. It is used to
5100** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005101** for additional information.
drh22827922000-06-06 17:27:05 +00005102*/
drh7d10d5a2008-08-20 16:35:10 +00005103static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005104 int i;
drh7d10d5a2008-08-20 16:35:10 +00005105 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005106 Parse *pParse = pNC->pParse;
5107 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005108 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005109
drh25c3b8c2018-04-16 10:34:13 +00005110 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005111 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005112 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005113 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005114 testcase( pExpr->op==TK_AGG_COLUMN );
5115 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005116 /* Check to see if the column is in one of the tables in the FROM
5117 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005118 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005119 struct SrcList_item *pItem = pSrcList->a;
5120 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5121 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005122 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005123 if( pExpr->iTable==pItem->iCursor ){
5124 /* If we reach this point, it means that pExpr refers to a table
5125 ** that is in the FROM clause of the aggregate query.
5126 **
5127 ** Make an entry for the column in pAggInfo->aCol[] if there
5128 ** is not an entry there already.
5129 */
drh7f906d62007-03-12 23:48:52 +00005130 int k;
drh13449892005-09-07 21:22:45 +00005131 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005132 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005133 if( pCol->iTable==pExpr->iTable &&
5134 pCol->iColumn==pExpr->iColumn ){
5135 break;
5136 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005137 }
danielk19771e536952007-08-16 10:09:01 +00005138 if( (k>=pAggInfo->nColumn)
5139 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5140 ){
drh7f906d62007-03-12 23:48:52 +00005141 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005142 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005143 pCol->iTable = pExpr->iTable;
5144 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005145 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005146 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005147 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005148 if( pAggInfo->pGroupBy ){
5149 int j, n;
5150 ExprList *pGB = pAggInfo->pGroupBy;
5151 struct ExprList_item *pTerm = pGB->a;
5152 n = pGB->nExpr;
5153 for(j=0; j<n; j++, pTerm++){
5154 Expr *pE = pTerm->pExpr;
5155 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5156 pE->iColumn==pExpr->iColumn ){
5157 pCol->iSorterColumn = j;
5158 break;
5159 }
5160 }
5161 }
5162 if( pCol->iSorterColumn<0 ){
5163 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5164 }
5165 }
5166 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5167 ** because it was there before or because we just created it).
5168 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5169 ** pAggInfo->aCol[] entry.
5170 */
drhebb6a652013-09-12 23:42:22 +00005171 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005172 pExpr->pAggInfo = pAggInfo;
5173 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005174 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005175 break;
5176 } /* endif pExpr->iTable==pItem->iCursor */
5177 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005178 }
drh7d10d5a2008-08-20 16:35:10 +00005179 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005180 }
5181 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005182 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005183 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005184 ){
drh13449892005-09-07 21:22:45 +00005185 /* Check to see if pExpr is a duplicate of another aggregate
5186 ** function that is already in the pAggInfo structure
5187 */
5188 struct AggInfo_func *pItem = pAggInfo->aFunc;
5189 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005190 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005191 break;
5192 }
drh22827922000-06-06 17:27:05 +00005193 }
drh13449892005-09-07 21:22:45 +00005194 if( i>=pAggInfo->nFunc ){
5195 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5196 */
danielk197714db2662006-01-09 16:12:04 +00005197 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005198 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005199 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005200 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005201 pItem = &pAggInfo->aFunc[i];
5202 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005203 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005204 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005205 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005206 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005207 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005208 if( pExpr->flags & EP_Distinct ){
5209 pItem->iDistinct = pParse->nTab++;
5210 }else{
5211 pItem->iDistinct = -1;
5212 }
drh13449892005-09-07 21:22:45 +00005213 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005214 }
drh13449892005-09-07 21:22:45 +00005215 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5216 */
drhc5cd1242013-09-12 16:50:49 +00005217 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005218 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005219 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005220 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005221 return WRC_Prune;
5222 }else{
5223 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005224 }
drh22827922000-06-06 17:27:05 +00005225 }
5226 }
drh7d10d5a2008-08-20 16:35:10 +00005227 return WRC_Continue;
5228}
5229static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005230 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005231 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005232 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005233}
drh979dd1b2017-05-29 14:26:07 +00005234static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5235 UNUSED_PARAMETER(pSelect);
5236 pWalker->walkerDepth--;
5237}
drh626a8792005-01-17 22:08:19 +00005238
5239/*
drhe8abb4c2012-11-02 18:24:57 +00005240** Analyze the pExpr expression looking for aggregate functions and
5241** for variables that need to be added to AggInfo object that pNC->pAggInfo
5242** points to. Additional entries are made on the AggInfo object as
5243** necessary.
drh626a8792005-01-17 22:08:19 +00005244**
5245** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005246** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005247*/
drhd2b3e232008-01-23 14:51:49 +00005248void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005249 Walker w;
5250 w.xExprCallback = analyzeAggregate;
5251 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005252 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5253 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005254 w.u.pNC = pNC;
drh20bc3932009-05-30 23:35:43 +00005255 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005256 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005257}
drh5d9a4af2005-08-30 00:54:01 +00005258
5259/*
5260** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5261** expression list. Return the number of errors.
5262**
5263** If an error is found, the analysis is cut short.
5264*/
drhd2b3e232008-01-23 14:51:49 +00005265void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005266 struct ExprList_item *pItem;
5267 int i;
drh5d9a4af2005-08-30 00:54:01 +00005268 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005269 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5270 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005271 }
5272 }
drh5d9a4af2005-08-30 00:54:01 +00005273}
drh892d3172008-01-10 03:46:36 +00005274
5275/*
drhceea3322009-04-23 13:22:42 +00005276** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005277*/
5278int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005279 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005280 return ++pParse->nMem;
5281 }
danielk19772f425f62008-07-04 09:41:39 +00005282 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005283}
drhceea3322009-04-23 13:22:42 +00005284
5285/*
5286** Deallocate a register, making available for reuse for some other
5287** purpose.
drhceea3322009-04-23 13:22:42 +00005288*/
drh892d3172008-01-10 03:46:36 +00005289void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005290 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005291 pParse->aTempReg[pParse->nTempReg++] = iReg;
5292 }
5293}
5294
5295/*
drhed24da42016-09-06 14:37:05 +00005296** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005297*/
5298int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005299 int i, n;
drhed24da42016-09-06 14:37:05 +00005300 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005301 i = pParse->iRangeReg;
5302 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005303 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005304 pParse->iRangeReg += nReg;
5305 pParse->nRangeReg -= nReg;
5306 }else{
5307 i = pParse->nMem+1;
5308 pParse->nMem += nReg;
5309 }
5310 return i;
5311}
5312void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005313 if( nReg==1 ){
5314 sqlite3ReleaseTempReg(pParse, iReg);
5315 return;
5316 }
drh892d3172008-01-10 03:46:36 +00005317 if( nReg>pParse->nRangeReg ){
5318 pParse->nRangeReg = nReg;
5319 pParse->iRangeReg = iReg;
5320 }
5321}
drhcdc69552011-12-06 13:24:59 +00005322
5323/*
5324** Mark all temporary registers as being unavailable for reuse.
5325*/
5326void sqlite3ClearTempRegCache(Parse *pParse){
5327 pParse->nTempReg = 0;
5328 pParse->nRangeReg = 0;
5329}
drhbb9b5f22016-03-19 00:35:02 +00005330
5331/*
5332** Validate that no temporary register falls within the range of
5333** iFirst..iLast, inclusive. This routine is only call from within assert()
5334** statements.
5335*/
5336#ifdef SQLITE_DEBUG
5337int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5338 int i;
5339 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005340 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5341 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005342 ){
5343 return 0;
5344 }
5345 for(i=0; i<pParse->nTempReg; i++){
5346 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5347 return 0;
5348 }
5349 }
5350 return 1;
5351}
5352#endif /* SQLITE_DEBUG */