blob: f225b59bce391f95a9c554df93035a01755303b1 [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*/
drhe7375bf2020-03-10 19:24:38 +000045char sqlite3ExprAffinity(const Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drh46fe1382020-08-19 23:32:06 +000047 while( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
drh9bb612f2020-10-02 12:42:51 +000048 assert( pExpr->op==TK_COLLATE
49 || pExpr->op==TK_IF_NULL_ROW
50 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
drha7d6db62019-06-11 21:02:15 +000051 pExpr = pExpr->pLeft;
52 assert( pExpr!=0 );
53 }
drh580c8c12012-12-08 03:34:04 +000054 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000055 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000056 assert( pExpr->flags&EP_xIsSelect );
drh6af305d2020-07-10 21:43:53 +000057 assert( pExpr->x.pSelect!=0 );
58 assert( pExpr->x.pSelect->pEList!=0 );
59 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
60 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000061 }
drhdb45bd52016-08-22 00:48:58 +000062 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000063#ifndef SQLITE_OMIT_CAST
64 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000065 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000066 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000067 }
68#endif
drheda079c2018-09-20 19:02:15 +000069 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
70 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000071 }
dan80aa5452016-09-03 19:52:12 +000072 if( op==TK_SELECT_COLUMN ){
73 assert( pExpr->pLeft->flags&EP_xIsSelect );
74 return sqlite3ExprAffinity(
75 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
76 );
77 }
drhdb36e252019-10-22 19:51:29 +000078 if( op==TK_VECTOR ){
79 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
80 }
drh11949042019-08-05 18:01:42 +000081 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000082}
83
drh53db1452004-05-20 13:54:53 +000084/*
drh8b4c40d2007-02-01 23:02:45 +000085** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000086** sequence named by pToken. Return a pointer to a new Expr node that
87** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000088**
89** If a memory allocation error occurs, that fact is recorded in pParse->db
90** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000091*/
drh4ef7efa2014-03-20 15:14:08 +000092Expr *sqlite3ExprAddCollateToken(
93 Parse *pParse, /* Parsing context */
94 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000095 const Token *pCollName, /* Name of collating sequence */
96 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000097){
drh9ffa2582021-01-16 20:22:11 +000098 assert( pExpr!=0 || pParse->db->mallocFailed );
99 if( pExpr==0 ) return 0;
100 if( pExpr->op==TK_VECTOR ){
101 ExprList *pList = pExpr->x.pList;
102 if( ALWAYS(pList!=0) ){
103 int i;
104 for(i=0; i<pList->nExpr; i++){
105 pList->a[i].pExpr = sqlite3ExprAddCollateToken(pParse,pList->a[i].pExpr,
106 pCollName, dequote);
107 }
108 }
109 }else if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +0000110 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000111 if( pNew ){
112 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000113 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000114 pExpr = pNew;
115 }
drhae80dde2012-12-06 21:16:43 +0000116 }
drh0a8a4062012-12-07 18:38:16 +0000117 return pExpr;
118}
119Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000120 Token s;
121 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000122 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000123 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000124}
125
126/*
drh0d950af2019-08-22 16:38:42 +0000127** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000128*/
129Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000130 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000131 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000132 pExpr = pExpr->pLeft;
133 }
134 return pExpr;
135}
136
137/*
138** Skip over any TK_COLLATE operators and/or any unlikely()
139** or likelihood() or likely() functions at the root of an
140** expression.
141*/
142Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000143 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000144 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000145 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
146 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000147 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000148 pExpr = pExpr->x.pList->a[0].pExpr;
149 }else{
drh46fe1382020-08-19 23:32:06 +0000150 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000151 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000152 }
drha4c3c872013-09-12 17:29:25 +0000153 }
drh0a8a4062012-12-07 18:38:16 +0000154 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000155}
156
157/*
drhae80dde2012-12-06 21:16:43 +0000158** Return the collation sequence for the expression pExpr. If
159** there is no defined collating sequence, return NULL.
160**
drh70efa842017-09-28 01:58:23 +0000161** See also: sqlite3ExprNNCollSeq()
162**
163** The sqlite3ExprNNCollSeq() works the same exact that it returns the
164** default collation if pExpr has no defined collation.
165**
drhae80dde2012-12-06 21:16:43 +0000166** The collating sequence might be determined by a COLLATE operator
167** or by the presence of a column with a defined collating sequence.
168** COLLATE operators take first precedence. Left operands take
169** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000170*/
drhe7375bf2020-03-10 19:24:38 +0000171CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000172 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000173 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000174 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000175 while( p ){
drhae80dde2012-12-06 21:16:43 +0000176 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000177 if( op==TK_REGISTER ) op = p->op2;
178 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000179 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000180 ){
drheda079c2018-09-20 19:02:15 +0000181 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000182 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000183 int j = p->iColumn;
184 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000185 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000186 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000187 }
188 break;
danielk19770202b292004-06-09 09:55:16 +0000189 }
drhe081d732018-07-27 18:19:12 +0000190 if( op==TK_CAST || op==TK_UPLUS ){
191 p = p->pLeft;
192 continue;
193 }
drh269d3222019-10-23 18:09:39 +0000194 if( op==TK_VECTOR ){
195 p = p->x.pList->a[0].pExpr;
196 continue;
197 }
drhcb0e04f2018-12-12 21:34:17 +0000198 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000199 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
200 break;
201 }
drhae80dde2012-12-06 21:16:43 +0000202 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000203 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000204 p = p->pLeft;
205 }else{
drh2308ed32015-02-09 16:09:34 +0000206 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000207 /* The Expr.x union is never used at the same time as Expr.pRight */
208 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000209 if( p->x.pList!=0
210 && !db->mallocFailed
211 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
212 ){
drh2308ed32015-02-09 16:09:34 +0000213 int i;
drh5b107652020-07-13 15:35:08 +0000214 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000215 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
216 pNext = p->x.pList->a[i].pExpr;
217 break;
218 }
219 }
220 }
221 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000222 }
223 }else{
drh7d10d5a2008-08-20 16:35:10 +0000224 break;
225 }
danielk19770202b292004-06-09 09:55:16 +0000226 }
danielk19777cedc8d2004-06-10 10:50:08 +0000227 if( sqlite3CheckCollSeq(pParse, pColl) ){
228 pColl = 0;
229 }
230 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000231}
232
233/*
drh70efa842017-09-28 01:58:23 +0000234** Return the collation sequence for the expression pExpr. If
235** there is no defined collating sequence, return a pointer to the
236** defautl collation sequence.
237**
238** See also: sqlite3ExprCollSeq()
239**
240** The sqlite3ExprCollSeq() routine works the same except that it
241** returns NULL if there is no defined collation.
242*/
drhe7375bf2020-03-10 19:24:38 +0000243CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000244 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
245 if( p==0 ) p = pParse->db->pDfltColl;
246 assert( p!=0 );
247 return p;
248}
249
250/*
251** Return TRUE if the two expressions have equivalent collating sequences.
252*/
drhe7375bf2020-03-10 19:24:38 +0000253int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000254 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
255 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
256 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
257}
258
259/*
drh626a8792005-01-17 22:08:19 +0000260** pExpr is an operand of a comparison operator. aff2 is the
261** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000262** type affinity that should be used for the comparison operator.
263*/
drhe7375bf2020-03-10 19:24:38 +0000264char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000265 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000266 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000267 /* Both sides of the comparison are columns. If one has numeric
268 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000269 */
drh8a512562005-11-14 22:29:05 +0000270 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000271 return SQLITE_AFF_NUMERIC;
272 }else{
drh05883a32015-06-02 15:32:08 +0000273 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000274 }
danielk1977e014a832004-05-17 10:48:57 +0000275 }else{
276 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000277 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
278 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000279 }
280}
281
drh53db1452004-05-20 13:54:53 +0000282/*
283** pExpr is a comparison operator. Return the type affinity that should
284** be applied to both operands prior to doing the comparison.
285*/
drhe7375bf2020-03-10 19:24:38 +0000286static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000287 char aff;
288 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
289 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000290 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000291 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000292 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000293 if( pExpr->pRight ){
294 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000295 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
296 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000297 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000298 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000299 }
300 return aff;
301}
302
303/*
304** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
305** idx_affinity is the affinity of an indexed column. Return true
306** if the index with affinity idx_affinity may be used to implement
307** the comparison in pExpr.
308*/
drhe7375bf2020-03-10 19:24:38 +0000309int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000310 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000311 if( aff<SQLITE_AFF_TEXT ){
312 return 1;
drh8a512562005-11-14 22:29:05 +0000313 }
drh915e4342019-08-06 15:18:15 +0000314 if( aff==SQLITE_AFF_TEXT ){
315 return idx_affinity==SQLITE_AFF_TEXT;
316 }
317 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000318}
319
danielk1977a37cdde2004-05-16 11:15:36 +0000320/*
drh35573352008-01-08 23:54:25 +0000321** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000322** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000323*/
drhe7375bf2020-03-10 19:24:38 +0000324static u8 binaryCompareP5(
325 const Expr *pExpr1, /* Left operand */
326 const Expr *pExpr2, /* Right operand */
327 int jumpIfNull /* Extra flags added to P5 */
328){
drh35573352008-01-08 23:54:25 +0000329 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000330 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000331 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000332}
333
drha2e00042002-01-22 03:13:42 +0000334/*
danielk19770202b292004-06-09 09:55:16 +0000335** Return a pointer to the collation sequence that should be used by
336** a binary comparison operator comparing pLeft and pRight.
337**
338** If the left hand expression has a collating sequence type, then it is
339** used. Otherwise the collation sequence for the right hand expression
340** is used, or the default (BINARY) if neither expression has a collating
341** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000342**
343** Argument pRight (but not pLeft) may be a null pointer. In this case,
344** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000345*/
drh0a0e1312007-08-07 17:04:59 +0000346CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000347 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000348 const Expr *pLeft,
349 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000350){
drhec41dda2007-02-07 13:09:45 +0000351 CollSeq *pColl;
352 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000353 if( pLeft->flags & EP_Collate ){
354 pColl = sqlite3ExprCollSeq(pParse, pLeft);
355 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
356 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000357 }else{
358 pColl = sqlite3ExprCollSeq(pParse, pLeft);
359 if( !pColl ){
360 pColl = sqlite3ExprCollSeq(pParse, pRight);
361 }
danielk19770202b292004-06-09 09:55:16 +0000362 }
363 return pColl;
364}
365
drh898c5272019-10-22 00:03:41 +0000366/* Expresssion p is a comparison operator. Return a collation sequence
367** appropriate for the comparison operator.
368**
369** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
370** However, if the OP_Commuted flag is set, then the order of the operands
371** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
372** correct collating sequence is found.
373*/
drhe7375bf2020-03-10 19:24:38 +0000374CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000375 if( ExprHasProperty(p, EP_Commuted) ){
376 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
377 }else{
378 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
379 }
380}
381
danielk19770202b292004-06-09 09:55:16 +0000382/*
drhbe5c89a2004-07-26 00:31:09 +0000383** Generate code for a comparison operator.
384*/
385static int codeCompare(
386 Parse *pParse, /* The parsing (and code generating) context */
387 Expr *pLeft, /* The left operand */
388 Expr *pRight, /* The right operand */
389 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000390 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000391 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000392 int jumpIfNull, /* If true, jump if either operand is NULL */
393 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000394){
drh35573352008-01-08 23:54:25 +0000395 int p5;
396 int addr;
397 CollSeq *p4;
398
drh86541862019-12-19 20:37:32 +0000399 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000400 if( isCommuted ){
401 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
402 }else{
403 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
404 }
drh35573352008-01-08 23:54:25 +0000405 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
406 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
407 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000408 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000409 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000410}
411
dancfbb5e82016-07-13 19:48:13 +0000412/*
dan870a0702016-08-01 16:37:43 +0000413** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000414**
415** A vector is defined as any expression that results in two or more
416** columns of result. Every TK_VECTOR node is an vector because the
417** parser will not generate a TK_VECTOR with fewer than two entries.
418** But a TK_SELECT might be either a vector or a scalar. It is only
419** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000420*/
421int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000422 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000423}
424
425/*
dancfbb5e82016-07-13 19:48:13 +0000426** If the expression passed as the only argument is of type TK_VECTOR
427** return the number of expressions in the vector. Or, if the expression
428** is a sub-select, return the number of columns in the sub-select. For
429** any other type of expression, return 1.
430*/
dan71c57db2016-07-09 20:23:55 +0000431int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000432 u8 op = pExpr->op;
433 if( op==TK_REGISTER ) op = pExpr->op2;
434 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000435 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000436 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000437 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000438 }else{
439 return 1;
dan71c57db2016-07-09 20:23:55 +0000440 }
dan71c57db2016-07-09 20:23:55 +0000441}
442
danba00e302016-07-23 20:24:06 +0000443/*
drhfc7f27b2016-08-20 00:07:01 +0000444** Return a pointer to a subexpression of pVector that is the i-th
445** column of the vector (numbered starting with 0). The caller must
446** ensure that i is within range.
447**
drh76dbe7a2016-08-20 21:02:38 +0000448** If pVector is really a scalar (and "scalar" here includes subqueries
449** that return a single column!) then return pVector unmodified.
450**
drhfc7f27b2016-08-20 00:07:01 +0000451** pVector retains ownership of the returned subexpression.
452**
453** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000454** just the expression for the i-th term of the result set, and may
455** not be ready for evaluation because the table cursor has not yet
456** been positioned.
danba00e302016-07-23 20:24:06 +0000457*/
drhfc7f27b2016-08-20 00:07:01 +0000458Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000459 assert( i<sqlite3ExprVectorSize(pVector) );
460 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000461 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
462 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000463 return pVector->x.pSelect->pEList->a[i].pExpr;
464 }else{
465 return pVector->x.pList->a[i].pExpr;
466 }
dan71c57db2016-07-09 20:23:55 +0000467 }
dan870a0702016-08-01 16:37:43 +0000468 return pVector;
dan71c57db2016-07-09 20:23:55 +0000469}
drhfc7f27b2016-08-20 00:07:01 +0000470
drhfc7f27b2016-08-20 00:07:01 +0000471/*
472** Compute and return a new Expr object which when passed to
473** sqlite3ExprCode() will generate all necessary code to compute
474** the iField-th column of the vector expression pVector.
475**
drh8762ec12016-08-20 01:06:22 +0000476** It is ok for pVector to be a scalar (as long as iField==0).
477** In that case, this routine works like sqlite3ExprDup().
478**
drhfc7f27b2016-08-20 00:07:01 +0000479** The caller owns the returned Expr object and is responsible for
480** ensuring that the returned value eventually gets freed.
481**
drh8762ec12016-08-20 01:06:22 +0000482** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000483** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000484** valid for the life of the returned object. If pVector is a TK_VECTOR
485** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000486** returns.
drh8762ec12016-08-20 01:06:22 +0000487**
488** A trick to cause a TK_SELECT pVector to be deleted together with
489** the returned Expr object is to attach the pVector to the pRight field
490** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000491*/
492Expr *sqlite3ExprForVectorField(
493 Parse *pParse, /* Parsing context */
494 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000495 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000496){
497 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000498 if( pVector->op==TK_SELECT ){
499 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000500 /* The TK_SELECT_COLUMN Expr node:
501 **
drh966e2912017-01-03 02:58:01 +0000502 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000503 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000504 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000505 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000506 ** pLeft->iTable: First in an array of register holding result, or 0
507 ** if the result is not yet computed.
508 **
509 ** sqlite3ExprDelete() specifically skips the recursive delete of
510 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000511 ** can be attached to pRight to cause this node to take ownership of
512 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
513 ** with the same pLeft pointer to the pVector, but only one of them
514 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000515 */
drhabfd35e2016-12-06 22:47:23 +0000516 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000517 if( pRet ){
518 pRet->iColumn = iField;
519 pRet->pLeft = pVector;
520 }
drhfc7f27b2016-08-20 00:07:01 +0000521 assert( pRet==0 || pRet->iTable==0 );
522 }else{
drha1251bc2016-08-20 00:51:37 +0000523 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
524 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000525 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000526 }
527 return pRet;
528}
dan71c57db2016-07-09 20:23:55 +0000529
dan5c288b92016-07-30 21:02:33 +0000530/*
531** If expression pExpr is of type TK_SELECT, generate code to evaluate
532** it. Return the register in which the result is stored (or, if the
533** sub-select returns more than one column, the first in an array
534** of registers in which the result is stored).
535**
536** If pExpr is not a TK_SELECT expression, return 0.
537*/
538static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000539 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000540#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000541 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000542 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000543 }
danf9b2e052016-08-02 17:45:00 +0000544#endif
dan8da209b2016-07-26 18:06:08 +0000545 return reg;
546}
547
dan5c288b92016-07-30 21:02:33 +0000548/*
549** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000550** or TK_SELECT that returns more than one column. This function returns
551** the register number of a register that contains the value of
552** element iField of the vector.
553**
554** If pVector is a TK_SELECT expression, then code for it must have
555** already been generated using the exprCodeSubselect() routine. In this
556** case parameter regSelect should be the first in an array of registers
557** containing the results of the sub-select.
558**
559** If pVector is of type TK_VECTOR, then code for the requested field
560** is generated. In this case (*pRegFree) may be set to the number of
561** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000562**
563** Before returning, output parameter (*ppExpr) is set to point to the
564** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000565*/
566static int exprVectorRegister(
567 Parse *pParse, /* Parse context */
568 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000569 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000570 int regSelect, /* First in array of registers */
571 Expr **ppExpr, /* OUT: Expression element */
572 int *pRegFree /* OUT: Temp register to free */
573){
drh12abf402016-08-22 14:30:05 +0000574 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000575 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000576 if( op==TK_REGISTER ){
577 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
578 return pVector->iTable+iField;
579 }
580 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000581 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
582 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000583 }
dan870a0702016-08-01 16:37:43 +0000584 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000585 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
586}
587
588/*
589** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000590** the result of the comparison (1, 0, or NULL) and write that
591** result into register dest.
592**
593** The caller must satisfy the following preconditions:
594**
595** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
596** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
597** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000598*/
drh79752b62016-08-13 10:02:17 +0000599static void codeVectorCompare(
600 Parse *pParse, /* Code generator context */
601 Expr *pExpr, /* The comparison operation */
602 int dest, /* Write results into this register */
603 u8 op, /* Comparison operator */
604 u8 p5 /* SQLITE_NULLEQ or zero */
605){
dan71c57db2016-07-09 20:23:55 +0000606 Vdbe *v = pParse->pVdbe;
607 Expr *pLeft = pExpr->pLeft;
608 Expr *pRight = pExpr->pRight;
609 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000610 int i;
611 int regLeft = 0;
612 int regRight = 0;
613 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000614 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000615 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000616
drhe7375bf2020-03-10 19:24:38 +0000617 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh70d6b832019-12-30 23:50:19 +0000618 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000619 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
620 sqlite3ErrorMsg(pParse, "row value misused");
621 return;
622 }
drhb29e60c2016-09-05 12:02:34 +0000623 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
624 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
625 || pExpr->op==TK_LT || pExpr->op==TK_GT
626 || pExpr->op==TK_LE || pExpr->op==TK_GE
627 );
628 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
629 || (pExpr->op==TK_ISNOT && op==TK_NE) );
630 assert( p5==0 || pExpr->op!=op );
631 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000632
drhb29e60c2016-09-05 12:02:34 +0000633 p5 |= SQLITE_STOREP2;
634 if( opx==TK_LE ) opx = TK_LT;
635 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000636
drhb29e60c2016-09-05 12:02:34 +0000637 regLeft = exprCodeSubselect(pParse, pLeft);
638 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000639
drhb29e60c2016-09-05 12:02:34 +0000640 for(i=0; 1 /*Loop exits by "break"*/; i++){
641 int regFree1 = 0, regFree2 = 0;
642 Expr *pL, *pR;
643 int r1, r2;
644 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000645 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
646 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000647 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000648 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
649 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
650 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
651 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
652 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
653 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
654 sqlite3ReleaseTempReg(pParse, regFree1);
655 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000656 if( i==nLeft-1 ){
657 break;
dan71c57db2016-07-09 20:23:55 +0000658 }
drhb29e60c2016-09-05 12:02:34 +0000659 if( opx==TK_EQ ){
660 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
661 p5 |= SQLITE_KEEPNULL;
662 }else if( opx==TK_NE ){
663 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
664 p5 |= SQLITE_KEEPNULL;
665 }else{
666 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
667 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
668 VdbeCoverageIf(v, op==TK_LT);
669 VdbeCoverageIf(v, op==TK_GT);
670 VdbeCoverageIf(v, op==TK_LE);
671 VdbeCoverageIf(v, op==TK_GE);
672 if( i==nLeft-2 ) opx = op;
673 }
dan71c57db2016-07-09 20:23:55 +0000674 }
drhb29e60c2016-09-05 12:02:34 +0000675 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000676}
677
danielk19774b5255a2008-06-05 16:47:39 +0000678#if SQLITE_MAX_EXPR_DEPTH>0
679/*
680** Check that argument nHeight is less than or equal to the maximum
681** expression depth allowed. If it is not, leave an error message in
682** pParse.
683*/
drh7d10d5a2008-08-20 16:35:10 +0000684int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000685 int rc = SQLITE_OK;
686 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
687 if( nHeight>mxHeight ){
688 sqlite3ErrorMsg(pParse,
689 "Expression tree is too large (maximum depth %d)", mxHeight
690 );
691 rc = SQLITE_ERROR;
692 }
693 return rc;
694}
695
696/* The following three functions, heightOfExpr(), heightOfExprList()
697** and heightOfSelect(), are used to determine the maximum height
698** of any expression tree referenced by the structure passed as the
699** first argument.
700**
701** If this maximum height is greater than the current value pointed
702** to by pnHeight, the second parameter, then set *pnHeight to that
703** value.
704*/
705static void heightOfExpr(Expr *p, int *pnHeight){
706 if( p ){
707 if( p->nHeight>*pnHeight ){
708 *pnHeight = p->nHeight;
709 }
710 }
711}
712static void heightOfExprList(ExprList *p, int *pnHeight){
713 if( p ){
714 int i;
715 for(i=0; i<p->nExpr; i++){
716 heightOfExpr(p->a[i].pExpr, pnHeight);
717 }
718 }
719}
dan1a3a3082018-01-18 19:00:54 +0000720static void heightOfSelect(Select *pSelect, int *pnHeight){
721 Select *p;
722 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000723 heightOfExpr(p->pWhere, pnHeight);
724 heightOfExpr(p->pHaving, pnHeight);
725 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000726 heightOfExprList(p->pEList, pnHeight);
727 heightOfExprList(p->pGroupBy, pnHeight);
728 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000729 }
730}
731
732/*
733** Set the Expr.nHeight variable in the structure passed as an
734** argument. An expression with no children, Expr.pList or
735** Expr.pSelect member has a height of 1. Any other expression
736** has a height equal to the maximum height of any other
737** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000738**
739** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
740** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000741*/
742static void exprSetHeight(Expr *p){
743 int nHeight = 0;
744 heightOfExpr(p->pLeft, &nHeight);
745 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000746 if( ExprHasProperty(p, EP_xIsSelect) ){
747 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000748 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000749 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000750 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000751 }
danielk19774b5255a2008-06-05 16:47:39 +0000752 p->nHeight = nHeight + 1;
753}
754
755/*
756** Set the Expr.nHeight variable using the exprSetHeight() function. If
757** the height is greater than the maximum allowed expression depth,
758** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000759**
760** Also propagate all EP_Propagate flags from the Expr.x.pList into
761** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000762*/
drh2308ed32015-02-09 16:09:34 +0000763void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000764 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000765 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000766 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000767}
768
769/*
770** Return the maximum height of any expression tree referenced
771** by the select statement passed as an argument.
772*/
773int sqlite3SelectExprHeight(Select *p){
774 int nHeight = 0;
775 heightOfSelect(p, &nHeight);
776 return nHeight;
777}
drh2308ed32015-02-09 16:09:34 +0000778#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
779/*
780** Propagate all EP_Propagate flags from the Expr.x.pList into
781** Expr.flags.
782*/
783void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000784 if( pParse->nErr ) return;
drh2308ed32015-02-09 16:09:34 +0000785 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
786 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
787 }
788}
789#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000790#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
791
drhbe5c89a2004-07-26 00:31:09 +0000792/*
drhb7916a72009-05-27 10:31:29 +0000793** This routine is the core allocator for Expr nodes.
794**
drha76b5df2002-02-23 02:32:10 +0000795** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000796** for this node and for the pToken argument is a single allocation
797** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000798** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000799**
800** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000801** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000802** parameter is ignored if pToken is NULL or if the token does not
803** appear to be quoted. If the quotes were of the form "..." (double-quotes)
804** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000805**
806** Special case: If op==TK_INTEGER and pToken points to a string that
807** can be translated into a 32-bit integer, then the token is not
808** stored in u.zToken. Instead, the integer values is written
809** into u.iValue and the EP_IntValue flag is set. No extra storage
810** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000811*/
drhb7916a72009-05-27 10:31:29 +0000812Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000813 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000814 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000815 const Token *pToken, /* Token argument. Might be NULL */
816 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000817){
drha76b5df2002-02-23 02:32:10 +0000818 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000819 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000820 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000821
drh575fad62016-02-05 13:38:36 +0000822 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000823 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000824 if( op!=TK_INTEGER || pToken->z==0
825 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
826 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000827 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000828 }
drhb7916a72009-05-27 10:31:29 +0000829 }
drh575fad62016-02-05 13:38:36 +0000830 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000831 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000832 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000833 pNew->op = (u8)op;
834 pNew->iAgg = -1;
835 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000836 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000837 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000838 pNew->u.iValue = iValue;
839 }else{
drh33e619f2009-05-28 01:00:55 +0000840 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000841 assert( pToken->z!=0 || pToken->n==0 );
842 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000843 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000844 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000845 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000846 }
drhb7916a72009-05-27 10:31:29 +0000847 }
848 }
849#if SQLITE_MAX_EXPR_DEPTH>0
850 pNew->nHeight = 1;
851#endif
852 }
drha76b5df2002-02-23 02:32:10 +0000853 return pNew;
854}
855
856/*
drhb7916a72009-05-27 10:31:29 +0000857** Allocate a new expression node from a zero-terminated token that has
858** already been dequoted.
859*/
860Expr *sqlite3Expr(
861 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
862 int op, /* Expression opcode */
863 const char *zToken /* Token argument. Might be NULL */
864){
865 Token x;
866 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000867 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000868 return sqlite3ExprAlloc(db, op, &x, 0);
869}
870
871/*
872** Attach subtrees pLeft and pRight to the Expr node pRoot.
873**
874** If pRoot==NULL that means that a memory allocation error has occurred.
875** In that case, delete the subtrees pLeft and pRight.
876*/
877void sqlite3ExprAttachSubtrees(
878 sqlite3 *db,
879 Expr *pRoot,
880 Expr *pLeft,
881 Expr *pRight
882){
883 if( pRoot==0 ){
884 assert( db->mallocFailed );
885 sqlite3ExprDelete(db, pLeft);
886 sqlite3ExprDelete(db, pRight);
887 }else{
888 if( pRight ){
889 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000890 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000891 }
892 if( pLeft ){
893 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000894 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000895 }
896 exprSetHeight(pRoot);
897 }
898}
899
900/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000901** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000902**
drhbf664462009-06-19 18:32:54 +0000903** One or both of the subtrees can be NULL. Return a pointer to the new
904** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
905** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000906*/
drh17435752007-08-16 04:30:38 +0000907Expr *sqlite3PExpr(
908 Parse *pParse, /* Parsing context */
909 int op, /* Expression opcode */
910 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000911 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000912){
drh5fb52ca2012-03-31 02:34:35 +0000913 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000914 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
915 if( p ){
916 memset(p, 0, sizeof(Expr));
917 p->op = op & 0xff;
918 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000919 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000920 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000921 }else{
922 sqlite3ExprDelete(pParse->db, pLeft);
923 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000924 }
drh4e0cff62004-11-05 05:10:28 +0000925 return p;
926}
927
928/*
drh08de4f72016-04-11 01:06:47 +0000929** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
930** do a memory allocation failure) then delete the pSelect object.
931*/
932void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
933 if( pExpr ){
934 pExpr->x.pSelect = pSelect;
935 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
936 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
937 }else{
938 assert( pParse->db->mallocFailed );
939 sqlite3SelectDelete(pParse->db, pSelect);
940 }
941}
942
943
944/*
drh91bb0ee2004-09-01 03:06:34 +0000945** Join two expressions using an AND operator. If either expression is
946** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000947**
948** If one side or the other of the AND is known to be false, then instead
949** of returning an AND expression, just return a constant expression with
950** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000951*/
drhd5c851c2019-04-19 13:38:34 +0000952Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
953 sqlite3 *db = pParse->db;
954 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000955 return pRight;
956 }else if( pRight==0 ){
957 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000958 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
959 && !IN_RENAME_OBJECT
960 ){
961 sqlite3ExprDelete(db, pLeft);
962 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000963 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000964 }else{
drhd5c851c2019-04-19 13:38:34 +0000965 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000966 }
967}
968
969/*
970** Construct a new expression node for a function with multiple
971** arguments.
972*/
drh954733b2018-07-27 23:33:16 +0000973Expr *sqlite3ExprFunction(
974 Parse *pParse, /* Parsing context */
975 ExprList *pList, /* Argument list */
976 Token *pToken, /* Name of the function */
977 int eDistinct /* SF_Distinct or SF_ALL or 0 */
978){
drha76b5df2002-02-23 02:32:10 +0000979 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000980 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000981 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000982 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000983 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000984 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000985 return 0;
986 }
drh954733b2018-07-27 23:33:16 +0000987 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
988 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
989 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000990 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000991 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000992 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000993 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000994 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000995 return pNew;
996}
997
998/*
drh0dfa5252020-01-08 17:28:19 +0000999** Check to see if a function is usable according to current access
1000** rules:
1001**
1002** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1003**
1004** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1005** top-level SQL
1006**
1007** If the function is not usable, create an error.
1008*/
1009void sqlite3ExprFunctionUsable(
1010 Parse *pParse, /* Parsing and code generating context */
1011 Expr *pExpr, /* The function invocation */
1012 FuncDef *pDef /* The function being invoked */
1013){
1014 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001015 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1016 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001017 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1018 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1019 ){
1020 /* Functions prohibited in triggers and views if:
1021 ** (1) tagged with SQLITE_DIRECTONLY
1022 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1023 ** is tagged with SQLITE_FUNC_UNSAFE) and
1024 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1025 ** that the schema is possibly tainted).
1026 */
1027 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1028 }
1029 }
1030}
1031
1032/*
drhfa6bc002004-09-07 16:19:52 +00001033** Assign a variable number to an expression that encodes a wildcard
1034** in the original SQL statement.
1035**
1036** Wildcards consisting of a single "?" are assigned the next sequential
1037** variable number.
1038**
1039** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001040** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001041** the SQL statement comes from an external source.
1042**
drh51f49f12009-05-21 20:41:32 +00001043** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001044** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001045** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001046** assigned.
1047*/
drhde25a882016-10-03 15:28:24 +00001048void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001049 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001050 const char *z;
drhf326d662016-12-23 13:30:53 +00001051 ynVar x;
drh17435752007-08-16 04:30:38 +00001052
drhfa6bc002004-09-07 16:19:52 +00001053 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001054 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001055 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001056 assert( z!=0 );
1057 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001058 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001059 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001060 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001061 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001062 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001063 }else{
drhf326d662016-12-23 13:30:53 +00001064 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001065 if( z[0]=='?' ){
1066 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1067 ** use it as the variable number */
1068 i64 i;
drh18814df2017-01-31 03:52:34 +00001069 int bOk;
1070 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1071 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1072 bOk = 1;
1073 }else{
1074 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1075 }
drh124c0b42011-06-01 18:15:55 +00001076 testcase( i==0 );
1077 testcase( i==1 );
1078 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1079 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1080 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1081 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1082 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001083 return;
drhfa6bc002004-09-07 16:19:52 +00001084 }
drh8e74e7b2017-01-31 12:41:48 +00001085 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001086 if( x>pParse->nVar ){
1087 pParse->nVar = (int)x;
1088 doAdd = 1;
1089 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1090 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001091 }
1092 }else{
1093 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1094 ** number as the prior appearance of the same name, or if the name
1095 ** has never appeared before, reuse the same variable number
1096 */
drh9bf755c2016-12-23 03:59:31 +00001097 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1098 if( x==0 ){
1099 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001100 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001101 }
drhfa6bc002004-09-07 16:19:52 +00001102 }
drhf326d662016-12-23 13:30:53 +00001103 if( doAdd ){
1104 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1105 }
1106 }
1107 pExpr->iColumn = x;
1108 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001109 sqlite3ErrorMsg(pParse, "too many SQL variables");
1110 }
drhfa6bc002004-09-07 16:19:52 +00001111}
1112
1113/*
danf6963f92009-11-23 14:39:14 +00001114** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001115*/
drh4f0010b2016-04-11 14:49:39 +00001116static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1117 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001118 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1119 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001120
1121 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1122 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001123 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001124#ifdef SQLITE_DEBUG
1125 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1126 assert( p->pLeft==0 );
1127 assert( p->pRight==0 );
1128 assert( p->x.pSelect==0 );
1129 }
1130#endif
1131 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001132 /* The Expr.x union is never used at the same time as Expr.pRight */
1133 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001134 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001135 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001136 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001137 sqlite3ExprDeleteNN(db, p->pRight);
1138 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001139 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001140 sqlite3SelectDelete(db, p->x.pSelect);
1141 }else{
1142 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001143#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001144 if( ExprHasProperty(p, EP_WinFunc) ){
1145 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001146 }
dan6ba7ab02019-07-02 11:56:47 +00001147#endif
dan8117f112019-07-10 20:16:53 +00001148 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001149 }
drh209bc522016-09-23 21:36:24 +00001150 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001151 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001152 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001153 }
drha2e00042002-01-22 03:13:42 +00001154}
drh4f0010b2016-04-11 14:49:39 +00001155void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1156 if( p ) sqlite3ExprDeleteNN(db, p);
1157}
drha2e00042002-01-22 03:13:42 +00001158
drh8e34e402019-06-11 10:43:56 +00001159/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1160** expression.
1161*/
1162void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1163 if( p ){
1164 if( IN_RENAME_OBJECT ){
1165 sqlite3RenameExprUnmap(pParse, p);
1166 }
1167 sqlite3ExprDeleteNN(pParse->db, p);
1168 }
1169}
1170
drhd2687b72005-08-12 22:56:09 +00001171/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001172** Return the number of bytes allocated for the expression structure
1173** passed as the first argument. This is always one of EXPR_FULLSIZE,
1174** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1175*/
1176static int exprStructSize(Expr *p){
1177 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001178 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1179 return EXPR_FULLSIZE;
1180}
1181
1182/*
drh33e619f2009-05-28 01:00:55 +00001183** The dupedExpr*Size() routines each return the number of bytes required
1184** to store a copy of an expression or expression tree. They differ in
1185** how much of the tree is measured.
1186**
1187** dupedExprStructSize() Size of only the Expr structure
1188** dupedExprNodeSize() Size of Expr + space for token
1189** dupedExprSize() Expr + token + subtree components
1190**
1191***************************************************************************
1192**
1193** The dupedExprStructSize() function returns two values OR-ed together:
1194** (1) the space required for a copy of the Expr structure only and
1195** (2) the EP_xxx flags that indicate what the structure size should be.
1196** The return values is always one of:
1197**
1198** EXPR_FULLSIZE
1199** EXPR_REDUCEDSIZE | EP_Reduced
1200** EXPR_TOKENONLYSIZE | EP_TokenOnly
1201**
1202** The size of the structure can be found by masking the return value
1203** of this routine with 0xfff. The flags can be found by masking the
1204** return value with EP_Reduced|EP_TokenOnly.
1205**
1206** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1207** (unreduced) Expr objects as they or originally constructed by the parser.
1208** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001209** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001210** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001211** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001212** to reduce a pristine expression tree from the parser. The implementation
1213** of dupedExprStructSize() contain multiple assert() statements that attempt
1214** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001215*/
1216static int dupedExprStructSize(Expr *p, int flags){
1217 int nSize;
drh33e619f2009-05-28 01:00:55 +00001218 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001219 assert( EXPR_FULLSIZE<=0xfff );
1220 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001221 if( 0==flags || p->op==TK_SELECT_COLUMN
1222#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001223 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001224#endif
1225 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001226 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001227 }else{
drhc5cd1242013-09-12 16:50:49 +00001228 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001229 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001230 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001231 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001232 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001233 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1234 }else{
drhaecd8022013-09-13 18:15:15 +00001235 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001236 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1237 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001238 }
1239 return nSize;
1240}
1241
1242/*
drh33e619f2009-05-28 01:00:55 +00001243** This function returns the space in bytes required to store the copy
1244** of the Expr structure and a copy of the Expr.u.zToken string (if that
1245** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001246*/
1247static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001248 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1249 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001250 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001251 }
danielk1977bc739712009-03-23 04:33:32 +00001252 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001253}
1254
1255/*
1256** Return the number of bytes required to create a duplicate of the
1257** expression passed as the first argument. The second argument is a
1258** mask containing EXPRDUP_XXX flags.
1259**
1260** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001261** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001262**
1263** If the EXPRDUP_REDUCE flag is set, then the return value includes
1264** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1265** and Expr.pRight variables (but not for any structures pointed to or
1266** descended from the Expr.x.pList or Expr.x.pSelect variables).
1267*/
1268static int dupedExprSize(Expr *p, int flags){
1269 int nByte = 0;
1270 if( p ){
1271 nByte = dupedExprNodeSize(p, flags);
1272 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001273 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001274 }
1275 }
1276 return nByte;
1277}
1278
1279/*
1280** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1281** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001282** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001283** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001284** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001285** portion of the buffer copied into by this function.
1286*/
drh3c194692016-04-11 16:43:43 +00001287static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1288 Expr *pNew; /* Value to return */
1289 u8 *zAlloc; /* Memory space from which to build Expr object */
1290 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1291
drh575fad62016-02-05 13:38:36 +00001292 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001293 assert( p );
1294 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1295 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001296
drh3c194692016-04-11 16:43:43 +00001297 /* Figure out where to write the new Expr structure. */
1298 if( pzBuffer ){
1299 zAlloc = *pzBuffer;
1300 staticFlag = EP_Static;
1301 }else{
1302 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1303 staticFlag = 0;
1304 }
1305 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001306
drh3c194692016-04-11 16:43:43 +00001307 if( pNew ){
1308 /* Set nNewSize to the size allocated for the structure pointed to
1309 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1310 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1311 ** by the copy of the p->u.zToken string (if any).
1312 */
1313 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1314 const int nNewSize = nStructSize & 0xfff;
1315 int nToken;
1316 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1317 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001318 }else{
drh3c194692016-04-11 16:43:43 +00001319 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001320 }
drh3c194692016-04-11 16:43:43 +00001321 if( dupFlags ){
1322 assert( ExprHasProperty(p, EP_Reduced)==0 );
1323 memcpy(zAlloc, p, nNewSize);
1324 }else{
1325 u32 nSize = (u32)exprStructSize(p);
1326 memcpy(zAlloc, p, nSize);
1327 if( nSize<EXPR_FULLSIZE ){
1328 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1329 }
1330 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001331
drh3c194692016-04-11 16:43:43 +00001332 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1333 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1334 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1335 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001336 ExprClearVVAProperties(pNew);
1337 if( dupFlags ){
1338 ExprSetVVAProperty(pNew, EP_Immutable);
1339 }
drh3c194692016-04-11 16:43:43 +00001340
1341 /* Copy the p->u.zToken string, if any. */
1342 if( nToken ){
1343 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1344 memcpy(zToken, p->u.zToken, nToken);
1345 }
1346
drh209bc522016-09-23 21:36:24 +00001347 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001348 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1349 if( ExprHasProperty(p, EP_xIsSelect) ){
1350 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001351 }else{
drh3c194692016-04-11 16:43:43 +00001352 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001353 }
drh3c194692016-04-11 16:43:43 +00001354 }
1355
1356 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001357 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001358 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001359 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001360 pNew->pLeft = p->pLeft ?
1361 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1362 pNew->pRight = p->pRight ?
1363 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001364 }
dan67a9b8e2018-06-22 20:51:35 +00001365#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001366 if( ExprHasProperty(p, EP_WinFunc) ){
1367 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1368 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001369 }
dan67a9b8e2018-06-22 20:51:35 +00001370#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001371 if( pzBuffer ){
1372 *pzBuffer = zAlloc;
1373 }
1374 }else{
drh209bc522016-09-23 21:36:24 +00001375 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001376 if( pNew->op==TK_SELECT_COLUMN ){
1377 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001378 assert( p->iColumn==0 || p->pRight==0 );
1379 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001380 }else{
1381 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1382 }
drh3c194692016-04-11 16:43:43 +00001383 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001384 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001385 }
1386 }
1387 return pNew;
1388}
1389
1390/*
danbfe31e72014-01-15 14:17:31 +00001391** Create and return a deep copy of the object passed as the second
1392** argument. If an OOM condition is encountered, NULL is returned
1393** and the db->mallocFailed flag set.
1394*/
daneede6a52014-01-15 19:42:23 +00001395#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001396static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001397 With *pRet = 0;
1398 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001399 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001400 pRet = sqlite3DbMallocZero(db, nByte);
1401 if( pRet ){
1402 int i;
1403 pRet->nCte = p->nCte;
1404 for(i=0; i<p->nCte; i++){
1405 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1406 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1407 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1408 }
1409 }
1410 }
1411 return pRet;
1412}
daneede6a52014-01-15 19:42:23 +00001413#else
1414# define withDup(x,y) 0
1415#endif
dan4e9119d2014-01-13 15:12:23 +00001416
drha8389972018-12-06 22:04:19 +00001417#ifndef SQLITE_OMIT_WINDOWFUNC
1418/*
1419** The gatherSelectWindows() procedure and its helper routine
1420** gatherSelectWindowsCallback() are used to scan all the expressions
1421** an a newly duplicated SELECT statement and gather all of the Window
1422** objects found there, assembling them onto the linked list at Select->pWin.
1423*/
1424static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001425 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001426 Select *pSelect = pWalker->u.pSelect;
1427 Window *pWin = pExpr->y.pWin;
1428 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001429 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001430 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001431 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001432 }
1433 return WRC_Continue;
1434}
drha37b6a52018-12-06 22:12:18 +00001435static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1436 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1437}
drha8389972018-12-06 22:04:19 +00001438static void gatherSelectWindows(Select *p){
1439 Walker w;
1440 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001441 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1442 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001443 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001444 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001445 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001446}
1447#endif
1448
1449
drha76b5df2002-02-23 02:32:10 +00001450/*
drhff78bd22002-02-27 01:47:11 +00001451** The following group of routines make deep copies of expressions,
1452** expression lists, ID lists, and select statements. The copies can
1453** be deleted (by being passed to their respective ...Delete() routines)
1454** without effecting the originals.
1455**
danielk19774adee202004-05-08 08:23:19 +00001456** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1457** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001458** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001459**
drhad3cab52002-05-24 02:04:32 +00001460** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001461**
drhb7916a72009-05-27 10:31:29 +00001462** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001463** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1464** truncated version of the usual Expr structure that will be stored as
1465** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001466*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001467Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001468 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001469 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001470}
danielk19776ab3a2e2009-02-19 14:39:25 +00001471ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001472 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001473 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001474 int i;
drhb1637482017-01-03 00:27:16 +00001475 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001476 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001477 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001478 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001479 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001480 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001481 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001482 pOldItem = p->a;
1483 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001484 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001485 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001486 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001487 if( pOldExpr
1488 && pOldExpr->op==TK_SELECT_COLUMN
1489 && (pNewExpr = pItem->pExpr)!=0
1490 ){
1491 assert( pNewExpr->iColumn==0 || i>0 );
1492 if( pNewExpr->iColumn==0 ){
1493 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001494 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1495 }else{
1496 assert( i>0 );
1497 assert( pItem[-1].pExpr!=0 );
1498 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1499 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1500 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001501 }
1502 }
drh41cee662019-12-12 20:22:34 +00001503 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001504 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001505 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001506 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001507 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001508 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001509 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001510 }
1511 return pNew;
1512}
danielk197793758c82005-01-21 08:13:14 +00001513
1514/*
1515** If cursors, triggers, views and subqueries are all omitted from
1516** the build, then none of the following routines, except for
1517** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1518** called with a NULL argument.
1519*/
danielk19776a67fe82005-02-04 04:07:16 +00001520#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1521 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001522SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001523 SrcList *pNew;
1524 int i;
drh113088e2003-03-20 01:16:58 +00001525 int nByte;
drh575fad62016-02-05 13:38:36 +00001526 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001527 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001528 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001529 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001530 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001531 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001532 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001533 struct SrcList_item *pNewItem = &pNew->a[i];
1534 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001535 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001536 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001537 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1538 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1539 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001540 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001541 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001542 pNewItem->addrFillSub = pOldItem->addrFillSub;
1543 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001544 if( pNewItem->fg.isIndexedBy ){
1545 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1546 }
1547 pNewItem->pIBIndex = pOldItem->pIBIndex;
1548 if( pNewItem->fg.isTabFunc ){
1549 pNewItem->u1.pFuncArg =
1550 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1551 }
drhed8a3bb2005-06-06 21:19:56 +00001552 pTab = pNewItem->pTab = pOldItem->pTab;
1553 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001554 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001555 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001556 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1557 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001558 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001559 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001560 }
1561 return pNew;
1562}
drh17435752007-08-16 04:30:38 +00001563IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001564 IdList *pNew;
1565 int i;
drh575fad62016-02-05 13:38:36 +00001566 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001567 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001568 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001569 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001570 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001571 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001572 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001573 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001574 return 0;
1575 }
drh6c535152012-02-02 03:38:30 +00001576 /* Note that because the size of the allocation for p->a[] is not
1577 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1578 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001579 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001580 struct IdList_item *pNewItem = &pNew->a[i];
1581 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001582 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001583 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001584 }
1585 return pNew;
1586}
dana7466202017-02-03 14:44:52 +00001587Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1588 Select *pRet = 0;
1589 Select *pNext = 0;
1590 Select **pp = &pRet;
1591 Select *p;
1592
drh575fad62016-02-05 13:38:36 +00001593 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001594 for(p=pDup; p; p=p->pPrior){
1595 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1596 if( pNew==0 ) break;
1597 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1598 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1599 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1600 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1601 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1602 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1603 pNew->op = p->op;
1604 pNew->pNext = pNext;
1605 pNew->pPrior = 0;
1606 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001607 pNew->iLimit = 0;
1608 pNew->iOffset = 0;
1609 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1610 pNew->addrOpenEphm[0] = -1;
1611 pNew->addrOpenEphm[1] = -1;
1612 pNew->nSelectRow = p->nSelectRow;
1613 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001614#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001615 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001616 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001617 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001618#endif
drhfef37762018-07-10 19:48:35 +00001619 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001620 *pp = pNew;
1621 pp = &pNew->pPrior;
1622 pNext = pNew;
1623 }
1624
1625 return pRet;
drhff78bd22002-02-27 01:47:11 +00001626}
danielk197793758c82005-01-21 08:13:14 +00001627#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001628Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001629 assert( p==0 );
1630 return 0;
1631}
1632#endif
drhff78bd22002-02-27 01:47:11 +00001633
1634
1635/*
drha76b5df2002-02-23 02:32:10 +00001636** Add a new element to the end of an expression list. If pList is
1637** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001638**
drha19543f2017-09-15 15:17:48 +00001639** The pList argument must be either NULL or a pointer to an ExprList
1640** obtained from a prior call to sqlite3ExprListAppend(). This routine
1641** may not be used with an ExprList obtained from sqlite3ExprListDup().
1642** Reason: This routine assumes that the number of slots in pList->a[]
1643** is a power of two. That is true for sqlite3ExprListAppend() returns
1644** but is not necessarily true from the return value of sqlite3ExprListDup().
1645**
drhb7916a72009-05-27 10:31:29 +00001646** If a memory allocation error occurs, the entire list is freed and
1647** NULL is returned. If non-NULL is returned, then it is guaranteed
1648** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001649*/
drh17435752007-08-16 04:30:38 +00001650ExprList *sqlite3ExprListAppend(
1651 Parse *pParse, /* Parsing context */
1652 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001653 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001654){
drh43606172017-04-05 11:32:13 +00001655 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001656 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001657 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001658 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001659 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001660 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001661 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001662 }
drhc263f7c2016-01-18 13:18:54 +00001663 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001664 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001665 ExprList *pNew;
1666 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001667 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001668 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001669 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001670 }
drh43606172017-04-05 11:32:13 +00001671 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001672 }
drh43606172017-04-05 11:32:13 +00001673 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001674 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001675 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001676 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001677 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001678 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001679
1680no_mem:
1681 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001682 sqlite3ExprDelete(db, pExpr);
1683 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001684 return 0;
drha76b5df2002-02-23 02:32:10 +00001685}
1686
1687/*
drh8762ec12016-08-20 01:06:22 +00001688** pColumns and pExpr form a vector assignment which is part of the SET
1689** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001690**
1691** (a,b,c) = (expr1,expr2,expr3)
1692** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1693**
1694** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001695** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001696** TK_SELECT_COLUMN expressions.
1697*/
1698ExprList *sqlite3ExprListAppendVector(
1699 Parse *pParse, /* Parsing context */
1700 ExprList *pList, /* List to which to append. Might be NULL */
1701 IdList *pColumns, /* List of names of LHS of the assignment */
1702 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1703){
1704 sqlite3 *db = pParse->db;
1705 int n;
1706 int i;
drh66860af2016-08-23 18:30:10 +00001707 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001708 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1709 ** exit prior to this routine being invoked */
1710 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001711 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001712
1713 /* If the RHS is a vector, then we can immediately check to see that
1714 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1715 ** wildcards ("*") in the result set of the SELECT must be expanded before
1716 ** we can do the size check, so defer the size check until code generation.
1717 */
1718 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001719 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1720 pColumns->nId, n);
1721 goto vector_append_error;
1722 }
drh966e2912017-01-03 02:58:01 +00001723
1724 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001725 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001726 assert( pSubExpr!=0 || db->mallocFailed );
1727 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1728 if( pSubExpr==0 ) continue;
1729 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001730 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1731 if( pList ){
drh66860af2016-08-23 18:30:10 +00001732 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001733 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001734 pColumns->a[i].zName = 0;
1735 }
1736 }
drh966e2912017-01-03 02:58:01 +00001737
drhffe28052017-05-06 18:09:36 +00001738 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001739 Expr *pFirst = pList->a[iFirst].pExpr;
1740 assert( pFirst!=0 );
1741 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001742
drhf4dd26c2017-04-05 11:49:06 +00001743 /* Store the SELECT statement in pRight so it will be deleted when
1744 ** sqlite3ExprListDelete() is called */
1745 pFirst->pRight = pExpr;
1746 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001747
drhf4dd26c2017-04-05 11:49:06 +00001748 /* Remember the size of the LHS in iTable so that we can check that
1749 ** the RHS and LHS sizes match during code generation. */
1750 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001751 }
1752
1753vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001754 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001755 sqlite3IdListDelete(db, pColumns);
1756 return pList;
1757}
1758
1759/*
drhbc622bc2015-08-24 15:39:42 +00001760** Set the sort order for the last element on the given ExprList.
1761*/
dan6e118922019-08-12 16:36:38 +00001762void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001763 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001764 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001765 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001766
1767 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1768 assert( iSortOrder==SQLITE_SO_UNDEFINED
1769 || iSortOrder==SQLITE_SO_ASC
1770 || iSortOrder==SQLITE_SO_DESC
1771 );
1772 assert( eNulls==SQLITE_SO_UNDEFINED
1773 || eNulls==SQLITE_SO_ASC
1774 || eNulls==SQLITE_SO_DESC
1775 );
1776
dan9105fd52019-08-19 17:26:32 +00001777 pItem = &p->a[p->nExpr-1];
1778 assert( pItem->bNulls==0 );
1779 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1780 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001781 }
dan9105fd52019-08-19 17:26:32 +00001782 pItem->sortFlags = (u8)iSortOrder;
1783
1784 if( eNulls!=SQLITE_SO_UNDEFINED ){
1785 pItem->bNulls = 1;
1786 if( iSortOrder!=eNulls ){
1787 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1788 }
drhbc622bc2015-08-24 15:39:42 +00001789 }
drhbc622bc2015-08-24 15:39:42 +00001790}
1791
1792/*
drh41cee662019-12-12 20:22:34 +00001793** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001794** on the expression list.
1795**
1796** pList might be NULL following an OOM error. But pName should never be
1797** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1798** is set.
1799*/
1800void sqlite3ExprListSetName(
1801 Parse *pParse, /* Parsing context */
1802 ExprList *pList, /* List to which to add the span. */
1803 Token *pName, /* Name to be added */
1804 int dequote /* True to cause the name to be dequoted */
1805){
1806 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001807 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001808 if( pList ){
1809 struct ExprList_item *pItem;
1810 assert( pList->nExpr>0 );
1811 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001812 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001813 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001814 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001815 if( dequote ){
1816 /* If dequote==0, then pName->z does not point to part of a DDL
1817 ** statement handled by the parser. And so no token need be added
1818 ** to the token-map. */
1819 sqlite3Dequote(pItem->zEName);
1820 if( IN_RENAME_OBJECT ){
1821 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1822 }
dan5be60c52018-08-15 20:28:39 +00001823 }
drhb7916a72009-05-27 10:31:29 +00001824 }
1825}
1826
1827/*
1828** Set the ExprList.a[].zSpan element of the most recently added item
1829** on the expression list.
1830**
1831** pList might be NULL following an OOM error. But pSpan should never be
1832** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1833** is set.
1834*/
1835void sqlite3ExprListSetSpan(
1836 Parse *pParse, /* Parsing context */
1837 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001838 const char *zStart, /* Start of the span */
1839 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001840){
1841 sqlite3 *db = pParse->db;
1842 assert( pList!=0 || db->mallocFailed!=0 );
1843 if( pList ){
1844 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1845 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001846 if( pItem->zEName==0 ){
1847 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1848 pItem->eEName = ENAME_SPAN;
1849 }
drhb7916a72009-05-27 10:31:29 +00001850 }
1851}
1852
1853/*
danielk19777a15a4b2007-05-08 17:54:43 +00001854** If the expression list pEList contains more than iLimit elements,
1855** leave an error message in pParse.
1856*/
1857void sqlite3ExprListCheckLength(
1858 Parse *pParse,
1859 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001860 const char *zObject
1861){
drhb1a6c3c2008-03-20 16:30:17 +00001862 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001863 testcase( pEList && pEList->nExpr==mx );
1864 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001865 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001866 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1867 }
1868}
1869
1870/*
drha76b5df2002-02-23 02:32:10 +00001871** Delete an entire expression list.
1872*/
drhaffa8552016-04-11 18:25:05 +00001873static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001874 int i = pList->nExpr;
1875 struct ExprList_item *pItem = pList->a;
1876 assert( pList->nExpr>0 );
1877 do{
drh633e6d52008-07-28 19:34:53 +00001878 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001879 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001880 pItem++;
1881 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001882 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001883}
drhaffa8552016-04-11 18:25:05 +00001884void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1885 if( pList ) exprListDeleteNN(db, pList);
1886}
drha76b5df2002-02-23 02:32:10 +00001887
1888/*
drh2308ed32015-02-09 16:09:34 +00001889** Return the bitwise-OR of all Expr.flags fields in the given
1890** ExprList.
drh885a5b02015-02-09 15:21:36 +00001891*/
drh2308ed32015-02-09 16:09:34 +00001892u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001893 int i;
drh2308ed32015-02-09 16:09:34 +00001894 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001895 assert( pList!=0 );
1896 for(i=0; i<pList->nExpr; i++){
1897 Expr *pExpr = pList->a[i].pExpr;
1898 assert( pExpr!=0 );
1899 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001900 }
drh2308ed32015-02-09 16:09:34 +00001901 return m;
drh885a5b02015-02-09 15:21:36 +00001902}
1903
1904/*
drh7e6f9802017-09-04 00:33:04 +00001905** This is a SELECT-node callback for the expression walker that
1906** always "fails". By "fail" in this case, we mean set
1907** pWalker->eCode to zero and abort.
1908**
1909** This callback is used by multiple expression walkers.
1910*/
1911int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1912 UNUSED_PARAMETER(NotUsed);
1913 pWalker->eCode = 0;
1914 return WRC_Abort;
1915}
1916
1917/*
drh0cbec592020-01-03 02:20:37 +00001918** Check the input string to see if it is "true" or "false" (in any case).
1919**
1920** If the string is.... Return
1921** "true" EP_IsTrue
1922** "false" EP_IsFalse
1923** anything else 0
1924*/
1925u32 sqlite3IsTrueOrFalse(const char *zIn){
1926 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1927 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1928 return 0;
1929}
1930
1931
1932/*
drh171d16b2018-02-26 20:15:54 +00001933** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001934** then convert it into an TK_TRUEFALSE term. Return non-zero if
1935** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001936*/
1937int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001938 u32 v;
drh171d16b2018-02-26 20:15:54 +00001939 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001940 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001941 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001942 ){
1943 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001944 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001945 return 1;
1946 }
1947 return 0;
1948}
1949
drh43c4ac82018-02-26 21:26:27 +00001950/*
drh96acafb2018-02-27 14:49:25 +00001951** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001952** and 0 if it is FALSE.
1953*/
drh96acafb2018-02-27 14:49:25 +00001954int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001955 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001956 assert( pExpr->op==TK_TRUEFALSE );
1957 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1958 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1959 return pExpr->u.zToken[4]==0;
1960}
1961
drh17180fc2019-04-19 17:26:19 +00001962/*
1963** If pExpr is an AND or OR expression, try to simplify it by eliminating
1964** terms that are always true or false. Return the simplified expression.
1965** Or return the original expression if no simplification is possible.
1966**
1967** Examples:
1968**
1969** (x<10) AND true => (x<10)
1970** (x<10) AND false => false
1971** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1972** (x<10) AND (y=22 OR true) => (x<10)
1973** (y=22) OR true => true
1974*/
1975Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1976 assert( pExpr!=0 );
1977 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1978 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1979 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1980 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1981 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1982 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1983 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1984 }
1985 }
1986 return pExpr;
1987}
1988
drh171d16b2018-02-26 20:15:54 +00001989
1990/*
drh059b2d52014-10-24 19:28:09 +00001991** These routines are Walker callbacks used to check expressions to
1992** see if they are "constant" for some definition of constant. The
1993** Walker.eCode value determines the type of "constant" we are looking
1994** for.
drh73b211a2005-01-18 04:00:42 +00001995**
drh7d10d5a2008-08-20 16:35:10 +00001996** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001997**
drh059b2d52014-10-24 19:28:09 +00001998** sqlite3ExprIsConstant() pWalker->eCode==1
1999** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002000** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002001** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002002**
drh059b2d52014-10-24 19:28:09 +00002003** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2004** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002005**
drh014fff22020-01-08 22:22:36 +00002006** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2007** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002008** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002009** when processing a new CREATE TABLE statement. A bound parameter raises
2010** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002011** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002012** contain a bound parameter because they were generated by older versions
2013** of SQLite to be parsed by newer versions of SQLite without raising a
2014** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002015*/
drh7d10d5a2008-08-20 16:35:10 +00002016static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002017
drh059b2d52014-10-24 19:28:09 +00002018 /* If pWalker->eCode is 2 then any term of the expression that comes from
2019 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002020 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002021 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2022 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002023 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002024 }
2025
drh626a8792005-01-17 22:08:19 +00002026 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002027 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002028 ** and either pWalker->eCode==4 or 5 or the function has the
2029 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002030 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002031 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2032 && !ExprHasProperty(pExpr, EP_WinFunc)
2033 ){
drh014fff22020-01-08 22:22:36 +00002034 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002035 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002036 }else{
2037 pWalker->eCode = 0;
2038 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002039 }
drh626a8792005-01-17 22:08:19 +00002040 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002041 /* Convert "true" or "false" in a DEFAULT clause into the
2042 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002043 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002044 return WRC_Prune;
2045 }
drh08b92082020-08-10 14:18:00 +00002046 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002047 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002048 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002049 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002050 testcase( pExpr->op==TK_ID );
2051 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002052 testcase( pExpr->op==TK_AGG_FUNCTION );
2053 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002054 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002055 return WRC_Continue;
2056 }
drh059b2d52014-10-24 19:28:09 +00002057 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2058 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002059 }
drh08b92082020-08-10 14:18:00 +00002060 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002061 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002062 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002063 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002064 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002065 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002066 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002067 pWalker->eCode = 0;
2068 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002069 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002070 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002071 /* Silently convert bound parameters that appear inside of CREATE
2072 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002073 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002074 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002075 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002076 /* A bound parameter in a CREATE statement that originates from
2077 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002078 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002079 return WRC_Abort;
2080 }
drh08b92082020-08-10 14:18:00 +00002081 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002082 default:
drh6e341b92018-04-17 18:50:40 +00002083 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2084 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002085 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002086 }
2087}
drh059b2d52014-10-24 19:28:09 +00002088static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002089 Walker w;
drh059b2d52014-10-24 19:28:09 +00002090 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002091 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002092 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002093#ifdef SQLITE_DEBUG
2094 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2095#endif
drh059b2d52014-10-24 19:28:09 +00002096 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002097 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002098 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002099}
drh626a8792005-01-17 22:08:19 +00002100
2101/*
drh059b2d52014-10-24 19:28:09 +00002102** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002103** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002104**
2105** For the purposes of this function, a double-quoted string (ex: "abc")
2106** is considered a variable but a single-quoted string (ex: 'abc') is
2107** a constant.
drhfef52082000-06-06 01:50:43 +00002108*/
danielk19774adee202004-05-08 08:23:19 +00002109int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002110 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002111}
2112
2113/*
drh07aded62018-07-28 16:24:08 +00002114** Walk an expression tree. Return non-zero if
2115**
2116** (1) the expression is constant, and
2117** (2) the expression does originate in the ON or USING clause
2118** of a LEFT JOIN, and
2119** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2120** operands created by the constant propagation optimization.
2121**
2122** When this routine returns true, it indicates that the expression
2123** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002124** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002125*/
2126int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002127 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002128}
2129
2130/*
drhfcb9f4f2015-06-01 18:13:16 +00002131** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002132** for any single row of the table with cursor iCur. In other words, the
2133** expression must not refer to any non-deterministic function nor any
2134** table other than iCur.
2135*/
2136int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2137 return exprIsConst(p, 3, iCur);
2138}
2139
danab31a842017-04-29 20:53:09 +00002140
2141/*
2142** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2143*/
2144static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2145 ExprList *pGroupBy = pWalker->u.pGroupBy;
2146 int i;
2147
2148 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2149 ** it constant. */
2150 for(i=0; i<pGroupBy->nExpr; i++){
2151 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002152 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002153 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002154 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002155 return WRC_Prune;
2156 }
2157 }
2158 }
2159
2160 /* Check if pExpr is a sub-select. If so, consider it variable. */
2161 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2162 pWalker->eCode = 0;
2163 return WRC_Abort;
2164 }
2165
2166 return exprNodeIsConstant(pWalker, pExpr);
2167}
2168
2169/*
2170** Walk the expression tree passed as the first argument. Return non-zero
2171** if the expression consists entirely of constants or copies of terms
2172** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002173**
2174** This routine is used to determine if a term of the HAVING clause can
2175** be promoted into the WHERE clause. In order for such a promotion to work,
2176** the value of the HAVING clause term must be the same for all members of
2177** a "group". The requirement that the GROUP BY term must be BINARY
2178** assumes that no other collating sequence will have a finer-grained
2179** grouping than binary. In other words (A=B COLLATE binary) implies
2180** A=B in every other collating sequence. The requirement that the
2181** GROUP BY be BINARY is stricter than necessary. It would also work
2182** to promote HAVING clauses that use the same alternative collating
2183** sequence as the GROUP BY term, but that is much harder to check,
2184** alternative collating sequences are uncommon, and this is only an
2185** optimization, so we take the easy way out and simply require the
2186** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002187*/
2188int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2189 Walker w;
danab31a842017-04-29 20:53:09 +00002190 w.eCode = 1;
2191 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002192 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002193 w.u.pGroupBy = pGroupBy;
2194 w.pParse = pParse;
2195 sqlite3WalkExpr(&w, p);
2196 return w.eCode;
2197}
2198
drh059b2d52014-10-24 19:28:09 +00002199/*
drh014fff22020-01-08 22:22:36 +00002200** Walk an expression tree for the DEFAULT field of a column definition
2201** in a CREATE TABLE statement. Return non-zero if the expression is
2202** acceptable for use as a DEFAULT. That is to say, return non-zero if
2203** the expression is constant or a function call with constant arguments.
2204** Return and 0 if there are any variables.
2205**
drh1e32bed2020-06-19 13:33:53 +00002206** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002207** processing a new CREATE TABLE statement. When isInit is true, parameters
2208** (such as ? or $abc) in the expression are converted into NULL. When
2209** isInit is false, parameters raise an error. Parameters should not be
2210** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002211** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002212** backwards compatibility.
2213**
2214** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002215**
2216** For the purposes of this function, a double-quoted string (ex: "abc")
2217** is considered a variable but a single-quoted string (ex: 'abc') is
2218** a constant.
2219*/
drhfeada2d2014-09-24 13:20:22 +00002220int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2221 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002222 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002223}
2224
drh5b88bc42013-12-07 23:35:21 +00002225#ifdef SQLITE_ENABLE_CURSOR_HINTS
2226/*
2227** Walk an expression tree. Return 1 if the expression contains a
2228** subquery of some kind. Return 0 if there are no subqueries.
2229*/
2230int sqlite3ExprContainsSubquery(Expr *p){
2231 Walker w;
drhbec24762015-08-13 20:07:13 +00002232 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002233 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002234 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002235#ifdef SQLITE_DEBUG
2236 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2237#endif
drh5b88bc42013-12-07 23:35:21 +00002238 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002239 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002240}
2241#endif
2242
drheb55bd22005-06-30 17:04:21 +00002243/*
drh73b211a2005-01-18 04:00:42 +00002244** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002245** to fit in a 32-bit integer, return 1 and put the value of the integer
2246** in *pValue. If the expression is not an integer or if it is too big
2247** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002248*/
danielk19774adee202004-05-08 08:23:19 +00002249int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002250 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002251 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002252
2253 /* If an expression is an integer literal that fits in a signed 32-bit
2254 ** integer, then the EP_IntValue flag will have already been set */
2255 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2256 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2257
drh92b01d52008-06-24 00:32:35 +00002258 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002259 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002260 return 1;
2261 }
drhe4de1fe2002-06-02 16:09:01 +00002262 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002263 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002264 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002265 break;
drh4b59ab52002-08-24 18:24:51 +00002266 }
drhe4de1fe2002-06-02 16:09:01 +00002267 case TK_UMINUS: {
2268 int v;
danielk19774adee202004-05-08 08:23:19 +00002269 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002270 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002271 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002272 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002273 }
2274 break;
2275 }
2276 default: break;
2277 }
drh92b01d52008-06-24 00:32:35 +00002278 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002279}
2280
2281/*
drh039fc322009-11-17 18:31:47 +00002282** Return FALSE if there is no chance that the expression can be NULL.
2283**
2284** If the expression might be NULL or if the expression is too complex
2285** to tell return TRUE.
2286**
2287** This routine is used as an optimization, to skip OP_IsNull opcodes
2288** when we know that a value cannot be NULL. Hence, a false positive
2289** (returning TRUE when in fact the expression can never be NULL) might
2290** be a small performance hit but is otherwise harmless. On the other
2291** hand, a false negative (returning FALSE when the result could be NULL)
2292** will likely result in an incorrect answer. So when in doubt, return
2293** TRUE.
2294*/
2295int sqlite3ExprCanBeNull(const Expr *p){
2296 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002297 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2298 p = p->pLeft;
2299 }
drh039fc322009-11-17 18:31:47 +00002300 op = p->op;
2301 if( op==TK_REGISTER ) op = p->op2;
2302 switch( op ){
2303 case TK_INTEGER:
2304 case TK_STRING:
2305 case TK_FLOAT:
2306 case TK_BLOB:
2307 return 0;
drh7248a8b2014-08-04 18:50:54 +00002308 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002309 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002310 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002311 (p->iColumn>=0
2312 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2313 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002314 default:
2315 return 1;
2316 }
2317}
2318
2319/*
2320** Return TRUE if the given expression is a constant which would be
2321** unchanged by OP_Affinity with the affinity given in the second
2322** argument.
2323**
2324** This routine is used to determine if the OP_Affinity operation
2325** can be omitted. When in doubt return FALSE. A false negative
2326** is harmless. A false positive, however, can result in the wrong
2327** answer.
2328*/
2329int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2330 u8 op;
drhaf866402019-08-22 11:11:28 +00002331 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002332 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002333 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2334 if( p->op==TK_UMINUS ) unaryMinus = 1;
2335 p = p->pLeft;
2336 }
drh039fc322009-11-17 18:31:47 +00002337 op = p->op;
2338 if( op==TK_REGISTER ) op = p->op2;
2339 switch( op ){
2340 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002341 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002342 }
2343 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002344 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002345 }
2346 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002347 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002348 }
2349 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002350 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002351 }
drh2f2855b2009-11-18 01:25:26 +00002352 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002353 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002354 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002355 }
drh039fc322009-11-17 18:31:47 +00002356 default: {
2357 return 0;
2358 }
2359 }
2360}
2361
2362/*
drhc4a3c772001-04-04 11:48:57 +00002363** Return TRUE if the given string is a row-id column name.
2364*/
danielk19774adee202004-05-08 08:23:19 +00002365int sqlite3IsRowid(const char *z){
2366 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2367 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2368 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002369 return 0;
2370}
2371
danielk19779a96b662007-11-29 17:05:18 +00002372/*
drh69c355b2016-03-09 15:34:51 +00002373** pX is the RHS of an IN operator. If pX is a SELECT statement
2374** that can be simplified to a direct table access, then return
2375** a pointer to the SELECT statement. If pX is not a SELECT statement,
2376** or if the SELECT statement needs to be manifested into a transient
2377** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002378*/
2379#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002380static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002381 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002382 SrcList *pSrc;
2383 ExprList *pEList;
2384 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002385 int i;
drh69c355b2016-03-09 15:34:51 +00002386 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2387 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2388 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002389 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002390 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002391 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2392 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2393 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002394 }
drh2e26a602020-01-06 18:59:46 +00002395 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002396 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002397 if( p->pWhere ) return 0; /* Has no WHERE clause */
2398 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002399 assert( pSrc!=0 );
2400 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002401 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002402 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002403 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002404 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002405 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2406 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002407 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002408 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002409 for(i=0; i<pEList->nExpr; i++){
2410 Expr *pRes = pEList->a[i].pExpr;
2411 if( pRes->op!=TK_COLUMN ) return 0;
2412 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002413 }
drh69c355b2016-03-09 15:34:51 +00002414 return p;
drhb287f4b2008-04-25 00:08:38 +00002415}
2416#endif /* SQLITE_OMIT_SUBQUERY */
2417
danf9b2e052016-08-02 17:45:00 +00002418#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002419/*
drh4c259e92014-08-01 21:12:35 +00002420** Generate code that checks the left-most column of index table iCur to see if
2421** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002422** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2423** to be set to NULL if iCur contains one or more NULL values.
2424*/
2425static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002426 int addr1;
drh6be515e2014-08-01 21:00:53 +00002427 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002428 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002429 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2430 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002431 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002432 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002433}
danf9b2e052016-08-02 17:45:00 +00002434#endif
drh6be515e2014-08-01 21:00:53 +00002435
drhbb53ecb2014-08-02 21:03:33 +00002436
2437#ifndef SQLITE_OMIT_SUBQUERY
2438/*
2439** The argument is an IN operator with a list (not a subquery) on the
2440** right-hand side. Return TRUE if that list is constant.
2441*/
2442static int sqlite3InRhsIsConstant(Expr *pIn){
2443 Expr *pLHS;
2444 int res;
2445 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2446 pLHS = pIn->pLeft;
2447 pIn->pLeft = 0;
2448 res = sqlite3ExprIsConstant(pIn);
2449 pIn->pLeft = pLHS;
2450 return res;
2451}
2452#endif
2453
drh6be515e2014-08-01 21:00:53 +00002454/*
danielk19779a96b662007-11-29 17:05:18 +00002455** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002456** The pX parameter is the expression on the RHS of the IN operator, which
2457** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002458**
drhd4305ca2012-09-18 17:08:33 +00002459** The job of this routine is to find or create a b-tree object that can
2460** be used either to test for membership in the RHS set or to iterate through
2461** all members of the RHS set, skipping duplicates.
2462**
drh3a856252014-08-01 14:46:57 +00002463** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002464** and pX->iTable is set to the index of that cursor.
2465**
drhb74b1012009-05-28 21:04:37 +00002466** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002467**
drh1ccce442013-03-12 20:38:51 +00002468** IN_INDEX_ROWID - The cursor was opened on a database table.
2469** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2470** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2471** IN_INDEX_EPH - The cursor was opened on a specially created and
2472** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002473** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2474** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002475**
drhd4305ca2012-09-18 17:08:33 +00002476** An existing b-tree might be used if the RHS expression pX is a simple
2477** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002478**
dan553168c2016-08-01 20:14:31 +00002479** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002480**
drhd4305ca2012-09-18 17:08:33 +00002481** If the RHS of the IN operator is a list or a more complex subquery, then
2482** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002483** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002484** existing table.
drhd4305ca2012-09-18 17:08:33 +00002485**
drh7fc0ba02017-11-17 15:02:00 +00002486** The inFlags parameter must contain, at a minimum, one of the bits
2487** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2488** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2489** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2490** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002491**
2492** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2493** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002494** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002495** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2496** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002497**
drh3a856252014-08-01 14:46:57 +00002498** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2499** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002500** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2501** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002502**
drhbb53ecb2014-08-02 21:03:33 +00002503** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2504** if the RHS of the IN operator is a list (not a subquery) then this
2505** routine might decide that creating an ephemeral b-tree for membership
2506** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2507** calling routine should implement the IN operator using a sequence
2508** of Eq or Ne comparison operations.
2509**
drhb74b1012009-05-28 21:04:37 +00002510** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002511** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002512** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002513** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002514** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002515** to *prRhsHasNull. If there is no chance that the (...) contains a
2516** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002517**
drhe21a6e12014-08-01 18:00:24 +00002518** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002519** the value in that register will be NULL if the b-tree contains one or more
2520** NULL values, and it will be some non-NULL value if the b-tree contains no
2521** NULL values.
dan553168c2016-08-01 20:14:31 +00002522**
2523** If the aiMap parameter is not NULL, it must point to an array containing
2524** one element for each column returned by the SELECT statement on the RHS
2525** of the IN(...) operator. The i'th entry of the array is populated with the
2526** offset of the index column that matches the i'th column returned by the
2527** SELECT. For example, if the expression and selected index are:
2528**
2529** (?,?,?) IN (SELECT a, b, c FROM t1)
2530** CREATE INDEX i1 ON t1(b, c, a);
2531**
2532** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002533*/
danielk1977284f4ac2007-12-10 05:03:46 +00002534#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002535int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002536 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002537 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002538 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2539 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002540 int *aiMap, /* Mapping from Index fields to RHS fields */
2541 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002542){
drhb74b1012009-05-28 21:04:37 +00002543 Select *p; /* SELECT to the right of IN operator */
2544 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2545 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002546 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002547 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002548
drh1450bc62009-10-30 13:25:56 +00002549 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002550 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002551
dan7b35a772016-07-28 19:47:15 +00002552 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2553 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002554 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002555 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002556 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002557 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2558 int i;
2559 ExprList *pEList = pX->x.pSelect->pEList;
2560 for(i=0; i<pEList->nExpr; i++){
2561 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2562 }
2563 if( i==pEList->nExpr ){
2564 prRhsHasNull = 0;
2565 }
2566 }
2567
drhb74b1012009-05-28 21:04:37 +00002568 /* Check to see if an existing table or index can be used to
2569 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002570 ** ephemeral table. */
2571 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002572 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002573 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002574 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002575 ExprList *pEList = p->pEList;
2576 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002577
drhb07028f2011-10-14 21:49:18 +00002578 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2579 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2580 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2581 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002582
drhb22f7c82014-02-06 23:56:27 +00002583 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002584 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drhbdd4f7d2020-05-26 10:54:46 +00002585 assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
danielk1977e1fb65a2009-04-02 17:23:32 +00002586 sqlite3CodeVerifySchema(pParse, iDb);
2587 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002588
drha84a2832016-08-26 21:15:35 +00002589 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002590 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002591 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002592 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002593 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002594
2595 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2596 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002597 ExplainQueryPlan((pParse, 0,
2598 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002599 sqlite3VdbeJumpHere(v, iAddr);
2600 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002601 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002602 int affinity_ok = 1;
2603 int i;
2604
2605 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002606 ** comparison is the same as the affinity of each column in table
2607 ** on the RHS of the IN operator. If it not, it is not possible to
2608 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002609 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002610 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002611 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002612 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002613 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002614 testcase( cmpaff==SQLITE_AFF_BLOB );
2615 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002616 switch( cmpaff ){
2617 case SQLITE_AFF_BLOB:
2618 break;
2619 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002620 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2621 ** other has no affinity and the other side is TEXT. Hence,
2622 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2623 ** and for the term on the LHS of the IN to have no affinity. */
2624 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002625 break;
2626 default:
2627 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2628 }
2629 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002630
drha84a2832016-08-26 21:15:35 +00002631 if( affinity_ok ){
2632 /* Search for an existing index that will work for this IN operator */
2633 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2634 Bitmask colUsed; /* Columns of the index used */
2635 Bitmask mCol; /* Mask for the current column */
2636 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002637 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002638 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2639 ** BITMASK(nExpr) without overflowing */
2640 testcase( pIdx->nColumn==BMS-2 );
2641 testcase( pIdx->nColumn==BMS-1 );
2642 if( pIdx->nColumn>=BMS-1 ) continue;
2643 if( mustBeUnique ){
2644 if( pIdx->nKeyCol>nExpr
2645 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2646 ){
2647 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002648 }
danielk19770cdc0222008-06-26 18:04:03 +00002649 }
drha84a2832016-08-26 21:15:35 +00002650
2651 colUsed = 0; /* Columns of index used so far */
2652 for(i=0; i<nExpr; i++){
2653 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2654 Expr *pRhs = pEList->a[i].pExpr;
2655 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2656 int j;
2657
2658 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2659 for(j=0; j<nExpr; j++){
2660 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2661 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002662 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2663 continue;
2664 }
drha84a2832016-08-26 21:15:35 +00002665 break;
2666 }
2667 if( j==nExpr ) break;
2668 mCol = MASKBIT(j);
2669 if( mCol & colUsed ) break; /* Each column used only once */
2670 colUsed |= mCol;
2671 if( aiMap ) aiMap[i] = j;
2672 }
2673
2674 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2675 if( colUsed==(MASKBIT(nExpr)-1) ){
2676 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002677 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002678 ExplainQueryPlan((pParse, 0,
2679 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002680 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2681 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2682 VdbeComment((v, "%s", pIdx->zName));
2683 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2684 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2685
2686 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002687#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002688 i64 mask = (1<<nExpr)-1;
2689 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2690 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002691#endif
2692 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002693 if( nExpr==1 ){
2694 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2695 }
2696 }
2697 sqlite3VdbeJumpHere(v, iAddr);
2698 }
2699 } /* End loop over indexes */
2700 } /* End if( affinity_ok ) */
2701 } /* End if not an rowid index */
2702 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002703
drhbb53ecb2014-08-02 21:03:33 +00002704 /* If no preexisting index is available for the IN clause
2705 ** and IN_INDEX_NOOP is an allowed reply
2706 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002707 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002708 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002709 ** the IN operator so return IN_INDEX_NOOP.
2710 */
2711 if( eType==0
2712 && (inFlags & IN_INDEX_NOOP_OK)
2713 && !ExprHasProperty(pX, EP_xIsSelect)
2714 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2715 ){
2716 eType = IN_INDEX_NOOP;
2717 }
drhbb53ecb2014-08-02 21:03:33 +00002718
danielk19779a96b662007-11-29 17:05:18 +00002719 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002720 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002721 ** We will have to generate an ephemeral table to do the job.
2722 */
drh8e23daf2013-06-11 13:30:04 +00002723 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002724 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002725 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002726 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002727 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002728 }else if( prRhsHasNull ){
2729 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002730 }
drh85bcdce2018-12-23 21:27:29 +00002731 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002732 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002733 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002734 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002735 }
drhcf4d38a2010-07-28 02:53:36 +00002736 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002737 }
danba00e302016-07-23 20:24:06 +00002738
2739 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2740 int i, n;
2741 n = sqlite3ExprVectorSize(pX->pLeft);
2742 for(i=0; i<n; i++) aiMap[i] = i;
2743 }
drh2c041312018-12-24 02:34:49 +00002744 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002745 return eType;
2746}
danielk1977284f4ac2007-12-10 05:03:46 +00002747#endif
drh626a8792005-01-17 22:08:19 +00002748
danf9b2e052016-08-02 17:45:00 +00002749#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002750/*
2751** Argument pExpr is an (?, ?...) IN(...) expression. This
2752** function allocates and returns a nul-terminated string containing
2753** the affinities to be used for each column of the comparison.
2754**
2755** It is the responsibility of the caller to ensure that the returned
2756** string is eventually freed using sqlite3DbFree().
2757*/
dan71c57db2016-07-09 20:23:55 +00002758static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2759 Expr *pLeft = pExpr->pLeft;
2760 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002761 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002762 char *zRet;
2763
dan553168c2016-08-01 20:14:31 +00002764 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002765 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002766 if( zRet ){
2767 int i;
2768 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002769 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002770 char a = sqlite3ExprAffinity(pA);
2771 if( pSelect ){
2772 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2773 }else{
2774 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002775 }
dan71c57db2016-07-09 20:23:55 +00002776 }
2777 zRet[nVal] = '\0';
2778 }
2779 return zRet;
2780}
danf9b2e052016-08-02 17:45:00 +00002781#endif
dan71c57db2016-07-09 20:23:55 +00002782
dan8da209b2016-07-26 18:06:08 +00002783#ifndef SQLITE_OMIT_SUBQUERY
2784/*
2785** Load the Parse object passed as the first argument with an error
2786** message of the form:
2787**
2788** "sub-select returns N columns - expected M"
2789*/
2790void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002791 if( pParse->nErr==0 ){
2792 const char *zFmt = "sub-select returns %d columns - expected %d";
2793 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2794 }
dan8da209b2016-07-26 18:06:08 +00002795}
2796#endif
2797
drh626a8792005-01-17 22:08:19 +00002798/*
dan44c56042016-12-07 15:38:37 +00002799** Expression pExpr is a vector that has been used in a context where
2800** it is not permitted. If pExpr is a sub-select vector, this routine
2801** loads the Parse object with a message of the form:
2802**
2803** "sub-select returns N columns - expected 1"
2804**
2805** Or, if it is a regular scalar vector:
2806**
2807** "row value misused"
2808*/
2809void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2810#ifndef SQLITE_OMIT_SUBQUERY
2811 if( pExpr->flags & EP_xIsSelect ){
2812 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2813 }else
2814#endif
2815 {
2816 sqlite3ErrorMsg(pParse, "row value misused");
2817 }
2818}
2819
drh85bcdce2018-12-23 21:27:29 +00002820#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002821/*
drh85bcdce2018-12-23 21:27:29 +00002822** Generate code that will construct an ephemeral table containing all terms
2823** in the RHS of an IN operator. The IN operator can be in either of two
2824** forms:
drh626a8792005-01-17 22:08:19 +00002825**
drh9cbe6352005-11-29 03:13:21 +00002826** x IN (4,5,11) -- IN operator with list on right-hand side
2827** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002828**
drh2c041312018-12-24 02:34:49 +00002829** The pExpr parameter is the IN operator. The cursor number for the
2830** constructed ephermeral table is returned. The first time the ephemeral
2831** table is computed, the cursor number is also stored in pExpr->iTable,
2832** however the cursor number returned might not be the same, as it might
2833** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002834**
drh85bcdce2018-12-23 21:27:29 +00002835** If the LHS expression ("x" in the examples) is a column value, or
2836** the SELECT statement returns a column value, then the affinity of that
2837** column is used to build the index keys. If both 'x' and the
2838** SELECT... statement are columns, then numeric affinity is used
2839** if either column has NUMERIC or INTEGER affinity. If neither
2840** 'x' nor the SELECT... statement are columns, then numeric affinity
2841** is used.
drhcce7d172000-05-31 15:34:51 +00002842*/
drh85bcdce2018-12-23 21:27:29 +00002843void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002844 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002845 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002846 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002847){
drh2c041312018-12-24 02:34:49 +00002848 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002849 int addr; /* Address of OP_OpenEphemeral instruction */
2850 Expr *pLeft; /* the LHS of the IN operator */
2851 KeyInfo *pKeyInfo = 0; /* Key information */
2852 int nVal; /* Size of vector pLeft */
2853 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002854
drh2c041312018-12-24 02:34:49 +00002855 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002856 assert( v!=0 );
2857
drh2c041312018-12-24 02:34:49 +00002858 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002859 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002860 **
2861 ** * The right-hand side is a correlated subquery
2862 ** * The right-hand side is an expression list containing variables
2863 ** * We are inside a trigger
2864 **
drh2c041312018-12-24 02:34:49 +00002865 ** If all of the above are false, then we can compute the RHS just once
2866 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002867 */
drhefb699f2018-12-24 11:55:44 +00002868 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002869 /* Reuse of the RHS is allowed */
2870 /* If this routine has already been coded, but the previous code
2871 ** might not have been invoked yet, so invoke it now as a subroutine.
2872 */
2873 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002874 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002875 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2876 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2877 pExpr->x.pSelect->selId));
2878 }
drh2c041312018-12-24 02:34:49 +00002879 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2880 pExpr->y.sub.iAddr);
2881 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002882 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002883 return;
2884 }
2885
2886 /* Begin coding the subroutine */
2887 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002888 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002889 pExpr->y.sub.regReturn = ++pParse->nMem;
2890 pExpr->y.sub.iAddr =
2891 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2892 VdbeComment((v, "return address"));
2893
2894 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002895 }
2896
drh85bcdce2018-12-23 21:27:29 +00002897 /* Check to see if this is a vector IN operator */
2898 pLeft = pExpr->pLeft;
2899 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002900
drh85bcdce2018-12-23 21:27:29 +00002901 /* Construct the ephemeral table that will contain the content of
2902 ** RHS of the IN operator.
2903 */
drh2c041312018-12-24 02:34:49 +00002904 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002905 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002906#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2907 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2908 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2909 }else{
2910 VdbeComment((v, "RHS of IN operator"));
2911 }
2912#endif
drh50ef6712019-02-22 23:29:56 +00002913 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002914
drh85bcdce2018-12-23 21:27:29 +00002915 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2916 /* Case 1: expr IN (SELECT ...)
2917 **
2918 ** Generate code to write the results of the select into the temporary
2919 ** table allocated and opened above.
2920 */
2921 Select *pSelect = pExpr->x.pSelect;
2922 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002923
drh2c041312018-12-24 02:34:49 +00002924 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2925 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002926 ));
drh85bcdce2018-12-23 21:27:29 +00002927 /* If the LHS and RHS of the IN operator do not match, that
2928 ** error will have been caught long before we reach this point. */
2929 if( ALWAYS(pEList->nExpr==nVal) ){
2930 SelectDest dest;
2931 int i;
drhbd462bc2018-12-24 20:21:06 +00002932 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002933 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2934 pSelect->iLimit = 0;
2935 testcase( pSelect->selFlags & SF_Distinct );
2936 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2937 if( sqlite3Select(pParse, pSelect, &dest) ){
2938 sqlite3DbFree(pParse->db, dest.zAffSdst);
2939 sqlite3KeyInfoUnref(pKeyInfo);
2940 return;
drhfef52082000-06-06 01:50:43 +00002941 }
drh85bcdce2018-12-23 21:27:29 +00002942 sqlite3DbFree(pParse->db, dest.zAffSdst);
2943 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2944 assert( pEList!=0 );
2945 assert( pEList->nExpr>0 );
2946 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2947 for(i=0; i<nVal; i++){
2948 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2949 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2950 pParse, p, pEList->a[i].pExpr
2951 );
danielk197741a05b72008-10-02 13:50:55 +00002952 }
drh85bcdce2018-12-23 21:27:29 +00002953 }
2954 }else if( ALWAYS(pExpr->x.pList!=0) ){
2955 /* Case 2: expr IN (exprlist)
2956 **
2957 ** For each expression, build an index key from the evaluation and
2958 ** store it in the temporary table. If <expr> is a column, then use
2959 ** that columns affinity when building index keys. If <expr> is not
2960 ** a column, use numeric affinity.
2961 */
2962 char affinity; /* Affinity of the LHS of the IN */
2963 int i;
2964 ExprList *pList = pExpr->x.pList;
2965 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002966 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002967 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002968 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002969 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00002970 }else if( affinity==SQLITE_AFF_REAL ){
2971 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00002972 }
2973 if( pKeyInfo ){
2974 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2975 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002976 }
2977
drh85bcdce2018-12-23 21:27:29 +00002978 /* Loop through each expression in <exprlist>. */
2979 r1 = sqlite3GetTempReg(pParse);
2980 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002981 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2982 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002983
2984 /* If the expression is not constant then we will need to
2985 ** disable the test that was generated above that makes sure
2986 ** this code only executes once. Because for a non-constant
2987 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002988 */
drh2c041312018-12-24 02:34:49 +00002989 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2990 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002991 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002992 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002993 }
drh1398ad32005-01-19 23:24:50 +00002994
drh85bcdce2018-12-23 21:27:29 +00002995 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002996 sqlite3ExprCode(pParse, pE2, r1);
2997 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2998 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002999 }
drh85bcdce2018-12-23 21:27:29 +00003000 sqlite3ReleaseTempReg(pParse, r1);
3001 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003002 }
drh85bcdce2018-12-23 21:27:29 +00003003 if( pKeyInfo ){
3004 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3005 }
drh2c041312018-12-24 02:34:49 +00003006 if( addrOnce ){
3007 sqlite3VdbeJumpHere(v, addrOnce);
3008 /* Subroutine return */
3009 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3010 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003011 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003012 }
3013}
3014#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003015
drh85bcdce2018-12-23 21:27:29 +00003016/*
3017** Generate code for scalar subqueries used as a subquery expression
3018** or EXISTS operator:
3019**
3020** (SELECT a FROM b) -- subquery
3021** EXISTS (SELECT a FROM b) -- EXISTS subquery
3022**
3023** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3024**
drhd86fe442019-08-26 13:45:49 +00003025** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003026** the result is stored in a contiguous array of registers and the
3027** return value is the register of the left-most result column.
3028** Return 0 if an error occurs.
3029*/
3030#ifndef SQLITE_OMIT_SUBQUERY
3031int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003032 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003033 int rReg = 0; /* Register storing resulting */
3034 Select *pSel; /* SELECT statement to encode */
3035 SelectDest dest; /* How to deal with SELECT result */
3036 int nReg; /* Registers to allocate */
3037 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003038
3039 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003040 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003041 testcase( pExpr->op==TK_EXISTS );
3042 testcase( pExpr->op==TK_SELECT );
3043 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3044 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3045 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003046
drh5198ff52018-12-24 12:09:47 +00003047 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003048 ** is encountered if any of the following is true:
3049 **
3050 ** * The right-hand side is a correlated subquery
3051 ** * The right-hand side is an expression list containing variables
3052 ** * We are inside a trigger
3053 **
3054 ** If all of the above are false, then we can run this code just once
3055 ** save the results, and reuse the same result on subsequent invocations.
3056 */
3057 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003058 /* If this routine has already been coded, then invoke it as a
3059 ** subroutine. */
3060 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003061 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003062 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3063 pExpr->y.sub.iAddr);
3064 return pExpr->iTable;
3065 }
3066
3067 /* Begin coding the subroutine */
3068 ExprSetProperty(pExpr, EP_Subrtn);
3069 pExpr->y.sub.regReturn = ++pParse->nMem;
3070 pExpr->y.sub.iAddr =
3071 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3072 VdbeComment((v, "return address"));
3073
drh2c041312018-12-24 02:34:49 +00003074 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003075 }
drh85bcdce2018-12-23 21:27:29 +00003076
3077 /* For a SELECT, generate code to put the values for all columns of
3078 ** the first row into an array of registers and return the index of
3079 ** the first register.
3080 **
3081 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3082 ** into a register and return that register number.
3083 **
3084 ** In both cases, the query is augmented with "LIMIT 1". Any
3085 ** preexisting limit is discarded in place of the new LIMIT 1.
3086 */
drhbd462bc2018-12-24 20:21:06 +00003087 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3088 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003089 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3090 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3091 pParse->nMem += nReg;
3092 if( pExpr->op==TK_SELECT ){
3093 dest.eDest = SRT_Mem;
3094 dest.iSdst = dest.iSDParm;
3095 dest.nSdst = nReg;
3096 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3097 VdbeComment((v, "Init subquery result"));
3098 }else{
3099 dest.eDest = SRT_Exists;
3100 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3101 VdbeComment((v, "Init EXISTS result"));
3102 }
drh85bcdce2018-12-23 21:27:29 +00003103 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003104 /* The subquery already has a limit. If the pre-existing limit is X
3105 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3106 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003107 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003108 if( pLimit ){
3109 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3110 pLimit = sqlite3PExpr(pParse, TK_NE,
3111 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3112 }
3113 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003114 pSel->pLimit->pLeft = pLimit;
3115 }else{
drh7ca13472019-09-23 11:55:22 +00003116 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003117 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003118 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3119 }
3120 pSel->iLimit = 0;
3121 if( sqlite3Select(pParse, pSel, &dest) ){
3122 return 0;
3123 }
drh2c041312018-12-24 02:34:49 +00003124 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003125 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003126 if( addrOnce ){
3127 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003128
drh5198ff52018-12-24 12:09:47 +00003129 /* Subroutine return */
3130 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3131 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003132 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003133 }
drh2c041312018-12-24 02:34:49 +00003134
drh1450bc62009-10-30 13:25:56 +00003135 return rReg;
drhcce7d172000-05-31 15:34:51 +00003136}
drh51522cd2005-01-20 13:36:19 +00003137#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003138
drhe3365e62009-11-12 17:52:24 +00003139#ifndef SQLITE_OMIT_SUBQUERY
3140/*
dan7b35a772016-07-28 19:47:15 +00003141** Expr pIn is an IN(...) expression. This function checks that the
3142** sub-select on the RHS of the IN() operator has the same number of
3143** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3144** a sub-query, that the LHS is a vector of size 1.
3145*/
3146int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3147 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3148 if( (pIn->flags & EP_xIsSelect) ){
3149 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3150 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3151 return 1;
3152 }
3153 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003154 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003155 return 1;
3156 }
3157 return 0;
3158}
3159#endif
3160
3161#ifndef SQLITE_OMIT_SUBQUERY
3162/*
drhe3365e62009-11-12 17:52:24 +00003163** Generate code for an IN expression.
3164**
3165** x IN (SELECT ...)
3166** x IN (value, value, ...)
3167**
drhecb87ac2016-08-25 15:46:25 +00003168** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003169** right-hand side (RHS) is an array of zero or more scalar values, or a
3170** subquery. If the RHS is a subquery, the number of result columns must
3171** match the number of columns in the vector on the LHS. If the RHS is
3172** a list of values, the LHS must be a scalar.
3173**
3174** The IN operator is true if the LHS value is contained within the RHS.
3175** The result is false if the LHS is definitely not in the RHS. The
3176** result is NULL if the presence of the LHS in the RHS cannot be
3177** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003178**
drh6be515e2014-08-01 21:00:53 +00003179** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003180** contained within the RHS. If due to NULLs we cannot determine if the LHS
3181** is contained in the RHS then jump to destIfNull. If the LHS is contained
3182** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003183**
3184** See the separate in-operator.md documentation file in the canonical
3185** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003186*/
3187static void sqlite3ExprCodeIN(
3188 Parse *pParse, /* Parsing and code generating context */
3189 Expr *pExpr, /* The IN expression */
3190 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3191 int destIfNull /* Jump here if the results are unknown due to NULLs */
3192){
3193 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003194 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003195 int rLhs; /* Register(s) holding the LHS values */
3196 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003197 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003198 int *aiMap = 0; /* Map from vector field to index column */
3199 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003200 int nVector; /* Size of vectors for this IN operator */
3201 int iDummy; /* Dummy parameter to exprCodeVector() */
3202 Expr *pLeft; /* The LHS of the IN operator */
3203 int i; /* loop counter */
3204 int destStep2; /* Where to jump when NULLs seen in step 2 */
3205 int destStep6 = 0; /* Start of code for Step 6 */
3206 int addrTruthOp; /* Address of opcode that determines the IN is true */
3207 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3208 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003209 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003210 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003211
drhe7375bf2020-03-10 19:24:38 +00003212 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003213 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003214 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003215 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003216 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3217 aiMap = (int*)sqlite3DbMallocZero(
3218 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3219 );
drhe347d3e2016-08-25 21:14:34 +00003220 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003221
danba00e302016-07-23 20:24:06 +00003222 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003223 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003224 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3225 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003226 v = pParse->pVdbe;
3227 assert( v!=0 ); /* OOM detected prior to this routine */
3228 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003229 eType = sqlite3FindInIndex(pParse, pExpr,
3230 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003231 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3232 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003233
danba00e302016-07-23 20:24:06 +00003234 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3235 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3236 );
drhecb87ac2016-08-25 15:46:25 +00003237#ifdef SQLITE_DEBUG
3238 /* Confirm that aiMap[] contains nVector integer values between 0 and
3239 ** nVector-1. */
3240 for(i=0; i<nVector; i++){
3241 int j, cnt;
3242 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3243 assert( cnt==1 );
3244 }
3245#endif
drhe3365e62009-11-12 17:52:24 +00003246
danba00e302016-07-23 20:24:06 +00003247 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3248 ** vector, then it is stored in an array of nVector registers starting
3249 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003250 **
3251 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3252 ** so that the fields are in the same order as an existing index. The
3253 ** aiMap[] array contains a mapping from the original LHS field order to
3254 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003255 **
3256 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3257 ** even if it is constant, as OP_Affinity may be used on the register
3258 ** by code generated below. */
3259 assert( pParse->okConstFactor==okConstFactor );
3260 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003261 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003262 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003263 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003264 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003265 /* LHS fields are not reordered */
3266 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003267 }else{
3268 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003269 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003270 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003271 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003272 }
danba00e302016-07-23 20:24:06 +00003273 }
drhe3365e62009-11-12 17:52:24 +00003274
drhbb53ecb2014-08-02 21:03:33 +00003275 /* If sqlite3FindInIndex() did not find or create an index that is
3276 ** suitable for evaluating the IN operator, then evaluate using a
3277 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003278 **
3279 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003280 */
drhbb53ecb2014-08-02 21:03:33 +00003281 if( eType==IN_INDEX_NOOP ){
3282 ExprList *pList = pExpr->x.pList;
3283 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003284 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003285 int r2, regToFree;
3286 int regCkNull = 0;
3287 int ii;
3288 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003289 if( destIfNull!=destIfFalse ){
3290 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003291 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003292 }
3293 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003294 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003295 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003296 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3297 }
drhf6ea97e2020-01-04 15:21:47 +00003298 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003299 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003300 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3301 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003302 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003303 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3304 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3305 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3306 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003307 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003308 }else{
drh47994882019-12-22 23:48:36 +00003309 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003310 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003311 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3312 (void*)pColl, P4_COLLSEQ);
3313 VdbeCoverageIf(v, op==OP_Ne);
3314 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003315 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003316 }
drhbb53ecb2014-08-02 21:03:33 +00003317 }
3318 if( regCkNull ){
3319 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003320 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003321 }
3322 sqlite3VdbeResolveLabel(v, labelOk);
3323 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003324 goto sqlite3ExprCodeIN_finished;
3325 }
3326
3327 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3328 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3329 ** We will then skip the binary search of the RHS.
3330 */
3331 if( destIfNull==destIfFalse ){
3332 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003333 }else{
drhec4ccdb2018-12-29 02:26:59 +00003334 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003335 }
drh4eac5f02019-12-24 15:01:17 +00003336 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003337 for(i=0; i<nVector; i++){
3338 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3339 if( sqlite3ExprCanBeNull(p) ){
3340 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003341 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003342 }
drhe3365e62009-11-12 17:52:24 +00003343 }
drhe347d3e2016-08-25 21:14:34 +00003344
3345 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3346 ** of the RHS using the LHS as a probe. If found, the result is
3347 ** true.
3348 */
3349 if( eType==IN_INDEX_ROWID ){
3350 /* In this case, the RHS is the ROWID of table b-tree and so we also
3351 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3352 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003353 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003354 VdbeCoverage(v);
3355 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3356 }else{
3357 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3358 if( destIfFalse==destIfNull ){
3359 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003360 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003361 rLhs, nVector); VdbeCoverage(v);
3362 goto sqlite3ExprCodeIN_finished;
3363 }
3364 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003365 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003366 rLhs, nVector); VdbeCoverage(v);
3367 }
3368
3369 /* Step 4. If the RHS is known to be non-NULL and we did not find
3370 ** an match on the search above, then the result must be FALSE.
3371 */
3372 if( rRhsHasNull && nVector==1 ){
3373 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3374 VdbeCoverage(v);
3375 }
3376
3377 /* Step 5. If we do not care about the difference between NULL and
3378 ** FALSE, then just return false.
3379 */
3380 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3381
3382 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3383 ** If any comparison is NULL, then the result is NULL. If all
3384 ** comparisons are FALSE then the final result is FALSE.
3385 **
3386 ** For a scalar LHS, it is sufficient to check just the first row
3387 ** of the RHS.
3388 */
3389 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003390 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003391 VdbeCoverage(v);
3392 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003393 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003394 }else{
3395 /* For nVector==1, combine steps 6 and 7 by immediately returning
3396 ** FALSE if the first comparison is not NULL */
3397 destNotNull = destIfFalse;
3398 }
3399 for(i=0; i<nVector; i++){
3400 Expr *p;
3401 CollSeq *pColl;
3402 int r3 = sqlite3GetTempReg(pParse);
3403 p = sqlite3VectorFieldSubexpr(pLeft, i);
3404 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003405 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003406 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3407 (void*)pColl, P4_COLLSEQ);
3408 VdbeCoverage(v);
3409 sqlite3ReleaseTempReg(pParse, r3);
3410 }
3411 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3412 if( nVector>1 ){
3413 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003414 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003415 VdbeCoverage(v);
3416
3417 /* Step 7: If we reach this point, we know that the result must
3418 ** be false. */
3419 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3420 }
3421
3422 /* Jumps here in order to return true. */
3423 sqlite3VdbeJumpHere(v, addrTruthOp);
3424
3425sqlite3ExprCodeIN_finished:
3426 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003427 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003428sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003429 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003430 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003431}
3432#endif /* SQLITE_OMIT_SUBQUERY */
3433
drh13573c72010-01-12 17:04:07 +00003434#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003435/*
3436** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003437** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003438**
3439** The z[] string will probably not be zero-terminated. But the
3440** z[n] character is guaranteed to be something that does not look
3441** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003442*/
drhb7916a72009-05-27 10:31:29 +00003443static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003444 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003445 double value;
drh9339da12010-09-30 00:50:49 +00003446 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003447 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3448 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003449 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003450 }
3451}
drh13573c72010-01-12 17:04:07 +00003452#endif
drh598f1342007-10-23 15:39:45 +00003453
3454
3455/*
drhfec19aa2004-05-19 20:41:03 +00003456** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003457** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003458**
shaneh5f1d6b62010-09-30 16:51:25 +00003459** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003460*/
drh13573c72010-01-12 17:04:07 +00003461static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3462 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003463 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003464 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003465 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003466 if( negFlag ) i = -i;
3467 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003468 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003469 int c;
3470 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003471 const char *z = pExpr->u.zToken;
3472 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003473 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003474 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003475#ifdef SQLITE_OMIT_FLOATING_POINT
3476 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3477#else
drh1b7ddc52014-07-23 14:52:05 +00003478#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003479 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003480 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003481 }else
3482#endif
3483 {
drh9296c182014-07-23 13:40:49 +00003484 codeReal(v, z, negFlag, iMem);
3485 }
drh13573c72010-01-12 17:04:07 +00003486#endif
drh77320ea2016-11-30 14:47:37 +00003487 }else{
drh84d4f1a2017-09-20 10:47:10 +00003488 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003489 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003490 }
drhfec19aa2004-05-19 20:41:03 +00003491 }
3492}
3493
drh5cd79232009-05-25 11:46:29 +00003494
drh1f9ca2c2015-08-25 16:57:52 +00003495/* Generate code that will load into register regOut a value that is
3496** appropriate for the iIdxCol-th column of index pIdx.
3497*/
3498void sqlite3ExprCodeLoadIndexColumn(
3499 Parse *pParse, /* The parsing context */
3500 Index *pIdx, /* The index whose column is to be loaded */
3501 int iTabCur, /* Cursor pointing to a table row */
3502 int iIdxCol, /* The column of the index to be loaded */
3503 int regOut /* Store the index column value in this register */
3504){
3505 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003506 if( iTabCol==XN_EXPR ){
3507 assert( pIdx->aColExpr );
3508 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003509 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003510 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003511 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003512 }else{
drh6df9c4b2019-10-18 12:52:08 +00003513 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003514 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003515 }
drh1f9ca2c2015-08-25 16:57:52 +00003516}
3517
drhe70fa7f2019-10-22 21:01:34 +00003518#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3519/*
3520** Generate code that will compute the value of generated column pCol
3521** and store the result in register regOut
3522*/
3523void sqlite3ExprCodeGeneratedColumn(
3524 Parse *pParse,
3525 Column *pCol,
3526 int regOut
3527){
drh4dad7ed2019-12-16 16:52:22 +00003528 int iAddr;
3529 Vdbe *v = pParse->pVdbe;
3530 assert( v!=0 );
3531 assert( pParse->iSelfTab!=0 );
3532 if( pParse->iSelfTab>0 ){
3533 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3534 }else{
3535 iAddr = 0;
3536 }
drh24e39902020-03-10 13:35:04 +00003537 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003538 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003539 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003540 }
drh4dad7ed2019-12-16 16:52:22 +00003541 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003542}
3543#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3544
drh5cd79232009-05-25 11:46:29 +00003545/*
drh5c092e82010-05-14 19:24:02 +00003546** Generate code to extract the value of the iCol-th column of a table.
3547*/
3548void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003549 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003550 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003551 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003552 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003553 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003554){
drhab45fc02019-10-16 22:01:56 +00003555 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003556 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003557 if( pTab==0 ){
3558 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3559 return;
3560 }
drh5c092e82010-05-14 19:24:02 +00003561 if( iCol<0 || iCol==pTab->iPKey ){
3562 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3563 }else{
drh81f7b372019-10-16 12:18:59 +00003564 int op;
3565 int x;
3566 if( IsVirtual(pTab) ){
3567 op = OP_VColumn;
3568 x = iCol;
3569#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003570 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003571 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003572 if( pCol->colFlags & COLFLAG_BUSY ){
3573 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3574 }else{
3575 int savedSelfTab = pParse->iSelfTab;
3576 pCol->colFlags |= COLFLAG_BUSY;
3577 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003578 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003579 pParse->iSelfTab = savedSelfTab;
3580 pCol->colFlags &= ~COLFLAG_BUSY;
3581 }
drh81f7b372019-10-16 12:18:59 +00003582 return;
3583#endif
3584 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003585 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003586 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003587 op = OP_Column;
3588 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003589 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003590 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003591 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003592 }
3593 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003594 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3595 }
3596}
3597
3598/*
drh945498f2007-02-24 11:52:52 +00003599** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003600** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003601**
3602** There must be an open cursor to pTab in iTable when this routine
3603** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003604*/
drhe55cbd72008-03-31 23:48:03 +00003605int sqlite3ExprCodeGetColumn(
3606 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003607 Table *pTab, /* Description of the table we are reading from */
3608 int iColumn, /* Index of the table column */
3609 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003610 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003611 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003612){
drh81f7b372019-10-16 12:18:59 +00003613 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003614 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003615 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003616 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3617 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003618 }
drhe55cbd72008-03-31 23:48:03 +00003619 return iReg;
3620}
drhe55cbd72008-03-31 23:48:03 +00003621
3622/*
drhb21e7c72008-06-22 12:37:57 +00003623** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003624** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003625*/
drhb21e7c72008-06-22 12:37:57 +00003626void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003627 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003628}
3629
drh652fbf52008-04-01 01:42:41 +00003630/*
drh12abf402016-08-22 14:30:05 +00003631** Convert a scalar expression node to a TK_REGISTER referencing
3632** register iReg. The caller must ensure that iReg already contains
3633** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003634*/
dan069d1b12019-06-16 08:58:14 +00003635static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003636 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003637 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003638 p->op2 = p->op;
3639 p->op = TK_REGISTER;
3640 p->iTable = iReg;
3641 ExprClearProperty(p, EP_Skip);
3642}
3643
drh12abf402016-08-22 14:30:05 +00003644/*
3645** Evaluate an expression (either a vector or a scalar expression) and store
3646** the result in continguous temporary registers. Return the index of
3647** the first register used to store the result.
3648**
3649** If the returned result register is a temporary scalar, then also write
3650** that register number into *piFreeable. If the returned result register
3651** is not a temporary or if the expression is a vector set *piFreeable
3652** to 0.
3653*/
3654static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3655 int iResult;
3656 int nResult = sqlite3ExprVectorSize(p);
3657 if( nResult==1 ){
3658 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3659 }else{
3660 *piFreeable = 0;
3661 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003662#if SQLITE_OMIT_SUBQUERY
3663 iResult = 0;
3664#else
drh85bcdce2018-12-23 21:27:29 +00003665 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003666#endif
drh12abf402016-08-22 14:30:05 +00003667 }else{
3668 int i;
3669 iResult = pParse->nMem+1;
3670 pParse->nMem += nResult;
3671 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003672 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003673 }
3674 }
3675 }
3676 return iResult;
3677}
3678
drh25c42962020-01-01 13:55:08 +00003679/*
drh92a27f72020-02-04 01:41:44 +00003680** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3681** so that a subsequent copy will not be merged into this one.
3682*/
3683static void setDoNotMergeFlagOnCopy(Vdbe *v){
3684 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3685 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3686 }
3687}
3688
3689/*
drh25c42962020-01-01 13:55:08 +00003690** Generate code to implement special SQL functions that are implemented
3691** in-line rather than by using the usual callbacks.
3692*/
3693static int exprCodeInlineFunction(
3694 Parse *pParse, /* Parsing context */
3695 ExprList *pFarg, /* List of function arguments */
3696 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3697 int target /* Store function result in this register */
3698){
3699 int nFarg;
3700 Vdbe *v = pParse->pVdbe;
3701 assert( v!=0 );
3702 assert( pFarg!=0 );
3703 nFarg = pFarg->nExpr;
3704 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3705 switch( iFuncId ){
3706 case INLINEFUNC_coalesce: {
3707 /* Attempt a direct implementation of the built-in COALESCE() and
3708 ** IFNULL() functions. This avoids unnecessary evaluation of
3709 ** arguments past the first non-NULL argument.
3710 */
3711 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3712 int i;
3713 assert( nFarg>=2 );
3714 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3715 for(i=1; i<nFarg; i++){
3716 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3717 VdbeCoverage(v);
3718 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3719 }
drh92a27f72020-02-04 01:41:44 +00003720 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003721 sqlite3VdbeResolveLabel(v, endCoalesce);
3722 break;
3723 }
drh3c0e6062020-05-13 18:03:34 +00003724 case INLINEFUNC_iif: {
3725 Expr caseExpr;
3726 memset(&caseExpr, 0, sizeof(caseExpr));
3727 caseExpr.op = TK_CASE;
3728 caseExpr.x.pList = pFarg;
3729 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3730 }
drh25c42962020-01-01 13:55:08 +00003731
drh171c50e2020-01-01 15:43:30 +00003732 default: {
drh25c42962020-01-01 13:55:08 +00003733 /* The UNLIKELY() function is a no-op. The result is the value
3734 ** of the first argument.
3735 */
drh171c50e2020-01-01 15:43:30 +00003736 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003737 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3738 break;
3739 }
3740
drh171c50e2020-01-01 15:43:30 +00003741 /***********************************************************************
3742 ** Test-only SQL functions that are only usable if enabled
3743 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3744 */
3745 case INLINEFUNC_expr_compare: {
3746 /* Compare two expressions using sqlite3ExprCompare() */
3747 assert( nFarg==2 );
3748 sqlite3VdbeAddOp2(v, OP_Integer,
3749 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3750 target);
3751 break;
3752 }
3753
3754 case INLINEFUNC_expr_implies_expr: {
3755 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3756 assert( nFarg==2 );
3757 sqlite3VdbeAddOp2(v, OP_Integer,
3758 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3759 target);
3760 break;
3761 }
3762
3763 case INLINEFUNC_implies_nonnull_row: {
3764 /* REsult of sqlite3ExprImpliesNonNullRow() */
3765 Expr *pA1;
3766 assert( nFarg==2 );
3767 pA1 = pFarg->a[1].pExpr;
3768 if( pA1->op==TK_COLUMN ){
3769 sqlite3VdbeAddOp2(v, OP_Integer,
3770 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3771 target);
3772 }else{
3773 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3774 }
3775 break;
3776 }
3777
drh25c42962020-01-01 13:55:08 +00003778#ifdef SQLITE_DEBUG
3779 case INLINEFUNC_affinity: {
3780 /* The AFFINITY() function evaluates to a string that describes
3781 ** the type affinity of the argument. This is used for testing of
3782 ** the SQLite type logic.
3783 */
3784 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3785 char aff;
3786 assert( nFarg==1 );
3787 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3788 sqlite3VdbeLoadString(v, target,
3789 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3790 break;
3791 }
3792#endif
3793 }
3794 return target;
3795}
3796
dan71c57db2016-07-09 20:23:55 +00003797
drha4c3c872013-09-12 17:29:25 +00003798/*
drhcce7d172000-05-31 15:34:51 +00003799** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003800** expression. Attempt to store the results in register "target".
3801** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003802**
drh8b213892008-08-29 02:14:02 +00003803** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003804** be stored in target. The result might be stored in some other
3805** register if it is convenient to do so. The calling function
3806** must check the return code and move the results to the desired
3807** register.
drhcce7d172000-05-31 15:34:51 +00003808*/
drh678ccce2008-03-31 18:19:54 +00003809int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003810 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3811 int op; /* The opcode being coded */
3812 int inReg = target; /* Results stored in register inReg */
3813 int regFree1 = 0; /* If non-zero free this temporary register */
3814 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003815 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003816 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003817 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003818
drh9cbf3422008-01-17 16:22:13 +00003819 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003820 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003821
drh1efa8022018-04-28 04:16:43 +00003822expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003823 if( pExpr==0 ){
3824 op = TK_NULL;
3825 }else{
drhe7375bf2020-03-10 19:24:38 +00003826 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003827 op = pExpr->op;
3828 }
drhf2bc0132004-10-04 13:19:23 +00003829 switch( op ){
drh13449892005-09-07 21:22:45 +00003830 case TK_AGG_COLUMN: {
3831 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003832 struct AggInfo_col *pCol;
3833 assert( pAggInfo!=0 );
3834 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3835 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003836 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003837 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003838 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003839 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003840 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003841 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003842 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003843 if( pCol->iColumn<0 ){
3844 VdbeComment((v,"%s.rowid",pTab->zName));
3845 }else{
3846 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3847 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3848 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3849 }
drh0c76e892020-03-10 11:50:43 +00003850 }
drhc332cc32016-09-19 10:24:19 +00003851 return target;
drh13449892005-09-07 21:22:45 +00003852 }
3853 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00003854 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00003855 }
drh967e8b72000-06-21 13:59:10 +00003856 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003857 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003858 int iReg;
drhefad2e22018-07-27 16:57:11 +00003859 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003860 /* This COLUMN expression is really a constant due to WHERE clause
3861 ** constraints, and that constant is coded by the pExpr->pLeft
3862 ** expresssion. However, make sure the constant has the correct
3863 ** datatype by applying the Affinity of the table column to the
3864 ** constant.
3865 */
drh57f7ece2019-11-21 18:28:44 +00003866 int aff;
drh67b9ba12019-12-20 20:45:02 +00003867 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003868 if( pExpr->y.pTab ){
3869 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3870 }else{
3871 aff = pExpr->affExpr;
3872 }
drh96fb16e2019-08-06 14:37:24 +00003873 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003874 static const char zAff[] = "B\000C\000D\000E";
3875 assert( SQLITE_AFF_BLOB=='A' );
3876 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003877 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3878 &zAff[(aff-'B')*2], P4_STATIC);
3879 }
3880 return iReg;
drhefad2e22018-07-27 16:57:11 +00003881 }
drhb2b9d3d2013-08-01 01:14:43 +00003882 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003883 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003884 /* Other columns in the same row for CHECK constraints or
3885 ** generated columns or for inserting into partial index.
3886 ** The row is unpacked into registers beginning at
3887 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3888 ** immediately prior to the first column.
3889 */
3890 Column *pCol;
3891 Table *pTab = pExpr->y.pTab;
3892 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003893 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003894 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003895 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003896 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003897 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003898 return -1-pParse->iSelfTab;
3899 }
drhc5f808d2019-10-19 15:01:52 +00003900 pCol = pTab->aCol + iCol;
3901 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3902 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003903#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3904 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003905 if( pCol->colFlags & COLFLAG_BUSY ){
3906 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3907 pCol->zName);
3908 return 0;
3909 }
3910 pCol->colFlags |= COLFLAG_BUSY;
3911 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3912 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3913 }
3914 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003915 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003916 }else
3917#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3918 if( pCol->affinity==SQLITE_AFF_REAL ){
3919 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003920 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3921 return target;
3922 }else{
drh9942ef02019-10-18 02:19:18 +00003923 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003924 }
drhb2b9d3d2013-08-01 01:14:43 +00003925 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003926 /* Coding an expression that is part of an index where column names
3927 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003928 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003929 }
drh22827922000-06-06 17:27:05 +00003930 }
drh67b9ba12019-12-20 20:45:02 +00003931 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003932 pExpr->iColumn, iTab, target,
3933 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003934 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3935 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3936 }
3937 return iReg;
drhcce7d172000-05-31 15:34:51 +00003938 }
3939 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003940 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003941 return target;
drhfec19aa2004-05-19 20:41:03 +00003942 }
drh8abed7b2018-02-26 18:49:05 +00003943 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003944 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003945 return target;
3946 }
drh13573c72010-01-12 17:04:07 +00003947#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003948 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003949 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3950 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003951 return target;
drh598f1342007-10-23 15:39:45 +00003952 }
drh13573c72010-01-12 17:04:07 +00003953#endif
drhfec19aa2004-05-19 20:41:03 +00003954 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003955 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003956 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003957 return target;
drhcce7d172000-05-31 15:34:51 +00003958 }
drhaac30f92019-12-14 15:01:55 +00003959 default: {
drhc29af652019-12-18 21:22:40 +00003960 /* Make NULL the default case so that if a bug causes an illegal
3961 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003962 ** sanely and not crash. But keep the assert() to bring the problem
3963 ** to the attention of the developers. */
3964 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003965 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003966 return target;
drhf0863fe2005-06-12 21:35:51 +00003967 }
danielk19775338a5f2005-01-20 13:03:10 +00003968#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003969 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003970 int n;
3971 const char *z;
drhca48c902008-01-18 14:08:24 +00003972 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003973 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3974 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3975 assert( pExpr->u.zToken[1]=='\'' );
3976 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003977 n = sqlite3Strlen30(z) - 1;
3978 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003979 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3980 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003981 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003982 }
danielk19775338a5f2005-01-20 13:03:10 +00003983#endif
drh50457892003-09-06 01:10:47 +00003984 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003985 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3986 assert( pExpr->u.zToken!=0 );
3987 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003988 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3989 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003990 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003991 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003992 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003993 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003994 }
drhc332cc32016-09-19 10:24:19 +00003995 return target;
drh50457892003-09-06 01:10:47 +00003996 }
drh4e0cff62004-11-05 05:10:28 +00003997 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003998 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003999 }
drh487e2622005-06-25 18:42:14 +00004000#ifndef SQLITE_OMIT_CAST
4001 case TK_CAST: {
4002 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004003 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004004 if( inReg!=target ){
4005 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4006 inReg = target;
4007 }
drh4169e432014-08-25 20:11:52 +00004008 sqlite3VdbeAddOp2(v, OP_Cast, target,
4009 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004010 return inReg;
drh487e2622005-06-25 18:42:14 +00004011 }
4012#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004013 case TK_IS:
4014 case TK_ISNOT:
4015 op = (op==TK_IS) ? TK_EQ : TK_NE;
4016 p5 = SQLITE_NULLEQ;
4017 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004018 case TK_LT:
4019 case TK_LE:
4020 case TK_GT:
4021 case TK_GE:
4022 case TK_NE:
4023 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004024 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004025 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004026 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004027 }else{
4028 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4029 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4030 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004031 r1, r2, inReg, SQLITE_STOREP2 | p5,
4032 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004033 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4034 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4035 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4036 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4037 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4038 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4039 testcase( regFree1==0 );
4040 testcase( regFree2==0 );
4041 }
drh6a2fe092009-09-23 02:29:36 +00004042 break;
4043 }
drhcce7d172000-05-31 15:34:51 +00004044 case TK_AND:
4045 case TK_OR:
4046 case TK_PLUS:
4047 case TK_STAR:
4048 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004049 case TK_REM:
4050 case TK_BITAND:
4051 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004052 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004053 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004054 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004055 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004056 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4057 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4058 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4059 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4060 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4061 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4062 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4063 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4064 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4065 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4066 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004067 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4068 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004069 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004070 testcase( regFree1==0 );
4071 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004072 break;
4073 }
drhcce7d172000-05-31 15:34:51 +00004074 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004075 Expr *pLeft = pExpr->pLeft;
4076 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004077 if( pLeft->op==TK_INTEGER ){
4078 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004079 return target;
drh13573c72010-01-12 17:04:07 +00004080#ifndef SQLITE_OMIT_FLOATING_POINT
4081 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004082 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4083 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004084 return target;
drh13573c72010-01-12 17:04:07 +00004085#endif
drh3c84ddf2008-01-09 02:15:38 +00004086 }else{
drh10d1edf2013-11-15 15:52:39 +00004087 tempX.op = TK_INTEGER;
4088 tempX.flags = EP_IntValue|EP_TokenOnly;
4089 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004090 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004091 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004092 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004093 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004094 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004095 }
drh3c84ddf2008-01-09 02:15:38 +00004096 break;
drh6e142f52000-06-08 13:36:40 +00004097 }
drhbf4133c2001-10-13 02:59:08 +00004098 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004099 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004100 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4101 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004102 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4103 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004104 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004105 break;
4106 }
drh8abed7b2018-02-26 18:49:05 +00004107 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004108 int isTrue; /* IS TRUE or IS NOT TRUE */
4109 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004110 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4111 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004112 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4113 bNormal = pExpr->op2==TK_IS;
4114 testcase( isTrue && bNormal);
4115 testcase( !isTrue && bNormal);
4116 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004117 break;
4118 }
drhcce7d172000-05-31 15:34:51 +00004119 case TK_ISNULL:
4120 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004121 int addr;
drh7d176102014-02-18 03:07:12 +00004122 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4123 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004124 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004125 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004126 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004127 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004128 VdbeCoverageIf(v, op==TK_ISNULL);
4129 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004130 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004131 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004132 break;
drhcce7d172000-05-31 15:34:51 +00004133 }
drh22827922000-06-06 17:27:05 +00004134 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004135 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004136 if( pInfo==0
4137 || NEVER(pExpr->iAgg<0)
4138 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4139 ){
drh33e619f2009-05-28 01:00:55 +00004140 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4141 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004142 }else{
drhc332cc32016-09-19 10:24:19 +00004143 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004144 }
drh22827922000-06-06 17:27:05 +00004145 break;
4146 }
drhcce7d172000-05-31 15:34:51 +00004147 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004148 ExprList *pFarg; /* List of function arguments */
4149 int nFarg; /* Number of function arguments */
4150 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004151 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004152 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004153 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004154 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004155 u8 enc = ENC(db); /* The text encoding used by this database */
4156 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004157
dan67a9b8e2018-06-22 20:51:35 +00004158#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004159 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4160 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004161 }
dan67a9b8e2018-06-22 20:51:35 +00004162#endif
dan86fb6e12018-05-16 20:58:07 +00004163
drh1e9b53f2017-01-04 01:07:24 +00004164 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004165 /* SQL functions can be expensive. So try to avoid running them
4166 ** multiple times if we know they always give the same result */
4167 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004168 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004169 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004170 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4171 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004172 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004173 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4174 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004175 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004176#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4177 if( pDef==0 && pParse->explain ){
4178 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4179 }
4180#endif
danb6e9f7a2018-05-19 14:15:29 +00004181 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004182 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004183 break;
4184 }
drh25c42962020-01-01 13:55:08 +00004185 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004186 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4187 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004188 return exprCodeInlineFunction(pParse, pFarg,
4189 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004190 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4191 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004192 }
4193
drhd1a01ed2013-11-21 16:08:52 +00004194 for(i=0; i<nFarg; i++){
4195 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004196 testcase( i==31 );
4197 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004198 }
4199 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4200 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4201 }
4202 }
drh12ffee82009-04-08 13:51:51 +00004203 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004204 if( constMask ){
4205 r1 = pParse->nMem+1;
4206 pParse->nMem += nFarg;
4207 }else{
4208 r1 = sqlite3GetTempRange(pParse, nFarg);
4209 }
drha748fdc2012-03-28 01:34:47 +00004210
4211 /* For length() and typeof() functions with a column argument,
4212 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4213 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4214 ** loading.
4215 */
drhd36e1042013-09-06 13:10:12 +00004216 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004217 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004218 assert( nFarg==1 );
4219 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004220 exprOp = pFarg->a[0].pExpr->op;
4221 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004222 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4223 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004224 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4225 pFarg->a[0].pExpr->op2 =
4226 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004227 }
4228 }
4229
drh5579d592015-08-26 14:01:41 +00004230 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004231 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004232 }else{
drh12ffee82009-04-08 13:51:51 +00004233 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004234 }
drhb7f6f682006-07-08 17:06:43 +00004235#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004236 /* Possibly overload the function if the first argument is
4237 ** a virtual table column.
4238 **
4239 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4240 ** second argument, not the first, as the argument to test to
4241 ** see if it is a column in a virtual table. This is done because
4242 ** the left operand of infix functions (the operand we want to
4243 ** control overloading) ends up as the second argument to the
4244 ** function. The expression "A glob B" is equivalent to
4245 ** "glob(B,A). We want to use the A in "A glob B" to test
4246 ** for function overloading. But we use the B term in "glob(B,A)".
4247 */
drh59155062018-05-26 18:03:48 +00004248 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004249 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4250 }else if( nFarg>0 ){
4251 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004252 }
4253#endif
drhd36e1042013-09-06 13:10:12 +00004254 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004255 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004256 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004257 }
drh092457b2017-12-29 15:04:49 +00004258#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4259 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004260 Expr *pArg = pFarg->a[0].pExpr;
4261 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004262 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004263 }else{
4264 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4265 }
drh092457b2017-12-29 15:04:49 +00004266 }else
4267#endif
4268 {
drh920cf592019-10-30 16:29:02 +00004269 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004270 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004271 }
drh13d79502019-12-23 02:18:49 +00004272 if( nFarg ){
4273 if( constMask==0 ){
4274 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4275 }else{
drh3aef2fb2020-01-02 17:46:02 +00004276 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004277 }
drh2dcef112008-01-12 19:03:48 +00004278 }
drhc332cc32016-09-19 10:24:19 +00004279 return target;
drhcce7d172000-05-31 15:34:51 +00004280 }
drhfe2093d2005-01-20 22:48:47 +00004281#ifndef SQLITE_OMIT_SUBQUERY
4282 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004283 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004284 int nCol;
drhc5499be2008-04-01 15:06:33 +00004285 testcase( op==TK_EXISTS );
4286 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004287 if( pParse->db->mallocFailed ){
4288 return 0;
4289 }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
dan8da209b2016-07-26 18:06:08 +00004290 sqlite3SubselectError(pParse, nCol, 1);
4291 }else{
drh85bcdce2018-12-23 21:27:29 +00004292 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004293 }
drh19a775c2000-06-05 18:54:46 +00004294 break;
4295 }
drhfc7f27b2016-08-20 00:07:01 +00004296 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004297 int n;
drhfc7f27b2016-08-20 00:07:01 +00004298 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004299 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004300 }
drh966e2912017-01-03 02:58:01 +00004301 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004302 if( pExpr->iTable!=0
4303 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004304 ){
4305 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4306 pExpr->iTable, n);
4307 }
drhc332cc32016-09-19 10:24:19 +00004308 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004309 }
drhfef52082000-06-06 01:50:43 +00004310 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004311 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4312 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004313 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4314 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4315 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4316 sqlite3VdbeResolveLabel(v, destIfFalse);
4317 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4318 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004319 return target;
drhfef52082000-06-06 01:50:43 +00004320 }
drhe3365e62009-11-12 17:52:24 +00004321#endif /* SQLITE_OMIT_SUBQUERY */
4322
4323
drh2dcef112008-01-12 19:03:48 +00004324 /*
4325 ** x BETWEEN y AND z
4326 **
4327 ** This is equivalent to
4328 **
4329 ** x>=y AND x<=z
4330 **
4331 ** X is stored in pExpr->pLeft.
4332 ** Y is stored in pExpr->pList->a[0].pExpr.
4333 ** Z is stored in pExpr->pList->a[1].pExpr.
4334 */
drhfef52082000-06-06 01:50:43 +00004335 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004336 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004337 return target;
drhfef52082000-06-06 01:50:43 +00004338 }
drh94fa9c42016-02-27 21:16:04 +00004339 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004340 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004341 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004342 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004343 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004344 }
drh2dcef112008-01-12 19:03:48 +00004345
dan165921a2009-08-28 18:53:45 +00004346 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004347 /* If the opcode is TK_TRIGGER, then the expression is a reference
4348 ** to a column in the new.* or old.* pseudo-tables available to
4349 ** trigger programs. In this case Expr.iTable is set to 1 for the
4350 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4351 ** is set to the column of the pseudo-table to read, or to -1 to
4352 ** read the rowid field.
4353 **
4354 ** The expression is implemented using an OP_Param opcode. The p1
4355 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4356 ** to reference another column of the old.* pseudo-table, where
4357 ** i is the index of the column. For a new.rowid reference, p1 is
4358 ** set to (n+1), where n is the number of columns in each pseudo-table.
4359 ** For a reference to any other column in the new.* pseudo-table, p1
4360 ** is set to (n+2+i), where n and i are as defined previously. For
4361 ** example, if the table on which triggers are being fired is
4362 ** declared as:
4363 **
4364 ** CREATE TABLE t1(a, b);
4365 **
4366 ** Then p1 is interpreted as follows:
4367 **
4368 ** p1==0 -> old.rowid p1==3 -> new.rowid
4369 ** p1==1 -> old.a p1==4 -> new.a
4370 ** p1==2 -> old.b p1==5 -> new.b
4371 */
drheda079c2018-09-20 19:02:15 +00004372 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004373 int iCol = pExpr->iColumn;
4374 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004375 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004376
4377 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004378 assert( iCol>=-1 && iCol<pTab->nCol );
4379 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004380 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4381
4382 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004383 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004384 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004385 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004386 ));
dan65a7cd12009-09-01 12:16:01 +00004387
drh44dbca82010-01-13 04:22:20 +00004388#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004389 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004390 ** integer. Use OP_RealAffinity to make sure it is really real.
4391 **
4392 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4393 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004394 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004395 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4396 }
drh44dbca82010-01-13 04:22:20 +00004397#endif
dan165921a2009-08-28 18:53:45 +00004398 break;
4399 }
4400
dan71c57db2016-07-09 20:23:55 +00004401 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004402 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004403 break;
4404 }
4405
drh9e9a67a2019-08-17 17:07:15 +00004406 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4407 ** that derive from the right-hand table of a LEFT JOIN. The
4408 ** Expr.iTable value is the table number for the right-hand table.
4409 ** The expression is only evaluated if that table is not currently
4410 ** on a LEFT JOIN NULL row.
4411 */
drh31d6fd52017-04-14 19:03:10 +00004412 case TK_IF_NULL_ROW: {
4413 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004414 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004415 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004416 /* Temporarily disable factoring of constant expressions, since
4417 ** even though expressions may appear to be constant, they are not
4418 ** really constant because they originate from the right-hand side
4419 ** of a LEFT JOIN. */
4420 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004421 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004422 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004423 sqlite3VdbeJumpHere(v, addrINR);
4424 sqlite3VdbeChangeP3(v, addrINR, inReg);
4425 break;
4426 }
4427
drh2dcef112008-01-12 19:03:48 +00004428 /*
4429 ** Form A:
4430 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4431 **
4432 ** Form B:
4433 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4434 **
4435 ** Form A is can be transformed into the equivalent form B as follows:
4436 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4437 ** WHEN x=eN THEN rN ELSE y END
4438 **
4439 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004440 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4441 ** odd. The Y is also optional. If the number of elements in x.pList
4442 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004443 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4444 **
4445 ** The result of the expression is the Ri for the first matching Ei,
4446 ** or if there is no matching Ei, the ELSE term Y, or if there is
4447 ** no ELSE term, NULL.
4448 */
drhaac30f92019-12-14 15:01:55 +00004449 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004450 int endLabel; /* GOTO label for end of CASE stmt */
4451 int nextCase; /* GOTO label for next WHEN clause */
4452 int nExpr; /* 2x number of WHEN terms */
4453 int i; /* Loop counter */
4454 ExprList *pEList; /* List of WHEN terms */
4455 struct ExprList_item *aListelem; /* Array of WHEN terms */
4456 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004457 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004458 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004459 Expr *pDel = 0;
4460 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004461
danielk19776ab3a2e2009-02-19 14:39:25 +00004462 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004463 assert(pExpr->x.pList->nExpr > 0);
4464 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004465 aListelem = pEList->a;
4466 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004467 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004468 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004469 pDel = sqlite3ExprDup(db, pX, 0);
4470 if( db->mallocFailed ){
4471 sqlite3ExprDelete(db, pDel);
4472 break;
4473 }
drh33cd4902009-05-30 20:49:20 +00004474 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004475 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004476 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004477 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004478 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004479 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004480 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004481 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4482 ** The value in regFree1 might get SCopy-ed into the file result.
4483 ** So make sure that the regFree1 register is not reused for other
4484 ** purposes and possibly overwritten. */
4485 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004486 }
drhc5cd1242013-09-12 16:50:49 +00004487 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004488 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004489 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004490 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004491 }else{
drh2dcef112008-01-12 19:03:48 +00004492 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004493 }
drhec4ccdb2018-12-29 02:26:59 +00004494 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004495 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004496 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004497 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004498 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004499 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004500 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004501 }
drhc5cd1242013-09-12 16:50:49 +00004502 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004503 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004504 }else{
drh9de221d2008-01-05 06:51:30 +00004505 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004506 }
dan8b65e592019-07-17 14:34:17 +00004507 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004508 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004509 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004510 break;
4511 }
danielk19775338a5f2005-01-20 13:03:10 +00004512#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004513 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004514 assert( pExpr->affExpr==OE_Rollback
4515 || pExpr->affExpr==OE_Abort
4516 || pExpr->affExpr==OE_Fail
4517 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004518 );
drh9e5fdc42020-05-08 19:02:21 +00004519 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004520 sqlite3ErrorMsg(pParse,
4521 "RAISE() may only be used within a trigger-program");
4522 return 0;
4523 }
drh11949042019-08-05 18:01:42 +00004524 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004525 sqlite3MayAbort(pParse);
4526 }
dan165921a2009-08-28 18:53:45 +00004527 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004528 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004529 sqlite3VdbeAddOp4(
4530 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004531 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004532 }else{
drh9e5fdc42020-05-08 19:02:21 +00004533 sqlite3HaltConstraint(pParse,
4534 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4535 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004536 }
4537
drhffe07b22005-11-03 00:41:17 +00004538 break;
drh17a7f8d2002-03-24 13:13:27 +00004539 }
danielk19775338a5f2005-01-20 13:03:10 +00004540#endif
drhffe07b22005-11-03 00:41:17 +00004541 }
drh2dcef112008-01-12 19:03:48 +00004542 sqlite3ReleaseTempReg(pParse, regFree1);
4543 sqlite3ReleaseTempReg(pParse, regFree2);
4544 return inReg;
4545}
4546
4547/*
drh9b258c52020-03-11 19:41:49 +00004548** Generate code that will evaluate expression pExpr just one time
4549** per prepared statement execution.
4550**
4551** If the expression uses functions (that might throw an exception) then
4552** guard them with an OP_Once opcode to ensure that the code is only executed
4553** once. If no functions are involved, then factor the code out and put it at
4554** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004555**
drhad879ff2017-01-04 04:10:02 +00004556** If regDest>=0 then the result is always stored in that register and the
4557** result is not reusable. If regDest<0 then this routine is free to
4558** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004559** is stored is returned. When regDest<0, two identical expressions might
4560** code to the same register, if they do not contain function calls and hence
4561** are factored out into the initialization section at the end of the
4562** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004563*/
drh9b258c52020-03-11 19:41:49 +00004564int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004565 Parse *pParse, /* Parsing context */
4566 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004567 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004568){
drhd1a01ed2013-11-21 16:08:52 +00004569 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004570 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004571 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004572 if( regDest<0 && p ){
4573 struct ExprList_item *pItem;
4574 int i;
4575 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004576 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004577 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004578 }
4579 }
drh1e9b53f2017-01-04 01:07:24 +00004580 }
drhd1a01ed2013-11-21 16:08:52 +00004581 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004582 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4583 Vdbe *v = pParse->pVdbe;
4584 int addr;
4585 assert( v );
4586 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4587 pParse->okConstFactor = 0;
4588 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004589 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004590 sqlite3ExprCode(pParse, pExpr, regDest);
4591 }
4592 pParse->okConstFactor = 1;
4593 sqlite3ExprDelete(pParse->db, pExpr);
4594 sqlite3VdbeJumpHere(v, addr);
4595 }else{
4596 p = sqlite3ExprListAppend(pParse, p, pExpr);
4597 if( p ){
4598 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4599 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004600 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004601 pItem->u.iConstExprReg = regDest;
4602 }
4603 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004604 }
drh1e9b53f2017-01-04 01:07:24 +00004605 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004606}
4607
4608/*
drh2dcef112008-01-12 19:03:48 +00004609** Generate code to evaluate an expression and store the results
4610** into a register. Return the register number where the results
4611** are stored.
4612**
4613** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004614** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004615** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004616**
4617** If pExpr is a constant, then this routine might generate this
4618** code to fill the register in the initialization section of the
4619** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004620*/
4621int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004622 int r2;
drh0d950af2019-08-22 16:38:42 +00004623 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004624 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004625 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004626 && pExpr->op!=TK_REGISTER
4627 && sqlite3ExprIsConstantNotJoin(pExpr)
4628 ){
drhf30a9692013-11-15 01:10:18 +00004629 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004630 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004631 }else{
drhf30a9692013-11-15 01:10:18 +00004632 int r1 = sqlite3GetTempReg(pParse);
4633 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4634 if( r2==r1 ){
4635 *pReg = r1;
4636 }else{
4637 sqlite3ReleaseTempReg(pParse, r1);
4638 *pReg = 0;
4639 }
drh2dcef112008-01-12 19:03:48 +00004640 }
4641 return r2;
4642}
4643
4644/*
4645** Generate code that will evaluate expression pExpr and store the
4646** results in register target. The results are guaranteed to appear
4647** in register target.
4648*/
drh05a86c52014-02-16 01:55:49 +00004649void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004650 int inReg;
4651
drhe7375bf2020-03-10 19:24:38 +00004652 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004653 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004654 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004655 if( pParse->pVdbe==0 ) return;
4656 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4657 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004658 u8 op;
4659 if( ExprHasProperty(pExpr,EP_Subquery) ){
4660 op = OP_Copy;
4661 }else{
4662 op = OP_SCopy;
4663 }
4664 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004665 }
drhcce7d172000-05-31 15:34:51 +00004666}
4667
4668/*
drh1c75c9d2015-12-21 15:22:13 +00004669** Make a transient copy of expression pExpr and then code it using
4670** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4671** except that the input expression is guaranteed to be unchanged.
4672*/
4673void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4674 sqlite3 *db = pParse->db;
4675 pExpr = sqlite3ExprDup(db, pExpr, 0);
4676 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4677 sqlite3ExprDelete(db, pExpr);
4678}
4679
4680/*
drh05a86c52014-02-16 01:55:49 +00004681** Generate code that will evaluate expression pExpr and store the
4682** results in register target. The results are guaranteed to appear
4683** in register target. If the expression is constant, then this routine
4684** might choose to code the expression at initialization time.
4685*/
4686void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004687 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004688 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004689 }else{
drh088489e2020-03-10 02:57:37 +00004690 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004691 }
drhcce7d172000-05-31 15:34:51 +00004692}
4693
4694/*
drh268380c2004-02-25 13:47:31 +00004695** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004696** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004697**
drh3df6c3b2017-09-15 15:38:01 +00004698** Return the number of elements evaluated. The number returned will
4699** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4700** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004701**
4702** The SQLITE_ECEL_DUP flag prevents the arguments from being
4703** filled using OP_SCopy. OP_Copy must be used instead.
4704**
4705** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4706** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004707**
4708** The SQLITE_ECEL_REF flag means that expressions in the list with
4709** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4710** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004711** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4712** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004713*/
danielk19774adee202004-05-08 08:23:19 +00004714int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004715 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004716 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004717 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004718 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004719 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004720){
4721 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004722 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004723 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004724 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004725 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004726 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004727 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004728 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004729 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004730 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004731 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004732#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4733 if( pItem->bSorterRef ){
4734 i--;
4735 n--;
4736 }else
4737#endif
dan257c13f2016-11-10 20:14:06 +00004738 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4739 if( flags & SQLITE_ECEL_OMITREF ){
4740 i--;
4741 n--;
4742 }else{
4743 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4744 }
drhb8b06692018-08-04 15:16:20 +00004745 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4746 && sqlite3ExprIsConstantNotJoin(pExpr)
4747 ){
drh9b258c52020-03-11 19:41:49 +00004748 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004749 }else{
4750 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4751 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004752 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004753 if( copyOp==OP_Copy
4754 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4755 && pOp->p1+pOp->p3+1==inReg
4756 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004757 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004758 ){
4759 pOp->p3++;
4760 }else{
4761 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4762 }
drhd1a01ed2013-11-21 16:08:52 +00004763 }
drhd1766112008-09-17 00:13:12 +00004764 }
drh268380c2004-02-25 13:47:31 +00004765 }
drhf9b596e2004-05-26 16:54:42 +00004766 return n;
drh268380c2004-02-25 13:47:31 +00004767}
4768
4769/*
drh36c563a2009-11-12 13:32:22 +00004770** Generate code for a BETWEEN operator.
4771**
4772** x BETWEEN y AND z
4773**
4774** The above is equivalent to
4775**
4776** x>=y AND x<=z
4777**
4778** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004779** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004780**
4781** The xJumpIf parameter determines details:
4782**
4783** NULL: Store the boolean result in reg[dest]
4784** sqlite3ExprIfTrue: Jump to dest if true
4785** sqlite3ExprIfFalse: Jump to dest if false
4786**
4787** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004788*/
4789static void exprCodeBetween(
4790 Parse *pParse, /* Parsing and code generating context */
4791 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004792 int dest, /* Jump destination or storage location */
4793 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004794 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4795){
dan8b65e592019-07-17 14:34:17 +00004796 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004797 Expr compLeft; /* The x>=y term */
4798 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004799 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004800 Expr *pDel = 0;
4801 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004802
dan71c57db2016-07-09 20:23:55 +00004803 memset(&compLeft, 0, sizeof(Expr));
4804 memset(&compRight, 0, sizeof(Expr));
4805 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004806
4807 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004808 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4809 if( db->mallocFailed==0 ){
4810 exprAnd.op = TK_AND;
4811 exprAnd.pLeft = &compLeft;
4812 exprAnd.pRight = &compRight;
4813 compLeft.op = TK_GE;
4814 compLeft.pLeft = pDel;
4815 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4816 compRight.op = TK_LE;
4817 compRight.pLeft = pDel;
4818 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4819 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4820 if( xJump ){
4821 xJump(pParse, &exprAnd, dest, jumpIfNull);
4822 }else{
4823 /* Mark the expression is being from the ON or USING clause of a join
4824 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4825 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4826 ** for clarity, but we are out of bits in the Expr.flags field so we
4827 ** have to reuse the EP_FromJoin bit. Bummer. */
4828 pDel->flags |= EP_FromJoin;
4829 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4830 }
4831 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004832 }
dan8b65e592019-07-17 14:34:17 +00004833 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004834
4835 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004836 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4837 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4838 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4839 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4840 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4841 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4842 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4843 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004844 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004845}
4846
4847/*
drhcce7d172000-05-31 15:34:51 +00004848** Generate code for a boolean expression such that a jump is made
4849** to the label "dest" if the expression is true but execution
4850** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004851**
4852** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004853** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004854**
4855** This code depends on the fact that certain token values (ex: TK_EQ)
4856** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4857** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4858** the make process cause these values to align. Assert()s in the code
4859** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004860*/
danielk19774adee202004-05-08 08:23:19 +00004861void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004862 Vdbe *v = pParse->pVdbe;
4863 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004864 int regFree1 = 0;
4865 int regFree2 = 0;
4866 int r1, r2;
4867
drh35573352008-01-08 23:54:25 +00004868 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004869 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004870 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004871 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004872 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004873 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004874 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004875 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004876 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4877 if( pAlt!=pExpr ){
4878 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4879 }else if( op==TK_AND ){
4880 int d2 = sqlite3VdbeMakeLabel(pParse);
4881 testcase( jumpIfNull==0 );
4882 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4883 jumpIfNull^SQLITE_JUMPIFNULL);
4884 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4885 sqlite3VdbeResolveLabel(v, d2);
4886 }else{
4887 testcase( jumpIfNull==0 );
4888 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4889 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4890 }
drhcce7d172000-05-31 15:34:51 +00004891 break;
4892 }
4893 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004894 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004895 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004896 break;
4897 }
drh8abed7b2018-02-26 18:49:05 +00004898 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004899 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4900 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004901 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004902 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004903 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004904 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004905 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004906 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004907 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4908 isNot ? SQLITE_JUMPIFNULL : 0);
4909 }else{
4910 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4911 isNot ? SQLITE_JUMPIFNULL : 0);
4912 }
drh007c8432018-02-26 03:20:18 +00004913 break;
4914 }
drhde845c22016-03-17 19:07:52 +00004915 case TK_IS:
4916 case TK_ISNOT:
4917 testcase( op==TK_IS );
4918 testcase( op==TK_ISNOT );
4919 op = (op==TK_IS) ? TK_EQ : TK_NE;
4920 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00004921 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00004922 case TK_LT:
4923 case TK_LE:
4924 case TK_GT:
4925 case TK_GE:
4926 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004927 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004928 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004929 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004930 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4931 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004932 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004933 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004934 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4935 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4936 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4937 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004938 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4939 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4940 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4941 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4942 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4943 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004944 testcase( regFree1==0 );
4945 testcase( regFree2==0 );
4946 break;
4947 }
drhcce7d172000-05-31 15:34:51 +00004948 case TK_ISNULL:
4949 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004950 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4951 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004952 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4953 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004954 VdbeCoverageIf(v, op==TK_ISNULL);
4955 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004956 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004957 break;
4958 }
drhfef52082000-06-06 01:50:43 +00004959 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004960 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004961 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004962 break;
4963 }
drh84e30ca2011-02-10 17:46:14 +00004964#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004965 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004966 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004967 int destIfNull = jumpIfNull ? dest : destIfFalse;
4968 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004969 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004970 sqlite3VdbeResolveLabel(v, destIfFalse);
4971 break;
4972 }
shanehbb201342011-02-09 19:55:20 +00004973#endif
drhcce7d172000-05-31 15:34:51 +00004974 default: {
dan7b35a772016-07-28 19:47:15 +00004975 default_expr:
drhad317272019-04-19 16:21:51 +00004976 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004977 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004978 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004979 /* No-op */
4980 }else{
4981 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4982 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004983 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004984 testcase( regFree1==0 );
4985 testcase( jumpIfNull==0 );
4986 }
drhcce7d172000-05-31 15:34:51 +00004987 break;
4988 }
4989 }
drh2dcef112008-01-12 19:03:48 +00004990 sqlite3ReleaseTempReg(pParse, regFree1);
4991 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004992}
4993
4994/*
drh66b89c82000-11-28 20:47:17 +00004995** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004996** to the label "dest" if the expression is false but execution
4997** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004998**
4999** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005000** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5001** is 0.
drhcce7d172000-05-31 15:34:51 +00005002*/
danielk19774adee202004-05-08 08:23:19 +00005003void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005004 Vdbe *v = pParse->pVdbe;
5005 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005006 int regFree1 = 0;
5007 int regFree2 = 0;
5008 int r1, r2;
5009
drh35573352008-01-08 23:54:25 +00005010 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005011 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005012 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005013 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005014
5015 /* The value of pExpr->op and op are related as follows:
5016 **
5017 ** pExpr->op op
5018 ** --------- ----------
5019 ** TK_ISNULL OP_NotNull
5020 ** TK_NOTNULL OP_IsNull
5021 ** TK_NE OP_Eq
5022 ** TK_EQ OP_Ne
5023 ** TK_GT OP_Le
5024 ** TK_LE OP_Gt
5025 ** TK_GE OP_Lt
5026 ** TK_LT OP_Ge
5027 **
5028 ** For other values of pExpr->op, op is undefined and unused.
5029 ** The value of TK_ and OP_ constants are arranged such that we
5030 ** can compute the mapping above using the following expression.
5031 ** Assert()s verify that the computation is correct.
5032 */
5033 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5034
5035 /* Verify correct alignment of TK_ and OP_ constants
5036 */
5037 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5038 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5039 assert( pExpr->op!=TK_NE || op==OP_Eq );
5040 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5041 assert( pExpr->op!=TK_LT || op==OP_Ge );
5042 assert( pExpr->op!=TK_LE || op==OP_Gt );
5043 assert( pExpr->op!=TK_GT || op==OP_Le );
5044 assert( pExpr->op!=TK_GE || op==OP_Lt );
5045
danba00e302016-07-23 20:24:06 +00005046 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005047 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005048 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005049 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5050 if( pAlt!=pExpr ){
5051 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5052 }else if( pExpr->op==TK_AND ){
5053 testcase( jumpIfNull==0 );
5054 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5055 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5056 }else{
5057 int d2 = sqlite3VdbeMakeLabel(pParse);
5058 testcase( jumpIfNull==0 );
5059 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5060 jumpIfNull^SQLITE_JUMPIFNULL);
5061 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5062 sqlite3VdbeResolveLabel(v, d2);
5063 }
drhcce7d172000-05-31 15:34:51 +00005064 break;
5065 }
5066 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005067 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005068 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005069 break;
5070 }
drh8abed7b2018-02-26 18:49:05 +00005071 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005072 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5073 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005074 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005075 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005076 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005077 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005078 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005079 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005080 /* IS TRUE and IS NOT FALSE */
5081 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5082 isNot ? 0 : SQLITE_JUMPIFNULL);
5083
5084 }else{
5085 /* IS FALSE and IS NOT TRUE */
5086 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005087 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005088 }
drh007c8432018-02-26 03:20:18 +00005089 break;
5090 }
drhde845c22016-03-17 19:07:52 +00005091 case TK_IS:
5092 case TK_ISNOT:
5093 testcase( pExpr->op==TK_IS );
5094 testcase( pExpr->op==TK_ISNOT );
5095 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5096 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005097 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005098 case TK_LT:
5099 case TK_LE:
5100 case TK_GT:
5101 case TK_GE:
5102 case TK_NE:
5103 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005104 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005105 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005106 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5107 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005108 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005109 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005110 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5111 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5112 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5113 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005114 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5115 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5116 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5117 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5118 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5119 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005120 testcase( regFree1==0 );
5121 testcase( regFree2==0 );
5122 break;
5123 }
drhcce7d172000-05-31 15:34:51 +00005124 case TK_ISNULL:
5125 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005126 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5127 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005128 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5129 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005130 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005131 break;
5132 }
drhfef52082000-06-06 01:50:43 +00005133 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005134 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005135 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005136 break;
5137 }
drh84e30ca2011-02-10 17:46:14 +00005138#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005139 case TK_IN: {
5140 if( jumpIfNull ){
5141 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5142 }else{
drhec4ccdb2018-12-29 02:26:59 +00005143 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005144 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5145 sqlite3VdbeResolveLabel(v, destIfNull);
5146 }
5147 break;
5148 }
shanehbb201342011-02-09 19:55:20 +00005149#endif
drhcce7d172000-05-31 15:34:51 +00005150 default: {
danba00e302016-07-23 20:24:06 +00005151 default_expr:
drhad317272019-04-19 16:21:51 +00005152 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005153 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005154 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005155 /* no-op */
5156 }else{
5157 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5158 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005159 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005160 testcase( regFree1==0 );
5161 testcase( jumpIfNull==0 );
5162 }
drhcce7d172000-05-31 15:34:51 +00005163 break;
5164 }
5165 }
drh2dcef112008-01-12 19:03:48 +00005166 sqlite3ReleaseTempReg(pParse, regFree1);
5167 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005168}
drh22827922000-06-06 17:27:05 +00005169
5170/*
drh72bc8202015-06-11 13:58:35 +00005171** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5172** code generation, and that copy is deleted after code generation. This
5173** ensures that the original pExpr is unchanged.
5174*/
5175void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5176 sqlite3 *db = pParse->db;
5177 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5178 if( db->mallocFailed==0 ){
5179 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5180 }
5181 sqlite3ExprDelete(db, pCopy);
5182}
5183
dan5aa550c2017-06-24 18:10:29 +00005184/*
5185** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5186** type of expression.
5187**
5188** If pExpr is a simple SQL value - an integer, real, string, blob
5189** or NULL value - then the VDBE currently being prepared is configured
5190** to re-prepare each time a new value is bound to variable pVar.
5191**
5192** Additionally, if pExpr is a simple SQL value and the value is the
5193** same as that currently bound to variable pVar, non-zero is returned.
5194** Otherwise, if the values are not the same or if pExpr is not a simple
5195** SQL value, zero is returned.
5196*/
5197static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5198 int res = 0;
drhc0804222017-06-28 21:47:16 +00005199 int iVar;
5200 sqlite3_value *pL, *pR = 0;
5201
5202 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5203 if( pR ){
5204 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005205 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005206 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005207 if( pL ){
5208 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5209 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5210 }
5211 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005212 }
drhc0804222017-06-28 21:47:16 +00005213 sqlite3ValueFree(pR);
5214 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005215 }
5216
5217 return res;
5218}
drh72bc8202015-06-11 13:58:35 +00005219
5220/*
drh1d9da702010-01-07 15:17:02 +00005221** Do a deep comparison of two expression trees. Return 0 if the two
5222** expressions are completely identical. Return 1 if they differ only
5223** by a COLLATE operator at the top level. Return 2 if there are differences
5224** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005225**
drh619a1302013-08-01 13:04:46 +00005226** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5227** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5228**
drh66518ca2013-08-01 15:09:57 +00005229** The pA side might be using TK_REGISTER. If that is the case and pB is
5230** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5231**
drh1d9da702010-01-07 15:17:02 +00005232** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005233** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005234** identical, we return 2 just to be safe. So if this routine
5235** returns 2, then you do not really know for certain if the two
5236** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005237** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005238** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005239** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005240** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005241**
drhc0804222017-06-28 21:47:16 +00005242** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5243** pParse->pReprepare can be matched against literals in pB. The
5244** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5245** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5246** Argument pParse should normally be NULL. If it is not NULL and pA or
5247** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005248*/
dan5aa550c2017-06-24 18:10:29 +00005249int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005250 u32 combinedFlags;
5251 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005252 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005253 }
dan5aa550c2017-06-24 18:10:29 +00005254 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5255 return 0;
5256 }
drh10d1edf2013-11-15 15:52:39 +00005257 combinedFlags = pA->flags | pB->flags;
5258 if( combinedFlags & EP_IntValue ){
5259 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5260 return 0;
5261 }
drh1d9da702010-01-07 15:17:02 +00005262 return 2;
drh22827922000-06-06 17:27:05 +00005263 }
dan16dd3982018-12-20 15:04:38 +00005264 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005265 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005266 return 1;
5267 }
dan5aa550c2017-06-24 18:10:29 +00005268 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005269 return 1;
5270 }
5271 return 2;
5272 }
drh2edc5fd2015-11-24 02:10:52 +00005273 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005274 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005275 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005276#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005277 assert( pA->op==pB->op );
5278 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5279 return 2;
5280 }
drheda079c2018-09-20 19:02:15 +00005281 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005282 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5283 return 2;
5284 }
drheda079c2018-09-20 19:02:15 +00005285 }
5286#endif
drhf20bbc52019-01-17 01:06:00 +00005287 }else if( pA->op==TK_NULL ){
5288 return 0;
drhd5af5422018-04-13 14:27:01 +00005289 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005290 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005291 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005292 return 2;
drh2646da72005-12-09 20:02:05 +00005293 }
drh22827922000-06-06 17:27:05 +00005294 }
drh898c5272019-10-22 00:03:41 +00005295 if( (pA->flags & (EP_Distinct|EP_Commuted))
5296 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005297 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005298 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005299 if( (combinedFlags & EP_FixedCol)==0
5300 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005301 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005302 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005303 if( pA->op!=TK_STRING
5304 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005305 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005306 ){
drh10d1edf2013-11-15 15:52:39 +00005307 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005308 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005309 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5310 return 2;
5311 }
drh10d1edf2013-11-15 15:52:39 +00005312 }
5313 }
drh1d9da702010-01-07 15:17:02 +00005314 return 0;
drh22827922000-06-06 17:27:05 +00005315}
5316
drh8c6f6662010-04-26 19:17:26 +00005317/*
danfbb6e9f2020-01-09 20:11:29 +00005318** Compare two ExprList objects. Return 0 if they are identical, 1
5319** if they are certainly different, or 2 if it is not possible to
5320** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005321**
drh619a1302013-08-01 13:04:46 +00005322** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5323** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5324**
drh8c6f6662010-04-26 19:17:26 +00005325** This routine might return non-zero for equivalent ExprLists. The
5326** only consequence will be disabled optimizations. But this routine
5327** must never return 0 if the two ExprList objects are different, or
5328** a malfunction will result.
5329**
5330** Two NULL pointers are considered to be the same. But a NULL pointer
5331** always differs from a non-NULL pointer.
5332*/
drh619a1302013-08-01 13:04:46 +00005333int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005334 int i;
5335 if( pA==0 && pB==0 ) return 0;
5336 if( pA==0 || pB==0 ) return 1;
5337 if( pA->nExpr!=pB->nExpr ) return 1;
5338 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005339 int res;
drh8c6f6662010-04-26 19:17:26 +00005340 Expr *pExprA = pA->a[i].pExpr;
5341 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005342 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005343 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005344 }
5345 return 0;
5346}
drh13449892005-09-07 21:22:45 +00005347
drh22827922000-06-06 17:27:05 +00005348/*
drhf9463df2017-02-11 14:59:58 +00005349** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5350** are ignored.
5351*/
5352int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005353 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005354 sqlite3ExprSkipCollateAndLikely(pA),
5355 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005356 iTab);
5357}
5358
5359/*
drhc51cf862019-05-11 19:36:03 +00005360** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005361**
5362** Or if seenNot is true, return non-zero if Expr p can only be
5363** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005364*/
5365static int exprImpliesNotNull(
5366 Parse *pParse, /* Parsing context */
5367 Expr *p, /* The expression to be checked */
5368 Expr *pNN, /* The expression that is NOT NULL */
5369 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005370 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005371){
5372 assert( p );
5373 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005374 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5375 return pNN->op!=TK_NULL;
5376 }
drhc51cf862019-05-11 19:36:03 +00005377 switch( p->op ){
5378 case TK_IN: {
5379 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5380 assert( ExprHasProperty(p,EP_xIsSelect)
5381 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005382 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005383 }
5384 case TK_BETWEEN: {
5385 ExprList *pList = p->x.pList;
5386 assert( pList!=0 );
5387 assert( pList->nExpr==2 );
5388 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005389 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5390 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005391 ){
5392 return 1;
5393 }
drh7a231b42019-08-30 15:11:08 +00005394 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005395 }
5396 case TK_EQ:
5397 case TK_NE:
5398 case TK_LT:
5399 case TK_LE:
5400 case TK_GT:
5401 case TK_GE:
5402 case TK_PLUS:
5403 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005404 case TK_BITOR:
5405 case TK_LSHIFT:
5406 case TK_RSHIFT:
5407 case TK_CONCAT:
5408 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005409 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005410 case TK_STAR:
5411 case TK_REM:
5412 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005413 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005414 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005415 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005416 }
5417 case TK_SPAN:
5418 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005419 case TK_UPLUS:
5420 case TK_UMINUS: {
5421 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5422 }
5423 case TK_TRUTH: {
5424 if( seenNot ) return 0;
5425 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005426 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005427 }
dan1cd382e2019-08-29 15:06:35 +00005428 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005429 case TK_NOT: {
5430 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5431 }
5432 }
5433 return 0;
5434}
5435
5436/*
drh4bd5f732013-07-31 23:22:39 +00005437** Return true if we can prove the pE2 will always be true if pE1 is
5438** true. Return false if we cannot complete the proof or if pE2 might
5439** be false. Examples:
5440**
drh619a1302013-08-01 13:04:46 +00005441** pE1: x==5 pE2: x==5 Result: true
5442** pE1: x>0 pE2: x==5 Result: false
5443** pE1: x=21 pE2: x=21 OR y=43 Result: true
5444** pE1: x!=123 pE2: x IS NOT NULL Result: true
5445** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5446** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5447** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005448**
5449** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5450** Expr.iTable<0 then assume a table number given by iTab.
5451**
drhc0804222017-06-28 21:47:16 +00005452** If pParse is not NULL, then the values of bound variables in pE1 are
5453** compared against literal values in pE2 and pParse->pVdbe->expmask is
5454** modified to record which bound variables are referenced. If pParse
5455** is NULL, then false will be returned if pE1 contains any bound variables.
5456**
drh4bd5f732013-07-31 23:22:39 +00005457** When in doubt, return false. Returning true might give a performance
5458** improvement. Returning false might cause a performance reduction, but
5459** it will always give the correct answer and is hence always safe.
5460*/
dan5aa550c2017-06-24 18:10:29 +00005461int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5462 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005463 return 1;
5464 }
5465 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005466 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5467 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005468 ){
5469 return 1;
5470 }
drh664d6d12019-05-04 17:32:07 +00005471 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005472 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005473 ){
drhc51cf862019-05-11 19:36:03 +00005474 return 1;
drh619a1302013-08-01 13:04:46 +00005475 }
5476 return 0;
drh4bd5f732013-07-31 23:22:39 +00005477}
5478
5479/*
drh6c68d752019-11-04 02:05:52 +00005480** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005481** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005482** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5483**
5484** This routine controls an optimization. False positives (setting
5485** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5486** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005487*/
5488static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005489 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005490 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005491 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5492 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005493 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005494 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005495 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005496 case TK_IS:
5497 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005498 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005499 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005500 case TK_IN:
drh25897872018-03-20 21:16:15 +00005501 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005502 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005503 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005504 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005505 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005506 testcase( pExpr->op==TK_IS );
5507 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005508 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005509 testcase( pExpr->op==TK_CASE );
5510 testcase( pExpr->op==TK_IN );
5511 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005512 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005513 return WRC_Prune;
5514 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005515 if( pWalker->u.iCur==pExpr->iTable ){
5516 pWalker->eCode = 1;
5517 return WRC_Abort;
5518 }
5519 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005520
dan9d23ea72019-08-29 19:34:29 +00005521 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005522 if( pWalker->eCode==0 ){
5523 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5524 if( pWalker->eCode ){
5525 pWalker->eCode = 0;
5526 sqlite3WalkExpr(pWalker, pExpr->pRight);
5527 }
dan9d23ea72019-08-29 19:34:29 +00005528 }
5529 return WRC_Prune;
5530
5531 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005532 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5533 assert( pWalker->eCode );
5534 return WRC_Abort;
5535 }
dan9d23ea72019-08-29 19:34:29 +00005536 return WRC_Prune;
5537
drh98811552018-04-03 14:04:48 +00005538 /* Virtual tables are allowed to use constraints like x=NULL. So
5539 ** a term of the form x=y does not prove that y is not null if x
5540 ** is the column of a virtual table */
5541 case TK_EQ:
5542 case TK_NE:
5543 case TK_LT:
5544 case TK_LE:
5545 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005546 case TK_GE: {
5547 Expr *pLeft = pExpr->pLeft;
5548 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005549 testcase( pExpr->op==TK_EQ );
5550 testcase( pExpr->op==TK_NE );
5551 testcase( pExpr->op==TK_LT );
5552 testcase( pExpr->op==TK_LE );
5553 testcase( pExpr->op==TK_GT );
5554 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005555 /* The y.pTab=0 assignment in wherecode.c always happens after the
5556 ** impliesNotNullRow() test */
5557 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5558 && IsVirtual(pLeft->y.pTab))
5559 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5560 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005561 ){
drh78d1d222020-02-17 19:25:07 +00005562 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005563 }
drh08b92082020-08-10 14:18:00 +00005564 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005565 }
drh25897872018-03-20 21:16:15 +00005566 default:
5567 return WRC_Continue;
5568 }
5569}
5570
5571/*
5572** Return true (non-zero) if expression p can only be true if at least
5573** one column of table iTab is non-null. In other words, return true
5574** if expression p will always be NULL or false if every column of iTab
5575** is NULL.
5576**
drh821b6102018-03-24 18:01:51 +00005577** False negatives are acceptable. In other words, it is ok to return
5578** zero even if expression p will never be true of every column of iTab
5579** is NULL. A false negative is merely a missed optimization opportunity.
5580**
5581** False positives are not allowed, however. A false positive may result
5582** in an incorrect answer.
5583**
drh25897872018-03-20 21:16:15 +00005584** Terms of p that are marked with EP_FromJoin (and hence that come from
5585** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5586**
5587** This routine is used to check if a LEFT JOIN can be converted into
5588** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5589** clause requires that some column of the right table of the LEFT JOIN
5590** be non-NULL, then the LEFT JOIN can be safely converted into an
5591** ordinary join.
5592*/
5593int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5594 Walker w;
drh0d950af2019-08-22 16:38:42 +00005595 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005596 if( p==0 ) return 0;
5597 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005598 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005599 }else{
5600 while( p->op==TK_AND ){
5601 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5602 p = p->pRight;
5603 }
drhd6db6592019-04-01 19:42:42 +00005604 }
drh25897872018-03-20 21:16:15 +00005605 w.xExprCallback = impliesNotNullRow;
5606 w.xSelectCallback = 0;
5607 w.xSelectCallback2 = 0;
5608 w.eCode = 0;
5609 w.u.iCur = iTab;
5610 sqlite3WalkExpr(&w, p);
5611 return w.eCode;
5612}
5613
5614/*
drh030796d2012-08-23 16:18:10 +00005615** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005616** to determine if an expression can be evaluated by reference to the
5617** index only, without having to do a search for the corresponding
5618** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5619** is the cursor for the table.
5620*/
5621struct IdxCover {
5622 Index *pIdx; /* The index to be tested for coverage */
5623 int iCur; /* Cursor number for the table corresponding to the index */
5624};
5625
5626/*
5627** Check to see if there are references to columns in table
5628** pWalker->u.pIdxCover->iCur can be satisfied using the index
5629** pWalker->u.pIdxCover->pIdx.
5630*/
5631static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5632 if( pExpr->op==TK_COLUMN
5633 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005634 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005635 ){
5636 pWalker->eCode = 1;
5637 return WRC_Abort;
5638 }
5639 return WRC_Continue;
5640}
5641
5642/*
drhe604ec02016-07-27 19:20:58 +00005643** Determine if an index pIdx on table with cursor iCur contains will
5644** the expression pExpr. Return true if the index does cover the
5645** expression and false if the pExpr expression references table columns
5646** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005647**
5648** An index covering an expression means that the expression can be
5649** evaluated using only the index and without having to lookup the
5650** corresponding table entry.
5651*/
5652int sqlite3ExprCoveredByIndex(
5653 Expr *pExpr, /* The index to be tested */
5654 int iCur, /* The cursor number for the corresponding table */
5655 Index *pIdx /* The index that might be used for coverage */
5656){
5657 Walker w;
5658 struct IdxCover xcov;
5659 memset(&w, 0, sizeof(w));
5660 xcov.iCur = iCur;
5661 xcov.pIdx = pIdx;
5662 w.xExprCallback = exprIdxCover;
5663 w.u.pIdxCover = &xcov;
5664 sqlite3WalkExpr(&w, pExpr);
5665 return !w.eCode;
5666}
5667
5668
5669/*
5670** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005671** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005672** aggregate function, in order to implement the
5673** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005674*/
drh030796d2012-08-23 16:18:10 +00005675struct SrcCount {
5676 SrcList *pSrc; /* One particular FROM clause in a nested query */
daned41a962020-06-09 17:45:48 +00005677 int iSrcInner; /* Smallest cursor number in this context */
drh030796d2012-08-23 16:18:10 +00005678 int nThis; /* Number of references to columns in pSrcList */
5679 int nOther; /* Number of references to columns in other FROM clauses */
5680};
5681
5682/*
daned41a962020-06-09 17:45:48 +00005683** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5684** SELECT with a FROM clause encountered during this iteration, set
5685** SrcCount.iSrcInner to the cursor number of the leftmost object in
5686** the FROM cause.
5687*/
5688static int selectSrcCount(Walker *pWalker, Select *pSel){
5689 struct SrcCount *p = pWalker->u.pSrcCount;
drhbc050b82020-06-09 22:11:06 +00005690 if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
daned41a962020-06-09 17:45:48 +00005691 pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5692 }
5693 return WRC_Continue;
5694}
5695
5696/*
drh030796d2012-08-23 16:18:10 +00005697** Count the number of references to columns.
5698*/
5699static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005700 /* There was once a NEVER() on the second term on the grounds that
5701 ** sqlite3FunctionUsesThisSrc() was always called before
5702 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5703 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5704 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5705 ** FunctionUsesThisSrc() when creating a new sub-select. */
5706 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005707 int i;
drh030796d2012-08-23 16:18:10 +00005708 struct SrcCount *p = pWalker->u.pSrcCount;
5709 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005710 int nSrc = pSrc ? pSrc->nSrc : 0;
5711 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005712 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005713 }
drh655814d2015-01-09 01:27:29 +00005714 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005715 p->nThis++;
daned41a962020-06-09 17:45:48 +00005716 }else if( pExpr->iTable<p->iSrcInner ){
drh80f6bfc2019-08-31 20:13:30 +00005717 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005718 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005719 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005720 p->nOther++;
5721 }
drh374fdce2012-04-17 16:38:53 +00005722 }
drh030796d2012-08-23 16:18:10 +00005723 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005724}
5725
5726/*
drh030796d2012-08-23 16:18:10 +00005727** Determine if any of the arguments to the pExpr Function reference
5728** pSrcList. Return true if they do. Also return true if the function
5729** has no arguments or has only constant arguments. Return false if pExpr
5730** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005731*/
drh030796d2012-08-23 16:18:10 +00005732int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005733 Walker w;
drh030796d2012-08-23 16:18:10 +00005734 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005735 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005736 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005737 w.xExprCallback = exprSrcCount;
daned41a962020-06-09 17:45:48 +00005738 w.xSelectCallback = selectSrcCount;
drh030796d2012-08-23 16:18:10 +00005739 w.u.pSrcCount = &cnt;
5740 cnt.pSrc = pSrcList;
daned41a962020-06-09 17:45:48 +00005741 cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
drh030796d2012-08-23 16:18:10 +00005742 cnt.nThis = 0;
5743 cnt.nOther = 0;
5744 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005745#ifndef SQLITE_OMIT_WINDOWFUNC
5746 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5747 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5748 }
5749#endif
drh030796d2012-08-23 16:18:10 +00005750 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005751}
5752
5753/*
drh89636622020-06-07 17:33:18 +00005754** This is a Walker expression node callback.
5755**
5756** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
5757** object that is referenced does not refer directly to the Expr. If
5758** it does, make a copy. This is done because the pExpr argument is
5759** subject to change.
5760**
5761** The copy is stored on pParse->pConstExpr with a register number of 0.
5762** This will cause the expression to be deleted automatically when the
5763** Parse object is destroyed, but the zero register number means that it
5764** will not generate any code in the preamble.
5765*/
5766static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00005767 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00005768 && pExpr->pAggInfo!=0
5769 ){
5770 AggInfo *pAggInfo = pExpr->pAggInfo;
5771 int iAgg = pExpr->iAgg;
5772 Parse *pParse = pWalker->pParse;
5773 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00005774 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
5775 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00005776 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00005777 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005778 pExpr = sqlite3ExprDup(db, pExpr, 0);
5779 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005780 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005781 pParse->pConstExpr =
5782 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5783 }
5784 }
5785 }else{
5786 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00005787 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005788 pExpr = sqlite3ExprDup(db, pExpr, 0);
5789 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005790 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005791 pParse->pConstExpr =
5792 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5793 }
5794 }
5795 }
5796 }
5797 return WRC_Continue;
5798}
5799
5800/*
5801** Initialize a Walker object so that will persist AggInfo entries referenced
5802** by the tree that is walked.
5803*/
5804void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
5805 memset(pWalker, 0, sizeof(*pWalker));
5806 pWalker->pParse = pParse;
5807 pWalker->xExprCallback = agginfoPersistExprCb;
5808 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
5809}
5810
5811/*
drh13449892005-09-07 21:22:45 +00005812** Add a new element to the pAggInfo->aCol[] array. Return the index of
5813** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005814*/
drh17435752007-08-16 04:30:38 +00005815static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005816 int i;
drhcf643722007-03-27 13:36:37 +00005817 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005818 db,
drhcf643722007-03-27 13:36:37 +00005819 pInfo->aCol,
5820 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005821 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005822 &i
5823 );
drh13449892005-09-07 21:22:45 +00005824 return i;
5825}
5826
5827/*
5828** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5829** the new element. Return a negative number if malloc fails.
5830*/
drh17435752007-08-16 04:30:38 +00005831static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005832 int i;
drhcf643722007-03-27 13:36:37 +00005833 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005834 db,
drhcf643722007-03-27 13:36:37 +00005835 pInfo->aFunc,
5836 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005837 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005838 &i
5839 );
drh13449892005-09-07 21:22:45 +00005840 return i;
drh89636622020-06-07 17:33:18 +00005841}
drh22827922000-06-06 17:27:05 +00005842
5843/*
drh7d10d5a2008-08-20 16:35:10 +00005844** This is the xExprCallback for a tree walker. It is used to
5845** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005846** for additional information.
drh22827922000-06-06 17:27:05 +00005847*/
drh7d10d5a2008-08-20 16:35:10 +00005848static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005849 int i;
drh7d10d5a2008-08-20 16:35:10 +00005850 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005851 Parse *pParse = pNC->pParse;
5852 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005853 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005854
drh25c3b8c2018-04-16 10:34:13 +00005855 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005856 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005857 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005858 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005859 testcase( pExpr->op==TK_AGG_COLUMN );
5860 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005861 /* Check to see if the column is in one of the tables in the FROM
5862 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005863 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005864 struct SrcList_item *pItem = pSrcList->a;
5865 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5866 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005867 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005868 if( pExpr->iTable==pItem->iCursor ){
5869 /* If we reach this point, it means that pExpr refers to a table
5870 ** that is in the FROM clause of the aggregate query.
5871 **
5872 ** Make an entry for the column in pAggInfo->aCol[] if there
5873 ** is not an entry there already.
5874 */
drh7f906d62007-03-12 23:48:52 +00005875 int k;
drh13449892005-09-07 21:22:45 +00005876 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005877 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005878 if( pCol->iTable==pExpr->iTable &&
5879 pCol->iColumn==pExpr->iColumn ){
5880 break;
5881 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005882 }
danielk19771e536952007-08-16 10:09:01 +00005883 if( (k>=pAggInfo->nColumn)
5884 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5885 ){
drh7f906d62007-03-12 23:48:52 +00005886 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005887 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005888 pCol->iTable = pExpr->iTable;
5889 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005890 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005891 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00005892 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005893 if( pAggInfo->pGroupBy ){
5894 int j, n;
5895 ExprList *pGB = pAggInfo->pGroupBy;
5896 struct ExprList_item *pTerm = pGB->a;
5897 n = pGB->nExpr;
5898 for(j=0; j<n; j++, pTerm++){
5899 Expr *pE = pTerm->pExpr;
5900 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5901 pE->iColumn==pExpr->iColumn ){
5902 pCol->iSorterColumn = j;
5903 break;
5904 }
5905 }
5906 }
5907 if( pCol->iSorterColumn<0 ){
5908 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5909 }
5910 }
5911 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5912 ** because it was there before or because we just created it).
5913 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5914 ** pAggInfo->aCol[] entry.
5915 */
drhebb6a652013-09-12 23:42:22 +00005916 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005917 pExpr->pAggInfo = pAggInfo;
5918 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005919 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005920 break;
5921 } /* endif pExpr->iTable==pItem->iCursor */
5922 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005923 }
drh7d10d5a2008-08-20 16:35:10 +00005924 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005925 }
5926 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005927 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005928 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005929 ){
drh13449892005-09-07 21:22:45 +00005930 /* Check to see if pExpr is a duplicate of another aggregate
5931 ** function that is already in the pAggInfo structure
5932 */
5933 struct AggInfo_func *pItem = pAggInfo->aFunc;
5934 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh81185a52020-06-09 13:38:12 +00005935 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005936 break;
5937 }
drh22827922000-06-06 17:27:05 +00005938 }
drh13449892005-09-07 21:22:45 +00005939 if( i>=pAggInfo->nFunc ){
5940 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5941 */
danielk197714db2662006-01-09 16:12:04 +00005942 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005943 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005944 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005945 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005946 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00005947 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005948 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005949 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005950 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005951 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005952 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005953 if( pExpr->flags & EP_Distinct ){
5954 pItem->iDistinct = pParse->nTab++;
5955 }else{
5956 pItem->iDistinct = -1;
5957 }
drh13449892005-09-07 21:22:45 +00005958 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005959 }
drh13449892005-09-07 21:22:45 +00005960 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5961 */
drhc5cd1242013-09-12 16:50:49 +00005962 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005963 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005964 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005965 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005966 return WRC_Prune;
5967 }else{
5968 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005969 }
drh22827922000-06-06 17:27:05 +00005970 }
5971 }
drh7d10d5a2008-08-20 16:35:10 +00005972 return WRC_Continue;
5973}
drh626a8792005-01-17 22:08:19 +00005974
5975/*
drhe8abb4c2012-11-02 18:24:57 +00005976** Analyze the pExpr expression looking for aggregate functions and
5977** for variables that need to be added to AggInfo object that pNC->pAggInfo
5978** points to. Additional entries are made on the AggInfo object as
5979** necessary.
drh626a8792005-01-17 22:08:19 +00005980**
5981** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005982** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005983*/
drhd2b3e232008-01-23 14:51:49 +00005984void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005985 Walker w;
5986 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00005987 w.xSelectCallback = sqlite3WalkerDepthIncrease;
5988 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00005989 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005990 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005991 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005992 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005993 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005994}
drh5d9a4af2005-08-30 00:54:01 +00005995
5996/*
5997** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5998** expression list. Return the number of errors.
5999**
6000** If an error is found, the analysis is cut short.
6001*/
drhd2b3e232008-01-23 14:51:49 +00006002void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006003 struct ExprList_item *pItem;
6004 int i;
drh5d9a4af2005-08-30 00:54:01 +00006005 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006006 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6007 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006008 }
6009 }
drh5d9a4af2005-08-30 00:54:01 +00006010}
drh892d3172008-01-10 03:46:36 +00006011
6012/*
drhceea3322009-04-23 13:22:42 +00006013** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006014*/
6015int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006016 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006017 return ++pParse->nMem;
6018 }
danielk19772f425f62008-07-04 09:41:39 +00006019 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006020}
drhceea3322009-04-23 13:22:42 +00006021
6022/*
6023** Deallocate a register, making available for reuse for some other
6024** purpose.
drhceea3322009-04-23 13:22:42 +00006025*/
drh892d3172008-01-10 03:46:36 +00006026void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006027 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006028 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006029 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6030 pParse->aTempReg[pParse->nTempReg++] = iReg;
6031 }
drh892d3172008-01-10 03:46:36 +00006032 }
6033}
6034
6035/*
drhed24da42016-09-06 14:37:05 +00006036** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006037*/
6038int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006039 int i, n;
drhed24da42016-09-06 14:37:05 +00006040 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006041 i = pParse->iRangeReg;
6042 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006043 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006044 pParse->iRangeReg += nReg;
6045 pParse->nRangeReg -= nReg;
6046 }else{
6047 i = pParse->nMem+1;
6048 pParse->nMem += nReg;
6049 }
6050 return i;
6051}
6052void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006053 if( nReg==1 ){
6054 sqlite3ReleaseTempReg(pParse, iReg);
6055 return;
6056 }
drh3aef2fb2020-01-02 17:46:02 +00006057 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006058 if( nReg>pParse->nRangeReg ){
6059 pParse->nRangeReg = nReg;
6060 pParse->iRangeReg = iReg;
6061 }
6062}
drhcdc69552011-12-06 13:24:59 +00006063
6064/*
6065** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006066**
6067** Always invoke this procedure after coding a subroutine or co-routine
6068** that might be invoked from other parts of the code, to ensure that
6069** the sub/co-routine does not use registers in common with the code that
6070** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006071*/
6072void sqlite3ClearTempRegCache(Parse *pParse){
6073 pParse->nTempReg = 0;
6074 pParse->nRangeReg = 0;
6075}
drhbb9b5f22016-03-19 00:35:02 +00006076
6077/*
6078** Validate that no temporary register falls within the range of
6079** iFirst..iLast, inclusive. This routine is only call from within assert()
6080** statements.
6081*/
6082#ifdef SQLITE_DEBUG
6083int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6084 int i;
6085 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006086 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6087 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006088 ){
6089 return 0;
6090 }
6091 for(i=0; i<pParse->nTempReg; i++){
6092 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6093 return 0;
6094 }
6095 }
6096 return 1;
6097}
6098#endif /* SQLITE_DEBUG */