blob: 150e34a2c1538f1407b755867fbe1c5b18499028 [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;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
48 assert( pExpr->op==TK_COLLATE );
49 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
drhdb36e252019-10-22 19:51:29 +000073 if( op==TK_VECTOR ){
74 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75 }
drh11949042019-08-05 18:01:42 +000076 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000077}
78
drh53db1452004-05-20 13:54:53 +000079/*
drh8b4c40d2007-02-01 23:02:45 +000080** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000081** sequence named by pToken. Return a pointer to a new Expr node that
82** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000083**
84** If a memory allocation error occurs, that fact is recorded in pParse->db
85** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000086*/
drh4ef7efa2014-03-20 15:14:08 +000087Expr *sqlite3ExprAddCollateToken(
88 Parse *pParse, /* Parsing context */
89 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000090 const Token *pCollName, /* Name of collating sequence */
91 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000092){
drh0a8a4062012-12-07 18:38:16 +000093 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000094 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000095 if( pNew ){
96 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000097 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000098 pExpr = pNew;
99 }
drhae80dde2012-12-06 21:16:43 +0000100 }
drh0a8a4062012-12-07 18:38:16 +0000101 return pExpr;
102}
103Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000104 Token s;
105 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000106 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000107 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000108}
109
110/*
drh0d950af2019-08-22 16:38:42 +0000111** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000112*/
113Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000114 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
115 assert( pExpr->op==TK_COLLATE );
116 pExpr = pExpr->pLeft;
117 }
118 return pExpr;
119}
120
121/*
122** Skip over any TK_COLLATE operators and/or any unlikely()
123** or likelihood() or likely() functions at the root of an
124** expression.
125*/
126Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000127 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000128 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000129 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000131 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000132 pExpr = pExpr->x.pList->a[0].pExpr;
133 }else{
drh0b8d2552015-09-05 22:36:07 +0000134 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000135 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000136 }
drha4c3c872013-09-12 17:29:25 +0000137 }
drh0a8a4062012-12-07 18:38:16 +0000138 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000139}
140
141/*
drhae80dde2012-12-06 21:16:43 +0000142** Return the collation sequence for the expression pExpr. If
143** there is no defined collating sequence, return NULL.
144**
drh70efa842017-09-28 01:58:23 +0000145** See also: sqlite3ExprNNCollSeq()
146**
147** The sqlite3ExprNNCollSeq() works the same exact that it returns the
148** default collation if pExpr has no defined collation.
149**
drhae80dde2012-12-06 21:16:43 +0000150** The collating sequence might be determined by a COLLATE operator
151** or by the presence of a column with a defined collating sequence.
152** COLLATE operators take first precedence. Left operands take
153** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000154*/
danielk19777cedc8d2004-06-10 10:50:08 +0000155CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000156 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000157 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000158 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000159 while( p ){
drhae80dde2012-12-06 21:16:43 +0000160 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_REGISTER ) op = p->op2;
162 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000163 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000164 ){
drheda079c2018-09-20 19:02:15 +0000165 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000166 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000167 int j = p->iColumn;
168 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000169 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000170 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000171 }
172 break;
danielk19770202b292004-06-09 09:55:16 +0000173 }
drhe081d732018-07-27 18:19:12 +0000174 if( op==TK_CAST || op==TK_UPLUS ){
175 p = p->pLeft;
176 continue;
177 }
drh269d3222019-10-23 18:09:39 +0000178 if( op==TK_VECTOR ){
179 p = p->x.pList->a[0].pExpr;
180 continue;
181 }
drhcb0e04f2018-12-12 21:34:17 +0000182 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000183 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
184 break;
185 }
drhae80dde2012-12-06 21:16:43 +0000186 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000187 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000188 p = p->pLeft;
189 }else{
drh2308ed32015-02-09 16:09:34 +0000190 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000191 /* The Expr.x union is never used at the same time as Expr.pRight */
192 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000193 if( p->x.pList!=0
194 && !db->mallocFailed
195 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
196 ){
drh2308ed32015-02-09 16:09:34 +0000197 int i;
drh95768022019-11-10 10:08:03 +0000198 for(i=0; i<p->x.pList->nExpr; i++){
drh2308ed32015-02-09 16:09:34 +0000199 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
200 pNext = p->x.pList->a[i].pExpr;
201 break;
202 }
203 }
204 }
205 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000206 }
207 }else{
drh7d10d5a2008-08-20 16:35:10 +0000208 break;
209 }
danielk19770202b292004-06-09 09:55:16 +0000210 }
danielk19777cedc8d2004-06-10 10:50:08 +0000211 if( sqlite3CheckCollSeq(pParse, pColl) ){
212 pColl = 0;
213 }
214 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000215}
216
217/*
drh70efa842017-09-28 01:58:23 +0000218** Return the collation sequence for the expression pExpr. If
219** there is no defined collating sequence, return a pointer to the
220** defautl collation sequence.
221**
222** See also: sqlite3ExprCollSeq()
223**
224** The sqlite3ExprCollSeq() routine works the same except that it
225** returns NULL if there is no defined collation.
226*/
227CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
228 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
229 if( p==0 ) p = pParse->db->pDfltColl;
230 assert( p!=0 );
231 return p;
232}
233
234/*
235** Return TRUE if the two expressions have equivalent collating sequences.
236*/
237int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
238 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
239 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
240 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
241}
242
243/*
drh626a8792005-01-17 22:08:19 +0000244** pExpr is an operand of a comparison operator. aff2 is the
245** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000246** type affinity that should be used for the comparison operator.
247*/
danielk1977e014a832004-05-17 10:48:57 +0000248char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000249 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000250 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000251 /* Both sides of the comparison are columns. If one has numeric
252 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000253 */
drh8a512562005-11-14 22:29:05 +0000254 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000255 return SQLITE_AFF_NUMERIC;
256 }else{
drh05883a32015-06-02 15:32:08 +0000257 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000258 }
danielk1977e014a832004-05-17 10:48:57 +0000259 }else{
260 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000261 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
262 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
264}
265
drh53db1452004-05-20 13:54:53 +0000266/*
267** pExpr is a comparison operator. Return the type affinity that should
268** be applied to both operands prior to doing the comparison.
269*/
danielk1977e014a832004-05-17 10:48:57 +0000270static char comparisonAffinity(Expr *pExpr){
271 char aff;
272 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000274 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000275 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000276 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000277 if( pExpr->pRight ){
278 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000279 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
280 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000281 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000282 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000283 }
284 return aff;
285}
286
287/*
288** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289** idx_affinity is the affinity of an indexed column. Return true
290** if the index with affinity idx_affinity may be used to implement
291** the comparison in pExpr.
292*/
293int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
294 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000295 if( aff<SQLITE_AFF_TEXT ){
296 return 1;
drh8a512562005-11-14 22:29:05 +0000297 }
drh915e4342019-08-06 15:18:15 +0000298 if( aff==SQLITE_AFF_TEXT ){
299 return idx_affinity==SQLITE_AFF_TEXT;
300 }
301 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000302}
303
danielk1977a37cdde2004-05-16 11:15:36 +0000304/*
drh35573352008-01-08 23:54:25 +0000305** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000306** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000307*/
drh35573352008-01-08 23:54:25 +0000308static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
309 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000310 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000311 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000312}
313
drha2e00042002-01-22 03:13:42 +0000314/*
danielk19770202b292004-06-09 09:55:16 +0000315** Return a pointer to the collation sequence that should be used by
316** a binary comparison operator comparing pLeft and pRight.
317**
318** If the left hand expression has a collating sequence type, then it is
319** used. Otherwise the collation sequence for the right hand expression
320** is used, or the default (BINARY) if neither expression has a collating
321** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000322**
323** Argument pRight (but not pLeft) may be a null pointer. In this case,
324** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000325*/
drh0a0e1312007-08-07 17:04:59 +0000326CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000327 Parse *pParse,
328 Expr *pLeft,
329 Expr *pRight
330){
drhec41dda2007-02-07 13:09:45 +0000331 CollSeq *pColl;
332 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000333 if( pLeft->flags & EP_Collate ){
334 pColl = sqlite3ExprCollSeq(pParse, pLeft);
335 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
336 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000337 }else{
338 pColl = sqlite3ExprCollSeq(pParse, pLeft);
339 if( !pColl ){
340 pColl = sqlite3ExprCollSeq(pParse, pRight);
341 }
danielk19770202b292004-06-09 09:55:16 +0000342 }
343 return pColl;
344}
345
drh898c5272019-10-22 00:03:41 +0000346/* Expresssion p is a comparison operator. Return a collation sequence
347** appropriate for the comparison operator.
348**
349** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
350** However, if the OP_Commuted flag is set, then the order of the operands
351** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
352** correct collating sequence is found.
353*/
354CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
355 if( ExprHasProperty(p, EP_Commuted) ){
356 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
357 }else{
358 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
359 }
360}
361
danielk19770202b292004-06-09 09:55:16 +0000362/*
drhbe5c89a2004-07-26 00:31:09 +0000363** Generate code for a comparison operator.
364*/
365static int codeCompare(
366 Parse *pParse, /* The parsing (and code generating) context */
367 Expr *pLeft, /* The left operand */
368 Expr *pRight, /* The right operand */
369 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000370 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000371 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000372 int jumpIfNull, /* If true, jump if either operand is NULL */
373 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000374){
drh35573352008-01-08 23:54:25 +0000375 int p5;
376 int addr;
377 CollSeq *p4;
378
drh898c5272019-10-22 00:03:41 +0000379 if( isCommuted ){
380 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
381 }else{
382 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
383 }
drh35573352008-01-08 23:54:25 +0000384 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
385 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
386 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000387 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000388 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000389}
390
dancfbb5e82016-07-13 19:48:13 +0000391/*
dan870a0702016-08-01 16:37:43 +0000392** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000393**
394** A vector is defined as any expression that results in two or more
395** columns of result. Every TK_VECTOR node is an vector because the
396** parser will not generate a TK_VECTOR with fewer than two entries.
397** But a TK_SELECT might be either a vector or a scalar. It is only
398** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000399*/
400int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000401 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000402}
403
404/*
dancfbb5e82016-07-13 19:48:13 +0000405** If the expression passed as the only argument is of type TK_VECTOR
406** return the number of expressions in the vector. Or, if the expression
407** is a sub-select, return the number of columns in the sub-select. For
408** any other type of expression, return 1.
409*/
dan71c57db2016-07-09 20:23:55 +0000410int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000411 u8 op = pExpr->op;
412 if( op==TK_REGISTER ) op = pExpr->op2;
413 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000414 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000415 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000416 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000417 }else{
418 return 1;
dan71c57db2016-07-09 20:23:55 +0000419 }
dan71c57db2016-07-09 20:23:55 +0000420}
421
danba00e302016-07-23 20:24:06 +0000422/*
drhfc7f27b2016-08-20 00:07:01 +0000423** Return a pointer to a subexpression of pVector that is the i-th
424** column of the vector (numbered starting with 0). The caller must
425** ensure that i is within range.
426**
drh76dbe7a2016-08-20 21:02:38 +0000427** If pVector is really a scalar (and "scalar" here includes subqueries
428** that return a single column!) then return pVector unmodified.
429**
drhfc7f27b2016-08-20 00:07:01 +0000430** pVector retains ownership of the returned subexpression.
431**
432** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000433** just the expression for the i-th term of the result set, and may
434** not be ready for evaluation because the table cursor has not yet
435** been positioned.
danba00e302016-07-23 20:24:06 +0000436*/
drhfc7f27b2016-08-20 00:07:01 +0000437Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000438 assert( i<sqlite3ExprVectorSize(pVector) );
439 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000440 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
441 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000442 return pVector->x.pSelect->pEList->a[i].pExpr;
443 }else{
444 return pVector->x.pList->a[i].pExpr;
445 }
dan71c57db2016-07-09 20:23:55 +0000446 }
dan870a0702016-08-01 16:37:43 +0000447 return pVector;
dan71c57db2016-07-09 20:23:55 +0000448}
drhfc7f27b2016-08-20 00:07:01 +0000449
drhfc7f27b2016-08-20 00:07:01 +0000450/*
451** Compute and return a new Expr object which when passed to
452** sqlite3ExprCode() will generate all necessary code to compute
453** the iField-th column of the vector expression pVector.
454**
drh8762ec12016-08-20 01:06:22 +0000455** It is ok for pVector to be a scalar (as long as iField==0).
456** In that case, this routine works like sqlite3ExprDup().
457**
drhfc7f27b2016-08-20 00:07:01 +0000458** The caller owns the returned Expr object and is responsible for
459** ensuring that the returned value eventually gets freed.
460**
drh8762ec12016-08-20 01:06:22 +0000461** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000462** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000463** valid for the life of the returned object. If pVector is a TK_VECTOR
464** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000465** returns.
drh8762ec12016-08-20 01:06:22 +0000466**
467** A trick to cause a TK_SELECT pVector to be deleted together with
468** the returned Expr object is to attach the pVector to the pRight field
469** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000470*/
471Expr *sqlite3ExprForVectorField(
472 Parse *pParse, /* Parsing context */
473 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000474 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000475){
476 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000477 if( pVector->op==TK_SELECT ){
478 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000479 /* The TK_SELECT_COLUMN Expr node:
480 **
drh966e2912017-01-03 02:58:01 +0000481 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000482 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000483 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000484 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000485 ** pLeft->iTable: First in an array of register holding result, or 0
486 ** if the result is not yet computed.
487 **
488 ** sqlite3ExprDelete() specifically skips the recursive delete of
489 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000490 ** can be attached to pRight to cause this node to take ownership of
491 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
492 ** with the same pLeft pointer to the pVector, but only one of them
493 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000494 */
drhabfd35e2016-12-06 22:47:23 +0000495 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000496 if( pRet ){
497 pRet->iColumn = iField;
498 pRet->pLeft = pVector;
499 }
drhfc7f27b2016-08-20 00:07:01 +0000500 assert( pRet==0 || pRet->iTable==0 );
501 }else{
drha1251bc2016-08-20 00:51:37 +0000502 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
503 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000504 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000505 }
506 return pRet;
507}
dan71c57db2016-07-09 20:23:55 +0000508
dan5c288b92016-07-30 21:02:33 +0000509/*
510** If expression pExpr is of type TK_SELECT, generate code to evaluate
511** it. Return the register in which the result is stored (or, if the
512** sub-select returns more than one column, the first in an array
513** of registers in which the result is stored).
514**
515** If pExpr is not a TK_SELECT expression, return 0.
516*/
517static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000518 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000519#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000520 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000521 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000522 }
danf9b2e052016-08-02 17:45:00 +0000523#endif
dan8da209b2016-07-26 18:06:08 +0000524 return reg;
525}
526
dan5c288b92016-07-30 21:02:33 +0000527/*
528** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000529** or TK_SELECT that returns more than one column. This function returns
530** the register number of a register that contains the value of
531** element iField of the vector.
532**
533** If pVector is a TK_SELECT expression, then code for it must have
534** already been generated using the exprCodeSubselect() routine. In this
535** case parameter regSelect should be the first in an array of registers
536** containing the results of the sub-select.
537**
538** If pVector is of type TK_VECTOR, then code for the requested field
539** is generated. In this case (*pRegFree) may be set to the number of
540** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000541**
542** Before returning, output parameter (*ppExpr) is set to point to the
543** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000544*/
545static int exprVectorRegister(
546 Parse *pParse, /* Parse context */
547 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000548 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000549 int regSelect, /* First in array of registers */
550 Expr **ppExpr, /* OUT: Expression element */
551 int *pRegFree /* OUT: Temp register to free */
552){
drh12abf402016-08-22 14:30:05 +0000553 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000554 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000555 if( op==TK_REGISTER ){
556 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
557 return pVector->iTable+iField;
558 }
559 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000560 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
561 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000562 }
dan870a0702016-08-01 16:37:43 +0000563 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000564 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
565}
566
567/*
568** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000569** the result of the comparison (1, 0, or NULL) and write that
570** result into register dest.
571**
572** The caller must satisfy the following preconditions:
573**
574** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
575** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
576** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000577*/
drh79752b62016-08-13 10:02:17 +0000578static void codeVectorCompare(
579 Parse *pParse, /* Code generator context */
580 Expr *pExpr, /* The comparison operation */
581 int dest, /* Write results into this register */
582 u8 op, /* Comparison operator */
583 u8 p5 /* SQLITE_NULLEQ or zero */
584){
dan71c57db2016-07-09 20:23:55 +0000585 Vdbe *v = pParse->pVdbe;
586 Expr *pLeft = pExpr->pLeft;
587 Expr *pRight = pExpr->pRight;
588 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000589 int i;
590 int regLeft = 0;
591 int regRight = 0;
592 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000593 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000594 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000595
drh245ce622017-01-01 12:44:07 +0000596 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
597 sqlite3ErrorMsg(pParse, "row value misused");
598 return;
599 }
drhb29e60c2016-09-05 12:02:34 +0000600 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
601 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
602 || pExpr->op==TK_LT || pExpr->op==TK_GT
603 || pExpr->op==TK_LE || pExpr->op==TK_GE
604 );
605 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
606 || (pExpr->op==TK_ISNOT && op==TK_NE) );
607 assert( p5==0 || pExpr->op!=op );
608 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000609
drhb29e60c2016-09-05 12:02:34 +0000610 p5 |= SQLITE_STOREP2;
611 if( opx==TK_LE ) opx = TK_LT;
612 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000613
drhb29e60c2016-09-05 12:02:34 +0000614 regLeft = exprCodeSubselect(pParse, pLeft);
615 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000616
drhb29e60c2016-09-05 12:02:34 +0000617 for(i=0; 1 /*Loop exits by "break"*/; i++){
618 int regFree1 = 0, regFree2 = 0;
619 Expr *pL, *pR;
620 int r1, r2;
621 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000622 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
623 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000624 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000625 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
626 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
627 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
628 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
629 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
630 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
631 sqlite3ReleaseTempReg(pParse, regFree1);
632 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000633 if( i==nLeft-1 ){
634 break;
dan71c57db2016-07-09 20:23:55 +0000635 }
drhb29e60c2016-09-05 12:02:34 +0000636 if( opx==TK_EQ ){
637 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
638 p5 |= SQLITE_KEEPNULL;
639 }else if( opx==TK_NE ){
640 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
641 p5 |= SQLITE_KEEPNULL;
642 }else{
643 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
644 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
645 VdbeCoverageIf(v, op==TK_LT);
646 VdbeCoverageIf(v, op==TK_GT);
647 VdbeCoverageIf(v, op==TK_LE);
648 VdbeCoverageIf(v, op==TK_GE);
649 if( i==nLeft-2 ) opx = op;
650 }
dan71c57db2016-07-09 20:23:55 +0000651 }
drhb29e60c2016-09-05 12:02:34 +0000652 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000653}
654
danielk19774b5255a2008-06-05 16:47:39 +0000655#if SQLITE_MAX_EXPR_DEPTH>0
656/*
657** Check that argument nHeight is less than or equal to the maximum
658** expression depth allowed. If it is not, leave an error message in
659** pParse.
660*/
drh7d10d5a2008-08-20 16:35:10 +0000661int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000662 int rc = SQLITE_OK;
663 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
664 if( nHeight>mxHeight ){
665 sqlite3ErrorMsg(pParse,
666 "Expression tree is too large (maximum depth %d)", mxHeight
667 );
668 rc = SQLITE_ERROR;
669 }
670 return rc;
671}
672
673/* The following three functions, heightOfExpr(), heightOfExprList()
674** and heightOfSelect(), are used to determine the maximum height
675** of any expression tree referenced by the structure passed as the
676** first argument.
677**
678** If this maximum height is greater than the current value pointed
679** to by pnHeight, the second parameter, then set *pnHeight to that
680** value.
681*/
682static void heightOfExpr(Expr *p, int *pnHeight){
683 if( p ){
684 if( p->nHeight>*pnHeight ){
685 *pnHeight = p->nHeight;
686 }
687 }
688}
689static void heightOfExprList(ExprList *p, int *pnHeight){
690 if( p ){
691 int i;
692 for(i=0; i<p->nExpr; i++){
693 heightOfExpr(p->a[i].pExpr, pnHeight);
694 }
695 }
696}
dan1a3a3082018-01-18 19:00:54 +0000697static void heightOfSelect(Select *pSelect, int *pnHeight){
698 Select *p;
699 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000700 heightOfExpr(p->pWhere, pnHeight);
701 heightOfExpr(p->pHaving, pnHeight);
702 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000703 heightOfExprList(p->pEList, pnHeight);
704 heightOfExprList(p->pGroupBy, pnHeight);
705 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000706 }
707}
708
709/*
710** Set the Expr.nHeight variable in the structure passed as an
711** argument. An expression with no children, Expr.pList or
712** Expr.pSelect member has a height of 1. Any other expression
713** has a height equal to the maximum height of any other
714** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000715**
716** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
717** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000718*/
719static void exprSetHeight(Expr *p){
720 int nHeight = 0;
721 heightOfExpr(p->pLeft, &nHeight);
722 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000723 if( ExprHasProperty(p, EP_xIsSelect) ){
724 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000725 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000726 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000727 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000728 }
danielk19774b5255a2008-06-05 16:47:39 +0000729 p->nHeight = nHeight + 1;
730}
731
732/*
733** Set the Expr.nHeight variable using the exprSetHeight() function. If
734** the height is greater than the maximum allowed expression depth,
735** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000736**
737** Also propagate all EP_Propagate flags from the Expr.x.pList into
738** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000739*/
drh2308ed32015-02-09 16:09:34 +0000740void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000741 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000742 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000743 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000744}
745
746/*
747** Return the maximum height of any expression tree referenced
748** by the select statement passed as an argument.
749*/
750int sqlite3SelectExprHeight(Select *p){
751 int nHeight = 0;
752 heightOfSelect(p, &nHeight);
753 return nHeight;
754}
drh2308ed32015-02-09 16:09:34 +0000755#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
756/*
757** Propagate all EP_Propagate flags from the Expr.x.pList into
758** Expr.flags.
759*/
760void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
761 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
762 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
763 }
764}
765#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000766#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
767
drhbe5c89a2004-07-26 00:31:09 +0000768/*
drhb7916a72009-05-27 10:31:29 +0000769** This routine is the core allocator for Expr nodes.
770**
drha76b5df2002-02-23 02:32:10 +0000771** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000772** for this node and for the pToken argument is a single allocation
773** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000774** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000775**
776** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000777** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000778** parameter is ignored if pToken is NULL or if the token does not
779** appear to be quoted. If the quotes were of the form "..." (double-quotes)
780** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000781**
782** Special case: If op==TK_INTEGER and pToken points to a string that
783** can be translated into a 32-bit integer, then the token is not
784** stored in u.zToken. Instead, the integer values is written
785** into u.iValue and the EP_IntValue flag is set. No extra storage
786** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000787*/
drhb7916a72009-05-27 10:31:29 +0000788Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000789 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000790 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000791 const Token *pToken, /* Token argument. Might be NULL */
792 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000793){
drha76b5df2002-02-23 02:32:10 +0000794 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000795 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000796 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000797
drh575fad62016-02-05 13:38:36 +0000798 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000799 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000800 if( op!=TK_INTEGER || pToken->z==0
801 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
802 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000803 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000804 }
drhb7916a72009-05-27 10:31:29 +0000805 }
drh575fad62016-02-05 13:38:36 +0000806 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000807 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000808 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000809 pNew->op = (u8)op;
810 pNew->iAgg = -1;
811 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000812 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000813 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000814 pNew->u.iValue = iValue;
815 }else{
drh33e619f2009-05-28 01:00:55 +0000816 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000817 assert( pToken->z!=0 || pToken->n==0 );
818 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000819 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000820 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000821 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000822 }
drhb7916a72009-05-27 10:31:29 +0000823 }
824 }
825#if SQLITE_MAX_EXPR_DEPTH>0
826 pNew->nHeight = 1;
827#endif
828 }
drha76b5df2002-02-23 02:32:10 +0000829 return pNew;
830}
831
832/*
drhb7916a72009-05-27 10:31:29 +0000833** Allocate a new expression node from a zero-terminated token that has
834** already been dequoted.
835*/
836Expr *sqlite3Expr(
837 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
838 int op, /* Expression opcode */
839 const char *zToken /* Token argument. Might be NULL */
840){
841 Token x;
842 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000843 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000844 return sqlite3ExprAlloc(db, op, &x, 0);
845}
846
847/*
848** Attach subtrees pLeft and pRight to the Expr node pRoot.
849**
850** If pRoot==NULL that means that a memory allocation error has occurred.
851** In that case, delete the subtrees pLeft and pRight.
852*/
853void sqlite3ExprAttachSubtrees(
854 sqlite3 *db,
855 Expr *pRoot,
856 Expr *pLeft,
857 Expr *pRight
858){
859 if( pRoot==0 ){
860 assert( db->mallocFailed );
861 sqlite3ExprDelete(db, pLeft);
862 sqlite3ExprDelete(db, pRight);
863 }else{
864 if( pRight ){
865 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000866 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000867 }
868 if( pLeft ){
869 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000870 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000871 }
872 exprSetHeight(pRoot);
873 }
874}
875
876/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000877** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000878**
drhbf664462009-06-19 18:32:54 +0000879** One or both of the subtrees can be NULL. Return a pointer to the new
880** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
881** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000882*/
drh17435752007-08-16 04:30:38 +0000883Expr *sqlite3PExpr(
884 Parse *pParse, /* Parsing context */
885 int op, /* Expression opcode */
886 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000887 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000888){
drh5fb52ca2012-03-31 02:34:35 +0000889 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000890 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
891 if( p ){
892 memset(p, 0, sizeof(Expr));
893 p->op = op & 0xff;
894 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000895 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000896 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000897 }else{
898 sqlite3ExprDelete(pParse->db, pLeft);
899 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000900 }
drh4e0cff62004-11-05 05:10:28 +0000901 return p;
902}
903
904/*
drh08de4f72016-04-11 01:06:47 +0000905** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
906** do a memory allocation failure) then delete the pSelect object.
907*/
908void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
909 if( pExpr ){
910 pExpr->x.pSelect = pSelect;
911 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
912 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
913 }else{
914 assert( pParse->db->mallocFailed );
915 sqlite3SelectDelete(pParse->db, pSelect);
916 }
917}
918
919
920/*
drh91bb0ee2004-09-01 03:06:34 +0000921** Join two expressions using an AND operator. If either expression is
922** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000923**
924** If one side or the other of the AND is known to be false, then instead
925** of returning an AND expression, just return a constant expression with
926** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000927*/
drhd5c851c2019-04-19 13:38:34 +0000928Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
929 sqlite3 *db = pParse->db;
930 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000931 return pRight;
932 }else if( pRight==0 ){
933 return pLeft;
drhad317272019-04-19 16:21:51 +0000934 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000935 sqlite3ExprUnmapAndDelete(pParse, pLeft);
936 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000937 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000938 }else{
drhd5c851c2019-04-19 13:38:34 +0000939 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000940 }
941}
942
943/*
944** Construct a new expression node for a function with multiple
945** arguments.
946*/
drh954733b2018-07-27 23:33:16 +0000947Expr *sqlite3ExprFunction(
948 Parse *pParse, /* Parsing context */
949 ExprList *pList, /* Argument list */
950 Token *pToken, /* Name of the function */
951 int eDistinct /* SF_Distinct or SF_ALL or 0 */
952){
drha76b5df2002-02-23 02:32:10 +0000953 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000954 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000955 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000956 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000957 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000958 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000959 return 0;
960 }
drh954733b2018-07-27 23:33:16 +0000961 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
962 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
963 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000964 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000965 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000966 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000967 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000968 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000969 return pNew;
970}
971
972/*
drhfa6bc002004-09-07 16:19:52 +0000973** Assign a variable number to an expression that encodes a wildcard
974** in the original SQL statement.
975**
976** Wildcards consisting of a single "?" are assigned the next sequential
977** variable number.
978**
979** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000980** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000981** the SQL statement comes from an external source.
982**
drh51f49f12009-05-21 20:41:32 +0000983** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000984** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000985** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000986** assigned.
987*/
drhde25a882016-10-03 15:28:24 +0000988void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000989 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000990 const char *z;
drhf326d662016-12-23 13:30:53 +0000991 ynVar x;
drh17435752007-08-16 04:30:38 +0000992
drhfa6bc002004-09-07 16:19:52 +0000993 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000994 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000995 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000996 assert( z!=0 );
997 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000998 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000999 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001000 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001001 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001002 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001003 }else{
drhf326d662016-12-23 13:30:53 +00001004 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001005 if( z[0]=='?' ){
1006 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1007 ** use it as the variable number */
1008 i64 i;
drh18814df2017-01-31 03:52:34 +00001009 int bOk;
1010 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1011 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1012 bOk = 1;
1013 }else{
1014 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1015 }
drh124c0b42011-06-01 18:15:55 +00001016 testcase( i==0 );
1017 testcase( i==1 );
1018 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1019 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1020 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1021 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1022 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001023 return;
drhfa6bc002004-09-07 16:19:52 +00001024 }
drh8e74e7b2017-01-31 12:41:48 +00001025 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001026 if( x>pParse->nVar ){
1027 pParse->nVar = (int)x;
1028 doAdd = 1;
1029 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1030 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001031 }
1032 }else{
1033 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1034 ** number as the prior appearance of the same name, or if the name
1035 ** has never appeared before, reuse the same variable number
1036 */
drh9bf755c2016-12-23 03:59:31 +00001037 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1038 if( x==0 ){
1039 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001040 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001041 }
drhfa6bc002004-09-07 16:19:52 +00001042 }
drhf326d662016-12-23 13:30:53 +00001043 if( doAdd ){
1044 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1045 }
1046 }
1047 pExpr->iColumn = x;
1048 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001049 sqlite3ErrorMsg(pParse, "too many SQL variables");
1050 }
drhfa6bc002004-09-07 16:19:52 +00001051}
1052
1053/*
danf6963f92009-11-23 14:39:14 +00001054** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001055*/
drh4f0010b2016-04-11 14:49:39 +00001056static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1057 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001058 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1059 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001060
1061 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1062 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001063 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001064#ifdef SQLITE_DEBUG
1065 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1066 assert( p->pLeft==0 );
1067 assert( p->pRight==0 );
1068 assert( p->x.pSelect==0 );
1069 }
1070#endif
1071 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001072 /* The Expr.x union is never used at the same time as Expr.pRight */
1073 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001074 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001075 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001076 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001077 sqlite3ExprDeleteNN(db, p->pRight);
1078 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001079 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001080 sqlite3SelectDelete(db, p->x.pSelect);
1081 }else{
1082 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001083#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001084 if( ExprHasProperty(p, EP_WinFunc) ){
1085 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001086 }
dan6ba7ab02019-07-02 11:56:47 +00001087#endif
dan8117f112019-07-10 20:16:53 +00001088 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001089 }
drh209bc522016-09-23 21:36:24 +00001090 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001091 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001092 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001093 }
drha2e00042002-01-22 03:13:42 +00001094}
drh4f0010b2016-04-11 14:49:39 +00001095void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1096 if( p ) sqlite3ExprDeleteNN(db, p);
1097}
drha2e00042002-01-22 03:13:42 +00001098
drh8e34e402019-06-11 10:43:56 +00001099/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1100** expression.
1101*/
1102void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1103 if( p ){
1104 if( IN_RENAME_OBJECT ){
1105 sqlite3RenameExprUnmap(pParse, p);
1106 }
1107 sqlite3ExprDeleteNN(pParse->db, p);
1108 }
1109}
1110
drhd2687b72005-08-12 22:56:09 +00001111/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001112** Return the number of bytes allocated for the expression structure
1113** passed as the first argument. This is always one of EXPR_FULLSIZE,
1114** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1115*/
1116static int exprStructSize(Expr *p){
1117 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001118 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1119 return EXPR_FULLSIZE;
1120}
1121
1122/*
drh33e619f2009-05-28 01:00:55 +00001123** The dupedExpr*Size() routines each return the number of bytes required
1124** to store a copy of an expression or expression tree. They differ in
1125** how much of the tree is measured.
1126**
1127** dupedExprStructSize() Size of only the Expr structure
1128** dupedExprNodeSize() Size of Expr + space for token
1129** dupedExprSize() Expr + token + subtree components
1130**
1131***************************************************************************
1132**
1133** The dupedExprStructSize() function returns two values OR-ed together:
1134** (1) the space required for a copy of the Expr structure only and
1135** (2) the EP_xxx flags that indicate what the structure size should be.
1136** The return values is always one of:
1137**
1138** EXPR_FULLSIZE
1139** EXPR_REDUCEDSIZE | EP_Reduced
1140** EXPR_TOKENONLYSIZE | EP_TokenOnly
1141**
1142** The size of the structure can be found by masking the return value
1143** of this routine with 0xfff. The flags can be found by masking the
1144** return value with EP_Reduced|EP_TokenOnly.
1145**
1146** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1147** (unreduced) Expr objects as they or originally constructed by the parser.
1148** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001149** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001150** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001151** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001152** to reduce a pristine expression tree from the parser. The implementation
1153** of dupedExprStructSize() contain multiple assert() statements that attempt
1154** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001155*/
1156static int dupedExprStructSize(Expr *p, int flags){
1157 int nSize;
drh33e619f2009-05-28 01:00:55 +00001158 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001159 assert( EXPR_FULLSIZE<=0xfff );
1160 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001161 if( 0==flags || p->op==TK_SELECT_COLUMN
1162#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001163 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001164#endif
1165 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001166 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001167 }else{
drhc5cd1242013-09-12 16:50:49 +00001168 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001169 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001170 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001171 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001172 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001173 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1174 }else{
drhaecd8022013-09-13 18:15:15 +00001175 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001176 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1177 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001178 }
1179 return nSize;
1180}
1181
1182/*
drh33e619f2009-05-28 01:00:55 +00001183** This function returns the space in bytes required to store the copy
1184** of the Expr structure and a copy of the Expr.u.zToken string (if that
1185** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001186*/
1187static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001188 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1189 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001190 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001191 }
danielk1977bc739712009-03-23 04:33:32 +00001192 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001193}
1194
1195/*
1196** Return the number of bytes required to create a duplicate of the
1197** expression passed as the first argument. The second argument is a
1198** mask containing EXPRDUP_XXX flags.
1199**
1200** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001201** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001202**
1203** If the EXPRDUP_REDUCE flag is set, then the return value includes
1204** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1205** and Expr.pRight variables (but not for any structures pointed to or
1206** descended from the Expr.x.pList or Expr.x.pSelect variables).
1207*/
1208static int dupedExprSize(Expr *p, int flags){
1209 int nByte = 0;
1210 if( p ){
1211 nByte = dupedExprNodeSize(p, flags);
1212 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001213 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001214 }
1215 }
1216 return nByte;
1217}
1218
1219/*
1220** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1221** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001222** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001223** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001224** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001225** portion of the buffer copied into by this function.
1226*/
drh3c194692016-04-11 16:43:43 +00001227static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1228 Expr *pNew; /* Value to return */
1229 u8 *zAlloc; /* Memory space from which to build Expr object */
1230 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1231
drh575fad62016-02-05 13:38:36 +00001232 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001233 assert( p );
1234 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1235 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001236
drh3c194692016-04-11 16:43:43 +00001237 /* Figure out where to write the new Expr structure. */
1238 if( pzBuffer ){
1239 zAlloc = *pzBuffer;
1240 staticFlag = EP_Static;
1241 }else{
1242 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1243 staticFlag = 0;
1244 }
1245 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001246
drh3c194692016-04-11 16:43:43 +00001247 if( pNew ){
1248 /* Set nNewSize to the size allocated for the structure pointed to
1249 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1250 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1251 ** by the copy of the p->u.zToken string (if any).
1252 */
1253 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1254 const int nNewSize = nStructSize & 0xfff;
1255 int nToken;
1256 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1257 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001258 }else{
drh3c194692016-04-11 16:43:43 +00001259 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001260 }
drh3c194692016-04-11 16:43:43 +00001261 if( dupFlags ){
1262 assert( ExprHasProperty(p, EP_Reduced)==0 );
1263 memcpy(zAlloc, p, nNewSize);
1264 }else{
1265 u32 nSize = (u32)exprStructSize(p);
1266 memcpy(zAlloc, p, nSize);
1267 if( nSize<EXPR_FULLSIZE ){
1268 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1269 }
1270 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001271
drh3c194692016-04-11 16:43:43 +00001272 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1273 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1274 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1275 pNew->flags |= staticFlag;
1276
1277 /* Copy the p->u.zToken string, if any. */
1278 if( nToken ){
1279 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1280 memcpy(zToken, p->u.zToken, nToken);
1281 }
1282
drh209bc522016-09-23 21:36:24 +00001283 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001284 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1285 if( ExprHasProperty(p, EP_xIsSelect) ){
1286 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001287 }else{
drh3c194692016-04-11 16:43:43 +00001288 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001289 }
drh3c194692016-04-11 16:43:43 +00001290 }
1291
1292 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001293 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001294 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001295 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001296 pNew->pLeft = p->pLeft ?
1297 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1298 pNew->pRight = p->pRight ?
1299 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001300 }
dan67a9b8e2018-06-22 20:51:35 +00001301#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001302 if( ExprHasProperty(p, EP_WinFunc) ){
1303 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1304 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001305 }
dan67a9b8e2018-06-22 20:51:35 +00001306#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001307 if( pzBuffer ){
1308 *pzBuffer = zAlloc;
1309 }
1310 }else{
drh209bc522016-09-23 21:36:24 +00001311 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001312 if( pNew->op==TK_SELECT_COLUMN ){
1313 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001314 assert( p->iColumn==0 || p->pRight==0 );
1315 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001316 }else{
1317 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1318 }
drh3c194692016-04-11 16:43:43 +00001319 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001320 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001321 }
1322 }
1323 return pNew;
1324}
1325
1326/*
danbfe31e72014-01-15 14:17:31 +00001327** Create and return a deep copy of the object passed as the second
1328** argument. If an OOM condition is encountered, NULL is returned
1329** and the db->mallocFailed flag set.
1330*/
daneede6a52014-01-15 19:42:23 +00001331#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001332static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001333 With *pRet = 0;
1334 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001335 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001336 pRet = sqlite3DbMallocZero(db, nByte);
1337 if( pRet ){
1338 int i;
1339 pRet->nCte = p->nCte;
1340 for(i=0; i<p->nCte; i++){
1341 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1342 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1343 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1344 }
1345 }
1346 }
1347 return pRet;
1348}
daneede6a52014-01-15 19:42:23 +00001349#else
1350# define withDup(x,y) 0
1351#endif
dan4e9119d2014-01-13 15:12:23 +00001352
drha8389972018-12-06 22:04:19 +00001353#ifndef SQLITE_OMIT_WINDOWFUNC
1354/*
1355** The gatherSelectWindows() procedure and its helper routine
1356** gatherSelectWindowsCallback() are used to scan all the expressions
1357** an a newly duplicated SELECT statement and gather all of the Window
1358** objects found there, assembling them onto the linked list at Select->pWin.
1359*/
1360static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001361 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001362 Select *pSelect = pWalker->u.pSelect;
1363 Window *pWin = pExpr->y.pWin;
1364 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001365 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001366 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001367 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001368 }
1369 return WRC_Continue;
1370}
drha37b6a52018-12-06 22:12:18 +00001371static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1372 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1373}
drha8389972018-12-06 22:04:19 +00001374static void gatherSelectWindows(Select *p){
1375 Walker w;
1376 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001377 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1378 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001379 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001380 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001381 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001382}
1383#endif
1384
1385
drha76b5df2002-02-23 02:32:10 +00001386/*
drhff78bd22002-02-27 01:47:11 +00001387** The following group of routines make deep copies of expressions,
1388** expression lists, ID lists, and select statements. The copies can
1389** be deleted (by being passed to their respective ...Delete() routines)
1390** without effecting the originals.
1391**
danielk19774adee202004-05-08 08:23:19 +00001392** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1393** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001394** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001395**
drhad3cab52002-05-24 02:04:32 +00001396** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001397**
drhb7916a72009-05-27 10:31:29 +00001398** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001399** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1400** truncated version of the usual Expr structure that will be stored as
1401** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001402*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001403Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001404 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001405 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001406}
danielk19776ab3a2e2009-02-19 14:39:25 +00001407ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001408 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001409 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001410 int i;
drhb1637482017-01-03 00:27:16 +00001411 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001412 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001413 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001414 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001415 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001416 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001417 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001418 pOldItem = p->a;
1419 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001420 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001421 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001422 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001423 if( pOldExpr
1424 && pOldExpr->op==TK_SELECT_COLUMN
1425 && (pNewExpr = pItem->pExpr)!=0
1426 ){
1427 assert( pNewExpr->iColumn==0 || i>0 );
1428 if( pNewExpr->iColumn==0 ){
1429 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001430 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1431 }else{
1432 assert( i>0 );
1433 assert( pItem[-1].pExpr!=0 );
1434 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1435 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1436 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001437 }
1438 }
drh41cee662019-12-12 20:22:34 +00001439 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001440 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001441 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001442 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001443 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001444 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001445 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001446 }
1447 return pNew;
1448}
danielk197793758c82005-01-21 08:13:14 +00001449
1450/*
1451** If cursors, triggers, views and subqueries are all omitted from
1452** the build, then none of the following routines, except for
1453** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1454** called with a NULL argument.
1455*/
danielk19776a67fe82005-02-04 04:07:16 +00001456#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1457 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001458SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001459 SrcList *pNew;
1460 int i;
drh113088e2003-03-20 01:16:58 +00001461 int nByte;
drh575fad62016-02-05 13:38:36 +00001462 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001463 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001464 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001465 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001466 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001467 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001468 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001469 struct SrcList_item *pNewItem = &pNew->a[i];
1470 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001471 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001472 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001473 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1474 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1475 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001476 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001477 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001478 pNewItem->addrFillSub = pOldItem->addrFillSub;
1479 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001480 if( pNewItem->fg.isIndexedBy ){
1481 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1482 }
1483 pNewItem->pIBIndex = pOldItem->pIBIndex;
1484 if( pNewItem->fg.isTabFunc ){
1485 pNewItem->u1.pFuncArg =
1486 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1487 }
drhed8a3bb2005-06-06 21:19:56 +00001488 pTab = pNewItem->pTab = pOldItem->pTab;
1489 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001490 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001491 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001492 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1493 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001494 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001495 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001496 }
1497 return pNew;
1498}
drh17435752007-08-16 04:30:38 +00001499IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001500 IdList *pNew;
1501 int i;
drh575fad62016-02-05 13:38:36 +00001502 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001503 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001504 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001505 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001506 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001507 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001508 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001509 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001510 return 0;
1511 }
drh6c535152012-02-02 03:38:30 +00001512 /* Note that because the size of the allocation for p->a[] is not
1513 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1514 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001515 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001516 struct IdList_item *pNewItem = &pNew->a[i];
1517 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001518 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001519 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001520 }
1521 return pNew;
1522}
dana7466202017-02-03 14:44:52 +00001523Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1524 Select *pRet = 0;
1525 Select *pNext = 0;
1526 Select **pp = &pRet;
1527 Select *p;
1528
drh575fad62016-02-05 13:38:36 +00001529 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001530 for(p=pDup; p; p=p->pPrior){
1531 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1532 if( pNew==0 ) break;
1533 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1534 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1535 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1536 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1537 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1538 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1539 pNew->op = p->op;
1540 pNew->pNext = pNext;
1541 pNew->pPrior = 0;
1542 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001543 pNew->iLimit = 0;
1544 pNew->iOffset = 0;
1545 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1546 pNew->addrOpenEphm[0] = -1;
1547 pNew->addrOpenEphm[1] = -1;
1548 pNew->nSelectRow = p->nSelectRow;
1549 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001550#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001551 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001552 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001553 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001554#endif
drhfef37762018-07-10 19:48:35 +00001555 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001556 *pp = pNew;
1557 pp = &pNew->pPrior;
1558 pNext = pNew;
1559 }
1560
1561 return pRet;
drhff78bd22002-02-27 01:47:11 +00001562}
danielk197793758c82005-01-21 08:13:14 +00001563#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001564Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001565 assert( p==0 );
1566 return 0;
1567}
1568#endif
drhff78bd22002-02-27 01:47:11 +00001569
1570
1571/*
drha76b5df2002-02-23 02:32:10 +00001572** Add a new element to the end of an expression list. If pList is
1573** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001574**
drha19543f2017-09-15 15:17:48 +00001575** The pList argument must be either NULL or a pointer to an ExprList
1576** obtained from a prior call to sqlite3ExprListAppend(). This routine
1577** may not be used with an ExprList obtained from sqlite3ExprListDup().
1578** Reason: This routine assumes that the number of slots in pList->a[]
1579** is a power of two. That is true for sqlite3ExprListAppend() returns
1580** but is not necessarily true from the return value of sqlite3ExprListDup().
1581**
drhb7916a72009-05-27 10:31:29 +00001582** If a memory allocation error occurs, the entire list is freed and
1583** NULL is returned. If non-NULL is returned, then it is guaranteed
1584** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001585*/
drh17435752007-08-16 04:30:38 +00001586ExprList *sqlite3ExprListAppend(
1587 Parse *pParse, /* Parsing context */
1588 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001589 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001590){
drh43606172017-04-05 11:32:13 +00001591 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001592 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001593 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001594 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001595 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001596 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001597 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001598 }
drhc263f7c2016-01-18 13:18:54 +00001599 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001600 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001601 ExprList *pNew;
1602 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001603 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001604 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001605 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001606 }
drh43606172017-04-05 11:32:13 +00001607 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001608 }
drh43606172017-04-05 11:32:13 +00001609 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001610 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001611 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001612 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001613 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001614 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001615
1616no_mem:
1617 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001618 sqlite3ExprDelete(db, pExpr);
1619 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001620 return 0;
drha76b5df2002-02-23 02:32:10 +00001621}
1622
1623/*
drh8762ec12016-08-20 01:06:22 +00001624** pColumns and pExpr form a vector assignment which is part of the SET
1625** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001626**
1627** (a,b,c) = (expr1,expr2,expr3)
1628** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1629**
1630** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001631** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001632** TK_SELECT_COLUMN expressions.
1633*/
1634ExprList *sqlite3ExprListAppendVector(
1635 Parse *pParse, /* Parsing context */
1636 ExprList *pList, /* List to which to append. Might be NULL */
1637 IdList *pColumns, /* List of names of LHS of the assignment */
1638 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1639){
1640 sqlite3 *db = pParse->db;
1641 int n;
1642 int i;
drh66860af2016-08-23 18:30:10 +00001643 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001644 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1645 ** exit prior to this routine being invoked */
1646 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001647 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001648
1649 /* If the RHS is a vector, then we can immediately check to see that
1650 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1651 ** wildcards ("*") in the result set of the SELECT must be expanded before
1652 ** we can do the size check, so defer the size check until code generation.
1653 */
1654 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001655 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1656 pColumns->nId, n);
1657 goto vector_append_error;
1658 }
drh966e2912017-01-03 02:58:01 +00001659
1660 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001661 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001662 assert( pSubExpr!=0 || db->mallocFailed );
1663 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1664 if( pSubExpr==0 ) continue;
1665 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001666 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1667 if( pList ){
drh66860af2016-08-23 18:30:10 +00001668 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001669 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001670 pColumns->a[i].zName = 0;
1671 }
1672 }
drh966e2912017-01-03 02:58:01 +00001673
drhffe28052017-05-06 18:09:36 +00001674 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001675 Expr *pFirst = pList->a[iFirst].pExpr;
1676 assert( pFirst!=0 );
1677 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001678
drhf4dd26c2017-04-05 11:49:06 +00001679 /* Store the SELECT statement in pRight so it will be deleted when
1680 ** sqlite3ExprListDelete() is called */
1681 pFirst->pRight = pExpr;
1682 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001683
drhf4dd26c2017-04-05 11:49:06 +00001684 /* Remember the size of the LHS in iTable so that we can check that
1685 ** the RHS and LHS sizes match during code generation. */
1686 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001687 }
1688
1689vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001690 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001691 sqlite3IdListDelete(db, pColumns);
1692 return pList;
1693}
1694
1695/*
drhbc622bc2015-08-24 15:39:42 +00001696** Set the sort order for the last element on the given ExprList.
1697*/
dan6e118922019-08-12 16:36:38 +00001698void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001699 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001700 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001701 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001702
1703 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1704 assert( iSortOrder==SQLITE_SO_UNDEFINED
1705 || iSortOrder==SQLITE_SO_ASC
1706 || iSortOrder==SQLITE_SO_DESC
1707 );
1708 assert( eNulls==SQLITE_SO_UNDEFINED
1709 || eNulls==SQLITE_SO_ASC
1710 || eNulls==SQLITE_SO_DESC
1711 );
1712
dan9105fd52019-08-19 17:26:32 +00001713 pItem = &p->a[p->nExpr-1];
1714 assert( pItem->bNulls==0 );
1715 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1716 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001717 }
dan9105fd52019-08-19 17:26:32 +00001718 pItem->sortFlags = (u8)iSortOrder;
1719
1720 if( eNulls!=SQLITE_SO_UNDEFINED ){
1721 pItem->bNulls = 1;
1722 if( iSortOrder!=eNulls ){
1723 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1724 }
drhbc622bc2015-08-24 15:39:42 +00001725 }
drhbc622bc2015-08-24 15:39:42 +00001726}
1727
1728/*
drh41cee662019-12-12 20:22:34 +00001729** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001730** on the expression list.
1731**
1732** pList might be NULL following an OOM error. But pName should never be
1733** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1734** is set.
1735*/
1736void sqlite3ExprListSetName(
1737 Parse *pParse, /* Parsing context */
1738 ExprList *pList, /* List to which to add the span. */
1739 Token *pName, /* Name to be added */
1740 int dequote /* True to cause the name to be dequoted */
1741){
1742 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1743 if( pList ){
1744 struct ExprList_item *pItem;
1745 assert( pList->nExpr>0 );
1746 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001747 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001748 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001749 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1750 if( dequote ) sqlite3Dequote(pItem->zEName);
danc9461ec2018-08-29 21:00:16 +00001751 if( IN_RENAME_OBJECT ){
drh41cee662019-12-12 20:22:34 +00001752 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
dan5be60c52018-08-15 20:28:39 +00001753 }
drhb7916a72009-05-27 10:31:29 +00001754 }
1755}
1756
1757/*
1758** Set the ExprList.a[].zSpan element of the most recently added item
1759** on the expression list.
1760**
1761** pList might be NULL following an OOM error. But pSpan should never be
1762** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1763** is set.
1764*/
1765void sqlite3ExprListSetSpan(
1766 Parse *pParse, /* Parsing context */
1767 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001768 const char *zStart, /* Start of the span */
1769 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001770){
1771 sqlite3 *db = pParse->db;
1772 assert( pList!=0 || db->mallocFailed!=0 );
1773 if( pList ){
1774 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1775 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001776 if( pItem->zEName==0 ){
1777 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1778 pItem->eEName = ENAME_SPAN;
1779 }
drhb7916a72009-05-27 10:31:29 +00001780 }
1781}
1782
1783/*
danielk19777a15a4b2007-05-08 17:54:43 +00001784** If the expression list pEList contains more than iLimit elements,
1785** leave an error message in pParse.
1786*/
1787void sqlite3ExprListCheckLength(
1788 Parse *pParse,
1789 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001790 const char *zObject
1791){
drhb1a6c3c2008-03-20 16:30:17 +00001792 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001793 testcase( pEList && pEList->nExpr==mx );
1794 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001795 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001796 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1797 }
1798}
1799
1800/*
drha76b5df2002-02-23 02:32:10 +00001801** Delete an entire expression list.
1802*/
drhaffa8552016-04-11 18:25:05 +00001803static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001804 int i = pList->nExpr;
1805 struct ExprList_item *pItem = pList->a;
1806 assert( pList->nExpr>0 );
1807 do{
drh633e6d52008-07-28 19:34:53 +00001808 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001809 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001810 pItem++;
1811 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001812 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001813}
drhaffa8552016-04-11 18:25:05 +00001814void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1815 if( pList ) exprListDeleteNN(db, pList);
1816}
drha76b5df2002-02-23 02:32:10 +00001817
1818/*
drh2308ed32015-02-09 16:09:34 +00001819** Return the bitwise-OR of all Expr.flags fields in the given
1820** ExprList.
drh885a5b02015-02-09 15:21:36 +00001821*/
drh2308ed32015-02-09 16:09:34 +00001822u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001823 int i;
drh2308ed32015-02-09 16:09:34 +00001824 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001825 assert( pList!=0 );
1826 for(i=0; i<pList->nExpr; i++){
1827 Expr *pExpr = pList->a[i].pExpr;
1828 assert( pExpr!=0 );
1829 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001830 }
drh2308ed32015-02-09 16:09:34 +00001831 return m;
drh885a5b02015-02-09 15:21:36 +00001832}
1833
1834/*
drh7e6f9802017-09-04 00:33:04 +00001835** This is a SELECT-node callback for the expression walker that
1836** always "fails". By "fail" in this case, we mean set
1837** pWalker->eCode to zero and abort.
1838**
1839** This callback is used by multiple expression walkers.
1840*/
1841int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1842 UNUSED_PARAMETER(NotUsed);
1843 pWalker->eCode = 0;
1844 return WRC_Abort;
1845}
1846
1847/*
drh171d16b2018-02-26 20:15:54 +00001848** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001849** then convert it into an TK_TRUEFALSE term. Return non-zero if
1850** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001851*/
1852int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1853 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001854 if( !ExprHasProperty(pExpr, EP_Quoted)
1855 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1856 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001857 ){
1858 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001859 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001860 return 1;
1861 }
1862 return 0;
1863}
1864
drh43c4ac82018-02-26 21:26:27 +00001865/*
drh96acafb2018-02-27 14:49:25 +00001866** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001867** and 0 if it is FALSE.
1868*/
drh96acafb2018-02-27 14:49:25 +00001869int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001870 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001871 assert( pExpr->op==TK_TRUEFALSE );
1872 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1873 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1874 return pExpr->u.zToken[4]==0;
1875}
1876
drh17180fc2019-04-19 17:26:19 +00001877/*
1878** If pExpr is an AND or OR expression, try to simplify it by eliminating
1879** terms that are always true or false. Return the simplified expression.
1880** Or return the original expression if no simplification is possible.
1881**
1882** Examples:
1883**
1884** (x<10) AND true => (x<10)
1885** (x<10) AND false => false
1886** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1887** (x<10) AND (y=22 OR true) => (x<10)
1888** (y=22) OR true => true
1889*/
1890Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1891 assert( pExpr!=0 );
1892 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1893 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1894 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1895 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1896 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1897 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1898 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1899 }
1900 }
1901 return pExpr;
1902}
1903
drh171d16b2018-02-26 20:15:54 +00001904
1905/*
drh059b2d52014-10-24 19:28:09 +00001906** These routines are Walker callbacks used to check expressions to
1907** see if they are "constant" for some definition of constant. The
1908** Walker.eCode value determines the type of "constant" we are looking
1909** for.
drh73b211a2005-01-18 04:00:42 +00001910**
drh7d10d5a2008-08-20 16:35:10 +00001911** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001912**
drh059b2d52014-10-24 19:28:09 +00001913** sqlite3ExprIsConstant() pWalker->eCode==1
1914** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001915** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001916** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001917**
drh059b2d52014-10-24 19:28:09 +00001918** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1919** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001920**
drhfeada2d2014-09-24 13:20:22 +00001921** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001922** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1923** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001924** parameter raises an error for new statements, but is silently converted
1925** to NULL for existing schemas. This allows sqlite_master tables that
1926** contain a bound parameter because they were generated by older versions
1927** of SQLite to be parsed by newer versions of SQLite without raising a
1928** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001929*/
drh7d10d5a2008-08-20 16:35:10 +00001930static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001931
drh059b2d52014-10-24 19:28:09 +00001932 /* If pWalker->eCode is 2 then any term of the expression that comes from
1933 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001934 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001935 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1936 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001937 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001938 }
1939
drh626a8792005-01-17 22:08:19 +00001940 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001941 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001942 ** and either pWalker->eCode==4 or 5 or the function has the
1943 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001944 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00001945 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
1946 && !ExprHasProperty(pExpr, EP_WinFunc)
1947 ){
drhb1fba282013-11-21 14:33:48 +00001948 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001949 }else{
1950 pWalker->eCode = 0;
1951 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001952 }
drh626a8792005-01-17 22:08:19 +00001953 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001954 /* Convert "true" or "false" in a DEFAULT clause into the
1955 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001956 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001957 return WRC_Prune;
1958 }
1959 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001960 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001961 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001962 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001963 testcase( pExpr->op==TK_ID );
1964 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001965 testcase( pExpr->op==TK_AGG_FUNCTION );
1966 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001967 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001968 return WRC_Continue;
1969 }
drh059b2d52014-10-24 19:28:09 +00001970 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1971 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001972 }
drhf43ce0b2017-05-25 00:08:48 +00001973 /* Fall through */
1974 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001975 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001976 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001977 testcase( pExpr->op==TK_IF_NULL_ROW );
1978 pWalker->eCode = 0;
1979 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001980 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001981 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001982 /* Silently convert bound parameters that appear inside of CREATE
1983 ** statements into a NULL when parsing the CREATE statement text out
1984 ** of the sqlite_master table */
1985 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001986 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001987 /* A bound parameter in a CREATE statement that originates from
1988 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001989 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001990 return WRC_Abort;
1991 }
1992 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001993 default:
drh6e341b92018-04-17 18:50:40 +00001994 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1995 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001996 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001997 }
1998}
drh059b2d52014-10-24 19:28:09 +00001999static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002000 Walker w;
drh059b2d52014-10-24 19:28:09 +00002001 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002002 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002003 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002004#ifdef SQLITE_DEBUG
2005 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2006#endif
drh059b2d52014-10-24 19:28:09 +00002007 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002008 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002009 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002010}
drh626a8792005-01-17 22:08:19 +00002011
2012/*
drh059b2d52014-10-24 19:28:09 +00002013** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002014** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002015**
2016** For the purposes of this function, a double-quoted string (ex: "abc")
2017** is considered a variable but a single-quoted string (ex: 'abc') is
2018** a constant.
drhfef52082000-06-06 01:50:43 +00002019*/
danielk19774adee202004-05-08 08:23:19 +00002020int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002021 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002022}
2023
2024/*
drh07aded62018-07-28 16:24:08 +00002025** Walk an expression tree. Return non-zero if
2026**
2027** (1) the expression is constant, and
2028** (2) the expression does originate in the ON or USING clause
2029** of a LEFT JOIN, and
2030** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2031** operands created by the constant propagation optimization.
2032**
2033** When this routine returns true, it indicates that the expression
2034** can be added to the pParse->pConstExpr list and evaluated once when
2035** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002036*/
2037int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002038 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002039}
2040
2041/*
drhfcb9f4f2015-06-01 18:13:16 +00002042** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002043** for any single row of the table with cursor iCur. In other words, the
2044** expression must not refer to any non-deterministic function nor any
2045** table other than iCur.
2046*/
2047int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2048 return exprIsConst(p, 3, iCur);
2049}
2050
danab31a842017-04-29 20:53:09 +00002051
2052/*
2053** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2054*/
2055static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2056 ExprList *pGroupBy = pWalker->u.pGroupBy;
2057 int i;
2058
2059 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2060 ** it constant. */
2061 for(i=0; i<pGroupBy->nExpr; i++){
2062 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002063 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002064 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002065 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002066 return WRC_Prune;
2067 }
2068 }
2069 }
2070
2071 /* Check if pExpr is a sub-select. If so, consider it variable. */
2072 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2073 pWalker->eCode = 0;
2074 return WRC_Abort;
2075 }
2076
2077 return exprNodeIsConstant(pWalker, pExpr);
2078}
2079
2080/*
2081** Walk the expression tree passed as the first argument. Return non-zero
2082** if the expression consists entirely of constants or copies of terms
2083** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002084**
2085** This routine is used to determine if a term of the HAVING clause can
2086** be promoted into the WHERE clause. In order for such a promotion to work,
2087** the value of the HAVING clause term must be the same for all members of
2088** a "group". The requirement that the GROUP BY term must be BINARY
2089** assumes that no other collating sequence will have a finer-grained
2090** grouping than binary. In other words (A=B COLLATE binary) implies
2091** A=B in every other collating sequence. The requirement that the
2092** GROUP BY be BINARY is stricter than necessary. It would also work
2093** to promote HAVING clauses that use the same alternative collating
2094** sequence as the GROUP BY term, but that is much harder to check,
2095** alternative collating sequences are uncommon, and this is only an
2096** optimization, so we take the easy way out and simply require the
2097** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002098*/
2099int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2100 Walker w;
danab31a842017-04-29 20:53:09 +00002101 w.eCode = 1;
2102 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002103 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002104 w.u.pGroupBy = pGroupBy;
2105 w.pParse = pParse;
2106 sqlite3WalkExpr(&w, p);
2107 return w.eCode;
2108}
2109
drh059b2d52014-10-24 19:28:09 +00002110/*
2111** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002112** or a function call with constant arguments. Return and 0 if there
2113** are any variables.
2114**
2115** For the purposes of this function, a double-quoted string (ex: "abc")
2116** is considered a variable but a single-quoted string (ex: 'abc') is
2117** a constant.
2118*/
drhfeada2d2014-09-24 13:20:22 +00002119int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2120 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002121 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002122}
2123
drh5b88bc42013-12-07 23:35:21 +00002124#ifdef SQLITE_ENABLE_CURSOR_HINTS
2125/*
2126** Walk an expression tree. Return 1 if the expression contains a
2127** subquery of some kind. Return 0 if there are no subqueries.
2128*/
2129int sqlite3ExprContainsSubquery(Expr *p){
2130 Walker w;
drhbec24762015-08-13 20:07:13 +00002131 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002132 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002133 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002134#ifdef SQLITE_DEBUG
2135 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2136#endif
drh5b88bc42013-12-07 23:35:21 +00002137 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002138 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002139}
2140#endif
2141
drheb55bd22005-06-30 17:04:21 +00002142/*
drh73b211a2005-01-18 04:00:42 +00002143** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002144** to fit in a 32-bit integer, return 1 and put the value of the integer
2145** in *pValue. If the expression is not an integer or if it is too big
2146** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002147*/
danielk19774adee202004-05-08 08:23:19 +00002148int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002149 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002150 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002151
2152 /* If an expression is an integer literal that fits in a signed 32-bit
2153 ** integer, then the EP_IntValue flag will have already been set */
2154 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2155 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2156
drh92b01d52008-06-24 00:32:35 +00002157 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002158 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002159 return 1;
2160 }
drhe4de1fe2002-06-02 16:09:01 +00002161 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002162 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002163 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002164 break;
drh4b59ab52002-08-24 18:24:51 +00002165 }
drhe4de1fe2002-06-02 16:09:01 +00002166 case TK_UMINUS: {
2167 int v;
danielk19774adee202004-05-08 08:23:19 +00002168 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002169 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002170 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002171 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002172 }
2173 break;
2174 }
2175 default: break;
2176 }
drh92b01d52008-06-24 00:32:35 +00002177 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002178}
2179
2180/*
drh039fc322009-11-17 18:31:47 +00002181** Return FALSE if there is no chance that the expression can be NULL.
2182**
2183** If the expression might be NULL or if the expression is too complex
2184** to tell return TRUE.
2185**
2186** This routine is used as an optimization, to skip OP_IsNull opcodes
2187** when we know that a value cannot be NULL. Hence, a false positive
2188** (returning TRUE when in fact the expression can never be NULL) might
2189** be a small performance hit but is otherwise harmless. On the other
2190** hand, a false negative (returning FALSE when the result could be NULL)
2191** will likely result in an incorrect answer. So when in doubt, return
2192** TRUE.
2193*/
2194int sqlite3ExprCanBeNull(const Expr *p){
2195 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002196 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2197 p = p->pLeft;
2198 }
drh039fc322009-11-17 18:31:47 +00002199 op = p->op;
2200 if( op==TK_REGISTER ) op = p->op2;
2201 switch( op ){
2202 case TK_INTEGER:
2203 case TK_STRING:
2204 case TK_FLOAT:
2205 case TK_BLOB:
2206 return 0;
drh7248a8b2014-08-04 18:50:54 +00002207 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002208 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002209 p->y.pTab==0 || /* Reference to column of index on expression */
2210 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002211 default:
2212 return 1;
2213 }
2214}
2215
2216/*
2217** Return TRUE if the given expression is a constant which would be
2218** unchanged by OP_Affinity with the affinity given in the second
2219** argument.
2220**
2221** This routine is used to determine if the OP_Affinity operation
2222** can be omitted. When in doubt return FALSE. A false negative
2223** is harmless. A false positive, however, can result in the wrong
2224** answer.
2225*/
2226int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2227 u8 op;
drhaf866402019-08-22 11:11:28 +00002228 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002229 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002230 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2231 if( p->op==TK_UMINUS ) unaryMinus = 1;
2232 p = p->pLeft;
2233 }
drh039fc322009-11-17 18:31:47 +00002234 op = p->op;
2235 if( op==TK_REGISTER ) op = p->op2;
2236 switch( op ){
2237 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002238 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002239 }
2240 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002241 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002242 }
2243 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002244 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002245 }
2246 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002247 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002248 }
drh2f2855b2009-11-18 01:25:26 +00002249 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002250 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002251 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002252 }
drh039fc322009-11-17 18:31:47 +00002253 default: {
2254 return 0;
2255 }
2256 }
2257}
2258
2259/*
drhc4a3c772001-04-04 11:48:57 +00002260** Return TRUE if the given string is a row-id column name.
2261*/
danielk19774adee202004-05-08 08:23:19 +00002262int sqlite3IsRowid(const char *z){
2263 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2264 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2265 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002266 return 0;
2267}
2268
danielk19779a96b662007-11-29 17:05:18 +00002269/*
drh69c355b2016-03-09 15:34:51 +00002270** pX is the RHS of an IN operator. If pX is a SELECT statement
2271** that can be simplified to a direct table access, then return
2272** a pointer to the SELECT statement. If pX is not a SELECT statement,
2273** or if the SELECT statement needs to be manifested into a transient
2274** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002275*/
2276#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002277static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002278 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002279 SrcList *pSrc;
2280 ExprList *pEList;
2281 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002282 int i;
drh69c355b2016-03-09 15:34:51 +00002283 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2284 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2285 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002286 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002287 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002288 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2289 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2290 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002291 }
drhb74b1012009-05-28 21:04:37 +00002292 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002293 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002294 if( p->pWhere ) return 0; /* Has no WHERE clause */
2295 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002296 assert( pSrc!=0 );
2297 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002298 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002299 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002300 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002301 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002302 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2303 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002304 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002305 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002306 for(i=0; i<pEList->nExpr; i++){
2307 Expr *pRes = pEList->a[i].pExpr;
2308 if( pRes->op!=TK_COLUMN ) return 0;
2309 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002310 }
drh69c355b2016-03-09 15:34:51 +00002311 return p;
drhb287f4b2008-04-25 00:08:38 +00002312}
2313#endif /* SQLITE_OMIT_SUBQUERY */
2314
danf9b2e052016-08-02 17:45:00 +00002315#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002316/*
drh4c259e92014-08-01 21:12:35 +00002317** Generate code that checks the left-most column of index table iCur to see if
2318** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002319** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2320** to be set to NULL if iCur contains one or more NULL values.
2321*/
2322static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002323 int addr1;
drh6be515e2014-08-01 21:00:53 +00002324 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002325 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002326 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2327 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002328 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002329 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002330}
danf9b2e052016-08-02 17:45:00 +00002331#endif
drh6be515e2014-08-01 21:00:53 +00002332
drhbb53ecb2014-08-02 21:03:33 +00002333
2334#ifndef SQLITE_OMIT_SUBQUERY
2335/*
2336** The argument is an IN operator with a list (not a subquery) on the
2337** right-hand side. Return TRUE if that list is constant.
2338*/
2339static int sqlite3InRhsIsConstant(Expr *pIn){
2340 Expr *pLHS;
2341 int res;
2342 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2343 pLHS = pIn->pLeft;
2344 pIn->pLeft = 0;
2345 res = sqlite3ExprIsConstant(pIn);
2346 pIn->pLeft = pLHS;
2347 return res;
2348}
2349#endif
2350
drh6be515e2014-08-01 21:00:53 +00002351/*
danielk19779a96b662007-11-29 17:05:18 +00002352** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002353** The pX parameter is the expression on the RHS of the IN operator, which
2354** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002355**
drhd4305ca2012-09-18 17:08:33 +00002356** The job of this routine is to find or create a b-tree object that can
2357** be used either to test for membership in the RHS set or to iterate through
2358** all members of the RHS set, skipping duplicates.
2359**
drh3a856252014-08-01 14:46:57 +00002360** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002361** and pX->iTable is set to the index of that cursor.
2362**
drhb74b1012009-05-28 21:04:37 +00002363** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002364**
drh1ccce442013-03-12 20:38:51 +00002365** IN_INDEX_ROWID - The cursor was opened on a database table.
2366** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2367** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2368** IN_INDEX_EPH - The cursor was opened on a specially created and
2369** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002370** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2371** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002372**
drhd4305ca2012-09-18 17:08:33 +00002373** An existing b-tree might be used if the RHS expression pX is a simple
2374** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002375**
dan553168c2016-08-01 20:14:31 +00002376** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002377**
drhd4305ca2012-09-18 17:08:33 +00002378** If the RHS of the IN operator is a list or a more complex subquery, then
2379** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002380** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002381** existing table.
drhd4305ca2012-09-18 17:08:33 +00002382**
drh7fc0ba02017-11-17 15:02:00 +00002383** The inFlags parameter must contain, at a minimum, one of the bits
2384** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2385** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2386** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2387** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002388**
2389** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2390** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002391** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002392** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2393** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002394**
drh3a856252014-08-01 14:46:57 +00002395** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2396** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002397** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2398** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002399**
drhbb53ecb2014-08-02 21:03:33 +00002400** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2401** if the RHS of the IN operator is a list (not a subquery) then this
2402** routine might decide that creating an ephemeral b-tree for membership
2403** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2404** calling routine should implement the IN operator using a sequence
2405** of Eq or Ne comparison operations.
2406**
drhb74b1012009-05-28 21:04:37 +00002407** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002408** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002409** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002410** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002411** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002412** to *prRhsHasNull. If there is no chance that the (...) contains a
2413** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002414**
drhe21a6e12014-08-01 18:00:24 +00002415** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002416** the value in that register will be NULL if the b-tree contains one or more
2417** NULL values, and it will be some non-NULL value if the b-tree contains no
2418** NULL values.
dan553168c2016-08-01 20:14:31 +00002419**
2420** If the aiMap parameter is not NULL, it must point to an array containing
2421** one element for each column returned by the SELECT statement on the RHS
2422** of the IN(...) operator. The i'th entry of the array is populated with the
2423** offset of the index column that matches the i'th column returned by the
2424** SELECT. For example, if the expression and selected index are:
2425**
2426** (?,?,?) IN (SELECT a, b, c FROM t1)
2427** CREATE INDEX i1 ON t1(b, c, a);
2428**
2429** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002430*/
danielk1977284f4ac2007-12-10 05:03:46 +00002431#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002432int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002433 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002434 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002435 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2436 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002437 int *aiMap, /* Mapping from Index fields to RHS fields */
2438 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002439){
drhb74b1012009-05-28 21:04:37 +00002440 Select *p; /* SELECT to the right of IN operator */
2441 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2442 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002443 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002444 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002445
drh1450bc62009-10-30 13:25:56 +00002446 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002447 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002448
dan7b35a772016-07-28 19:47:15 +00002449 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2450 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002451 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002452 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002453 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002454 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2455 int i;
2456 ExprList *pEList = pX->x.pSelect->pEList;
2457 for(i=0; i<pEList->nExpr; i++){
2458 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2459 }
2460 if( i==pEList->nExpr ){
2461 prRhsHasNull = 0;
2462 }
2463 }
2464
drhb74b1012009-05-28 21:04:37 +00002465 /* Check to see if an existing table or index can be used to
2466 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002467 ** ephemeral table. */
2468 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002469 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002470 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002471 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002472 ExprList *pEList = p->pEList;
2473 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002474
drhb07028f2011-10-14 21:49:18 +00002475 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2476 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2477 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2478 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002479
drhb22f7c82014-02-06 23:56:27 +00002480 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002481 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2482 sqlite3CodeVerifySchema(pParse, iDb);
2483 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002484
drha84a2832016-08-26 21:15:35 +00002485 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002486 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002487 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002488 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002489 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002490
2491 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2492 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002493 ExplainQueryPlan((pParse, 0,
2494 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002495 sqlite3VdbeJumpHere(v, iAddr);
2496 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002497 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002498 int affinity_ok = 1;
2499 int i;
2500
2501 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002502 ** comparison is the same as the affinity of each column in table
2503 ** on the RHS of the IN operator. If it not, it is not possible to
2504 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002505 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002506 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002507 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002508 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002509 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002510 testcase( cmpaff==SQLITE_AFF_BLOB );
2511 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002512 switch( cmpaff ){
2513 case SQLITE_AFF_BLOB:
2514 break;
2515 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002516 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2517 ** other has no affinity and the other side is TEXT. Hence,
2518 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2519 ** and for the term on the LHS of the IN to have no affinity. */
2520 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002521 break;
2522 default:
2523 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2524 }
2525 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002526
drha84a2832016-08-26 21:15:35 +00002527 if( affinity_ok ){
2528 /* Search for an existing index that will work for this IN operator */
2529 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2530 Bitmask colUsed; /* Columns of the index used */
2531 Bitmask mCol; /* Mask for the current column */
2532 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002533 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002534 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2535 ** BITMASK(nExpr) without overflowing */
2536 testcase( pIdx->nColumn==BMS-2 );
2537 testcase( pIdx->nColumn==BMS-1 );
2538 if( pIdx->nColumn>=BMS-1 ) continue;
2539 if( mustBeUnique ){
2540 if( pIdx->nKeyCol>nExpr
2541 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2542 ){
2543 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002544 }
danielk19770cdc0222008-06-26 18:04:03 +00002545 }
drha84a2832016-08-26 21:15:35 +00002546
2547 colUsed = 0; /* Columns of index used so far */
2548 for(i=0; i<nExpr; i++){
2549 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2550 Expr *pRhs = pEList->a[i].pExpr;
2551 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2552 int j;
2553
2554 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2555 for(j=0; j<nExpr; j++){
2556 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2557 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002558 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2559 continue;
2560 }
drha84a2832016-08-26 21:15:35 +00002561 break;
2562 }
2563 if( j==nExpr ) break;
2564 mCol = MASKBIT(j);
2565 if( mCol & colUsed ) break; /* Each column used only once */
2566 colUsed |= mCol;
2567 if( aiMap ) aiMap[i] = j;
2568 }
2569
2570 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2571 if( colUsed==(MASKBIT(nExpr)-1) ){
2572 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002573 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002574 ExplainQueryPlan((pParse, 0,
2575 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002576 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2577 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2578 VdbeComment((v, "%s", pIdx->zName));
2579 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2580 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2581
2582 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002583#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002584 i64 mask = (1<<nExpr)-1;
2585 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2586 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002587#endif
2588 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002589 if( nExpr==1 ){
2590 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2591 }
2592 }
2593 sqlite3VdbeJumpHere(v, iAddr);
2594 }
2595 } /* End loop over indexes */
2596 } /* End if( affinity_ok ) */
2597 } /* End if not an rowid index */
2598 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002599
drhbb53ecb2014-08-02 21:03:33 +00002600 /* If no preexisting index is available for the IN clause
2601 ** and IN_INDEX_NOOP is an allowed reply
2602 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002603 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002604 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002605 ** the IN operator so return IN_INDEX_NOOP.
2606 */
2607 if( eType==0
2608 && (inFlags & IN_INDEX_NOOP_OK)
2609 && !ExprHasProperty(pX, EP_xIsSelect)
2610 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2611 ){
2612 eType = IN_INDEX_NOOP;
2613 }
drhbb53ecb2014-08-02 21:03:33 +00002614
danielk19779a96b662007-11-29 17:05:18 +00002615 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002616 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002617 ** We will have to generate an ephemeral table to do the job.
2618 */
drh8e23daf2013-06-11 13:30:04 +00002619 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002620 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002621 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002622 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002623 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002624 }else if( prRhsHasNull ){
2625 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002626 }
drh85bcdce2018-12-23 21:27:29 +00002627 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002628 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002629 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002630 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002631 }
drhcf4d38a2010-07-28 02:53:36 +00002632 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002633 }
danba00e302016-07-23 20:24:06 +00002634
2635 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2636 int i, n;
2637 n = sqlite3ExprVectorSize(pX->pLeft);
2638 for(i=0; i<n; i++) aiMap[i] = i;
2639 }
drh2c041312018-12-24 02:34:49 +00002640 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002641 return eType;
2642}
danielk1977284f4ac2007-12-10 05:03:46 +00002643#endif
drh626a8792005-01-17 22:08:19 +00002644
danf9b2e052016-08-02 17:45:00 +00002645#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002646/*
2647** Argument pExpr is an (?, ?...) IN(...) expression. This
2648** function allocates and returns a nul-terminated string containing
2649** the affinities to be used for each column of the comparison.
2650**
2651** It is the responsibility of the caller to ensure that the returned
2652** string is eventually freed using sqlite3DbFree().
2653*/
dan71c57db2016-07-09 20:23:55 +00002654static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2655 Expr *pLeft = pExpr->pLeft;
2656 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002657 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002658 char *zRet;
2659
dan553168c2016-08-01 20:14:31 +00002660 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002661 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002662 if( zRet ){
2663 int i;
2664 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002665 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002666 char a = sqlite3ExprAffinity(pA);
2667 if( pSelect ){
2668 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2669 }else{
2670 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002671 }
dan71c57db2016-07-09 20:23:55 +00002672 }
2673 zRet[nVal] = '\0';
2674 }
2675 return zRet;
2676}
danf9b2e052016-08-02 17:45:00 +00002677#endif
dan71c57db2016-07-09 20:23:55 +00002678
dan8da209b2016-07-26 18:06:08 +00002679#ifndef SQLITE_OMIT_SUBQUERY
2680/*
2681** Load the Parse object passed as the first argument with an error
2682** message of the form:
2683**
2684** "sub-select returns N columns - expected M"
2685*/
2686void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2687 const char *zFmt = "sub-select returns %d columns - expected %d";
2688 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2689}
2690#endif
2691
drh626a8792005-01-17 22:08:19 +00002692/*
dan44c56042016-12-07 15:38:37 +00002693** Expression pExpr is a vector that has been used in a context where
2694** it is not permitted. If pExpr is a sub-select vector, this routine
2695** loads the Parse object with a message of the form:
2696**
2697** "sub-select returns N columns - expected 1"
2698**
2699** Or, if it is a regular scalar vector:
2700**
2701** "row value misused"
2702*/
2703void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2704#ifndef SQLITE_OMIT_SUBQUERY
2705 if( pExpr->flags & EP_xIsSelect ){
2706 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2707 }else
2708#endif
2709 {
2710 sqlite3ErrorMsg(pParse, "row value misused");
2711 }
2712}
2713
drh85bcdce2018-12-23 21:27:29 +00002714#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002715/*
drh85bcdce2018-12-23 21:27:29 +00002716** Generate code that will construct an ephemeral table containing all terms
2717** in the RHS of an IN operator. The IN operator can be in either of two
2718** forms:
drh626a8792005-01-17 22:08:19 +00002719**
drh9cbe6352005-11-29 03:13:21 +00002720** x IN (4,5,11) -- IN operator with list on right-hand side
2721** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002722**
drh2c041312018-12-24 02:34:49 +00002723** The pExpr parameter is the IN operator. The cursor number for the
2724** constructed ephermeral table is returned. The first time the ephemeral
2725** table is computed, the cursor number is also stored in pExpr->iTable,
2726** however the cursor number returned might not be the same, as it might
2727** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002728**
drh85bcdce2018-12-23 21:27:29 +00002729** If the LHS expression ("x" in the examples) is a column value, or
2730** the SELECT statement returns a column value, then the affinity of that
2731** column is used to build the index keys. If both 'x' and the
2732** SELECT... statement are columns, then numeric affinity is used
2733** if either column has NUMERIC or INTEGER affinity. If neither
2734** 'x' nor the SELECT... statement are columns, then numeric affinity
2735** is used.
drhcce7d172000-05-31 15:34:51 +00002736*/
drh85bcdce2018-12-23 21:27:29 +00002737void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002738 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002739 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002740 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002741){
drh2c041312018-12-24 02:34:49 +00002742 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002743 int addr; /* Address of OP_OpenEphemeral instruction */
2744 Expr *pLeft; /* the LHS of the IN operator */
2745 KeyInfo *pKeyInfo = 0; /* Key information */
2746 int nVal; /* Size of vector pLeft */
2747 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002748
drh2c041312018-12-24 02:34:49 +00002749 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002750 assert( v!=0 );
2751
drh2c041312018-12-24 02:34:49 +00002752 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002753 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002754 **
2755 ** * The right-hand side is a correlated subquery
2756 ** * The right-hand side is an expression list containing variables
2757 ** * We are inside a trigger
2758 **
drh2c041312018-12-24 02:34:49 +00002759 ** If all of the above are false, then we can compute the RHS just once
2760 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002761 */
drhefb699f2018-12-24 11:55:44 +00002762 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002763 /* Reuse of the RHS is allowed */
2764 /* If this routine has already been coded, but the previous code
2765 ** might not have been invoked yet, so invoke it now as a subroutine.
2766 */
2767 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002768 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002769 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2770 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2771 pExpr->x.pSelect->selId));
2772 }
drh2c041312018-12-24 02:34:49 +00002773 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2774 pExpr->y.sub.iAddr);
2775 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002776 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002777 return;
2778 }
2779
2780 /* Begin coding the subroutine */
2781 ExprSetProperty(pExpr, EP_Subrtn);
2782 pExpr->y.sub.regReturn = ++pParse->nMem;
2783 pExpr->y.sub.iAddr =
2784 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2785 VdbeComment((v, "return address"));
2786
2787 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002788 }
2789
drh85bcdce2018-12-23 21:27:29 +00002790 /* Check to see if this is a vector IN operator */
2791 pLeft = pExpr->pLeft;
2792 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002793
drh85bcdce2018-12-23 21:27:29 +00002794 /* Construct the ephemeral table that will contain the content of
2795 ** RHS of the IN operator.
2796 */
drh2c041312018-12-24 02:34:49 +00002797 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002798 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002799#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2800 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2801 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2802 }else{
2803 VdbeComment((v, "RHS of IN operator"));
2804 }
2805#endif
drh50ef6712019-02-22 23:29:56 +00002806 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002807
drh85bcdce2018-12-23 21:27:29 +00002808 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2809 /* Case 1: expr IN (SELECT ...)
2810 **
2811 ** Generate code to write the results of the select into the temporary
2812 ** table allocated and opened above.
2813 */
2814 Select *pSelect = pExpr->x.pSelect;
2815 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002816
drh2c041312018-12-24 02:34:49 +00002817 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2818 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002819 ));
drh85bcdce2018-12-23 21:27:29 +00002820 /* If the LHS and RHS of the IN operator do not match, that
2821 ** error will have been caught long before we reach this point. */
2822 if( ALWAYS(pEList->nExpr==nVal) ){
2823 SelectDest dest;
2824 int i;
drhbd462bc2018-12-24 20:21:06 +00002825 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002826 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2827 pSelect->iLimit = 0;
2828 testcase( pSelect->selFlags & SF_Distinct );
2829 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2830 if( sqlite3Select(pParse, pSelect, &dest) ){
2831 sqlite3DbFree(pParse->db, dest.zAffSdst);
2832 sqlite3KeyInfoUnref(pKeyInfo);
2833 return;
drhfef52082000-06-06 01:50:43 +00002834 }
drh85bcdce2018-12-23 21:27:29 +00002835 sqlite3DbFree(pParse->db, dest.zAffSdst);
2836 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2837 assert( pEList!=0 );
2838 assert( pEList->nExpr>0 );
2839 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2840 for(i=0; i<nVal; i++){
2841 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2842 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2843 pParse, p, pEList->a[i].pExpr
2844 );
danielk197741a05b72008-10-02 13:50:55 +00002845 }
drh85bcdce2018-12-23 21:27:29 +00002846 }
2847 }else if( ALWAYS(pExpr->x.pList!=0) ){
2848 /* Case 2: expr IN (exprlist)
2849 **
2850 ** For each expression, build an index key from the evaluation and
2851 ** store it in the temporary table. If <expr> is a column, then use
2852 ** that columns affinity when building index keys. If <expr> is not
2853 ** a column, use numeric affinity.
2854 */
2855 char affinity; /* Affinity of the LHS of the IN */
2856 int i;
2857 ExprList *pList = pExpr->x.pList;
2858 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002859 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002860 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002861 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002862 affinity = SQLITE_AFF_BLOB;
2863 }
2864 if( pKeyInfo ){
2865 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2866 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002867 }
2868
drh85bcdce2018-12-23 21:27:29 +00002869 /* Loop through each expression in <exprlist>. */
2870 r1 = sqlite3GetTempReg(pParse);
2871 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002872 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2873 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002874
2875 /* If the expression is not constant then we will need to
2876 ** disable the test that was generated above that makes sure
2877 ** this code only executes once. Because for a non-constant
2878 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002879 */
drh2c041312018-12-24 02:34:49 +00002880 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2881 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002882 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002883 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002884 }
drh1398ad32005-01-19 23:24:50 +00002885
drh85bcdce2018-12-23 21:27:29 +00002886 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002887 sqlite3ExprCode(pParse, pE2, r1);
2888 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2889 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002890 }
drh85bcdce2018-12-23 21:27:29 +00002891 sqlite3ReleaseTempReg(pParse, r1);
2892 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002893 }
drh85bcdce2018-12-23 21:27:29 +00002894 if( pKeyInfo ){
2895 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2896 }
drh2c041312018-12-24 02:34:49 +00002897 if( addrOnce ){
2898 sqlite3VdbeJumpHere(v, addrOnce);
2899 /* Subroutine return */
2900 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2901 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002902 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002903 }
2904}
2905#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002906
drh85bcdce2018-12-23 21:27:29 +00002907/*
2908** Generate code for scalar subqueries used as a subquery expression
2909** or EXISTS operator:
2910**
2911** (SELECT a FROM b) -- subquery
2912** EXISTS (SELECT a FROM b) -- EXISTS subquery
2913**
2914** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2915**
drhd86fe442019-08-26 13:45:49 +00002916** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002917** the result is stored in a contiguous array of registers and the
2918** return value is the register of the left-most result column.
2919** Return 0 if an error occurs.
2920*/
2921#ifndef SQLITE_OMIT_SUBQUERY
2922int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002923 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002924 int rReg = 0; /* Register storing resulting */
2925 Select *pSel; /* SELECT statement to encode */
2926 SelectDest dest; /* How to deal with SELECT result */
2927 int nReg; /* Registers to allocate */
2928 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002929
2930 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002931 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002932 testcase( pExpr->op==TK_EXISTS );
2933 testcase( pExpr->op==TK_SELECT );
2934 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2935 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2936 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002937
drh5198ff52018-12-24 12:09:47 +00002938 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002939 ** is encountered if any of the following is true:
2940 **
2941 ** * The right-hand side is a correlated subquery
2942 ** * The right-hand side is an expression list containing variables
2943 ** * We are inside a trigger
2944 **
2945 ** If all of the above are false, then we can run this code just once
2946 ** save the results, and reuse the same result on subsequent invocations.
2947 */
2948 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002949 /* If this routine has already been coded, then invoke it as a
2950 ** subroutine. */
2951 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002952 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002953 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2954 pExpr->y.sub.iAddr);
2955 return pExpr->iTable;
2956 }
2957
2958 /* Begin coding the subroutine */
2959 ExprSetProperty(pExpr, EP_Subrtn);
2960 pExpr->y.sub.regReturn = ++pParse->nMem;
2961 pExpr->y.sub.iAddr =
2962 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2963 VdbeComment((v, "return address"));
2964
drh2c041312018-12-24 02:34:49 +00002965 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002966 }
drh85bcdce2018-12-23 21:27:29 +00002967
2968 /* For a SELECT, generate code to put the values for all columns of
2969 ** the first row into an array of registers and return the index of
2970 ** the first register.
2971 **
2972 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2973 ** into a register and return that register number.
2974 **
2975 ** In both cases, the query is augmented with "LIMIT 1". Any
2976 ** preexisting limit is discarded in place of the new LIMIT 1.
2977 */
drhbd462bc2018-12-24 20:21:06 +00002978 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2979 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002980 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2981 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2982 pParse->nMem += nReg;
2983 if( pExpr->op==TK_SELECT ){
2984 dest.eDest = SRT_Mem;
2985 dest.iSdst = dest.iSDParm;
2986 dest.nSdst = nReg;
2987 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2988 VdbeComment((v, "Init subquery result"));
2989 }else{
2990 dest.eDest = SRT_Exists;
2991 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2992 VdbeComment((v, "Init EXISTS result"));
2993 }
drh85bcdce2018-12-23 21:27:29 +00002994 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00002995 /* The subquery already has a limit. If the pre-existing limit is X
2996 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
2997 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00002998 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00002999 if( pLimit ){
3000 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3001 pLimit = sqlite3PExpr(pParse, TK_NE,
3002 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3003 }
3004 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003005 pSel->pLimit->pLeft = pLimit;
3006 }else{
drh7ca13472019-09-23 11:55:22 +00003007 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003008 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003009 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3010 }
3011 pSel->iLimit = 0;
3012 if( sqlite3Select(pParse, pSel, &dest) ){
3013 return 0;
3014 }
drh2c041312018-12-24 02:34:49 +00003015 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003016 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003017 if( addrOnce ){
3018 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003019
drh5198ff52018-12-24 12:09:47 +00003020 /* Subroutine return */
3021 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3022 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003023 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003024 }
drh2c041312018-12-24 02:34:49 +00003025
drh1450bc62009-10-30 13:25:56 +00003026 return rReg;
drhcce7d172000-05-31 15:34:51 +00003027}
drh51522cd2005-01-20 13:36:19 +00003028#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003029
drhe3365e62009-11-12 17:52:24 +00003030#ifndef SQLITE_OMIT_SUBQUERY
3031/*
dan7b35a772016-07-28 19:47:15 +00003032** Expr pIn is an IN(...) expression. This function checks that the
3033** sub-select on the RHS of the IN() operator has the same number of
3034** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3035** a sub-query, that the LHS is a vector of size 1.
3036*/
3037int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3038 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3039 if( (pIn->flags & EP_xIsSelect) ){
3040 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3041 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3042 return 1;
3043 }
3044 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003045 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003046 return 1;
3047 }
3048 return 0;
3049}
3050#endif
3051
3052#ifndef SQLITE_OMIT_SUBQUERY
3053/*
drhe3365e62009-11-12 17:52:24 +00003054** Generate code for an IN expression.
3055**
3056** x IN (SELECT ...)
3057** x IN (value, value, ...)
3058**
drhecb87ac2016-08-25 15:46:25 +00003059** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003060** right-hand side (RHS) is an array of zero or more scalar values, or a
3061** subquery. If the RHS is a subquery, the number of result columns must
3062** match the number of columns in the vector on the LHS. If the RHS is
3063** a list of values, the LHS must be a scalar.
3064**
3065** The IN operator is true if the LHS value is contained within the RHS.
3066** The result is false if the LHS is definitely not in the RHS. The
3067** result is NULL if the presence of the LHS in the RHS cannot be
3068** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003069**
drh6be515e2014-08-01 21:00:53 +00003070** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003071** contained within the RHS. If due to NULLs we cannot determine if the LHS
3072** is contained in the RHS then jump to destIfNull. If the LHS is contained
3073** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003074**
3075** See the separate in-operator.md documentation file in the canonical
3076** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003077*/
3078static void sqlite3ExprCodeIN(
3079 Parse *pParse, /* Parsing and code generating context */
3080 Expr *pExpr, /* The IN expression */
3081 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3082 int destIfNull /* Jump here if the results are unknown due to NULLs */
3083){
3084 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003085 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003086 int rLhs; /* Register(s) holding the LHS values */
3087 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003088 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003089 int *aiMap = 0; /* Map from vector field to index column */
3090 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003091 int nVector; /* Size of vectors for this IN operator */
3092 int iDummy; /* Dummy parameter to exprCodeVector() */
3093 Expr *pLeft; /* The LHS of the IN operator */
3094 int i; /* loop counter */
3095 int destStep2; /* Where to jump when NULLs seen in step 2 */
3096 int destStep6 = 0; /* Start of code for Step 6 */
3097 int addrTruthOp; /* Address of opcode that determines the IN is true */
3098 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3099 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003100 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003101
drhe347d3e2016-08-25 21:14:34 +00003102 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003103 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003104 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003105 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3106 aiMap = (int*)sqlite3DbMallocZero(
3107 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3108 );
drhe347d3e2016-08-25 21:14:34 +00003109 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003110
danba00e302016-07-23 20:24:06 +00003111 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003112 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003113 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3114 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003115 v = pParse->pVdbe;
3116 assert( v!=0 ); /* OOM detected prior to this routine */
3117 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003118 eType = sqlite3FindInIndex(pParse, pExpr,
3119 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003120 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3121 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003122
danba00e302016-07-23 20:24:06 +00003123 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3124 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3125 );
drhecb87ac2016-08-25 15:46:25 +00003126#ifdef SQLITE_DEBUG
3127 /* Confirm that aiMap[] contains nVector integer values between 0 and
3128 ** nVector-1. */
3129 for(i=0; i<nVector; i++){
3130 int j, cnt;
3131 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3132 assert( cnt==1 );
3133 }
3134#endif
drhe3365e62009-11-12 17:52:24 +00003135
danba00e302016-07-23 20:24:06 +00003136 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3137 ** vector, then it is stored in an array of nVector registers starting
3138 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003139 **
3140 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3141 ** so that the fields are in the same order as an existing index. The
3142 ** aiMap[] array contains a mapping from the original LHS field order to
3143 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003144 */
drhe347d3e2016-08-25 21:14:34 +00003145 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3146 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003147 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003148 /* LHS fields are not reordered */
3149 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003150 }else{
3151 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003152 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003153 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003154 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003155 }
danba00e302016-07-23 20:24:06 +00003156 }
drhe3365e62009-11-12 17:52:24 +00003157
drhbb53ecb2014-08-02 21:03:33 +00003158 /* If sqlite3FindInIndex() did not find or create an index that is
3159 ** suitable for evaluating the IN operator, then evaluate using a
3160 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003161 **
3162 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003163 */
drhbb53ecb2014-08-02 21:03:33 +00003164 if( eType==IN_INDEX_NOOP ){
3165 ExprList *pList = pExpr->x.pList;
3166 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003167 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003168 int r2, regToFree;
3169 int regCkNull = 0;
3170 int ii;
drhdd668c22019-09-02 02:21:58 +00003171 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003172 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003173 if( destIfNull!=destIfFalse ){
3174 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003175 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003176 }
drhdd668c22019-09-02 02:21:58 +00003177 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003178 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003179 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003180 r2 = regToFree = sqlite3GetTempReg(pParse);
3181 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003182 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003183 }else{
3184 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003185 }
drha9769792014-08-04 16:39:39 +00003186 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003187 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3188 }
3189 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003190 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003191 (void*)pColl, P4_COLLSEQ);
3192 VdbeCoverageIf(v, ii<pList->nExpr-1);
3193 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003194 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003195 }else{
3196 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003197 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003198 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003199 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003200 }
3201 sqlite3ReleaseTempReg(pParse, regToFree);
3202 }
3203 if( regCkNull ){
3204 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003205 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003206 }
3207 sqlite3VdbeResolveLabel(v, labelOk);
3208 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003209 goto sqlite3ExprCodeIN_finished;
3210 }
3211
3212 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3213 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3214 ** We will then skip the binary search of the RHS.
3215 */
3216 if( destIfNull==destIfFalse ){
3217 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003218 }else{
drhec4ccdb2018-12-29 02:26:59 +00003219 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003220 }
3221 for(i=0; i<nVector; i++){
3222 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3223 if( sqlite3ExprCanBeNull(p) ){
3224 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003225 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003226 }
drhe3365e62009-11-12 17:52:24 +00003227 }
drhe347d3e2016-08-25 21:14:34 +00003228
3229 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3230 ** of the RHS using the LHS as a probe. If found, the result is
3231 ** true.
3232 */
3233 if( eType==IN_INDEX_ROWID ){
3234 /* In this case, the RHS is the ROWID of table b-tree and so we also
3235 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3236 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003237 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003238 VdbeCoverage(v);
3239 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3240 }else{
3241 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3242 if( destIfFalse==destIfNull ){
3243 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003244 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003245 rLhs, nVector); VdbeCoverage(v);
3246 goto sqlite3ExprCodeIN_finished;
3247 }
3248 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003249 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003250 rLhs, nVector); VdbeCoverage(v);
3251 }
3252
3253 /* Step 4. If the RHS is known to be non-NULL and we did not find
3254 ** an match on the search above, then the result must be FALSE.
3255 */
3256 if( rRhsHasNull && nVector==1 ){
3257 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3258 VdbeCoverage(v);
3259 }
3260
3261 /* Step 5. If we do not care about the difference between NULL and
3262 ** FALSE, then just return false.
3263 */
3264 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3265
3266 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3267 ** If any comparison is NULL, then the result is NULL. If all
3268 ** comparisons are FALSE then the final result is FALSE.
3269 **
3270 ** For a scalar LHS, it is sufficient to check just the first row
3271 ** of the RHS.
3272 */
3273 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003274 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003275 VdbeCoverage(v);
3276 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003277 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003278 }else{
3279 /* For nVector==1, combine steps 6 and 7 by immediately returning
3280 ** FALSE if the first comparison is not NULL */
3281 destNotNull = destIfFalse;
3282 }
3283 for(i=0; i<nVector; i++){
3284 Expr *p;
3285 CollSeq *pColl;
3286 int r3 = sqlite3GetTempReg(pParse);
3287 p = sqlite3VectorFieldSubexpr(pLeft, i);
3288 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003289 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003290 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3291 (void*)pColl, P4_COLLSEQ);
3292 VdbeCoverage(v);
3293 sqlite3ReleaseTempReg(pParse, r3);
3294 }
3295 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3296 if( nVector>1 ){
3297 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003298 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003299 VdbeCoverage(v);
3300
3301 /* Step 7: If we reach this point, we know that the result must
3302 ** be false. */
3303 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3304 }
3305
3306 /* Jumps here in order to return true. */
3307 sqlite3VdbeJumpHere(v, addrTruthOp);
3308
3309sqlite3ExprCodeIN_finished:
3310 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003311 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003312sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003313 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003314 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003315}
3316#endif /* SQLITE_OMIT_SUBQUERY */
3317
drh13573c72010-01-12 17:04:07 +00003318#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003319/*
3320** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003321** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003322**
3323** The z[] string will probably not be zero-terminated. But the
3324** z[n] character is guaranteed to be something that does not look
3325** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003326*/
drhb7916a72009-05-27 10:31:29 +00003327static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003328 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003329 double value;
drh9339da12010-09-30 00:50:49 +00003330 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003331 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3332 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003333 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003334 }
3335}
drh13573c72010-01-12 17:04:07 +00003336#endif
drh598f1342007-10-23 15:39:45 +00003337
3338
3339/*
drhfec19aa2004-05-19 20:41:03 +00003340** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003341** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003342**
shaneh5f1d6b62010-09-30 16:51:25 +00003343** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003344*/
drh13573c72010-01-12 17:04:07 +00003345static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3346 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003347 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003348 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003349 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003350 if( negFlag ) i = -i;
3351 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003352 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003353 int c;
3354 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003355 const char *z = pExpr->u.zToken;
3356 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003357 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003358 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003359#ifdef SQLITE_OMIT_FLOATING_POINT
3360 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3361#else
drh1b7ddc52014-07-23 14:52:05 +00003362#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003363 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003364 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003365 }else
3366#endif
3367 {
drh9296c182014-07-23 13:40:49 +00003368 codeReal(v, z, negFlag, iMem);
3369 }
drh13573c72010-01-12 17:04:07 +00003370#endif
drh77320ea2016-11-30 14:47:37 +00003371 }else{
drh84d4f1a2017-09-20 10:47:10 +00003372 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003373 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003374 }
drhfec19aa2004-05-19 20:41:03 +00003375 }
3376}
3377
drh5cd79232009-05-25 11:46:29 +00003378
drh1f9ca2c2015-08-25 16:57:52 +00003379/* Generate code that will load into register regOut a value that is
3380** appropriate for the iIdxCol-th column of index pIdx.
3381*/
3382void sqlite3ExprCodeLoadIndexColumn(
3383 Parse *pParse, /* The parsing context */
3384 Index *pIdx, /* The index whose column is to be loaded */
3385 int iTabCur, /* Cursor pointing to a table row */
3386 int iIdxCol, /* The column of the index to be loaded */
3387 int regOut /* Store the index column value in this register */
3388){
3389 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003390 if( iTabCol==XN_EXPR ){
3391 assert( pIdx->aColExpr );
3392 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003393 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003394 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003395 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003396 }else{
drh6df9c4b2019-10-18 12:52:08 +00003397 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003398 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003399 }
drh1f9ca2c2015-08-25 16:57:52 +00003400}
3401
drhe70fa7f2019-10-22 21:01:34 +00003402#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3403/*
3404** Generate code that will compute the value of generated column pCol
3405** and store the result in register regOut
3406*/
3407void sqlite3ExprCodeGeneratedColumn(
3408 Parse *pParse,
3409 Column *pCol,
3410 int regOut
3411){
3412 sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3413 if( pCol->affinity>=SQLITE_AFF_TEXT ){
3414 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Affinity, regOut, 1, 0,
3415 &pCol->affinity, 1);
3416 }
3417}
3418#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3419
drh5cd79232009-05-25 11:46:29 +00003420/*
drh5c092e82010-05-14 19:24:02 +00003421** Generate code to extract the value of the iCol-th column of a table.
3422*/
3423void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003424 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003425 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003426 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003427 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003428 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003429){
drhab45fc02019-10-16 22:01:56 +00003430 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003431 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003432 if( pTab==0 ){
3433 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3434 return;
3435 }
drh5c092e82010-05-14 19:24:02 +00003436 if( iCol<0 || iCol==pTab->iPKey ){
3437 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3438 }else{
drh81f7b372019-10-16 12:18:59 +00003439 int op;
3440 int x;
3441 if( IsVirtual(pTab) ){
3442 op = OP_VColumn;
3443 x = iCol;
3444#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003445 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003446 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003447 if( pCol->colFlags & COLFLAG_BUSY ){
3448 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3449 }else{
3450 int savedSelfTab = pParse->iSelfTab;
3451 pCol->colFlags |= COLFLAG_BUSY;
3452 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003453 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003454 pParse->iSelfTab = savedSelfTab;
3455 pCol->colFlags &= ~COLFLAG_BUSY;
3456 }
drh81f7b372019-10-16 12:18:59 +00003457 return;
3458#endif
3459 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003460 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003461 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003462 op = OP_Column;
3463 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003464 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003465 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003466 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003467 }
3468 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003469 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3470 }
3471}
3472
3473/*
drh945498f2007-02-24 11:52:52 +00003474** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003475** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003476**
3477** There must be an open cursor to pTab in iTable when this routine
3478** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003479*/
drhe55cbd72008-03-31 23:48:03 +00003480int sqlite3ExprCodeGetColumn(
3481 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003482 Table *pTab, /* Description of the table we are reading from */
3483 int iColumn, /* Index of the table column */
3484 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003485 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003486 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003487){
drh81f7b372019-10-16 12:18:59 +00003488 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003489 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003490 if( p5 ){
drh81f7b372019-10-16 12:18:59 +00003491 sqlite3VdbeChangeP5(pParse->pVdbe, p5);
drha748fdc2012-03-28 01:34:47 +00003492 }
drhe55cbd72008-03-31 23:48:03 +00003493 return iReg;
3494}
drhe55cbd72008-03-31 23:48:03 +00003495
3496/*
drhb21e7c72008-06-22 12:37:57 +00003497** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003498** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003499*/
drhb21e7c72008-06-22 12:37:57 +00003500void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003501 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003502 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003503}
3504
drh652fbf52008-04-01 01:42:41 +00003505/*
drh12abf402016-08-22 14:30:05 +00003506** Convert a scalar expression node to a TK_REGISTER referencing
3507** register iReg. The caller must ensure that iReg already contains
3508** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003509*/
dan069d1b12019-06-16 08:58:14 +00003510static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003511 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003512 p->op2 = p->op;
3513 p->op = TK_REGISTER;
3514 p->iTable = iReg;
3515 ExprClearProperty(p, EP_Skip);
3516}
3517
drh12abf402016-08-22 14:30:05 +00003518/*
3519** Evaluate an expression (either a vector or a scalar expression) and store
3520** the result in continguous temporary registers. Return the index of
3521** the first register used to store the result.
3522**
3523** If the returned result register is a temporary scalar, then also write
3524** that register number into *piFreeable. If the returned result register
3525** is not a temporary or if the expression is a vector set *piFreeable
3526** to 0.
3527*/
3528static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3529 int iResult;
3530 int nResult = sqlite3ExprVectorSize(p);
3531 if( nResult==1 ){
3532 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3533 }else{
3534 *piFreeable = 0;
3535 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003536#if SQLITE_OMIT_SUBQUERY
3537 iResult = 0;
3538#else
drh85bcdce2018-12-23 21:27:29 +00003539 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003540#endif
drh12abf402016-08-22 14:30:05 +00003541 }else{
3542 int i;
3543 iResult = pParse->nMem+1;
3544 pParse->nMem += nResult;
3545 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003546 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003547 }
3548 }
3549 }
3550 return iResult;
3551}
3552
dan71c57db2016-07-09 20:23:55 +00003553
drha4c3c872013-09-12 17:29:25 +00003554/*
drhcce7d172000-05-31 15:34:51 +00003555** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003556** expression. Attempt to store the results in register "target".
3557** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003558**
drh8b213892008-08-29 02:14:02 +00003559** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003560** be stored in target. The result might be stored in some other
3561** register if it is convenient to do so. The calling function
3562** must check the return code and move the results to the desired
3563** register.
drhcce7d172000-05-31 15:34:51 +00003564*/
drh678ccce2008-03-31 18:19:54 +00003565int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003566 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3567 int op; /* The opcode being coded */
3568 int inReg = target; /* Results stored in register inReg */
3569 int regFree1 = 0; /* If non-zero free this temporary register */
3570 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003571 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003572 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003573 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003574
drh9cbf3422008-01-17 16:22:13 +00003575 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003576 if( v==0 ){
3577 assert( pParse->db->mallocFailed );
3578 return 0;
3579 }
drh389a1ad2008-01-03 23:44:53 +00003580
drh1efa8022018-04-28 04:16:43 +00003581expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003582 if( pExpr==0 ){
3583 op = TK_NULL;
3584 }else{
3585 op = pExpr->op;
3586 }
drhf2bc0132004-10-04 13:19:23 +00003587 switch( op ){
drh13449892005-09-07 21:22:45 +00003588 case TK_AGG_COLUMN: {
3589 AggInfo *pAggInfo = pExpr->pAggInfo;
3590 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3591 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003592 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003593 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003594 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003595 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003596 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003597 return target;
drh13449892005-09-07 21:22:45 +00003598 }
3599 /* Otherwise, fall thru into the TK_COLUMN case */
3600 }
drh967e8b72000-06-21 13:59:10 +00003601 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003602 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003603 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003604 /* This COLUMN expression is really a constant due to WHERE clause
3605 ** constraints, and that constant is coded by the pExpr->pLeft
3606 ** expresssion. However, make sure the constant has the correct
3607 ** datatype by applying the Affinity of the table column to the
3608 ** constant.
3609 */
3610 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003611 int aff;
3612 if( pExpr->y.pTab ){
3613 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3614 }else{
3615 aff = pExpr->affExpr;
3616 }
drh96fb16e2019-08-06 14:37:24 +00003617 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003618 static const char zAff[] = "B\000C\000D\000E";
3619 assert( SQLITE_AFF_BLOB=='A' );
3620 assert( SQLITE_AFF_TEXT=='B' );
3621 if( iReg!=target ){
3622 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3623 iReg = target;
3624 }
3625 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3626 &zAff[(aff-'B')*2], P4_STATIC);
3627 }
3628 return iReg;
drhefad2e22018-07-27 16:57:11 +00003629 }
drhb2b9d3d2013-08-01 01:14:43 +00003630 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003631 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003632 /* Other columns in the same row for CHECK constraints or
3633 ** generated columns or for inserting into partial index.
3634 ** The row is unpacked into registers beginning at
3635 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3636 ** immediately prior to the first column.
3637 */
3638 Column *pCol;
3639 Table *pTab = pExpr->y.pTab;
3640 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003641 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003642 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003643 assert( iCol>=XN_ROWID );
3644 assert( iCol<pExpr->y.pTab->nCol );
3645 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003646 return -1-pParse->iSelfTab;
3647 }
drhc5f808d2019-10-19 15:01:52 +00003648 pCol = pTab->aCol + iCol;
3649 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3650 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003651#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3652 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003653 if( pCol->colFlags & COLFLAG_BUSY ){
3654 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3655 pCol->zName);
3656 return 0;
3657 }
3658 pCol->colFlags |= COLFLAG_BUSY;
3659 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3660 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3661 }
3662 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003663 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003664 }else
3665#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3666 if( pCol->affinity==SQLITE_AFF_REAL ){
3667 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003668 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3669 return target;
3670 }else{
drh9942ef02019-10-18 02:19:18 +00003671 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003672 }
drhb2b9d3d2013-08-01 01:14:43 +00003673 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003674 /* Coding an expression that is part of an index where column names
3675 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003676 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003677 }
drh22827922000-06-06 17:27:05 +00003678 }
drheda079c2018-09-20 19:02:15 +00003679 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003680 pExpr->iColumn, iTab, target,
3681 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003682 }
3683 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003684 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003685 return target;
drhfec19aa2004-05-19 20:41:03 +00003686 }
drh8abed7b2018-02-26 18:49:05 +00003687 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003688 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003689 return target;
3690 }
drh13573c72010-01-12 17:04:07 +00003691#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003692 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003693 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3694 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003695 return target;
drh598f1342007-10-23 15:39:45 +00003696 }
drh13573c72010-01-12 17:04:07 +00003697#endif
drhfec19aa2004-05-19 20:41:03 +00003698 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003699 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003700 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003701 return target;
drhcce7d172000-05-31 15:34:51 +00003702 }
drhf0863fe2005-06-12 21:35:51 +00003703 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003704 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003705 return target;
drhf0863fe2005-06-12 21:35:51 +00003706 }
danielk19775338a5f2005-01-20 13:03:10 +00003707#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003708 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003709 int n;
3710 const char *z;
drhca48c902008-01-18 14:08:24 +00003711 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003712 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3713 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3714 assert( pExpr->u.zToken[1]=='\'' );
3715 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003716 n = sqlite3Strlen30(z) - 1;
3717 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003718 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3719 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003720 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003721 }
danielk19775338a5f2005-01-20 13:03:10 +00003722#endif
drh50457892003-09-06 01:10:47 +00003723 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003724 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3725 assert( pExpr->u.zToken!=0 );
3726 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003727 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3728 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003729 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003730 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003731 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003732 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003733 }
drhc332cc32016-09-19 10:24:19 +00003734 return target;
drh50457892003-09-06 01:10:47 +00003735 }
drh4e0cff62004-11-05 05:10:28 +00003736 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003737 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003738 }
drh487e2622005-06-25 18:42:14 +00003739#ifndef SQLITE_OMIT_CAST
3740 case TK_CAST: {
3741 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003742 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003743 if( inReg!=target ){
3744 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3745 inReg = target;
3746 }
drh4169e432014-08-25 20:11:52 +00003747 sqlite3VdbeAddOp2(v, OP_Cast, target,
3748 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003749 return inReg;
drh487e2622005-06-25 18:42:14 +00003750 }
3751#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003752 case TK_IS:
3753 case TK_ISNOT:
3754 op = (op==TK_IS) ? TK_EQ : TK_NE;
3755 p5 = SQLITE_NULLEQ;
3756 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003757 case TK_LT:
3758 case TK_LE:
3759 case TK_GT:
3760 case TK_GE:
3761 case TK_NE:
3762 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003763 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003764 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003765 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003766 }else{
3767 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3768 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3769 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00003770 r1, r2, inReg, SQLITE_STOREP2 | p5,
3771 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00003772 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3773 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3774 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3775 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3776 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3777 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3778 testcase( regFree1==0 );
3779 testcase( regFree2==0 );
3780 }
drh6a2fe092009-09-23 02:29:36 +00003781 break;
3782 }
drhcce7d172000-05-31 15:34:51 +00003783 case TK_AND:
3784 case TK_OR:
3785 case TK_PLUS:
3786 case TK_STAR:
3787 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003788 case TK_REM:
3789 case TK_BITAND:
3790 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003791 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003792 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003793 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003794 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003795 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3796 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3797 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3798 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3799 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3800 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3801 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3802 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3803 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3804 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3805 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003806 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3807 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003808 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003809 testcase( regFree1==0 );
3810 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003811 break;
3812 }
drhcce7d172000-05-31 15:34:51 +00003813 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003814 Expr *pLeft = pExpr->pLeft;
3815 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003816 if( pLeft->op==TK_INTEGER ){
3817 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003818 return target;
drh13573c72010-01-12 17:04:07 +00003819#ifndef SQLITE_OMIT_FLOATING_POINT
3820 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003821 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3822 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003823 return target;
drh13573c72010-01-12 17:04:07 +00003824#endif
drh3c84ddf2008-01-09 02:15:38 +00003825 }else{
drh10d1edf2013-11-15 15:52:39 +00003826 tempX.op = TK_INTEGER;
3827 tempX.flags = EP_IntValue|EP_TokenOnly;
3828 tempX.u.iValue = 0;
3829 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003830 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003831 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003832 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003833 }
drh3c84ddf2008-01-09 02:15:38 +00003834 break;
drh6e142f52000-06-08 13:36:40 +00003835 }
drhbf4133c2001-10-13 02:59:08 +00003836 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003837 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003838 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3839 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003840 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3841 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003842 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003843 break;
3844 }
drh8abed7b2018-02-26 18:49:05 +00003845 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003846 int isTrue; /* IS TRUE or IS NOT TRUE */
3847 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003848 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3849 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003850 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3851 bNormal = pExpr->op2==TK_IS;
3852 testcase( isTrue && bNormal);
3853 testcase( !isTrue && bNormal);
3854 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003855 break;
3856 }
drhcce7d172000-05-31 15:34:51 +00003857 case TK_ISNULL:
3858 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003859 int addr;
drh7d176102014-02-18 03:07:12 +00003860 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3861 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003862 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003863 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003864 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003865 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003866 VdbeCoverageIf(v, op==TK_ISNULL);
3867 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003868 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003869 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003870 break;
drhcce7d172000-05-31 15:34:51 +00003871 }
drh22827922000-06-06 17:27:05 +00003872 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003873 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003874 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003875 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3876 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003877 }else{
drhc332cc32016-09-19 10:24:19 +00003878 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003879 }
drh22827922000-06-06 17:27:05 +00003880 break;
3881 }
drhcce7d172000-05-31 15:34:51 +00003882 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003883 ExprList *pFarg; /* List of function arguments */
3884 int nFarg; /* Number of function arguments */
3885 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003886 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003887 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003888 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003889 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003890 u8 enc = ENC(db); /* The text encoding used by this database */
3891 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003892
dan67a9b8e2018-06-22 20:51:35 +00003893#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003894 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3895 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003896 }
dan67a9b8e2018-06-22 20:51:35 +00003897#endif
dan86fb6e12018-05-16 20:58:07 +00003898
drh1e9b53f2017-01-04 01:07:24 +00003899 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003900 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003901 ** out of the inner loop, even if that means an extra OP_Copy. */
3902 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003903 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003904 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003905 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003906 pFarg = 0;
3907 }else{
3908 pFarg = pExpr->x.pList;
3909 }
3910 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003911 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3912 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003913 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003914#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3915 if( pDef==0 && pParse->explain ){
3916 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3917 }
3918#endif
danb6e9f7a2018-05-19 14:15:29 +00003919 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003920 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003921 break;
3922 }
drhae6bb952009-11-11 00:24:31 +00003923
3924 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003925 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003926 ** arguments past the first non-NULL argument.
3927 */
drhd36e1042013-09-06 13:10:12 +00003928 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003929 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003930 assert( nFarg>=2 );
3931 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3932 for(i=1; i<nFarg; i++){
3933 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003934 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003935 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003936 }
3937 sqlite3VdbeResolveLabel(v, endCoalesce);
3938 break;
3939 }
3940
drhcca9f3d2013-09-06 15:23:29 +00003941 /* The UNLIKELY() function is a no-op. The result is the value
3942 ** of the first argument.
3943 */
3944 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3945 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003946 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003947 }
drhae6bb952009-11-11 00:24:31 +00003948
drh54240752017-01-03 14:39:30 +00003949#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003950 /* The AFFINITY() function evaluates to a string that describes
3951 ** the type affinity of the argument. This is used for testing of
3952 ** the SQLite type logic.
3953 */
3954 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3955 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3956 char aff;
3957 assert( nFarg==1 );
3958 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3959 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003960 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003961 return target;
3962 }
drh54240752017-01-03 14:39:30 +00003963#endif
drha1a523a2016-12-26 00:18:36 +00003964
drhd1a01ed2013-11-21 16:08:52 +00003965 for(i=0; i<nFarg; i++){
3966 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003967 testcase( i==31 );
3968 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003969 }
3970 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3971 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3972 }
3973 }
drh12ffee82009-04-08 13:51:51 +00003974 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003975 if( constMask ){
3976 r1 = pParse->nMem+1;
3977 pParse->nMem += nFarg;
3978 }else{
3979 r1 = sqlite3GetTempRange(pParse, nFarg);
3980 }
drha748fdc2012-03-28 01:34:47 +00003981
3982 /* For length() and typeof() functions with a column argument,
3983 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3984 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3985 ** loading.
3986 */
drhd36e1042013-09-06 13:10:12 +00003987 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003988 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003989 assert( nFarg==1 );
3990 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003991 exprOp = pFarg->a[0].pExpr->op;
3992 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003993 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3994 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003995 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3996 pFarg->a[0].pExpr->op2 =
3997 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003998 }
3999 }
4000
drh5579d592015-08-26 14:01:41 +00004001 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004002 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004003 }else{
drh12ffee82009-04-08 13:51:51 +00004004 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004005 }
drhb7f6f682006-07-08 17:06:43 +00004006#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004007 /* Possibly overload the function if the first argument is
4008 ** a virtual table column.
4009 **
4010 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4011 ** second argument, not the first, as the argument to test to
4012 ** see if it is a column in a virtual table. This is done because
4013 ** the left operand of infix functions (the operand we want to
4014 ** control overloading) ends up as the second argument to the
4015 ** function. The expression "A glob B" is equivalent to
4016 ** "glob(B,A). We want to use the A in "A glob B" to test
4017 ** for function overloading. But we use the B term in "glob(B,A)".
4018 */
drh59155062018-05-26 18:03:48 +00004019 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004020 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4021 }else if( nFarg>0 ){
4022 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004023 }
4024#endif
drhd36e1042013-09-06 13:10:12 +00004025 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004026 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004027 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004028 }
drh092457b2017-12-29 15:04:49 +00004029#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4030 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004031 Expr *pArg = pFarg->a[0].pExpr;
4032 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004033 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004034 }else{
4035 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4036 }
drh092457b2017-12-29 15:04:49 +00004037 }else
4038#endif
4039 {
drh920cf592019-10-30 16:29:02 +00004040 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004041 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004042 }
drhd1a01ed2013-11-21 16:08:52 +00004043 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00004044 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00004045 }
drhc332cc32016-09-19 10:24:19 +00004046 return target;
drhcce7d172000-05-31 15:34:51 +00004047 }
drhfe2093d2005-01-20 22:48:47 +00004048#ifndef SQLITE_OMIT_SUBQUERY
4049 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004050 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004051 int nCol;
drhc5499be2008-04-01 15:06:33 +00004052 testcase( op==TK_EXISTS );
4053 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004054 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4055 sqlite3SubselectError(pParse, nCol, 1);
4056 }else{
drh85bcdce2018-12-23 21:27:29 +00004057 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004058 }
drh19a775c2000-06-05 18:54:46 +00004059 break;
4060 }
drhfc7f27b2016-08-20 00:07:01 +00004061 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004062 int n;
drhfc7f27b2016-08-20 00:07:01 +00004063 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004064 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004065 }
drh966e2912017-01-03 02:58:01 +00004066 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004067 if( pExpr->iTable!=0
4068 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004069 ){
4070 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4071 pExpr->iTable, n);
4072 }
drhc332cc32016-09-19 10:24:19 +00004073 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004074 }
drhfef52082000-06-06 01:50:43 +00004075 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004076 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4077 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004078 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4079 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4080 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4081 sqlite3VdbeResolveLabel(v, destIfFalse);
4082 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4083 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004084 return target;
drhfef52082000-06-06 01:50:43 +00004085 }
drhe3365e62009-11-12 17:52:24 +00004086#endif /* SQLITE_OMIT_SUBQUERY */
4087
4088
drh2dcef112008-01-12 19:03:48 +00004089 /*
4090 ** x BETWEEN y AND z
4091 **
4092 ** This is equivalent to
4093 **
4094 ** x>=y AND x<=z
4095 **
4096 ** X is stored in pExpr->pLeft.
4097 ** Y is stored in pExpr->pList->a[0].pExpr.
4098 ** Z is stored in pExpr->pList->a[1].pExpr.
4099 */
drhfef52082000-06-06 01:50:43 +00004100 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004101 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004102 return target;
drhfef52082000-06-06 01:50:43 +00004103 }
drh94fa9c42016-02-27 21:16:04 +00004104 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004105 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004106 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004107 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004108 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004109 }
drh2dcef112008-01-12 19:03:48 +00004110
dan165921a2009-08-28 18:53:45 +00004111 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004112 /* If the opcode is TK_TRIGGER, then the expression is a reference
4113 ** to a column in the new.* or old.* pseudo-tables available to
4114 ** trigger programs. In this case Expr.iTable is set to 1 for the
4115 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4116 ** is set to the column of the pseudo-table to read, or to -1 to
4117 ** read the rowid field.
4118 **
4119 ** The expression is implemented using an OP_Param opcode. The p1
4120 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4121 ** to reference another column of the old.* pseudo-table, where
4122 ** i is the index of the column. For a new.rowid reference, p1 is
4123 ** set to (n+1), where n is the number of columns in each pseudo-table.
4124 ** For a reference to any other column in the new.* pseudo-table, p1
4125 ** is set to (n+2+i), where n and i are as defined previously. For
4126 ** example, if the table on which triggers are being fired is
4127 ** declared as:
4128 **
4129 ** CREATE TABLE t1(a, b);
4130 **
4131 ** Then p1 is interpreted as follows:
4132 **
4133 ** p1==0 -> old.rowid p1==3 -> new.rowid
4134 ** p1==1 -> old.a p1==4 -> new.a
4135 ** p1==2 -> old.b p1==5 -> new.b
4136 */
drheda079c2018-09-20 19:02:15 +00004137 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004138 int iCol = pExpr->iColumn;
4139 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004140 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004141
4142 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004143 assert( iCol>=-1 && iCol<pTab->nCol );
4144 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004145 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4146
4147 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004148 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004149 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004150 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004151 ));
dan65a7cd12009-09-01 12:16:01 +00004152
drh44dbca82010-01-13 04:22:20 +00004153#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004154 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004155 ** integer. Use OP_RealAffinity to make sure it is really real.
4156 **
4157 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4158 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004159 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004160 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4161 }
drh44dbca82010-01-13 04:22:20 +00004162#endif
dan165921a2009-08-28 18:53:45 +00004163 break;
4164 }
4165
dan71c57db2016-07-09 20:23:55 +00004166 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004167 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004168 break;
4169 }
4170
drh9e9a67a2019-08-17 17:07:15 +00004171 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4172 ** that derive from the right-hand table of a LEFT JOIN. The
4173 ** Expr.iTable value is the table number for the right-hand table.
4174 ** The expression is only evaluated if that table is not currently
4175 ** on a LEFT JOIN NULL row.
4176 */
drh31d6fd52017-04-14 19:03:10 +00004177 case TK_IF_NULL_ROW: {
4178 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004179 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004180 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004181 /* Temporarily disable factoring of constant expressions, since
4182 ** even though expressions may appear to be constant, they are not
4183 ** really constant because they originate from the right-hand side
4184 ** of a LEFT JOIN. */
4185 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004186 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004187 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004188 sqlite3VdbeJumpHere(v, addrINR);
4189 sqlite3VdbeChangeP3(v, addrINR, inReg);
4190 break;
4191 }
4192
drh2dcef112008-01-12 19:03:48 +00004193 /*
4194 ** Form A:
4195 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4196 **
4197 ** Form B:
4198 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4199 **
4200 ** Form A is can be transformed into the equivalent form B as follows:
4201 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4202 ** WHEN x=eN THEN rN ELSE y END
4203 **
4204 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004205 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4206 ** odd. The Y is also optional. If the number of elements in x.pList
4207 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004208 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4209 **
4210 ** The result of the expression is the Ri for the first matching Ei,
4211 ** or if there is no matching Ei, the ELSE term Y, or if there is
4212 ** no ELSE term, NULL.
4213 */
drh33cd4902009-05-30 20:49:20 +00004214 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004215 int endLabel; /* GOTO label for end of CASE stmt */
4216 int nextCase; /* GOTO label for next WHEN clause */
4217 int nExpr; /* 2x number of WHEN terms */
4218 int i; /* Loop counter */
4219 ExprList *pEList; /* List of WHEN terms */
4220 struct ExprList_item *aListelem; /* Array of WHEN terms */
4221 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004222 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004223 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004224 Expr *pDel = 0;
4225 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004226
danielk19776ab3a2e2009-02-19 14:39:25 +00004227 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004228 assert(pExpr->x.pList->nExpr > 0);
4229 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004230 aListelem = pEList->a;
4231 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004232 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004233 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004234 pDel = sqlite3ExprDup(db, pX, 0);
4235 if( db->mallocFailed ){
4236 sqlite3ExprDelete(db, pDel);
4237 break;
4238 }
drh33cd4902009-05-30 20:49:20 +00004239 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004240 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004241 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004242 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004243 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004244 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004245 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004246 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4247 ** The value in regFree1 might get SCopy-ed into the file result.
4248 ** So make sure that the regFree1 register is not reused for other
4249 ** purposes and possibly overwritten. */
4250 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004251 }
drhc5cd1242013-09-12 16:50:49 +00004252 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004253 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004254 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004255 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004256 }else{
drh2dcef112008-01-12 19:03:48 +00004257 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004258 }
drhec4ccdb2018-12-29 02:26:59 +00004259 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004260 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004261 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004262 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004263 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004264 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004265 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004266 }
drhc5cd1242013-09-12 16:50:49 +00004267 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004268 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004269 }else{
drh9de221d2008-01-05 06:51:30 +00004270 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004271 }
dan8b65e592019-07-17 14:34:17 +00004272 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004273 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004274 break;
4275 }
danielk19775338a5f2005-01-20 13:03:10 +00004276#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004277 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004278 assert( pExpr->affExpr==OE_Rollback
4279 || pExpr->affExpr==OE_Abort
4280 || pExpr->affExpr==OE_Fail
4281 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004282 );
dane0af83a2009-09-08 19:15:01 +00004283 if( !pParse->pTriggerTab ){
4284 sqlite3ErrorMsg(pParse,
4285 "RAISE() may only be used within a trigger-program");
4286 return 0;
4287 }
drh11949042019-08-05 18:01:42 +00004288 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004289 sqlite3MayAbort(pParse);
4290 }
dan165921a2009-08-28 18:53:45 +00004291 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004292 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004293 sqlite3VdbeAddOp4(
4294 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004295 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004296 }else{
drh433dccf2013-02-09 15:37:11 +00004297 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004298 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004299 }
4300
drhffe07b22005-11-03 00:41:17 +00004301 break;
drh17a7f8d2002-03-24 13:13:27 +00004302 }
danielk19775338a5f2005-01-20 13:03:10 +00004303#endif
drhffe07b22005-11-03 00:41:17 +00004304 }
drh2dcef112008-01-12 19:03:48 +00004305 sqlite3ReleaseTempReg(pParse, regFree1);
4306 sqlite3ReleaseTempReg(pParse, regFree2);
4307 return inReg;
4308}
4309
4310/*
drhd1a01ed2013-11-21 16:08:52 +00004311** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004312**
drhad879ff2017-01-04 04:10:02 +00004313** If regDest>=0 then the result is always stored in that register and the
4314** result is not reusable. If regDest<0 then this routine is free to
4315** store the value whereever it wants. The register where the expression
4316** is stored is returned. When regDest<0, two identical expressions will
4317** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004318*/
drh1e9b53f2017-01-04 01:07:24 +00004319int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004320 Parse *pParse, /* Parsing context */
4321 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004322 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004323){
drhd1a01ed2013-11-21 16:08:52 +00004324 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004325 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004326 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004327 if( regDest<0 && p ){
4328 struct ExprList_item *pItem;
4329 int i;
4330 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004331 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004332 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004333 }
4334 }
drh1e9b53f2017-01-04 01:07:24 +00004335 }
drhd1a01ed2013-11-21 16:08:52 +00004336 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4337 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004338 if( p ){
4339 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004340 pItem->reusable = regDest<0;
4341 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004342 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004343 }
drhd1a01ed2013-11-21 16:08:52 +00004344 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004345 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004346}
4347
4348/*
drh2dcef112008-01-12 19:03:48 +00004349** Generate code to evaluate an expression and store the results
4350** into a register. Return the register number where the results
4351** are stored.
4352**
4353** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004354** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004355** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004356**
4357** If pExpr is a constant, then this routine might generate this
4358** code to fill the register in the initialization section of the
4359** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004360*/
4361int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004362 int r2;
drh0d950af2019-08-22 16:38:42 +00004363 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004364 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004365 && pExpr->op!=TK_REGISTER
4366 && sqlite3ExprIsConstantNotJoin(pExpr)
4367 ){
drhf30a9692013-11-15 01:10:18 +00004368 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004369 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004370 }else{
drhf30a9692013-11-15 01:10:18 +00004371 int r1 = sqlite3GetTempReg(pParse);
4372 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4373 if( r2==r1 ){
4374 *pReg = r1;
4375 }else{
4376 sqlite3ReleaseTempReg(pParse, r1);
4377 *pReg = 0;
4378 }
drh2dcef112008-01-12 19:03:48 +00004379 }
4380 return r2;
4381}
4382
4383/*
4384** Generate code that will evaluate expression pExpr and store the
4385** results in register target. The results are guaranteed to appear
4386** in register target.
4387*/
drh05a86c52014-02-16 01:55:49 +00004388void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004389 int inReg;
4390
4391 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004392 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4393 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4394 if( inReg!=target && pParse->pVdbe ){
4395 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004396 }
drhcce7d172000-05-31 15:34:51 +00004397}
4398
4399/*
drh1c75c9d2015-12-21 15:22:13 +00004400** Make a transient copy of expression pExpr and then code it using
4401** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4402** except that the input expression is guaranteed to be unchanged.
4403*/
4404void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4405 sqlite3 *db = pParse->db;
4406 pExpr = sqlite3ExprDup(db, pExpr, 0);
4407 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4408 sqlite3ExprDelete(db, pExpr);
4409}
4410
4411/*
drh05a86c52014-02-16 01:55:49 +00004412** Generate code that will evaluate expression pExpr and store the
4413** results in register target. The results are guaranteed to appear
4414** in register target. If the expression is constant, then this routine
4415** might choose to code the expression at initialization time.
4416*/
4417void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004418 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004419 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004420 }else{
4421 sqlite3ExprCode(pParse, pExpr, target);
4422 }
drhcce7d172000-05-31 15:34:51 +00004423}
4424
4425/*
drh268380c2004-02-25 13:47:31 +00004426** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004427** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004428**
drh3df6c3b2017-09-15 15:38:01 +00004429** Return the number of elements evaluated. The number returned will
4430** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4431** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004432**
4433** The SQLITE_ECEL_DUP flag prevents the arguments from being
4434** filled using OP_SCopy. OP_Copy must be used instead.
4435**
4436** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4437** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004438**
4439** The SQLITE_ECEL_REF flag means that expressions in the list with
4440** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4441** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004442** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4443** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004444*/
danielk19774adee202004-05-08 08:23:19 +00004445int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004446 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004447 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004448 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004449 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004450 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004451){
4452 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004453 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004454 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004455 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004456 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004457 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004458 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004459 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004460 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004461 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004462 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004463#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4464 if( pItem->bSorterRef ){
4465 i--;
4466 n--;
4467 }else
4468#endif
dan257c13f2016-11-10 20:14:06 +00004469 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4470 if( flags & SQLITE_ECEL_OMITREF ){
4471 i--;
4472 n--;
4473 }else{
4474 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4475 }
drhb8b06692018-08-04 15:16:20 +00004476 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4477 && sqlite3ExprIsConstantNotJoin(pExpr)
4478 ){
drhad879ff2017-01-04 04:10:02 +00004479 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004480 }else{
4481 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4482 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004483 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004484 if( copyOp==OP_Copy
4485 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4486 && pOp->p1+pOp->p3+1==inReg
4487 && pOp->p2+pOp->p3+1==target+i
4488 ){
4489 pOp->p3++;
4490 }else{
4491 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4492 }
drhd1a01ed2013-11-21 16:08:52 +00004493 }
drhd1766112008-09-17 00:13:12 +00004494 }
drh268380c2004-02-25 13:47:31 +00004495 }
drhf9b596e2004-05-26 16:54:42 +00004496 return n;
drh268380c2004-02-25 13:47:31 +00004497}
4498
4499/*
drh36c563a2009-11-12 13:32:22 +00004500** Generate code for a BETWEEN operator.
4501**
4502** x BETWEEN y AND z
4503**
4504** The above is equivalent to
4505**
4506** x>=y AND x<=z
4507**
4508** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004509** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004510**
4511** The xJumpIf parameter determines details:
4512**
4513** NULL: Store the boolean result in reg[dest]
4514** sqlite3ExprIfTrue: Jump to dest if true
4515** sqlite3ExprIfFalse: Jump to dest if false
4516**
4517** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004518*/
4519static void exprCodeBetween(
4520 Parse *pParse, /* Parsing and code generating context */
4521 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004522 int dest, /* Jump destination or storage location */
4523 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004524 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4525){
dan8b65e592019-07-17 14:34:17 +00004526 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004527 Expr compLeft; /* The x>=y term */
4528 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004529 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004530 Expr *pDel = 0;
4531 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004532
dan71c57db2016-07-09 20:23:55 +00004533 memset(&compLeft, 0, sizeof(Expr));
4534 memset(&compRight, 0, sizeof(Expr));
4535 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004536
4537 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004538 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4539 if( db->mallocFailed==0 ){
4540 exprAnd.op = TK_AND;
4541 exprAnd.pLeft = &compLeft;
4542 exprAnd.pRight = &compRight;
4543 compLeft.op = TK_GE;
4544 compLeft.pLeft = pDel;
4545 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4546 compRight.op = TK_LE;
4547 compRight.pLeft = pDel;
4548 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4549 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4550 if( xJump ){
4551 xJump(pParse, &exprAnd, dest, jumpIfNull);
4552 }else{
4553 /* Mark the expression is being from the ON or USING clause of a join
4554 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4555 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4556 ** for clarity, but we are out of bits in the Expr.flags field so we
4557 ** have to reuse the EP_FromJoin bit. Bummer. */
4558 pDel->flags |= EP_FromJoin;
4559 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4560 }
4561 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004562 }
dan8b65e592019-07-17 14:34:17 +00004563 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004564
4565 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004566 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4567 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4568 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4569 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4570 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4571 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4572 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4573 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004574 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004575}
4576
4577/*
drhcce7d172000-05-31 15:34:51 +00004578** Generate code for a boolean expression such that a jump is made
4579** to the label "dest" if the expression is true but execution
4580** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004581**
4582** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004583** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004584**
4585** This code depends on the fact that certain token values (ex: TK_EQ)
4586** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4587** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4588** the make process cause these values to align. Assert()s in the code
4589** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004590*/
danielk19774adee202004-05-08 08:23:19 +00004591void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004592 Vdbe *v = pParse->pVdbe;
4593 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004594 int regFree1 = 0;
4595 int regFree2 = 0;
4596 int r1, r2;
4597
drh35573352008-01-08 23:54:25 +00004598 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004599 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004600 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004601 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004602 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004603 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004604 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004605 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4606 if( pAlt!=pExpr ){
4607 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4608 }else if( op==TK_AND ){
4609 int d2 = sqlite3VdbeMakeLabel(pParse);
4610 testcase( jumpIfNull==0 );
4611 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4612 jumpIfNull^SQLITE_JUMPIFNULL);
4613 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4614 sqlite3VdbeResolveLabel(v, d2);
4615 }else{
4616 testcase( jumpIfNull==0 );
4617 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4618 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4619 }
drhcce7d172000-05-31 15:34:51 +00004620 break;
4621 }
4622 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004623 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004624 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004625 break;
4626 }
drh8abed7b2018-02-26 18:49:05 +00004627 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004628 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4629 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004630 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004631 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004632 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004633 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004634 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004635 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004636 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4637 isNot ? SQLITE_JUMPIFNULL : 0);
4638 }else{
4639 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4640 isNot ? SQLITE_JUMPIFNULL : 0);
4641 }
drh007c8432018-02-26 03:20:18 +00004642 break;
4643 }
drhde845c22016-03-17 19:07:52 +00004644 case TK_IS:
4645 case TK_ISNOT:
4646 testcase( op==TK_IS );
4647 testcase( op==TK_ISNOT );
4648 op = (op==TK_IS) ? TK_EQ : TK_NE;
4649 jumpIfNull = SQLITE_NULLEQ;
4650 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004651 case TK_LT:
4652 case TK_LE:
4653 case TK_GT:
4654 case TK_GE:
4655 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004656 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004657 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004658 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004659 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4660 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004661 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004662 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004663 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4664 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4665 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4666 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004667 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4668 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4669 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4670 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4671 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4672 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004673 testcase( regFree1==0 );
4674 testcase( regFree2==0 );
4675 break;
4676 }
drhcce7d172000-05-31 15:34:51 +00004677 case TK_ISNULL:
4678 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004679 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4680 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004681 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4682 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004683 VdbeCoverageIf(v, op==TK_ISNULL);
4684 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004685 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004686 break;
4687 }
drhfef52082000-06-06 01:50:43 +00004688 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004689 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004690 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004691 break;
4692 }
drh84e30ca2011-02-10 17:46:14 +00004693#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004694 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004695 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004696 int destIfNull = jumpIfNull ? dest : destIfFalse;
4697 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004698 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004699 sqlite3VdbeResolveLabel(v, destIfFalse);
4700 break;
4701 }
shanehbb201342011-02-09 19:55:20 +00004702#endif
drhcce7d172000-05-31 15:34:51 +00004703 default: {
dan7b35a772016-07-28 19:47:15 +00004704 default_expr:
drhad317272019-04-19 16:21:51 +00004705 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004706 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004707 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004708 /* No-op */
4709 }else{
4710 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4711 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004712 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004713 testcase( regFree1==0 );
4714 testcase( jumpIfNull==0 );
4715 }
drhcce7d172000-05-31 15:34:51 +00004716 break;
4717 }
4718 }
drh2dcef112008-01-12 19:03:48 +00004719 sqlite3ReleaseTempReg(pParse, regFree1);
4720 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004721}
4722
4723/*
drh66b89c82000-11-28 20:47:17 +00004724** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004725** to the label "dest" if the expression is false but execution
4726** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004727**
4728** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004729** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4730** is 0.
drhcce7d172000-05-31 15:34:51 +00004731*/
danielk19774adee202004-05-08 08:23:19 +00004732void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004733 Vdbe *v = pParse->pVdbe;
4734 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004735 int regFree1 = 0;
4736 int regFree2 = 0;
4737 int r1, r2;
4738
drh35573352008-01-08 23:54:25 +00004739 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004740 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004741 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004742
4743 /* The value of pExpr->op and op are related as follows:
4744 **
4745 ** pExpr->op op
4746 ** --------- ----------
4747 ** TK_ISNULL OP_NotNull
4748 ** TK_NOTNULL OP_IsNull
4749 ** TK_NE OP_Eq
4750 ** TK_EQ OP_Ne
4751 ** TK_GT OP_Le
4752 ** TK_LE OP_Gt
4753 ** TK_GE OP_Lt
4754 ** TK_LT OP_Ge
4755 **
4756 ** For other values of pExpr->op, op is undefined and unused.
4757 ** The value of TK_ and OP_ constants are arranged such that we
4758 ** can compute the mapping above using the following expression.
4759 ** Assert()s verify that the computation is correct.
4760 */
4761 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4762
4763 /* Verify correct alignment of TK_ and OP_ constants
4764 */
4765 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4766 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4767 assert( pExpr->op!=TK_NE || op==OP_Eq );
4768 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4769 assert( pExpr->op!=TK_LT || op==OP_Ge );
4770 assert( pExpr->op!=TK_LE || op==OP_Gt );
4771 assert( pExpr->op!=TK_GT || op==OP_Le );
4772 assert( pExpr->op!=TK_GE || op==OP_Lt );
4773
danba00e302016-07-23 20:24:06 +00004774 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004775 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004776 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004777 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4778 if( pAlt!=pExpr ){
4779 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4780 }else if( pExpr->op==TK_AND ){
4781 testcase( jumpIfNull==0 );
4782 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4783 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4784 }else{
4785 int d2 = sqlite3VdbeMakeLabel(pParse);
4786 testcase( jumpIfNull==0 );
4787 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4788 jumpIfNull^SQLITE_JUMPIFNULL);
4789 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4790 sqlite3VdbeResolveLabel(v, d2);
4791 }
drhcce7d172000-05-31 15:34:51 +00004792 break;
4793 }
4794 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004795 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004796 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004797 break;
4798 }
drh8abed7b2018-02-26 18:49:05 +00004799 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004800 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4801 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004802 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004803 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004804 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004805 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004806 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004807 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004808 /* IS TRUE and IS NOT FALSE */
4809 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4810 isNot ? 0 : SQLITE_JUMPIFNULL);
4811
4812 }else{
4813 /* IS FALSE and IS NOT TRUE */
4814 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004815 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004816 }
drh007c8432018-02-26 03:20:18 +00004817 break;
4818 }
drhde845c22016-03-17 19:07:52 +00004819 case TK_IS:
4820 case TK_ISNOT:
4821 testcase( pExpr->op==TK_IS );
4822 testcase( pExpr->op==TK_ISNOT );
4823 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4824 jumpIfNull = SQLITE_NULLEQ;
4825 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004826 case TK_LT:
4827 case TK_LE:
4828 case TK_GT:
4829 case TK_GE:
4830 case TK_NE:
4831 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004832 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004833 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004834 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4835 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004836 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004837 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004838 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4839 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4840 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4841 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004842 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4843 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4844 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4845 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4846 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4847 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004848 testcase( regFree1==0 );
4849 testcase( regFree2==0 );
4850 break;
4851 }
drhcce7d172000-05-31 15:34:51 +00004852 case TK_ISNULL:
4853 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004854 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4855 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004856 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4857 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004858 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004859 break;
4860 }
drhfef52082000-06-06 01:50:43 +00004861 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004862 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004863 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004864 break;
4865 }
drh84e30ca2011-02-10 17:46:14 +00004866#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004867 case TK_IN: {
4868 if( jumpIfNull ){
4869 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4870 }else{
drhec4ccdb2018-12-29 02:26:59 +00004871 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004872 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4873 sqlite3VdbeResolveLabel(v, destIfNull);
4874 }
4875 break;
4876 }
shanehbb201342011-02-09 19:55:20 +00004877#endif
drhcce7d172000-05-31 15:34:51 +00004878 default: {
danba00e302016-07-23 20:24:06 +00004879 default_expr:
drhad317272019-04-19 16:21:51 +00004880 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004881 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004882 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004883 /* no-op */
4884 }else{
4885 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4886 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004887 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004888 testcase( regFree1==0 );
4889 testcase( jumpIfNull==0 );
4890 }
drhcce7d172000-05-31 15:34:51 +00004891 break;
4892 }
4893 }
drh2dcef112008-01-12 19:03:48 +00004894 sqlite3ReleaseTempReg(pParse, regFree1);
4895 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004896}
drh22827922000-06-06 17:27:05 +00004897
4898/*
drh72bc8202015-06-11 13:58:35 +00004899** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4900** code generation, and that copy is deleted after code generation. This
4901** ensures that the original pExpr is unchanged.
4902*/
4903void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4904 sqlite3 *db = pParse->db;
4905 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4906 if( db->mallocFailed==0 ){
4907 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4908 }
4909 sqlite3ExprDelete(db, pCopy);
4910}
4911
dan5aa550c2017-06-24 18:10:29 +00004912/*
4913** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4914** type of expression.
4915**
4916** If pExpr is a simple SQL value - an integer, real, string, blob
4917** or NULL value - then the VDBE currently being prepared is configured
4918** to re-prepare each time a new value is bound to variable pVar.
4919**
4920** Additionally, if pExpr is a simple SQL value and the value is the
4921** same as that currently bound to variable pVar, non-zero is returned.
4922** Otherwise, if the values are not the same or if pExpr is not a simple
4923** SQL value, zero is returned.
4924*/
4925static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4926 int res = 0;
drhc0804222017-06-28 21:47:16 +00004927 int iVar;
4928 sqlite3_value *pL, *pR = 0;
4929
4930 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4931 if( pR ){
4932 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004933 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004934 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004935 if( pL ){
4936 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4937 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4938 }
4939 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004940 }
drhc0804222017-06-28 21:47:16 +00004941 sqlite3ValueFree(pR);
4942 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004943 }
4944
4945 return res;
4946}
drh72bc8202015-06-11 13:58:35 +00004947
4948/*
drh1d9da702010-01-07 15:17:02 +00004949** Do a deep comparison of two expression trees. Return 0 if the two
4950** expressions are completely identical. Return 1 if they differ only
4951** by a COLLATE operator at the top level. Return 2 if there are differences
4952** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004953**
drh619a1302013-08-01 13:04:46 +00004954** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4955** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4956**
drh66518ca2013-08-01 15:09:57 +00004957** The pA side might be using TK_REGISTER. If that is the case and pB is
4958** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4959**
drh1d9da702010-01-07 15:17:02 +00004960** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004961** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004962** identical, we return 2 just to be safe. So if this routine
4963** returns 2, then you do not really know for certain if the two
4964** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004965** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004966** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004967** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004968** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004969**
drhc0804222017-06-28 21:47:16 +00004970** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4971** pParse->pReprepare can be matched against literals in pB. The
4972** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4973** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4974** Argument pParse should normally be NULL. If it is not NULL and pA or
4975** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004976*/
dan5aa550c2017-06-24 18:10:29 +00004977int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004978 u32 combinedFlags;
4979 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004980 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004981 }
dan5aa550c2017-06-24 18:10:29 +00004982 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4983 return 0;
4984 }
drh10d1edf2013-11-15 15:52:39 +00004985 combinedFlags = pA->flags | pB->flags;
4986 if( combinedFlags & EP_IntValue ){
4987 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4988 return 0;
4989 }
drh1d9da702010-01-07 15:17:02 +00004990 return 2;
drh22827922000-06-06 17:27:05 +00004991 }
dan16dd3982018-12-20 15:04:38 +00004992 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004993 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004994 return 1;
4995 }
dan5aa550c2017-06-24 18:10:29 +00004996 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004997 return 1;
4998 }
4999 return 2;
5000 }
drh2edc5fd2015-11-24 02:10:52 +00005001 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005002 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005003 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005004#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005005 assert( pA->op==pB->op );
5006 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5007 return 2;
5008 }
drheda079c2018-09-20 19:02:15 +00005009 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005010 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5011 return 2;
5012 }
drheda079c2018-09-20 19:02:15 +00005013 }
5014#endif
drhf20bbc52019-01-17 01:06:00 +00005015 }else if( pA->op==TK_NULL ){
5016 return 0;
drhd5af5422018-04-13 14:27:01 +00005017 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005018 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005019 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005020 return 2;
drh2646da72005-12-09 20:02:05 +00005021 }
drh22827922000-06-06 17:27:05 +00005022 }
drh898c5272019-10-22 00:03:41 +00005023 if( (pA->flags & (EP_Distinct|EP_Commuted))
5024 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drh89b6de02018-12-12 20:11:23 +00005025 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00005026 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005027 if( (combinedFlags & EP_FixedCol)==0
5028 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005029 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005030 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005031 if( pA->op!=TK_STRING
5032 && pA->op!=TK_TRUEFALSE
5033 && (combinedFlags & EP_Reduced)==0
5034 ){
drh10d1edf2013-11-15 15:52:39 +00005035 if( pA->iColumn!=pB->iColumn ) return 2;
drh04307c82019-10-31 13:16:26 +00005036 if( pA->op2!=pB->op2 ){
5037 if( pA->op==TK_TRUTH ) return 2;
5038 if( pA->op==TK_FUNCTION && iTab<0 ){
5039 /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
5040 ** INSERT INTO t1(a) VALUES(julianday('now')+10);
5041 ** Without this test, sqlite3ExprCodeAtInit() will run on the
5042 ** the julianday() of INSERT first, and remember that expression.
5043 ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
5044 ** constraint as redundant, reusing the one from the INSERT, even
5045 ** though the julianday() in INSERT lacks the critical NC_IsCheck
5046 ** flag. See ticket [830277d9db6c3ba1] (2019-10-30)
5047 */
5048 return 2;
5049 }
5050 }
drh0f28e1b2019-10-28 13:07:01 +00005051 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5052 return 2;
5053 }
drh10d1edf2013-11-15 15:52:39 +00005054 }
5055 }
drh1d9da702010-01-07 15:17:02 +00005056 return 0;
drh22827922000-06-06 17:27:05 +00005057}
5058
drh8c6f6662010-04-26 19:17:26 +00005059/*
5060** Compare two ExprList objects. Return 0 if they are identical and
5061** non-zero if they differ in any way.
5062**
drh619a1302013-08-01 13:04:46 +00005063** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5064** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5065**
drh8c6f6662010-04-26 19:17:26 +00005066** This routine might return non-zero for equivalent ExprLists. The
5067** only consequence will be disabled optimizations. But this routine
5068** must never return 0 if the two ExprList objects are different, or
5069** a malfunction will result.
5070**
5071** Two NULL pointers are considered to be the same. But a NULL pointer
5072** always differs from a non-NULL pointer.
5073*/
drh619a1302013-08-01 13:04:46 +00005074int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005075 int i;
5076 if( pA==0 && pB==0 ) return 0;
5077 if( pA==0 || pB==0 ) return 1;
5078 if( pA->nExpr!=pB->nExpr ) return 1;
5079 for(i=0; i<pA->nExpr; i++){
5080 Expr *pExprA = pA->a[i].pExpr;
5081 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005082 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00005083 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00005084 }
5085 return 0;
5086}
drh13449892005-09-07 21:22:45 +00005087
drh22827922000-06-06 17:27:05 +00005088/*
drhf9463df2017-02-11 14:59:58 +00005089** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5090** are ignored.
5091*/
5092int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005093 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005094 sqlite3ExprSkipCollateAndLikely(pA),
5095 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005096 iTab);
5097}
5098
5099/*
drhc51cf862019-05-11 19:36:03 +00005100** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005101**
5102** Or if seenNot is true, return non-zero if Expr p can only be
5103** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005104*/
5105static int exprImpliesNotNull(
5106 Parse *pParse, /* Parsing context */
5107 Expr *p, /* The expression to be checked */
5108 Expr *pNN, /* The expression that is NOT NULL */
5109 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005110 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005111){
5112 assert( p );
5113 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005114 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5115 return pNN->op!=TK_NULL;
5116 }
drhc51cf862019-05-11 19:36:03 +00005117 switch( p->op ){
5118 case TK_IN: {
5119 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5120 assert( ExprHasProperty(p,EP_xIsSelect)
5121 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005122 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005123 }
5124 case TK_BETWEEN: {
5125 ExprList *pList = p->x.pList;
5126 assert( pList!=0 );
5127 assert( pList->nExpr==2 );
5128 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005129 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5130 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005131 ){
5132 return 1;
5133 }
drh7a231b42019-08-30 15:11:08 +00005134 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005135 }
5136 case TK_EQ:
5137 case TK_NE:
5138 case TK_LT:
5139 case TK_LE:
5140 case TK_GT:
5141 case TK_GE:
5142 case TK_PLUS:
5143 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005144 case TK_BITOR:
5145 case TK_LSHIFT:
5146 case TK_RSHIFT:
5147 case TK_CONCAT:
5148 seenNot = 1;
5149 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005150 case TK_STAR:
5151 case TK_REM:
5152 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005153 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005154 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5155 /* Fall thru into the next case */
5156 }
5157 case TK_SPAN:
5158 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005159 case TK_UPLUS:
5160 case TK_UMINUS: {
5161 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5162 }
5163 case TK_TRUTH: {
5164 if( seenNot ) return 0;
5165 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005166 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005167 }
dan1cd382e2019-08-29 15:06:35 +00005168 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005169 case TK_NOT: {
5170 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5171 }
5172 }
5173 return 0;
5174}
5175
5176/*
drh4bd5f732013-07-31 23:22:39 +00005177** Return true if we can prove the pE2 will always be true if pE1 is
5178** true. Return false if we cannot complete the proof or if pE2 might
5179** be false. Examples:
5180**
drh619a1302013-08-01 13:04:46 +00005181** pE1: x==5 pE2: x==5 Result: true
5182** pE1: x>0 pE2: x==5 Result: false
5183** pE1: x=21 pE2: x=21 OR y=43 Result: true
5184** pE1: x!=123 pE2: x IS NOT NULL Result: true
5185** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5186** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5187** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005188**
5189** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5190** Expr.iTable<0 then assume a table number given by iTab.
5191**
drhc0804222017-06-28 21:47:16 +00005192** If pParse is not NULL, then the values of bound variables in pE1 are
5193** compared against literal values in pE2 and pParse->pVdbe->expmask is
5194** modified to record which bound variables are referenced. If pParse
5195** is NULL, then false will be returned if pE1 contains any bound variables.
5196**
drh4bd5f732013-07-31 23:22:39 +00005197** When in doubt, return false. Returning true might give a performance
5198** improvement. Returning false might cause a performance reduction, but
5199** it will always give the correct answer and is hence always safe.
5200*/
dan5aa550c2017-06-24 18:10:29 +00005201int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5202 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005203 return 1;
5204 }
5205 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005206 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5207 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005208 ){
5209 return 1;
5210 }
drh664d6d12019-05-04 17:32:07 +00005211 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005212 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005213 ){
drhc51cf862019-05-11 19:36:03 +00005214 return 1;
drh619a1302013-08-01 13:04:46 +00005215 }
5216 return 0;
drh4bd5f732013-07-31 23:22:39 +00005217}
5218
5219/*
drh6c68d752019-11-04 02:05:52 +00005220** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005221** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005222** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5223**
5224** This routine controls an optimization. False positives (setting
5225** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5226** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005227*/
5228static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005229 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005230 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005231 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5232 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005233 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005234 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005235 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005236 case TK_IS:
5237 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005238 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005239 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005240 case TK_IN:
drh25897872018-03-20 21:16:15 +00005241 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005242 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005243 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005244 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005245 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005246 testcase( pExpr->op==TK_IS );
5247 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005248 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005249 testcase( pExpr->op==TK_CASE );
5250 testcase( pExpr->op==TK_IN );
5251 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005252 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005253 return WRC_Prune;
5254 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005255 if( pWalker->u.iCur==pExpr->iTable ){
5256 pWalker->eCode = 1;
5257 return WRC_Abort;
5258 }
5259 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005260
dan9d23ea72019-08-29 19:34:29 +00005261 case TK_AND:
dan0287c952019-10-10 17:09:44 +00005262 assert( pWalker->eCode==0 );
5263 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5264 if( pWalker->eCode ){
5265 pWalker->eCode = 0;
5266 sqlite3WalkExpr(pWalker, pExpr->pRight);
dan9d23ea72019-08-29 19:34:29 +00005267 }
5268 return WRC_Prune;
5269
5270 case TK_BETWEEN:
5271 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5272 return WRC_Prune;
5273
drh98811552018-04-03 14:04:48 +00005274 /* Virtual tables are allowed to use constraints like x=NULL. So
5275 ** a term of the form x=y does not prove that y is not null if x
5276 ** is the column of a virtual table */
5277 case TK_EQ:
5278 case TK_NE:
5279 case TK_LT:
5280 case TK_LE:
5281 case TK_GT:
5282 case TK_GE:
5283 testcase( pExpr->op==TK_EQ );
5284 testcase( pExpr->op==TK_NE );
5285 testcase( pExpr->op==TK_LT );
5286 testcase( pExpr->op==TK_LE );
5287 testcase( pExpr->op==TK_GT );
5288 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005289 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5290 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005291 ){
5292 return WRC_Prune;
5293 }
dan9d23ea72019-08-29 19:34:29 +00005294
drh25897872018-03-20 21:16:15 +00005295 default:
5296 return WRC_Continue;
5297 }
5298}
5299
5300/*
5301** Return true (non-zero) if expression p can only be true if at least
5302** one column of table iTab is non-null. In other words, return true
5303** if expression p will always be NULL or false if every column of iTab
5304** is NULL.
5305**
drh821b6102018-03-24 18:01:51 +00005306** False negatives are acceptable. In other words, it is ok to return
5307** zero even if expression p will never be true of every column of iTab
5308** is NULL. A false negative is merely a missed optimization opportunity.
5309**
5310** False positives are not allowed, however. A false positive may result
5311** in an incorrect answer.
5312**
drh25897872018-03-20 21:16:15 +00005313** Terms of p that are marked with EP_FromJoin (and hence that come from
5314** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5315**
5316** This routine is used to check if a LEFT JOIN can be converted into
5317** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5318** clause requires that some column of the right table of the LEFT JOIN
5319** be non-NULL, then the LEFT JOIN can be safely converted into an
5320** ordinary join.
5321*/
5322int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5323 Walker w;
drh0d950af2019-08-22 16:38:42 +00005324 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005325 if( p==0 ) return 0;
5326 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005327 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005328 }else{
5329 while( p->op==TK_AND ){
5330 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5331 p = p->pRight;
5332 }
drhd6db6592019-04-01 19:42:42 +00005333 }
drh25897872018-03-20 21:16:15 +00005334 w.xExprCallback = impliesNotNullRow;
5335 w.xSelectCallback = 0;
5336 w.xSelectCallback2 = 0;
5337 w.eCode = 0;
5338 w.u.iCur = iTab;
5339 sqlite3WalkExpr(&w, p);
5340 return w.eCode;
5341}
5342
5343/*
drh030796d2012-08-23 16:18:10 +00005344** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005345** to determine if an expression can be evaluated by reference to the
5346** index only, without having to do a search for the corresponding
5347** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5348** is the cursor for the table.
5349*/
5350struct IdxCover {
5351 Index *pIdx; /* The index to be tested for coverage */
5352 int iCur; /* Cursor number for the table corresponding to the index */
5353};
5354
5355/*
5356** Check to see if there are references to columns in table
5357** pWalker->u.pIdxCover->iCur can be satisfied using the index
5358** pWalker->u.pIdxCover->pIdx.
5359*/
5360static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5361 if( pExpr->op==TK_COLUMN
5362 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005363 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005364 ){
5365 pWalker->eCode = 1;
5366 return WRC_Abort;
5367 }
5368 return WRC_Continue;
5369}
5370
5371/*
drhe604ec02016-07-27 19:20:58 +00005372** Determine if an index pIdx on table with cursor iCur contains will
5373** the expression pExpr. Return true if the index does cover the
5374** expression and false if the pExpr expression references table columns
5375** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005376**
5377** An index covering an expression means that the expression can be
5378** evaluated using only the index and without having to lookup the
5379** corresponding table entry.
5380*/
5381int sqlite3ExprCoveredByIndex(
5382 Expr *pExpr, /* The index to be tested */
5383 int iCur, /* The cursor number for the corresponding table */
5384 Index *pIdx /* The index that might be used for coverage */
5385){
5386 Walker w;
5387 struct IdxCover xcov;
5388 memset(&w, 0, sizeof(w));
5389 xcov.iCur = iCur;
5390 xcov.pIdx = pIdx;
5391 w.xExprCallback = exprIdxCover;
5392 w.u.pIdxCover = &xcov;
5393 sqlite3WalkExpr(&w, pExpr);
5394 return !w.eCode;
5395}
5396
5397
5398/*
5399** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005400** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005401** aggregate function, in order to implement the
5402** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005403*/
drh030796d2012-08-23 16:18:10 +00005404struct SrcCount {
5405 SrcList *pSrc; /* One particular FROM clause in a nested query */
5406 int nThis; /* Number of references to columns in pSrcList */
5407 int nOther; /* Number of references to columns in other FROM clauses */
5408};
5409
5410/*
5411** Count the number of references to columns.
5412*/
5413static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005414 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5415 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5416 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5417 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5418 ** NEVER() will need to be removed. */
5419 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005420 int i;
drh030796d2012-08-23 16:18:10 +00005421 struct SrcCount *p = pWalker->u.pSrcCount;
5422 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005423 int nSrc = pSrc ? pSrc->nSrc : 0;
5424 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005425 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005426 }
drh655814d2015-01-09 01:27:29 +00005427 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005428 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005429 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5430 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005431 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005432 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005433 p->nOther++;
5434 }
drh374fdce2012-04-17 16:38:53 +00005435 }
drh030796d2012-08-23 16:18:10 +00005436 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005437}
5438
5439/*
drh030796d2012-08-23 16:18:10 +00005440** Determine if any of the arguments to the pExpr Function reference
5441** pSrcList. Return true if they do. Also return true if the function
5442** has no arguments or has only constant arguments. Return false if pExpr
5443** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005444*/
drh030796d2012-08-23 16:18:10 +00005445int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005446 Walker w;
drh030796d2012-08-23 16:18:10 +00005447 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005448 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005449 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005450 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005451 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005452 w.u.pSrcCount = &cnt;
5453 cnt.pSrc = pSrcList;
5454 cnt.nThis = 0;
5455 cnt.nOther = 0;
5456 sqlite3WalkExprList(&w, pExpr->x.pList);
5457 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005458}
5459
5460/*
drh13449892005-09-07 21:22:45 +00005461** Add a new element to the pAggInfo->aCol[] array. Return the index of
5462** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005463*/
drh17435752007-08-16 04:30:38 +00005464static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005465 int i;
drhcf643722007-03-27 13:36:37 +00005466 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005467 db,
drhcf643722007-03-27 13:36:37 +00005468 pInfo->aCol,
5469 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005470 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005471 &i
5472 );
drh13449892005-09-07 21:22:45 +00005473 return i;
5474}
5475
5476/*
5477** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5478** the new element. Return a negative number if malloc fails.
5479*/
drh17435752007-08-16 04:30:38 +00005480static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005481 int i;
drhcf643722007-03-27 13:36:37 +00005482 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005483 db,
drhcf643722007-03-27 13:36:37 +00005484 pInfo->aFunc,
5485 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005486 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005487 &i
5488 );
drh13449892005-09-07 21:22:45 +00005489 return i;
5490}
drh22827922000-06-06 17:27:05 +00005491
5492/*
drh7d10d5a2008-08-20 16:35:10 +00005493** This is the xExprCallback for a tree walker. It is used to
5494** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005495** for additional information.
drh22827922000-06-06 17:27:05 +00005496*/
drh7d10d5a2008-08-20 16:35:10 +00005497static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005498 int i;
drh7d10d5a2008-08-20 16:35:10 +00005499 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005500 Parse *pParse = pNC->pParse;
5501 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005502 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005503
drh25c3b8c2018-04-16 10:34:13 +00005504 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005505 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005506 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005507 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005508 testcase( pExpr->op==TK_AGG_COLUMN );
5509 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005510 /* Check to see if the column is in one of the tables in the FROM
5511 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005512 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005513 struct SrcList_item *pItem = pSrcList->a;
5514 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5515 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005516 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005517 if( pExpr->iTable==pItem->iCursor ){
5518 /* If we reach this point, it means that pExpr refers to a table
5519 ** that is in the FROM clause of the aggregate query.
5520 **
5521 ** Make an entry for the column in pAggInfo->aCol[] if there
5522 ** is not an entry there already.
5523 */
drh7f906d62007-03-12 23:48:52 +00005524 int k;
drh13449892005-09-07 21:22:45 +00005525 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005526 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005527 if( pCol->iTable==pExpr->iTable &&
5528 pCol->iColumn==pExpr->iColumn ){
5529 break;
5530 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005531 }
danielk19771e536952007-08-16 10:09:01 +00005532 if( (k>=pAggInfo->nColumn)
5533 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5534 ){
drh7f906d62007-03-12 23:48:52 +00005535 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005536 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005537 pCol->iTable = pExpr->iTable;
5538 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005539 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005540 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005541 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005542 if( pAggInfo->pGroupBy ){
5543 int j, n;
5544 ExprList *pGB = pAggInfo->pGroupBy;
5545 struct ExprList_item *pTerm = pGB->a;
5546 n = pGB->nExpr;
5547 for(j=0; j<n; j++, pTerm++){
5548 Expr *pE = pTerm->pExpr;
5549 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5550 pE->iColumn==pExpr->iColumn ){
5551 pCol->iSorterColumn = j;
5552 break;
5553 }
5554 }
5555 }
5556 if( pCol->iSorterColumn<0 ){
5557 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5558 }
5559 }
5560 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5561 ** because it was there before or because we just created it).
5562 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5563 ** pAggInfo->aCol[] entry.
5564 */
drhebb6a652013-09-12 23:42:22 +00005565 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005566 pExpr->pAggInfo = pAggInfo;
5567 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005568 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005569 break;
5570 } /* endif pExpr->iTable==pItem->iCursor */
5571 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005572 }
drh7d10d5a2008-08-20 16:35:10 +00005573 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005574 }
5575 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005576 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005577 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005578 ){
drh13449892005-09-07 21:22:45 +00005579 /* Check to see if pExpr is a duplicate of another aggregate
5580 ** function that is already in the pAggInfo structure
5581 */
5582 struct AggInfo_func *pItem = pAggInfo->aFunc;
5583 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005584 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005585 break;
5586 }
drh22827922000-06-06 17:27:05 +00005587 }
drh13449892005-09-07 21:22:45 +00005588 if( i>=pAggInfo->nFunc ){
5589 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5590 */
danielk197714db2662006-01-09 16:12:04 +00005591 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005592 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005593 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005594 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005595 pItem = &pAggInfo->aFunc[i];
5596 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005597 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005598 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005599 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005600 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005601 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005602 if( pExpr->flags & EP_Distinct ){
5603 pItem->iDistinct = pParse->nTab++;
5604 }else{
5605 pItem->iDistinct = -1;
5606 }
drh13449892005-09-07 21:22:45 +00005607 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005608 }
drh13449892005-09-07 21:22:45 +00005609 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5610 */
drhc5cd1242013-09-12 16:50:49 +00005611 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005612 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005613 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005614 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005615 return WRC_Prune;
5616 }else{
5617 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005618 }
drh22827922000-06-06 17:27:05 +00005619 }
5620 }
drh7d10d5a2008-08-20 16:35:10 +00005621 return WRC_Continue;
5622}
5623static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005624 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005625 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005626 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005627}
drh979dd1b2017-05-29 14:26:07 +00005628static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5629 UNUSED_PARAMETER(pSelect);
5630 pWalker->walkerDepth--;
5631}
drh626a8792005-01-17 22:08:19 +00005632
5633/*
drhe8abb4c2012-11-02 18:24:57 +00005634** Analyze the pExpr expression looking for aggregate functions and
5635** for variables that need to be added to AggInfo object that pNC->pAggInfo
5636** points to. Additional entries are made on the AggInfo object as
5637** necessary.
drh626a8792005-01-17 22:08:19 +00005638**
5639** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005640** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005641*/
drhd2b3e232008-01-23 14:51:49 +00005642void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005643 Walker w;
5644 w.xExprCallback = analyzeAggregate;
5645 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005646 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5647 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005648 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005649 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005650 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005651 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005652}
drh5d9a4af2005-08-30 00:54:01 +00005653
5654/*
5655** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5656** expression list. Return the number of errors.
5657**
5658** If an error is found, the analysis is cut short.
5659*/
drhd2b3e232008-01-23 14:51:49 +00005660void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005661 struct ExprList_item *pItem;
5662 int i;
drh5d9a4af2005-08-30 00:54:01 +00005663 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005664 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5665 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005666 }
5667 }
drh5d9a4af2005-08-30 00:54:01 +00005668}
drh892d3172008-01-10 03:46:36 +00005669
5670/*
drhceea3322009-04-23 13:22:42 +00005671** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005672*/
5673int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005674 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005675 return ++pParse->nMem;
5676 }
danielk19772f425f62008-07-04 09:41:39 +00005677 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005678}
drhceea3322009-04-23 13:22:42 +00005679
5680/*
5681** Deallocate a register, making available for reuse for some other
5682** purpose.
drhceea3322009-04-23 13:22:42 +00005683*/
drh892d3172008-01-10 03:46:36 +00005684void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005685 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005686 pParse->aTempReg[pParse->nTempReg++] = iReg;
5687 }
5688}
5689
5690/*
drhed24da42016-09-06 14:37:05 +00005691** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005692*/
5693int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005694 int i, n;
drhed24da42016-09-06 14:37:05 +00005695 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005696 i = pParse->iRangeReg;
5697 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005698 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005699 pParse->iRangeReg += nReg;
5700 pParse->nRangeReg -= nReg;
5701 }else{
5702 i = pParse->nMem+1;
5703 pParse->nMem += nReg;
5704 }
5705 return i;
5706}
5707void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005708 if( nReg==1 ){
5709 sqlite3ReleaseTempReg(pParse, iReg);
5710 return;
5711 }
drh892d3172008-01-10 03:46:36 +00005712 if( nReg>pParse->nRangeReg ){
5713 pParse->nRangeReg = nReg;
5714 pParse->iRangeReg = iReg;
5715 }
5716}
drhcdc69552011-12-06 13:24:59 +00005717
5718/*
5719** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005720**
5721** Always invoke this procedure after coding a subroutine or co-routine
5722** that might be invoked from other parts of the code, to ensure that
5723** the sub/co-routine does not use registers in common with the code that
5724** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005725*/
5726void sqlite3ClearTempRegCache(Parse *pParse){
5727 pParse->nTempReg = 0;
5728 pParse->nRangeReg = 0;
5729}
drhbb9b5f22016-03-19 00:35:02 +00005730
5731/*
5732** Validate that no temporary register falls within the range of
5733** iFirst..iLast, inclusive. This routine is only call from within assert()
5734** statements.
5735*/
5736#ifdef SQLITE_DEBUG
5737int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5738 int i;
5739 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005740 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5741 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005742 ){
5743 return 0;
5744 }
5745 for(i=0; i<pParse->nTempReg; i++){
5746 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5747 return 0;
5748 }
5749 }
5750 return 1;
5751}
5752#endif /* SQLITE_DEBUG */