blob: ac0f4073f188d3b80164af05b18a3584a15e5ca1 [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;
drh4bc20452021-03-29 18:53:47 +0000614 int addrCmp = 0;
drhec4ccdb2018-12-29 02:26:59 +0000615 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000616 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000617
drhe7375bf2020-03-10 19:24:38 +0000618 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh340fd0b2021-03-19 16:29:40 +0000619 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000620 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
621 sqlite3ErrorMsg(pParse, "row value misused");
622 return;
623 }
drhb29e60c2016-09-05 12:02:34 +0000624 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
625 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
626 || pExpr->op==TK_LT || pExpr->op==TK_GT
627 || pExpr->op==TK_LE || pExpr->op==TK_GE
628 );
629 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
630 || (pExpr->op==TK_ISNOT && op==TK_NE) );
631 assert( p5==0 || pExpr->op!=op );
632 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000633
drh4bc20452021-03-29 18:53:47 +0000634 if( op==TK_LE ) opx = TK_LT;
635 if( op==TK_GE ) opx = TK_GT;
636 if( op==TK_NE ) opx = TK_EQ;
dan71c57db2016-07-09 20:23:55 +0000637
drhb29e60c2016-09-05 12:02:34 +0000638 regLeft = exprCodeSubselect(pParse, pLeft);
639 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000640
drh4bc20452021-03-29 18:53:47 +0000641 sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
drhb29e60c2016-09-05 12:02:34 +0000642 for(i=0; 1 /*Loop exits by "break"*/; i++){
643 int regFree1 = 0, regFree2 = 0;
644 Expr *pL, *pR;
645 int r1, r2;
646 assert( i>=0 && i<nLeft );
drh4bc20452021-03-29 18:53:47 +0000647 if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000648 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
649 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh4bc20452021-03-29 18:53:47 +0000650 addrCmp = sqlite3VdbeCurrentAddr(v);
651 codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000652 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
653 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
654 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
655 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
656 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
657 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
658 sqlite3ReleaseTempReg(pParse, regFree1);
659 sqlite3ReleaseTempReg(pParse, regFree2);
drh4bc20452021-03-29 18:53:47 +0000660 if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
661 addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
662 testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
663 testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
664 }
665 if( p5==SQLITE_NULLEQ ){
666 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
667 }else{
668 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
669 }
drhb29e60c2016-09-05 12:02:34 +0000670 if( i==nLeft-1 ){
671 break;
dan71c57db2016-07-09 20:23:55 +0000672 }
drhb29e60c2016-09-05 12:02:34 +0000673 if( opx==TK_EQ ){
drh4bc20452021-03-29 18:53:47 +0000674 sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
drhb29e60c2016-09-05 12:02:34 +0000675 }else{
676 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
drh4bc20452021-03-29 18:53:47 +0000677 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
drhb29e60c2016-09-05 12:02:34 +0000678 if( i==nLeft-2 ) opx = op;
679 }
dan71c57db2016-07-09 20:23:55 +0000680 }
drh4bc20452021-03-29 18:53:47 +0000681 sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000682 sqlite3VdbeResolveLabel(v, addrDone);
drh4bc20452021-03-29 18:53:47 +0000683 if( op==TK_NE ){
684 sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
685 }
dan71c57db2016-07-09 20:23:55 +0000686}
687
danielk19774b5255a2008-06-05 16:47:39 +0000688#if SQLITE_MAX_EXPR_DEPTH>0
689/*
690** Check that argument nHeight is less than or equal to the maximum
691** expression depth allowed. If it is not, leave an error message in
692** pParse.
693*/
drh7d10d5a2008-08-20 16:35:10 +0000694int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000695 int rc = SQLITE_OK;
696 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
697 if( nHeight>mxHeight ){
698 sqlite3ErrorMsg(pParse,
699 "Expression tree is too large (maximum depth %d)", mxHeight
700 );
701 rc = SQLITE_ERROR;
702 }
703 return rc;
704}
705
706/* The following three functions, heightOfExpr(), heightOfExprList()
707** and heightOfSelect(), are used to determine the maximum height
708** of any expression tree referenced by the structure passed as the
709** first argument.
710**
711** If this maximum height is greater than the current value pointed
712** to by pnHeight, the second parameter, then set *pnHeight to that
713** value.
714*/
715static void heightOfExpr(Expr *p, int *pnHeight){
716 if( p ){
717 if( p->nHeight>*pnHeight ){
718 *pnHeight = p->nHeight;
719 }
720 }
721}
722static void heightOfExprList(ExprList *p, int *pnHeight){
723 if( p ){
724 int i;
725 for(i=0; i<p->nExpr; i++){
726 heightOfExpr(p->a[i].pExpr, pnHeight);
727 }
728 }
729}
dan1a3a3082018-01-18 19:00:54 +0000730static void heightOfSelect(Select *pSelect, int *pnHeight){
731 Select *p;
732 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000733 heightOfExpr(p->pWhere, pnHeight);
734 heightOfExpr(p->pHaving, pnHeight);
735 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000736 heightOfExprList(p->pEList, pnHeight);
737 heightOfExprList(p->pGroupBy, pnHeight);
738 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000739 }
740}
741
742/*
743** Set the Expr.nHeight variable in the structure passed as an
744** argument. An expression with no children, Expr.pList or
745** Expr.pSelect member has a height of 1. Any other expression
746** has a height equal to the maximum height of any other
747** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000748**
749** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
750** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000751*/
752static void exprSetHeight(Expr *p){
753 int nHeight = 0;
754 heightOfExpr(p->pLeft, &nHeight);
755 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000756 if( ExprHasProperty(p, EP_xIsSelect) ){
757 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000758 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000759 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000760 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000761 }
danielk19774b5255a2008-06-05 16:47:39 +0000762 p->nHeight = nHeight + 1;
763}
764
765/*
766** Set the Expr.nHeight variable using the exprSetHeight() function. If
767** the height is greater than the maximum allowed expression depth,
768** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000769**
770** Also propagate all EP_Propagate flags from the Expr.x.pList into
771** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000772*/
drh2308ed32015-02-09 16:09:34 +0000773void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000774 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000775 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000776 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000777}
778
779/*
780** Return the maximum height of any expression tree referenced
781** by the select statement passed as an argument.
782*/
783int sqlite3SelectExprHeight(Select *p){
784 int nHeight = 0;
785 heightOfSelect(p, &nHeight);
786 return nHeight;
787}
drh2308ed32015-02-09 16:09:34 +0000788#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
789/*
790** Propagate all EP_Propagate flags from the Expr.x.pList into
791** Expr.flags.
792*/
793void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000794 if( pParse->nErr ) return;
drh2308ed32015-02-09 16:09:34 +0000795 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
796 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
797 }
798}
799#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000800#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
801
drhbe5c89a2004-07-26 00:31:09 +0000802/*
drhb7916a72009-05-27 10:31:29 +0000803** This routine is the core allocator for Expr nodes.
804**
drha76b5df2002-02-23 02:32:10 +0000805** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000806** for this node and for the pToken argument is a single allocation
807** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000808** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000809**
810** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000811** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000812** parameter is ignored if pToken is NULL or if the token does not
813** appear to be quoted. If the quotes were of the form "..." (double-quotes)
814** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000815**
816** Special case: If op==TK_INTEGER and pToken points to a string that
817** can be translated into a 32-bit integer, then the token is not
818** stored in u.zToken. Instead, the integer values is written
819** into u.iValue and the EP_IntValue flag is set. No extra storage
820** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000821*/
drhb7916a72009-05-27 10:31:29 +0000822Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000823 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000824 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000825 const Token *pToken, /* Token argument. Might be NULL */
826 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000827){
drha76b5df2002-02-23 02:32:10 +0000828 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000829 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000830 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000831
drh575fad62016-02-05 13:38:36 +0000832 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000833 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000834 if( op!=TK_INTEGER || pToken->z==0
835 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
836 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000837 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000838 }
drhb7916a72009-05-27 10:31:29 +0000839 }
drh575fad62016-02-05 13:38:36 +0000840 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000841 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000842 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000843 pNew->op = (u8)op;
844 pNew->iAgg = -1;
845 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000846 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000847 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000848 pNew->u.iValue = iValue;
849 }else{
drh33e619f2009-05-28 01:00:55 +0000850 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000851 assert( pToken->z!=0 || pToken->n==0 );
852 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000853 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000854 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000855 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000856 }
drhb7916a72009-05-27 10:31:29 +0000857 }
858 }
859#if SQLITE_MAX_EXPR_DEPTH>0
860 pNew->nHeight = 1;
861#endif
862 }
drha76b5df2002-02-23 02:32:10 +0000863 return pNew;
864}
865
866/*
drhb7916a72009-05-27 10:31:29 +0000867** Allocate a new expression node from a zero-terminated token that has
868** already been dequoted.
869*/
870Expr *sqlite3Expr(
871 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
872 int op, /* Expression opcode */
873 const char *zToken /* Token argument. Might be NULL */
874){
875 Token x;
876 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000877 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000878 return sqlite3ExprAlloc(db, op, &x, 0);
879}
880
881/*
882** Attach subtrees pLeft and pRight to the Expr node pRoot.
883**
884** If pRoot==NULL that means that a memory allocation error has occurred.
885** In that case, delete the subtrees pLeft and pRight.
886*/
887void sqlite3ExprAttachSubtrees(
888 sqlite3 *db,
889 Expr *pRoot,
890 Expr *pLeft,
891 Expr *pRight
892){
893 if( pRoot==0 ){
894 assert( db->mallocFailed );
895 sqlite3ExprDelete(db, pLeft);
896 sqlite3ExprDelete(db, pRight);
897 }else{
898 if( pRight ){
899 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000900 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000901 }
902 if( pLeft ){
903 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000904 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000905 }
906 exprSetHeight(pRoot);
907 }
908}
909
910/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000911** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000912**
drhbf664462009-06-19 18:32:54 +0000913** One or both of the subtrees can be NULL. Return a pointer to the new
914** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
915** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000916*/
drh17435752007-08-16 04:30:38 +0000917Expr *sqlite3PExpr(
918 Parse *pParse, /* Parsing context */
919 int op, /* Expression opcode */
920 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000921 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000922){
drh5fb52ca2012-03-31 02:34:35 +0000923 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000924 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
925 if( p ){
926 memset(p, 0, sizeof(Expr));
927 p->op = op & 0xff;
928 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000929 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000930 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000931 }else{
932 sqlite3ExprDelete(pParse->db, pLeft);
933 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000934 }
drh4e0cff62004-11-05 05:10:28 +0000935 return p;
936}
937
938/*
drh08de4f72016-04-11 01:06:47 +0000939** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
940** do a memory allocation failure) then delete the pSelect object.
941*/
942void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
943 if( pExpr ){
944 pExpr->x.pSelect = pSelect;
945 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
946 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
947 }else{
948 assert( pParse->db->mallocFailed );
949 sqlite3SelectDelete(pParse->db, pSelect);
950 }
951}
952
953
954/*
drh91bb0ee2004-09-01 03:06:34 +0000955** Join two expressions using an AND operator. If either expression is
956** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000957**
958** If one side or the other of the AND is known to be false, then instead
959** of returning an AND expression, just return a constant expression with
960** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000961*/
drhd5c851c2019-04-19 13:38:34 +0000962Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
963 sqlite3 *db = pParse->db;
964 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000965 return pRight;
966 }else if( pRight==0 ){
967 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000968 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
969 && !IN_RENAME_OBJECT
970 ){
drhb3ad4e62021-03-31 13:31:33 +0000971 sqlite3ExprDeferredDelete(pParse, pLeft);
972 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000973 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000974 }else{
drhd5c851c2019-04-19 13:38:34 +0000975 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000976 }
977}
978
979/*
980** Construct a new expression node for a function with multiple
981** arguments.
982*/
drh954733b2018-07-27 23:33:16 +0000983Expr *sqlite3ExprFunction(
984 Parse *pParse, /* Parsing context */
985 ExprList *pList, /* Argument list */
986 Token *pToken, /* Name of the function */
987 int eDistinct /* SF_Distinct or SF_ALL or 0 */
988){
drha76b5df2002-02-23 02:32:10 +0000989 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000990 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000991 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000992 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000993 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000994 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000995 return 0;
996 }
drh954733b2018-07-27 23:33:16 +0000997 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
998 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
999 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001000 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +00001001 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +00001002 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +00001003 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +00001004 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +00001005 return pNew;
1006}
1007
1008/*
drh0dfa5252020-01-08 17:28:19 +00001009** Check to see if a function is usable according to current access
1010** rules:
1011**
1012** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1013**
1014** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1015** top-level SQL
1016**
1017** If the function is not usable, create an error.
1018*/
1019void sqlite3ExprFunctionUsable(
1020 Parse *pParse, /* Parsing and code generating context */
1021 Expr *pExpr, /* The function invocation */
1022 FuncDef *pDef /* The function being invoked */
1023){
1024 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001025 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1026 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001027 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1028 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1029 ){
1030 /* Functions prohibited in triggers and views if:
1031 ** (1) tagged with SQLITE_DIRECTONLY
1032 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1033 ** is tagged with SQLITE_FUNC_UNSAFE) and
1034 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1035 ** that the schema is possibly tainted).
1036 */
1037 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1038 }
1039 }
1040}
1041
1042/*
drhfa6bc002004-09-07 16:19:52 +00001043** Assign a variable number to an expression that encodes a wildcard
1044** in the original SQL statement.
1045**
1046** Wildcards consisting of a single "?" are assigned the next sequential
1047** variable number.
1048**
1049** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001050** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001051** the SQL statement comes from an external source.
1052**
drh51f49f12009-05-21 20:41:32 +00001053** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001054** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001055** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001056** assigned.
1057*/
drhde25a882016-10-03 15:28:24 +00001058void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001059 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001060 const char *z;
drhf326d662016-12-23 13:30:53 +00001061 ynVar x;
drh17435752007-08-16 04:30:38 +00001062
drhfa6bc002004-09-07 16:19:52 +00001063 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001064 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001065 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001066 assert( z!=0 );
1067 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001068 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001069 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001070 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001071 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001072 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001073 }else{
drhf326d662016-12-23 13:30:53 +00001074 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001075 if( z[0]=='?' ){
1076 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1077 ** use it as the variable number */
1078 i64 i;
drh18814df2017-01-31 03:52:34 +00001079 int bOk;
1080 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1081 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1082 bOk = 1;
1083 }else{
1084 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1085 }
drh124c0b42011-06-01 18:15:55 +00001086 testcase( i==0 );
1087 testcase( i==1 );
1088 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1089 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1090 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1091 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1092 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001093 return;
drhfa6bc002004-09-07 16:19:52 +00001094 }
drh8e74e7b2017-01-31 12:41:48 +00001095 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001096 if( x>pParse->nVar ){
1097 pParse->nVar = (int)x;
1098 doAdd = 1;
1099 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1100 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001101 }
1102 }else{
1103 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1104 ** number as the prior appearance of the same name, or if the name
1105 ** has never appeared before, reuse the same variable number
1106 */
drh9bf755c2016-12-23 03:59:31 +00001107 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1108 if( x==0 ){
1109 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001110 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001111 }
drhfa6bc002004-09-07 16:19:52 +00001112 }
drhf326d662016-12-23 13:30:53 +00001113 if( doAdd ){
1114 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1115 }
1116 }
1117 pExpr->iColumn = x;
1118 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001119 sqlite3ErrorMsg(pParse, "too many SQL variables");
1120 }
drhfa6bc002004-09-07 16:19:52 +00001121}
1122
1123/*
danf6963f92009-11-23 14:39:14 +00001124** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001125*/
drh4f0010b2016-04-11 14:49:39 +00001126static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1127 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001128 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1129 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001130
1131 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1132 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001133 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001134#ifdef SQLITE_DEBUG
1135 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1136 assert( p->pLeft==0 );
1137 assert( p->pRight==0 );
1138 assert( p->x.pSelect==0 );
1139 }
1140#endif
1141 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001142 /* The Expr.x union is never used at the same time as Expr.pRight */
1143 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001144 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001145 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001146 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001147 sqlite3ExprDeleteNN(db, p->pRight);
1148 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001149 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001150 sqlite3SelectDelete(db, p->x.pSelect);
1151 }else{
1152 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001153#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001154 if( ExprHasProperty(p, EP_WinFunc) ){
1155 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001156 }
dan6ba7ab02019-07-02 11:56:47 +00001157#endif
dan8117f112019-07-10 20:16:53 +00001158 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001159 }
drh209bc522016-09-23 21:36:24 +00001160 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001161 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001162 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001163 }
drha2e00042002-01-22 03:13:42 +00001164}
drh4f0010b2016-04-11 14:49:39 +00001165void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1166 if( p ) sqlite3ExprDeleteNN(db, p);
1167}
drha2e00042002-01-22 03:13:42 +00001168
drhb3ad4e62021-03-31 13:31:33 +00001169
1170/*
1171** Arrange to cause pExpr to be deleted when the pParse is deleted.
1172** This is similar to sqlite3ExprDelete() except that the delete is
1173** deferred untilthe pParse is deleted.
1174**
1175** The pExpr might be deleted immediately on an OOM error.
1176**
1177** The deferred delete is (currently) implemented by adding the
1178** pExpr to the pParse->pConstExpr list with a register number of 0.
1179*/
1180void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1181 pParse->pConstExpr =
1182 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1183}
1184
drh8e34e402019-06-11 10:43:56 +00001185/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1186** expression.
1187*/
1188void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1189 if( p ){
1190 if( IN_RENAME_OBJECT ){
1191 sqlite3RenameExprUnmap(pParse, p);
1192 }
1193 sqlite3ExprDeleteNN(pParse->db, p);
1194 }
1195}
1196
drhd2687b72005-08-12 22:56:09 +00001197/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001198** Return the number of bytes allocated for the expression structure
1199** passed as the first argument. This is always one of EXPR_FULLSIZE,
1200** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1201*/
1202static int exprStructSize(Expr *p){
1203 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001204 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1205 return EXPR_FULLSIZE;
1206}
1207
1208/*
drh33e619f2009-05-28 01:00:55 +00001209** The dupedExpr*Size() routines each return the number of bytes required
1210** to store a copy of an expression or expression tree. They differ in
1211** how much of the tree is measured.
1212**
1213** dupedExprStructSize() Size of only the Expr structure
1214** dupedExprNodeSize() Size of Expr + space for token
1215** dupedExprSize() Expr + token + subtree components
1216**
1217***************************************************************************
1218**
1219** The dupedExprStructSize() function returns two values OR-ed together:
1220** (1) the space required for a copy of the Expr structure only and
1221** (2) the EP_xxx flags that indicate what the structure size should be.
1222** The return values is always one of:
1223**
1224** EXPR_FULLSIZE
1225** EXPR_REDUCEDSIZE | EP_Reduced
1226** EXPR_TOKENONLYSIZE | EP_TokenOnly
1227**
1228** The size of the structure can be found by masking the return value
1229** of this routine with 0xfff. The flags can be found by masking the
1230** return value with EP_Reduced|EP_TokenOnly.
1231**
1232** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1233** (unreduced) Expr objects as they or originally constructed by the parser.
1234** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001235** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001236** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001237** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001238** to reduce a pristine expression tree from the parser. The implementation
1239** of dupedExprStructSize() contain multiple assert() statements that attempt
1240** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001241*/
1242static int dupedExprStructSize(Expr *p, int flags){
1243 int nSize;
drh33e619f2009-05-28 01:00:55 +00001244 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001245 assert( EXPR_FULLSIZE<=0xfff );
1246 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001247 if( 0==flags || p->op==TK_SELECT_COLUMN
1248#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001249 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001250#endif
1251 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001252 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001253 }else{
drhc5cd1242013-09-12 16:50:49 +00001254 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001255 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001256 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001257 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001258 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001259 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1260 }else{
drhaecd8022013-09-13 18:15:15 +00001261 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001262 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1263 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001264 }
1265 return nSize;
1266}
1267
1268/*
drh33e619f2009-05-28 01:00:55 +00001269** This function returns the space in bytes required to store the copy
1270** of the Expr structure and a copy of the Expr.u.zToken string (if that
1271** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001272*/
1273static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001274 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1275 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001276 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001277 }
danielk1977bc739712009-03-23 04:33:32 +00001278 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001279}
1280
1281/*
1282** Return the number of bytes required to create a duplicate of the
1283** expression passed as the first argument. The second argument is a
1284** mask containing EXPRDUP_XXX flags.
1285**
1286** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001287** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001288**
1289** If the EXPRDUP_REDUCE flag is set, then the return value includes
1290** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1291** and Expr.pRight variables (but not for any structures pointed to or
1292** descended from the Expr.x.pList or Expr.x.pSelect variables).
1293*/
1294static int dupedExprSize(Expr *p, int flags){
1295 int nByte = 0;
1296 if( p ){
1297 nByte = dupedExprNodeSize(p, flags);
1298 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001299 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001300 }
1301 }
1302 return nByte;
1303}
1304
1305/*
1306** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1307** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001308** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001309** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001310** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001311** portion of the buffer copied into by this function.
1312*/
drh3c194692016-04-11 16:43:43 +00001313static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1314 Expr *pNew; /* Value to return */
1315 u8 *zAlloc; /* Memory space from which to build Expr object */
1316 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1317
drh575fad62016-02-05 13:38:36 +00001318 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001319 assert( p );
1320 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1321 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001322
drh3c194692016-04-11 16:43:43 +00001323 /* Figure out where to write the new Expr structure. */
1324 if( pzBuffer ){
1325 zAlloc = *pzBuffer;
1326 staticFlag = EP_Static;
1327 }else{
1328 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1329 staticFlag = 0;
1330 }
1331 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001332
drh3c194692016-04-11 16:43:43 +00001333 if( pNew ){
1334 /* Set nNewSize to the size allocated for the structure pointed to
1335 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1336 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1337 ** by the copy of the p->u.zToken string (if any).
1338 */
1339 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1340 const int nNewSize = nStructSize & 0xfff;
1341 int nToken;
1342 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1343 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001344 }else{
drh3c194692016-04-11 16:43:43 +00001345 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001346 }
drh3c194692016-04-11 16:43:43 +00001347 if( dupFlags ){
1348 assert( ExprHasProperty(p, EP_Reduced)==0 );
1349 memcpy(zAlloc, p, nNewSize);
1350 }else{
1351 u32 nSize = (u32)exprStructSize(p);
1352 memcpy(zAlloc, p, nSize);
1353 if( nSize<EXPR_FULLSIZE ){
1354 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1355 }
1356 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001357
drh3c194692016-04-11 16:43:43 +00001358 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1359 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1360 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1361 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001362 ExprClearVVAProperties(pNew);
1363 if( dupFlags ){
1364 ExprSetVVAProperty(pNew, EP_Immutable);
1365 }
drh3c194692016-04-11 16:43:43 +00001366
1367 /* Copy the p->u.zToken string, if any. */
1368 if( nToken ){
1369 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1370 memcpy(zToken, p->u.zToken, nToken);
1371 }
1372
drh209bc522016-09-23 21:36:24 +00001373 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001374 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1375 if( ExprHasProperty(p, EP_xIsSelect) ){
1376 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001377 }else{
drh3c194692016-04-11 16:43:43 +00001378 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001379 }
drh3c194692016-04-11 16:43:43 +00001380 }
1381
1382 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001383 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001384 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001385 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001386 pNew->pLeft = p->pLeft ?
1387 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1388 pNew->pRight = p->pRight ?
1389 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001390 }
dan67a9b8e2018-06-22 20:51:35 +00001391#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001392 if( ExprHasProperty(p, EP_WinFunc) ){
1393 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1394 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001395 }
dan67a9b8e2018-06-22 20:51:35 +00001396#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001397 if( pzBuffer ){
1398 *pzBuffer = zAlloc;
1399 }
1400 }else{
drh209bc522016-09-23 21:36:24 +00001401 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001402 if( pNew->op==TK_SELECT_COLUMN ){
1403 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001404 assert( p->iColumn==0 || p->pRight==0 );
1405 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001406 }else{
1407 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1408 }
drh3c194692016-04-11 16:43:43 +00001409 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001410 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001411 }
1412 }
1413 return pNew;
1414}
1415
1416/*
danbfe31e72014-01-15 14:17:31 +00001417** Create and return a deep copy of the object passed as the second
1418** argument. If an OOM condition is encountered, NULL is returned
1419** and the db->mallocFailed flag set.
1420*/
daneede6a52014-01-15 19:42:23 +00001421#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001422static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001423 With *pRet = 0;
1424 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001425 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001426 pRet = sqlite3DbMallocZero(db, nByte);
1427 if( pRet ){
1428 int i;
1429 pRet->nCte = p->nCte;
1430 for(i=0; i<p->nCte; i++){
1431 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1432 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1433 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1434 }
1435 }
1436 }
1437 return pRet;
1438}
daneede6a52014-01-15 19:42:23 +00001439#else
1440# define withDup(x,y) 0
1441#endif
dan4e9119d2014-01-13 15:12:23 +00001442
drha8389972018-12-06 22:04:19 +00001443#ifndef SQLITE_OMIT_WINDOWFUNC
1444/*
1445** The gatherSelectWindows() procedure and its helper routine
1446** gatherSelectWindowsCallback() are used to scan all the expressions
1447** an a newly duplicated SELECT statement and gather all of the Window
1448** objects found there, assembling them onto the linked list at Select->pWin.
1449*/
1450static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001451 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001452 Select *pSelect = pWalker->u.pSelect;
1453 Window *pWin = pExpr->y.pWin;
1454 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001455 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001456 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001457 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001458 }
1459 return WRC_Continue;
1460}
drha37b6a52018-12-06 22:12:18 +00001461static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1462 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1463}
drha8389972018-12-06 22:04:19 +00001464static void gatherSelectWindows(Select *p){
1465 Walker w;
1466 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001467 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1468 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001469 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001470 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001471 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001472}
1473#endif
1474
1475
drha76b5df2002-02-23 02:32:10 +00001476/*
drhff78bd22002-02-27 01:47:11 +00001477** The following group of routines make deep copies of expressions,
1478** expression lists, ID lists, and select statements. The copies can
1479** be deleted (by being passed to their respective ...Delete() routines)
1480** without effecting the originals.
1481**
danielk19774adee202004-05-08 08:23:19 +00001482** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1483** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001484** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001485**
drhad3cab52002-05-24 02:04:32 +00001486** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001487**
drhb7916a72009-05-27 10:31:29 +00001488** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001489** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1490** truncated version of the usual Expr structure that will be stored as
1491** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001492*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001493Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001494 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001495 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001496}
danielk19776ab3a2e2009-02-19 14:39:25 +00001497ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001498 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001499 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001500 int i;
drhb1637482017-01-03 00:27:16 +00001501 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001502 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001503 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001504 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001505 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001506 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001507 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001508 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001509 pOldItem = p->a;
1510 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001511 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001512 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001513 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001514 if( pOldExpr
1515 && pOldExpr->op==TK_SELECT_COLUMN
1516 && (pNewExpr = pItem->pExpr)!=0
1517 ){
1518 assert( pNewExpr->iColumn==0 || i>0 );
1519 if( pNewExpr->iColumn==0 ){
1520 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001521 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1522 }else{
1523 assert( i>0 );
1524 assert( pItem[-1].pExpr!=0 );
1525 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1526 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1527 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001528 }
1529 }
drh41cee662019-12-12 20:22:34 +00001530 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001531 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001532 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001533 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001534 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001535 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001536 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001537 }
1538 return pNew;
1539}
danielk197793758c82005-01-21 08:13:14 +00001540
1541/*
1542** If cursors, triggers, views and subqueries are all omitted from
1543** the build, then none of the following routines, except for
1544** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1545** called with a NULL argument.
1546*/
danielk19776a67fe82005-02-04 04:07:16 +00001547#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1548 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001549SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001550 SrcList *pNew;
1551 int i;
drh113088e2003-03-20 01:16:58 +00001552 int nByte;
drh575fad62016-02-05 13:38:36 +00001553 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001554 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001555 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001556 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001557 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001558 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001559 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001560 SrcItem *pNewItem = &pNew->a[i];
1561 SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001562 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001563 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001564 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1565 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1566 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001567 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001568 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001569 pNewItem->addrFillSub = pOldItem->addrFillSub;
1570 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001571 if( pNewItem->fg.isIndexedBy ){
1572 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1573 }
drha79e2a22021-02-21 23:44:14 +00001574 pNewItem->u2 = pOldItem->u2;
1575 if( pNewItem->fg.isCte ){
1576 pNewItem->u2.pCteUse->nUse++;
1577 }
drh8a48b9c2015-08-19 15:20:00 +00001578 if( pNewItem->fg.isTabFunc ){
1579 pNewItem->u1.pFuncArg =
1580 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1581 }
drhed8a3bb2005-06-06 21:19:56 +00001582 pTab = pNewItem->pTab = pOldItem->pTab;
1583 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001584 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001585 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001586 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1587 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001588 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001589 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001590 }
1591 return pNew;
1592}
drh17435752007-08-16 04:30:38 +00001593IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001594 IdList *pNew;
1595 int i;
drh575fad62016-02-05 13:38:36 +00001596 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001597 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001598 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001599 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001600 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001601 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001602 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001603 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001604 return 0;
1605 }
drh6c535152012-02-02 03:38:30 +00001606 /* Note that because the size of the allocation for p->a[] is not
1607 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1608 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001609 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001610 struct IdList_item *pNewItem = &pNew->a[i];
1611 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001612 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001613 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001614 }
1615 return pNew;
1616}
dana7466202017-02-03 14:44:52 +00001617Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1618 Select *pRet = 0;
1619 Select *pNext = 0;
1620 Select **pp = &pRet;
1621 Select *p;
1622
drh575fad62016-02-05 13:38:36 +00001623 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001624 for(p=pDup; p; p=p->pPrior){
1625 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1626 if( pNew==0 ) break;
1627 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1628 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1629 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1630 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1631 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1632 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1633 pNew->op = p->op;
1634 pNew->pNext = pNext;
1635 pNew->pPrior = 0;
1636 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001637 pNew->iLimit = 0;
1638 pNew->iOffset = 0;
1639 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1640 pNew->addrOpenEphm[0] = -1;
1641 pNew->addrOpenEphm[1] = -1;
1642 pNew->nSelectRow = p->nSelectRow;
1643 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001644#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001645 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001646 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001647 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001648#endif
drhfef37762018-07-10 19:48:35 +00001649 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001650 *pp = pNew;
1651 pp = &pNew->pPrior;
1652 pNext = pNew;
1653 }
1654
1655 return pRet;
drhff78bd22002-02-27 01:47:11 +00001656}
danielk197793758c82005-01-21 08:13:14 +00001657#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001658Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001659 assert( p==0 );
1660 return 0;
1661}
1662#endif
drhff78bd22002-02-27 01:47:11 +00001663
1664
1665/*
drha76b5df2002-02-23 02:32:10 +00001666** Add a new element to the end of an expression list. If pList is
1667** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001668**
drha19543f2017-09-15 15:17:48 +00001669** The pList argument must be either NULL or a pointer to an ExprList
1670** obtained from a prior call to sqlite3ExprListAppend(). This routine
1671** may not be used with an ExprList obtained from sqlite3ExprListDup().
1672** Reason: This routine assumes that the number of slots in pList->a[]
1673** is a power of two. That is true for sqlite3ExprListAppend() returns
1674** but is not necessarily true from the return value of sqlite3ExprListDup().
1675**
drhb7916a72009-05-27 10:31:29 +00001676** If a memory allocation error occurs, the entire list is freed and
1677** NULL is returned. If non-NULL is returned, then it is guaranteed
1678** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001679*/
drh50e43c52021-03-23 14:27:35 +00001680static const struct ExprList_item zeroItem;
1681SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1682 sqlite3 *db, /* Database handle. Used for memory allocation */
1683 Expr *pExpr /* Expression to be appended. Might be NULL */
1684){
1685 struct ExprList_item *pItem;
1686 ExprList *pList;
1687
1688 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1689 if( pList==0 ){
1690 sqlite3ExprDelete(db, pExpr);
1691 return 0;
1692 }
1693 pList->nAlloc = 4;
1694 pList->nExpr = 1;
1695 pItem = &pList->a[0];
1696 *pItem = zeroItem;
1697 pItem->pExpr = pExpr;
1698 return pList;
1699}
1700SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1701 sqlite3 *db, /* Database handle. Used for memory allocation */
1702 ExprList *pList, /* List to which to append. Might be NULL */
1703 Expr *pExpr /* Expression to be appended. Might be NULL */
1704){
1705 struct ExprList_item *pItem;
1706 ExprList *pNew;
1707 pList->nAlloc *= 2;
1708 pNew = sqlite3DbRealloc(db, pList,
1709 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1710 if( pNew==0 ){
1711 sqlite3ExprListDelete(db, pList);
1712 sqlite3ExprDelete(db, pExpr);
1713 return 0;
1714 }else{
1715 pList = pNew;
1716 }
1717 pItem = &pList->a[pList->nExpr++];
1718 *pItem = zeroItem;
1719 pItem->pExpr = pExpr;
1720 return pList;
1721}
drh17435752007-08-16 04:30:38 +00001722ExprList *sqlite3ExprListAppend(
1723 Parse *pParse, /* Parsing context */
1724 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001725 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001726){
drh43606172017-04-05 11:32:13 +00001727 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001728 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001729 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1730 }
1731 if( pList->nAlloc<pList->nExpr+1 ){
1732 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001733 }
drh43606172017-04-05 11:32:13 +00001734 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001735 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001736 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001737 return pList;
1738}
1739
1740/*
drh8762ec12016-08-20 01:06:22 +00001741** pColumns and pExpr form a vector assignment which is part of the SET
1742** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001743**
1744** (a,b,c) = (expr1,expr2,expr3)
1745** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1746**
1747** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001748** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001749** TK_SELECT_COLUMN expressions.
1750*/
1751ExprList *sqlite3ExprListAppendVector(
1752 Parse *pParse, /* Parsing context */
1753 ExprList *pList, /* List to which to append. Might be NULL */
1754 IdList *pColumns, /* List of names of LHS of the assignment */
1755 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1756){
1757 sqlite3 *db = pParse->db;
1758 int n;
1759 int i;
drh66860af2016-08-23 18:30:10 +00001760 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001761 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1762 ** exit prior to this routine being invoked */
1763 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001764 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001765
1766 /* If the RHS is a vector, then we can immediately check to see that
1767 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1768 ** wildcards ("*") in the result set of the SELECT must be expanded before
1769 ** we can do the size check, so defer the size check until code generation.
1770 */
1771 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001772 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1773 pColumns->nId, n);
1774 goto vector_append_error;
1775 }
drh966e2912017-01-03 02:58:01 +00001776
1777 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001778 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001779 assert( pSubExpr!=0 || db->mallocFailed );
1780 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1781 if( pSubExpr==0 ) continue;
1782 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001783 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1784 if( pList ){
drh66860af2016-08-23 18:30:10 +00001785 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001786 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001787 pColumns->a[i].zName = 0;
1788 }
1789 }
drh966e2912017-01-03 02:58:01 +00001790
drhffe28052017-05-06 18:09:36 +00001791 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001792 Expr *pFirst = pList->a[iFirst].pExpr;
1793 assert( pFirst!=0 );
1794 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001795
drhf4dd26c2017-04-05 11:49:06 +00001796 /* Store the SELECT statement in pRight so it will be deleted when
1797 ** sqlite3ExprListDelete() is called */
1798 pFirst->pRight = pExpr;
1799 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001800
drhf4dd26c2017-04-05 11:49:06 +00001801 /* Remember the size of the LHS in iTable so that we can check that
1802 ** the RHS and LHS sizes match during code generation. */
1803 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001804 }
1805
1806vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001807 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001808 sqlite3IdListDelete(db, pColumns);
1809 return pList;
1810}
1811
1812/*
drhbc622bc2015-08-24 15:39:42 +00001813** Set the sort order for the last element on the given ExprList.
1814*/
dan6e118922019-08-12 16:36:38 +00001815void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001816 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001817 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001818 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001819
1820 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1821 assert( iSortOrder==SQLITE_SO_UNDEFINED
1822 || iSortOrder==SQLITE_SO_ASC
1823 || iSortOrder==SQLITE_SO_DESC
1824 );
1825 assert( eNulls==SQLITE_SO_UNDEFINED
1826 || eNulls==SQLITE_SO_ASC
1827 || eNulls==SQLITE_SO_DESC
1828 );
1829
dan9105fd52019-08-19 17:26:32 +00001830 pItem = &p->a[p->nExpr-1];
1831 assert( pItem->bNulls==0 );
1832 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1833 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001834 }
dan9105fd52019-08-19 17:26:32 +00001835 pItem->sortFlags = (u8)iSortOrder;
1836
1837 if( eNulls!=SQLITE_SO_UNDEFINED ){
1838 pItem->bNulls = 1;
1839 if( iSortOrder!=eNulls ){
1840 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1841 }
drhbc622bc2015-08-24 15:39:42 +00001842 }
drhbc622bc2015-08-24 15:39:42 +00001843}
1844
1845/*
drh41cee662019-12-12 20:22:34 +00001846** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001847** on the expression list.
1848**
1849** pList might be NULL following an OOM error. But pName should never be
1850** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1851** is set.
1852*/
1853void sqlite3ExprListSetName(
1854 Parse *pParse, /* Parsing context */
1855 ExprList *pList, /* List to which to add the span. */
1856 Token *pName, /* Name to be added */
1857 int dequote /* True to cause the name to be dequoted */
1858){
1859 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001860 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001861 if( pList ){
1862 struct ExprList_item *pItem;
1863 assert( pList->nExpr>0 );
1864 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001865 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001866 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001867 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001868 if( dequote ){
1869 /* If dequote==0, then pName->z does not point to part of a DDL
1870 ** statement handled by the parser. And so no token need be added
1871 ** to the token-map. */
1872 sqlite3Dequote(pItem->zEName);
1873 if( IN_RENAME_OBJECT ){
1874 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1875 }
dan5be60c52018-08-15 20:28:39 +00001876 }
drhb7916a72009-05-27 10:31:29 +00001877 }
1878}
1879
1880/*
1881** Set the ExprList.a[].zSpan element of the most recently added item
1882** on the expression list.
1883**
1884** pList might be NULL following an OOM error. But pSpan should never be
1885** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1886** is set.
1887*/
1888void sqlite3ExprListSetSpan(
1889 Parse *pParse, /* Parsing context */
1890 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001891 const char *zStart, /* Start of the span */
1892 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001893){
1894 sqlite3 *db = pParse->db;
1895 assert( pList!=0 || db->mallocFailed!=0 );
1896 if( pList ){
1897 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1898 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001899 if( pItem->zEName==0 ){
1900 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1901 pItem->eEName = ENAME_SPAN;
1902 }
drhb7916a72009-05-27 10:31:29 +00001903 }
1904}
1905
1906/*
danielk19777a15a4b2007-05-08 17:54:43 +00001907** If the expression list pEList contains more than iLimit elements,
1908** leave an error message in pParse.
1909*/
1910void sqlite3ExprListCheckLength(
1911 Parse *pParse,
1912 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001913 const char *zObject
1914){
drhb1a6c3c2008-03-20 16:30:17 +00001915 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001916 testcase( pEList && pEList->nExpr==mx );
1917 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001918 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001919 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1920 }
1921}
1922
1923/*
drha76b5df2002-02-23 02:32:10 +00001924** Delete an entire expression list.
1925*/
drhaffa8552016-04-11 18:25:05 +00001926static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001927 int i = pList->nExpr;
1928 struct ExprList_item *pItem = pList->a;
1929 assert( pList->nExpr>0 );
1930 do{
drh633e6d52008-07-28 19:34:53 +00001931 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001932 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001933 pItem++;
1934 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001935 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001936}
drhaffa8552016-04-11 18:25:05 +00001937void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1938 if( pList ) exprListDeleteNN(db, pList);
1939}
drha76b5df2002-02-23 02:32:10 +00001940
1941/*
drh2308ed32015-02-09 16:09:34 +00001942** Return the bitwise-OR of all Expr.flags fields in the given
1943** ExprList.
drh885a5b02015-02-09 15:21:36 +00001944*/
drh2308ed32015-02-09 16:09:34 +00001945u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001946 int i;
drh2308ed32015-02-09 16:09:34 +00001947 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001948 assert( pList!=0 );
1949 for(i=0; i<pList->nExpr; i++){
1950 Expr *pExpr = pList->a[i].pExpr;
1951 assert( pExpr!=0 );
1952 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001953 }
drh2308ed32015-02-09 16:09:34 +00001954 return m;
drh885a5b02015-02-09 15:21:36 +00001955}
1956
1957/*
drh7e6f9802017-09-04 00:33:04 +00001958** This is a SELECT-node callback for the expression walker that
1959** always "fails". By "fail" in this case, we mean set
1960** pWalker->eCode to zero and abort.
1961**
1962** This callback is used by multiple expression walkers.
1963*/
1964int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1965 UNUSED_PARAMETER(NotUsed);
1966 pWalker->eCode = 0;
1967 return WRC_Abort;
1968}
1969
1970/*
drh0cbec592020-01-03 02:20:37 +00001971** Check the input string to see if it is "true" or "false" (in any case).
1972**
1973** If the string is.... Return
1974** "true" EP_IsTrue
1975** "false" EP_IsFalse
1976** anything else 0
1977*/
1978u32 sqlite3IsTrueOrFalse(const char *zIn){
1979 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1980 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1981 return 0;
1982}
1983
1984
1985/*
drh171d16b2018-02-26 20:15:54 +00001986** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001987** then convert it into an TK_TRUEFALSE term. Return non-zero if
1988** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001989*/
1990int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001991 u32 v;
drh171d16b2018-02-26 20:15:54 +00001992 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001993 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001994 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001995 ){
1996 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001997 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001998 return 1;
1999 }
2000 return 0;
2001}
2002
drh43c4ac82018-02-26 21:26:27 +00002003/*
drh96acafb2018-02-27 14:49:25 +00002004** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002005** and 0 if it is FALSE.
2006*/
drh96acafb2018-02-27 14:49:25 +00002007int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002008 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002009 assert( pExpr->op==TK_TRUEFALSE );
2010 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2011 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2012 return pExpr->u.zToken[4]==0;
2013}
2014
drh17180fc2019-04-19 17:26:19 +00002015/*
2016** If pExpr is an AND or OR expression, try to simplify it by eliminating
2017** terms that are always true or false. Return the simplified expression.
2018** Or return the original expression if no simplification is possible.
2019**
2020** Examples:
2021**
2022** (x<10) AND true => (x<10)
2023** (x<10) AND false => false
2024** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2025** (x<10) AND (y=22 OR true) => (x<10)
2026** (y=22) OR true => true
2027*/
2028Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2029 assert( pExpr!=0 );
2030 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2031 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2032 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2033 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2034 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2035 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2036 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2037 }
2038 }
2039 return pExpr;
2040}
2041
drh171d16b2018-02-26 20:15:54 +00002042
2043/*
drh059b2d52014-10-24 19:28:09 +00002044** These routines are Walker callbacks used to check expressions to
2045** see if they are "constant" for some definition of constant. The
2046** Walker.eCode value determines the type of "constant" we are looking
2047** for.
drh73b211a2005-01-18 04:00:42 +00002048**
drh7d10d5a2008-08-20 16:35:10 +00002049** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002050**
drh059b2d52014-10-24 19:28:09 +00002051** sqlite3ExprIsConstant() pWalker->eCode==1
2052** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002053** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002054** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002055**
drh059b2d52014-10-24 19:28:09 +00002056** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2057** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002058**
drh014fff22020-01-08 22:22:36 +00002059** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2060** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002061** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002062** when processing a new CREATE TABLE statement. A bound parameter raises
2063** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002064** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002065** contain a bound parameter because they were generated by older versions
2066** of SQLite to be parsed by newer versions of SQLite without raising a
2067** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002068*/
drh7d10d5a2008-08-20 16:35:10 +00002069static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002070
drh059b2d52014-10-24 19:28:09 +00002071 /* If pWalker->eCode is 2 then any term of the expression that comes from
2072 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002073 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002074 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2075 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002076 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002077 }
2078
drh626a8792005-01-17 22:08:19 +00002079 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002080 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002081 ** and either pWalker->eCode==4 or 5 or the function has the
2082 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002083 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002084 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2085 && !ExprHasProperty(pExpr, EP_WinFunc)
2086 ){
drh014fff22020-01-08 22:22:36 +00002087 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002088 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002089 }else{
2090 pWalker->eCode = 0;
2091 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002092 }
drh626a8792005-01-17 22:08:19 +00002093 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002094 /* Convert "true" or "false" in a DEFAULT clause into the
2095 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002096 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002097 return WRC_Prune;
2098 }
drh08b92082020-08-10 14:18:00 +00002099 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002100 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002101 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002102 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002103 testcase( pExpr->op==TK_ID );
2104 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002105 testcase( pExpr->op==TK_AGG_FUNCTION );
2106 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002107 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002108 return WRC_Continue;
2109 }
drh059b2d52014-10-24 19:28:09 +00002110 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2111 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002112 }
drh08b92082020-08-10 14:18:00 +00002113 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002114 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002115 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002116 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002117 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002118 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002119 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002120 pWalker->eCode = 0;
2121 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002122 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002123 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002124 /* Silently convert bound parameters that appear inside of CREATE
2125 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002126 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002127 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002128 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002129 /* A bound parameter in a CREATE statement that originates from
2130 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002131 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002132 return WRC_Abort;
2133 }
drh08b92082020-08-10 14:18:00 +00002134 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002135 default:
drh6e341b92018-04-17 18:50:40 +00002136 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2137 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002138 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002139 }
2140}
drh059b2d52014-10-24 19:28:09 +00002141static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002142 Walker w;
drh059b2d52014-10-24 19:28:09 +00002143 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002144 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002145 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002146#ifdef SQLITE_DEBUG
2147 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2148#endif
drh059b2d52014-10-24 19:28:09 +00002149 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002150 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002151 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002152}
drh626a8792005-01-17 22:08:19 +00002153
2154/*
drh059b2d52014-10-24 19:28:09 +00002155** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002156** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002157**
2158** For the purposes of this function, a double-quoted string (ex: "abc")
2159** is considered a variable but a single-quoted string (ex: 'abc') is
2160** a constant.
drhfef52082000-06-06 01:50:43 +00002161*/
danielk19774adee202004-05-08 08:23:19 +00002162int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002163 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002164}
2165
2166/*
drh07aded62018-07-28 16:24:08 +00002167** Walk an expression tree. Return non-zero if
2168**
2169** (1) the expression is constant, and
2170** (2) the expression does originate in the ON or USING clause
2171** of a LEFT JOIN, and
2172** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2173** operands created by the constant propagation optimization.
2174**
2175** When this routine returns true, it indicates that the expression
2176** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002177** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002178*/
2179int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002180 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002181}
2182
2183/*
drhfcb9f4f2015-06-01 18:13:16 +00002184** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002185** for any single row of the table with cursor iCur. In other words, the
2186** expression must not refer to any non-deterministic function nor any
2187** table other than iCur.
2188*/
2189int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2190 return exprIsConst(p, 3, iCur);
2191}
2192
danab31a842017-04-29 20:53:09 +00002193
2194/*
2195** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2196*/
2197static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2198 ExprList *pGroupBy = pWalker->u.pGroupBy;
2199 int i;
2200
2201 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2202 ** it constant. */
2203 for(i=0; i<pGroupBy->nExpr; i++){
2204 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002205 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002206 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002207 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002208 return WRC_Prune;
2209 }
2210 }
2211 }
2212
2213 /* Check if pExpr is a sub-select. If so, consider it variable. */
2214 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2215 pWalker->eCode = 0;
2216 return WRC_Abort;
2217 }
2218
2219 return exprNodeIsConstant(pWalker, pExpr);
2220}
2221
2222/*
2223** Walk the expression tree passed as the first argument. Return non-zero
2224** if the expression consists entirely of constants or copies of terms
2225** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002226**
2227** This routine is used to determine if a term of the HAVING clause can
2228** be promoted into the WHERE clause. In order for such a promotion to work,
2229** the value of the HAVING clause term must be the same for all members of
2230** a "group". The requirement that the GROUP BY term must be BINARY
2231** assumes that no other collating sequence will have a finer-grained
2232** grouping than binary. In other words (A=B COLLATE binary) implies
2233** A=B in every other collating sequence. The requirement that the
2234** GROUP BY be BINARY is stricter than necessary. It would also work
2235** to promote HAVING clauses that use the same alternative collating
2236** sequence as the GROUP BY term, but that is much harder to check,
2237** alternative collating sequences are uncommon, and this is only an
2238** optimization, so we take the easy way out and simply require the
2239** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002240*/
2241int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2242 Walker w;
danab31a842017-04-29 20:53:09 +00002243 w.eCode = 1;
2244 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002245 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002246 w.u.pGroupBy = pGroupBy;
2247 w.pParse = pParse;
2248 sqlite3WalkExpr(&w, p);
2249 return w.eCode;
2250}
2251
drh059b2d52014-10-24 19:28:09 +00002252/*
drh014fff22020-01-08 22:22:36 +00002253** Walk an expression tree for the DEFAULT field of a column definition
2254** in a CREATE TABLE statement. Return non-zero if the expression is
2255** acceptable for use as a DEFAULT. That is to say, return non-zero if
2256** the expression is constant or a function call with constant arguments.
2257** Return and 0 if there are any variables.
2258**
drh1e32bed2020-06-19 13:33:53 +00002259** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002260** processing a new CREATE TABLE statement. When isInit is true, parameters
2261** (such as ? or $abc) in the expression are converted into NULL. When
2262** isInit is false, parameters raise an error. Parameters should not be
2263** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002264** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002265** backwards compatibility.
2266**
2267** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002268**
2269** For the purposes of this function, a double-quoted string (ex: "abc")
2270** is considered a variable but a single-quoted string (ex: 'abc') is
2271** a constant.
2272*/
drhfeada2d2014-09-24 13:20:22 +00002273int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2274 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002275 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002276}
2277
drh5b88bc42013-12-07 23:35:21 +00002278#ifdef SQLITE_ENABLE_CURSOR_HINTS
2279/*
2280** Walk an expression tree. Return 1 if the expression contains a
2281** subquery of some kind. Return 0 if there are no subqueries.
2282*/
2283int sqlite3ExprContainsSubquery(Expr *p){
2284 Walker w;
drhbec24762015-08-13 20:07:13 +00002285 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002286 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002287 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002288#ifdef SQLITE_DEBUG
2289 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2290#endif
drh5b88bc42013-12-07 23:35:21 +00002291 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002292 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002293}
2294#endif
2295
drheb55bd22005-06-30 17:04:21 +00002296/*
drh73b211a2005-01-18 04:00:42 +00002297** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002298** to fit in a 32-bit integer, return 1 and put the value of the integer
2299** in *pValue. If the expression is not an integer or if it is too big
2300** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002301*/
danielk19774adee202004-05-08 08:23:19 +00002302int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002303 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002304 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002305
2306 /* If an expression is an integer literal that fits in a signed 32-bit
2307 ** integer, then the EP_IntValue flag will have already been set */
2308 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2309 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2310
drh92b01d52008-06-24 00:32:35 +00002311 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002312 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002313 return 1;
2314 }
drhe4de1fe2002-06-02 16:09:01 +00002315 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002316 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002317 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002318 break;
drh4b59ab52002-08-24 18:24:51 +00002319 }
drhe4de1fe2002-06-02 16:09:01 +00002320 case TK_UMINUS: {
2321 int v;
danielk19774adee202004-05-08 08:23:19 +00002322 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002323 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002324 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002325 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002326 }
2327 break;
2328 }
2329 default: break;
2330 }
drh92b01d52008-06-24 00:32:35 +00002331 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002332}
2333
2334/*
drh039fc322009-11-17 18:31:47 +00002335** Return FALSE if there is no chance that the expression can be NULL.
2336**
2337** If the expression might be NULL or if the expression is too complex
2338** to tell return TRUE.
2339**
2340** This routine is used as an optimization, to skip OP_IsNull opcodes
2341** when we know that a value cannot be NULL. Hence, a false positive
2342** (returning TRUE when in fact the expression can never be NULL) might
2343** be a small performance hit but is otherwise harmless. On the other
2344** hand, a false negative (returning FALSE when the result could be NULL)
2345** will likely result in an incorrect answer. So when in doubt, return
2346** TRUE.
2347*/
2348int sqlite3ExprCanBeNull(const Expr *p){
2349 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002350 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2351 p = p->pLeft;
2352 }
drh039fc322009-11-17 18:31:47 +00002353 op = p->op;
2354 if( op==TK_REGISTER ) op = p->op2;
2355 switch( op ){
2356 case TK_INTEGER:
2357 case TK_STRING:
2358 case TK_FLOAT:
2359 case TK_BLOB:
2360 return 0;
drh7248a8b2014-08-04 18:50:54 +00002361 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002362 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002363 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002364 (p->iColumn>=0
2365 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2366 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002367 default:
2368 return 1;
2369 }
2370}
2371
2372/*
2373** Return TRUE if the given expression is a constant which would be
2374** unchanged by OP_Affinity with the affinity given in the second
2375** argument.
2376**
2377** This routine is used to determine if the OP_Affinity operation
2378** can be omitted. When in doubt return FALSE. A false negative
2379** is harmless. A false positive, however, can result in the wrong
2380** answer.
2381*/
2382int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2383 u8 op;
drhaf866402019-08-22 11:11:28 +00002384 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002385 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002386 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2387 if( p->op==TK_UMINUS ) unaryMinus = 1;
2388 p = p->pLeft;
2389 }
drh039fc322009-11-17 18:31:47 +00002390 op = p->op;
2391 if( op==TK_REGISTER ) op = p->op2;
2392 switch( op ){
2393 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002394 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002395 }
2396 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002397 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002398 }
2399 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002400 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002401 }
2402 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002403 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002404 }
drh2f2855b2009-11-18 01:25:26 +00002405 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002406 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002407 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002408 }
drh039fc322009-11-17 18:31:47 +00002409 default: {
2410 return 0;
2411 }
2412 }
2413}
2414
2415/*
drhc4a3c772001-04-04 11:48:57 +00002416** Return TRUE if the given string is a row-id column name.
2417*/
danielk19774adee202004-05-08 08:23:19 +00002418int sqlite3IsRowid(const char *z){
2419 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2420 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2421 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002422 return 0;
2423}
2424
danielk19779a96b662007-11-29 17:05:18 +00002425/*
drh69c355b2016-03-09 15:34:51 +00002426** pX is the RHS of an IN operator. If pX is a SELECT statement
2427** that can be simplified to a direct table access, then return
2428** a pointer to the SELECT statement. If pX is not a SELECT statement,
2429** or if the SELECT statement needs to be manifested into a transient
2430** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002431*/
2432#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002433static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002434 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002435 SrcList *pSrc;
2436 ExprList *pEList;
2437 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002438 int i;
drh69c355b2016-03-09 15:34:51 +00002439 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2440 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2441 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002442 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002443 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002444 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2445 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2446 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002447 }
drh2e26a602020-01-06 18:59:46 +00002448 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002449 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002450 if( p->pWhere ) return 0; /* Has no WHERE clause */
2451 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002452 assert( pSrc!=0 );
2453 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002454 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002455 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002456 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002457 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002458 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2459 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002460 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002461 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002462 for(i=0; i<pEList->nExpr; i++){
2463 Expr *pRes = pEList->a[i].pExpr;
2464 if( pRes->op!=TK_COLUMN ) return 0;
2465 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002466 }
drh69c355b2016-03-09 15:34:51 +00002467 return p;
drhb287f4b2008-04-25 00:08:38 +00002468}
2469#endif /* SQLITE_OMIT_SUBQUERY */
2470
danf9b2e052016-08-02 17:45:00 +00002471#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002472/*
drh4c259e92014-08-01 21:12:35 +00002473** Generate code that checks the left-most column of index table iCur to see if
2474** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002475** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2476** to be set to NULL if iCur contains one or more NULL values.
2477*/
2478static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002479 int addr1;
drh6be515e2014-08-01 21:00:53 +00002480 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002481 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002482 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2483 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002484 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002485 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002486}
danf9b2e052016-08-02 17:45:00 +00002487#endif
drh6be515e2014-08-01 21:00:53 +00002488
drhbb53ecb2014-08-02 21:03:33 +00002489
2490#ifndef SQLITE_OMIT_SUBQUERY
2491/*
2492** The argument is an IN operator with a list (not a subquery) on the
2493** right-hand side. Return TRUE if that list is constant.
2494*/
2495static int sqlite3InRhsIsConstant(Expr *pIn){
2496 Expr *pLHS;
2497 int res;
2498 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2499 pLHS = pIn->pLeft;
2500 pIn->pLeft = 0;
2501 res = sqlite3ExprIsConstant(pIn);
2502 pIn->pLeft = pLHS;
2503 return res;
2504}
2505#endif
2506
drh6be515e2014-08-01 21:00:53 +00002507/*
danielk19779a96b662007-11-29 17:05:18 +00002508** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002509** The pX parameter is the expression on the RHS of the IN operator, which
2510** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002511**
drhd4305ca2012-09-18 17:08:33 +00002512** The job of this routine is to find or create a b-tree object that can
2513** be used either to test for membership in the RHS set or to iterate through
2514** all members of the RHS set, skipping duplicates.
2515**
drh3a856252014-08-01 14:46:57 +00002516** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002517** and pX->iTable is set to the index of that cursor.
2518**
drhb74b1012009-05-28 21:04:37 +00002519** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002520**
drh1ccce442013-03-12 20:38:51 +00002521** IN_INDEX_ROWID - The cursor was opened on a database table.
2522** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2523** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2524** IN_INDEX_EPH - The cursor was opened on a specially created and
2525** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002526** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2527** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002528**
drhd4305ca2012-09-18 17:08:33 +00002529** An existing b-tree might be used if the RHS expression pX is a simple
2530** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002531**
dan553168c2016-08-01 20:14:31 +00002532** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002533**
drhd4305ca2012-09-18 17:08:33 +00002534** If the RHS of the IN operator is a list or a more complex subquery, then
2535** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002536** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002537** existing table.
drhd4305ca2012-09-18 17:08:33 +00002538**
drh7fc0ba02017-11-17 15:02:00 +00002539** The inFlags parameter must contain, at a minimum, one of the bits
2540** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2541** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2542** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2543** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002544**
2545** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2546** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002547** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002548** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2549** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002550**
drh3a856252014-08-01 14:46:57 +00002551** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2552** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002553** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2554** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002555**
drhbb53ecb2014-08-02 21:03:33 +00002556** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2557** if the RHS of the IN operator is a list (not a subquery) then this
2558** routine might decide that creating an ephemeral b-tree for membership
2559** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2560** calling routine should implement the IN operator using a sequence
2561** of Eq or Ne comparison operations.
2562**
drhb74b1012009-05-28 21:04:37 +00002563** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002564** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002565** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002566** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002567** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002568** to *prRhsHasNull. If there is no chance that the (...) contains a
2569** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002570**
drhe21a6e12014-08-01 18:00:24 +00002571** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002572** the value in that register will be NULL if the b-tree contains one or more
2573** NULL values, and it will be some non-NULL value if the b-tree contains no
2574** NULL values.
dan553168c2016-08-01 20:14:31 +00002575**
2576** If the aiMap parameter is not NULL, it must point to an array containing
2577** one element for each column returned by the SELECT statement on the RHS
2578** of the IN(...) operator. The i'th entry of the array is populated with the
2579** offset of the index column that matches the i'th column returned by the
2580** SELECT. For example, if the expression and selected index are:
2581**
2582** (?,?,?) IN (SELECT a, b, c FROM t1)
2583** CREATE INDEX i1 ON t1(b, c, a);
2584**
2585** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002586*/
danielk1977284f4ac2007-12-10 05:03:46 +00002587#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002588int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002589 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002590 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002591 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2592 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002593 int *aiMap, /* Mapping from Index fields to RHS fields */
2594 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002595){
drhb74b1012009-05-28 21:04:37 +00002596 Select *p; /* SELECT to the right of IN operator */
2597 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2598 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002599 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002600 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002601
drh1450bc62009-10-30 13:25:56 +00002602 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002603 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002604
dan7b35a772016-07-28 19:47:15 +00002605 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2606 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002607 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002608 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002609 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002610 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2611 int i;
2612 ExprList *pEList = pX->x.pSelect->pEList;
2613 for(i=0; i<pEList->nExpr; i++){
2614 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2615 }
2616 if( i==pEList->nExpr ){
2617 prRhsHasNull = 0;
2618 }
2619 }
2620
drhb74b1012009-05-28 21:04:37 +00002621 /* Check to see if an existing table or index can be used to
2622 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002623 ** ephemeral table. */
2624 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002625 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002626 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002627 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002628 ExprList *pEList = p->pEList;
2629 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002630
drhb07028f2011-10-14 21:49:18 +00002631 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2632 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2633 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2634 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002635
drhb22f7c82014-02-06 23:56:27 +00002636 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002637 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002638 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002639 sqlite3CodeVerifySchema(pParse, iDb);
2640 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002641
drha84a2832016-08-26 21:15:35 +00002642 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002643 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002644 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002645 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002646 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002647
2648 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2649 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002650 ExplainQueryPlan((pParse, 0,
2651 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002652 sqlite3VdbeJumpHere(v, iAddr);
2653 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002654 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002655 int affinity_ok = 1;
2656 int i;
2657
2658 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002659 ** comparison is the same as the affinity of each column in table
2660 ** on the RHS of the IN operator. If it not, it is not possible to
2661 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002662 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002663 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002664 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002665 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002666 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002667 testcase( cmpaff==SQLITE_AFF_BLOB );
2668 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002669 switch( cmpaff ){
2670 case SQLITE_AFF_BLOB:
2671 break;
2672 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002673 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2674 ** other has no affinity and the other side is TEXT. Hence,
2675 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2676 ** and for the term on the LHS of the IN to have no affinity. */
2677 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002678 break;
2679 default:
2680 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2681 }
2682 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002683
drha84a2832016-08-26 21:15:35 +00002684 if( affinity_ok ){
2685 /* Search for an existing index that will work for this IN operator */
2686 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2687 Bitmask colUsed; /* Columns of the index used */
2688 Bitmask mCol; /* Mask for the current column */
2689 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002690 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002691 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2692 ** BITMASK(nExpr) without overflowing */
2693 testcase( pIdx->nColumn==BMS-2 );
2694 testcase( pIdx->nColumn==BMS-1 );
2695 if( pIdx->nColumn>=BMS-1 ) continue;
2696 if( mustBeUnique ){
2697 if( pIdx->nKeyCol>nExpr
2698 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2699 ){
2700 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002701 }
danielk19770cdc0222008-06-26 18:04:03 +00002702 }
drha84a2832016-08-26 21:15:35 +00002703
2704 colUsed = 0; /* Columns of index used so far */
2705 for(i=0; i<nExpr; i++){
2706 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2707 Expr *pRhs = pEList->a[i].pExpr;
2708 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2709 int j;
2710
2711 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2712 for(j=0; j<nExpr; j++){
2713 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2714 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002715 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2716 continue;
2717 }
drha84a2832016-08-26 21:15:35 +00002718 break;
2719 }
2720 if( j==nExpr ) break;
2721 mCol = MASKBIT(j);
2722 if( mCol & colUsed ) break; /* Each column used only once */
2723 colUsed |= mCol;
2724 if( aiMap ) aiMap[i] = j;
2725 }
2726
2727 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2728 if( colUsed==(MASKBIT(nExpr)-1) ){
2729 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002730 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002731 ExplainQueryPlan((pParse, 0,
2732 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002733 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2734 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2735 VdbeComment((v, "%s", pIdx->zName));
2736 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2737 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2738
2739 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002740#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002741 i64 mask = (1<<nExpr)-1;
2742 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2743 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002744#endif
2745 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002746 if( nExpr==1 ){
2747 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2748 }
2749 }
2750 sqlite3VdbeJumpHere(v, iAddr);
2751 }
2752 } /* End loop over indexes */
2753 } /* End if( affinity_ok ) */
2754 } /* End if not an rowid index */
2755 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002756
drhbb53ecb2014-08-02 21:03:33 +00002757 /* If no preexisting index is available for the IN clause
2758 ** and IN_INDEX_NOOP is an allowed reply
2759 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002760 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002761 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002762 ** the IN operator so return IN_INDEX_NOOP.
2763 */
2764 if( eType==0
2765 && (inFlags & IN_INDEX_NOOP_OK)
2766 && !ExprHasProperty(pX, EP_xIsSelect)
2767 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2768 ){
2769 eType = IN_INDEX_NOOP;
2770 }
drhbb53ecb2014-08-02 21:03:33 +00002771
danielk19779a96b662007-11-29 17:05:18 +00002772 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002773 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002774 ** We will have to generate an ephemeral table to do the job.
2775 */
drh8e23daf2013-06-11 13:30:04 +00002776 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002777 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002778 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002779 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002780 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002781 }else if( prRhsHasNull ){
2782 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002783 }
drh85bcdce2018-12-23 21:27:29 +00002784 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002785 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002786 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002787 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002788 }
drhcf4d38a2010-07-28 02:53:36 +00002789 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002790 }
danba00e302016-07-23 20:24:06 +00002791
2792 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2793 int i, n;
2794 n = sqlite3ExprVectorSize(pX->pLeft);
2795 for(i=0; i<n; i++) aiMap[i] = i;
2796 }
drh2c041312018-12-24 02:34:49 +00002797 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002798 return eType;
2799}
danielk1977284f4ac2007-12-10 05:03:46 +00002800#endif
drh626a8792005-01-17 22:08:19 +00002801
danf9b2e052016-08-02 17:45:00 +00002802#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002803/*
2804** Argument pExpr is an (?, ?...) IN(...) expression. This
2805** function allocates and returns a nul-terminated string containing
2806** the affinities to be used for each column of the comparison.
2807**
2808** It is the responsibility of the caller to ensure that the returned
2809** string is eventually freed using sqlite3DbFree().
2810*/
dan71c57db2016-07-09 20:23:55 +00002811static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2812 Expr *pLeft = pExpr->pLeft;
2813 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002814 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002815 char *zRet;
2816
dan553168c2016-08-01 20:14:31 +00002817 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002818 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002819 if( zRet ){
2820 int i;
2821 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002822 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002823 char a = sqlite3ExprAffinity(pA);
2824 if( pSelect ){
2825 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2826 }else{
2827 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002828 }
dan71c57db2016-07-09 20:23:55 +00002829 }
2830 zRet[nVal] = '\0';
2831 }
2832 return zRet;
2833}
danf9b2e052016-08-02 17:45:00 +00002834#endif
dan71c57db2016-07-09 20:23:55 +00002835
dan8da209b2016-07-26 18:06:08 +00002836#ifndef SQLITE_OMIT_SUBQUERY
2837/*
2838** Load the Parse object passed as the first argument with an error
2839** message of the form:
2840**
2841** "sub-select returns N columns - expected M"
2842*/
2843void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002844 if( pParse->nErr==0 ){
2845 const char *zFmt = "sub-select returns %d columns - expected %d";
2846 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2847 }
dan8da209b2016-07-26 18:06:08 +00002848}
2849#endif
2850
drh626a8792005-01-17 22:08:19 +00002851/*
dan44c56042016-12-07 15:38:37 +00002852** Expression pExpr is a vector that has been used in a context where
2853** it is not permitted. If pExpr is a sub-select vector, this routine
2854** loads the Parse object with a message of the form:
2855**
2856** "sub-select returns N columns - expected 1"
2857**
2858** Or, if it is a regular scalar vector:
2859**
2860** "row value misused"
2861*/
2862void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2863#ifndef SQLITE_OMIT_SUBQUERY
2864 if( pExpr->flags & EP_xIsSelect ){
2865 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2866 }else
2867#endif
2868 {
2869 sqlite3ErrorMsg(pParse, "row value misused");
2870 }
2871}
2872
drh85bcdce2018-12-23 21:27:29 +00002873#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002874/*
drh85bcdce2018-12-23 21:27:29 +00002875** Generate code that will construct an ephemeral table containing all terms
2876** in the RHS of an IN operator. The IN operator can be in either of two
2877** forms:
drh626a8792005-01-17 22:08:19 +00002878**
drh9cbe6352005-11-29 03:13:21 +00002879** x IN (4,5,11) -- IN operator with list on right-hand side
2880** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002881**
drh2c041312018-12-24 02:34:49 +00002882** The pExpr parameter is the IN operator. The cursor number for the
2883** constructed ephermeral table is returned. The first time the ephemeral
2884** table is computed, the cursor number is also stored in pExpr->iTable,
2885** however the cursor number returned might not be the same, as it might
2886** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002887**
drh85bcdce2018-12-23 21:27:29 +00002888** If the LHS expression ("x" in the examples) is a column value, or
2889** the SELECT statement returns a column value, then the affinity of that
2890** column is used to build the index keys. If both 'x' and the
2891** SELECT... statement are columns, then numeric affinity is used
2892** if either column has NUMERIC or INTEGER affinity. If neither
2893** 'x' nor the SELECT... statement are columns, then numeric affinity
2894** is used.
drhcce7d172000-05-31 15:34:51 +00002895*/
drh85bcdce2018-12-23 21:27:29 +00002896void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002897 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002898 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002899 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002900){
drh2c041312018-12-24 02:34:49 +00002901 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002902 int addr; /* Address of OP_OpenEphemeral instruction */
2903 Expr *pLeft; /* the LHS of the IN operator */
2904 KeyInfo *pKeyInfo = 0; /* Key information */
2905 int nVal; /* Size of vector pLeft */
2906 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002907
drh2c041312018-12-24 02:34:49 +00002908 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002909 assert( v!=0 );
2910
drh2c041312018-12-24 02:34:49 +00002911 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002912 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002913 **
2914 ** * The right-hand side is a correlated subquery
2915 ** * The right-hand side is an expression list containing variables
2916 ** * We are inside a trigger
2917 **
drh2c041312018-12-24 02:34:49 +00002918 ** If all of the above are false, then we can compute the RHS just once
2919 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002920 */
drhefb699f2018-12-24 11:55:44 +00002921 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002922 /* Reuse of the RHS is allowed */
2923 /* If this routine has already been coded, but the previous code
2924 ** might not have been invoked yet, so invoke it now as a subroutine.
2925 */
2926 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002927 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002928 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2929 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2930 pExpr->x.pSelect->selId));
2931 }
drh2c041312018-12-24 02:34:49 +00002932 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2933 pExpr->y.sub.iAddr);
2934 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002935 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002936 return;
2937 }
2938
2939 /* Begin coding the subroutine */
2940 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002941 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002942 pExpr->y.sub.regReturn = ++pParse->nMem;
2943 pExpr->y.sub.iAddr =
2944 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2945 VdbeComment((v, "return address"));
2946
2947 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002948 }
2949
drh85bcdce2018-12-23 21:27:29 +00002950 /* Check to see if this is a vector IN operator */
2951 pLeft = pExpr->pLeft;
2952 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002953
drh85bcdce2018-12-23 21:27:29 +00002954 /* Construct the ephemeral table that will contain the content of
2955 ** RHS of the IN operator.
2956 */
drh2c041312018-12-24 02:34:49 +00002957 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002958 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002959#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2960 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2961 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2962 }else{
2963 VdbeComment((v, "RHS of IN operator"));
2964 }
2965#endif
drh50ef6712019-02-22 23:29:56 +00002966 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002967
drh85bcdce2018-12-23 21:27:29 +00002968 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2969 /* Case 1: expr IN (SELECT ...)
2970 **
2971 ** Generate code to write the results of the select into the temporary
2972 ** table allocated and opened above.
2973 */
2974 Select *pSelect = pExpr->x.pSelect;
2975 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002976
drh2c041312018-12-24 02:34:49 +00002977 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2978 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002979 ));
drh85bcdce2018-12-23 21:27:29 +00002980 /* If the LHS and RHS of the IN operator do not match, that
2981 ** error will have been caught long before we reach this point. */
2982 if( ALWAYS(pEList->nExpr==nVal) ){
2983 SelectDest dest;
2984 int i;
drhbd462bc2018-12-24 20:21:06 +00002985 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002986 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2987 pSelect->iLimit = 0;
2988 testcase( pSelect->selFlags & SF_Distinct );
2989 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2990 if( sqlite3Select(pParse, pSelect, &dest) ){
2991 sqlite3DbFree(pParse->db, dest.zAffSdst);
2992 sqlite3KeyInfoUnref(pKeyInfo);
2993 return;
drhfef52082000-06-06 01:50:43 +00002994 }
drh85bcdce2018-12-23 21:27:29 +00002995 sqlite3DbFree(pParse->db, dest.zAffSdst);
2996 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2997 assert( pEList!=0 );
2998 assert( pEList->nExpr>0 );
2999 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3000 for(i=0; i<nVal; i++){
3001 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3002 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3003 pParse, p, pEList->a[i].pExpr
3004 );
danielk197741a05b72008-10-02 13:50:55 +00003005 }
drh85bcdce2018-12-23 21:27:29 +00003006 }
3007 }else if( ALWAYS(pExpr->x.pList!=0) ){
3008 /* Case 2: expr IN (exprlist)
3009 **
3010 ** For each expression, build an index key from the evaluation and
3011 ** store it in the temporary table. If <expr> is a column, then use
3012 ** that columns affinity when building index keys. If <expr> is not
3013 ** a column, use numeric affinity.
3014 */
3015 char affinity; /* Affinity of the LHS of the IN */
3016 int i;
3017 ExprList *pList = pExpr->x.pList;
3018 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003019 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003020 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003021 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003022 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003023 }else if( affinity==SQLITE_AFF_REAL ){
3024 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003025 }
3026 if( pKeyInfo ){
3027 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3028 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003029 }
3030
drh85bcdce2018-12-23 21:27:29 +00003031 /* Loop through each expression in <exprlist>. */
3032 r1 = sqlite3GetTempReg(pParse);
3033 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003034 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3035 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003036
3037 /* If the expression is not constant then we will need to
3038 ** disable the test that was generated above that makes sure
3039 ** this code only executes once. Because for a non-constant
3040 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003041 */
drh2c041312018-12-24 02:34:49 +00003042 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
3043 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003044 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003045 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003046 }
drh1398ad32005-01-19 23:24:50 +00003047
drh85bcdce2018-12-23 21:27:29 +00003048 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003049 sqlite3ExprCode(pParse, pE2, r1);
3050 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3051 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003052 }
drh85bcdce2018-12-23 21:27:29 +00003053 sqlite3ReleaseTempReg(pParse, r1);
3054 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003055 }
drh85bcdce2018-12-23 21:27:29 +00003056 if( pKeyInfo ){
3057 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3058 }
drh2c041312018-12-24 02:34:49 +00003059 if( addrOnce ){
3060 sqlite3VdbeJumpHere(v, addrOnce);
3061 /* Subroutine return */
3062 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3063 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003064 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003065 }
3066}
3067#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003068
drh85bcdce2018-12-23 21:27:29 +00003069/*
3070** Generate code for scalar subqueries used as a subquery expression
3071** or EXISTS operator:
3072**
3073** (SELECT a FROM b) -- subquery
3074** EXISTS (SELECT a FROM b) -- EXISTS subquery
3075**
3076** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3077**
drhd86fe442019-08-26 13:45:49 +00003078** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003079** the result is stored in a contiguous array of registers and the
3080** return value is the register of the left-most result column.
3081** Return 0 if an error occurs.
3082*/
3083#ifndef SQLITE_OMIT_SUBQUERY
3084int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003085 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003086 int rReg = 0; /* Register storing resulting */
3087 Select *pSel; /* SELECT statement to encode */
3088 SelectDest dest; /* How to deal with SELECT result */
3089 int nReg; /* Registers to allocate */
3090 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003091
3092 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003093 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003094 testcase( pExpr->op==TK_EXISTS );
3095 testcase( pExpr->op==TK_SELECT );
3096 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3097 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3098 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003099
drh5198ff52018-12-24 12:09:47 +00003100 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003101 ** is encountered if any of the following is true:
3102 **
3103 ** * The right-hand side is a correlated subquery
3104 ** * The right-hand side is an expression list containing variables
3105 ** * We are inside a trigger
3106 **
3107 ** If all of the above are false, then we can run this code just once
3108 ** save the results, and reuse the same result on subsequent invocations.
3109 */
3110 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003111 /* If this routine has already been coded, then invoke it as a
3112 ** subroutine. */
3113 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003114 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003115 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3116 pExpr->y.sub.iAddr);
3117 return pExpr->iTable;
3118 }
3119
3120 /* Begin coding the subroutine */
3121 ExprSetProperty(pExpr, EP_Subrtn);
3122 pExpr->y.sub.regReturn = ++pParse->nMem;
3123 pExpr->y.sub.iAddr =
3124 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3125 VdbeComment((v, "return address"));
3126
drh2c041312018-12-24 02:34:49 +00003127 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003128 }
drh85bcdce2018-12-23 21:27:29 +00003129
3130 /* For a SELECT, generate code to put the values for all columns of
3131 ** the first row into an array of registers and return the index of
3132 ** the first register.
3133 **
3134 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3135 ** into a register and return that register number.
3136 **
3137 ** In both cases, the query is augmented with "LIMIT 1". Any
3138 ** preexisting limit is discarded in place of the new LIMIT 1.
3139 */
drhbd462bc2018-12-24 20:21:06 +00003140 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3141 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003142 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3143 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3144 pParse->nMem += nReg;
3145 if( pExpr->op==TK_SELECT ){
3146 dest.eDest = SRT_Mem;
3147 dest.iSdst = dest.iSDParm;
3148 dest.nSdst = nReg;
3149 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3150 VdbeComment((v, "Init subquery result"));
3151 }else{
3152 dest.eDest = SRT_Exists;
3153 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3154 VdbeComment((v, "Init EXISTS result"));
3155 }
drh85bcdce2018-12-23 21:27:29 +00003156 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003157 /* The subquery already has a limit. If the pre-existing limit is X
3158 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3159 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003160 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003161 if( pLimit ){
3162 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3163 pLimit = sqlite3PExpr(pParse, TK_NE,
3164 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3165 }
3166 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003167 pSel->pLimit->pLeft = pLimit;
3168 }else{
drh7ca13472019-09-23 11:55:22 +00003169 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003170 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003171 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3172 }
3173 pSel->iLimit = 0;
3174 if( sqlite3Select(pParse, pSel, &dest) ){
3175 return 0;
3176 }
drh2c041312018-12-24 02:34:49 +00003177 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003178 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003179 if( addrOnce ){
3180 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003181
drh5198ff52018-12-24 12:09:47 +00003182 /* Subroutine return */
3183 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3184 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003185 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003186 }
drh2c041312018-12-24 02:34:49 +00003187
drh1450bc62009-10-30 13:25:56 +00003188 return rReg;
drhcce7d172000-05-31 15:34:51 +00003189}
drh51522cd2005-01-20 13:36:19 +00003190#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003191
drhe3365e62009-11-12 17:52:24 +00003192#ifndef SQLITE_OMIT_SUBQUERY
3193/*
dan7b35a772016-07-28 19:47:15 +00003194** Expr pIn is an IN(...) expression. This function checks that the
3195** sub-select on the RHS of the IN() operator has the same number of
3196** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3197** a sub-query, that the LHS is a vector of size 1.
3198*/
3199int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3200 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3201 if( (pIn->flags & EP_xIsSelect) ){
3202 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3203 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3204 return 1;
3205 }
3206 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003207 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003208 return 1;
3209 }
3210 return 0;
3211}
3212#endif
3213
3214#ifndef SQLITE_OMIT_SUBQUERY
3215/*
drhe3365e62009-11-12 17:52:24 +00003216** Generate code for an IN expression.
3217**
3218** x IN (SELECT ...)
3219** x IN (value, value, ...)
3220**
drhecb87ac2016-08-25 15:46:25 +00003221** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003222** right-hand side (RHS) is an array of zero or more scalar values, or a
3223** subquery. If the RHS is a subquery, the number of result columns must
3224** match the number of columns in the vector on the LHS. If the RHS is
3225** a list of values, the LHS must be a scalar.
3226**
3227** The IN operator is true if the LHS value is contained within the RHS.
3228** The result is false if the LHS is definitely not in the RHS. The
3229** result is NULL if the presence of the LHS in the RHS cannot be
3230** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003231**
drh6be515e2014-08-01 21:00:53 +00003232** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003233** contained within the RHS. If due to NULLs we cannot determine if the LHS
3234** is contained in the RHS then jump to destIfNull. If the LHS is contained
3235** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003236**
3237** See the separate in-operator.md documentation file in the canonical
3238** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003239*/
3240static void sqlite3ExprCodeIN(
3241 Parse *pParse, /* Parsing and code generating context */
3242 Expr *pExpr, /* The IN expression */
3243 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3244 int destIfNull /* Jump here if the results are unknown due to NULLs */
3245){
3246 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003247 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003248 int rLhs; /* Register(s) holding the LHS values */
3249 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003250 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003251 int *aiMap = 0; /* Map from vector field to index column */
3252 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003253 int nVector; /* Size of vectors for this IN operator */
3254 int iDummy; /* Dummy parameter to exprCodeVector() */
3255 Expr *pLeft; /* The LHS of the IN operator */
3256 int i; /* loop counter */
3257 int destStep2; /* Where to jump when NULLs seen in step 2 */
3258 int destStep6 = 0; /* Start of code for Step 6 */
3259 int addrTruthOp; /* Address of opcode that determines the IN is true */
3260 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3261 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003262 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003263 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003264
drhe7375bf2020-03-10 19:24:38 +00003265 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003266 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003267 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003268 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003269 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3270 aiMap = (int*)sqlite3DbMallocZero(
3271 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3272 );
drhe347d3e2016-08-25 21:14:34 +00003273 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003274
danba00e302016-07-23 20:24:06 +00003275 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003276 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003277 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3278 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003279 v = pParse->pVdbe;
3280 assert( v!=0 ); /* OOM detected prior to this routine */
3281 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003282 eType = sqlite3FindInIndex(pParse, pExpr,
3283 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003284 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3285 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003286
danba00e302016-07-23 20:24:06 +00003287 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3288 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3289 );
drhecb87ac2016-08-25 15:46:25 +00003290#ifdef SQLITE_DEBUG
3291 /* Confirm that aiMap[] contains nVector integer values between 0 and
3292 ** nVector-1. */
3293 for(i=0; i<nVector; i++){
3294 int j, cnt;
3295 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3296 assert( cnt==1 );
3297 }
3298#endif
drhe3365e62009-11-12 17:52:24 +00003299
danba00e302016-07-23 20:24:06 +00003300 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3301 ** vector, then it is stored in an array of nVector registers starting
3302 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003303 **
3304 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3305 ** so that the fields are in the same order as an existing index. The
3306 ** aiMap[] array contains a mapping from the original LHS field order to
3307 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003308 **
3309 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3310 ** even if it is constant, as OP_Affinity may be used on the register
3311 ** by code generated below. */
3312 assert( pParse->okConstFactor==okConstFactor );
3313 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003314 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003315 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003316 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003317 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003318 /* LHS fields are not reordered */
3319 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003320 }else{
3321 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003322 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003323 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003324 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003325 }
danba00e302016-07-23 20:24:06 +00003326 }
drhe3365e62009-11-12 17:52:24 +00003327
drhbb53ecb2014-08-02 21:03:33 +00003328 /* If sqlite3FindInIndex() did not find or create an index that is
3329 ** suitable for evaluating the IN operator, then evaluate using a
3330 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003331 **
3332 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003333 */
drhbb53ecb2014-08-02 21:03:33 +00003334 if( eType==IN_INDEX_NOOP ){
3335 ExprList *pList = pExpr->x.pList;
3336 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003337 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003338 int r2, regToFree;
3339 int regCkNull = 0;
3340 int ii;
3341 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003342 if( destIfNull!=destIfFalse ){
3343 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003344 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003345 }
3346 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003347 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003348 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003349 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3350 }
drhf6ea97e2020-01-04 15:21:47 +00003351 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003352 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003353 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3354 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003355 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003356 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3357 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3358 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3359 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003360 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003361 }else{
drh47994882019-12-22 23:48:36 +00003362 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003363 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003364 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3365 (void*)pColl, P4_COLLSEQ);
3366 VdbeCoverageIf(v, op==OP_Ne);
3367 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003368 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003369 }
drhbb53ecb2014-08-02 21:03:33 +00003370 }
3371 if( regCkNull ){
3372 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003373 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003374 }
3375 sqlite3VdbeResolveLabel(v, labelOk);
3376 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003377 goto sqlite3ExprCodeIN_finished;
3378 }
3379
3380 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3381 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3382 ** We will then skip the binary search of the RHS.
3383 */
3384 if( destIfNull==destIfFalse ){
3385 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003386 }else{
drhec4ccdb2018-12-29 02:26:59 +00003387 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003388 }
drh4eac5f02019-12-24 15:01:17 +00003389 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003390 for(i=0; i<nVector; i++){
3391 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3392 if( sqlite3ExprCanBeNull(p) ){
3393 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003394 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003395 }
drhe3365e62009-11-12 17:52:24 +00003396 }
drhe347d3e2016-08-25 21:14:34 +00003397
3398 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3399 ** of the RHS using the LHS as a probe. If found, the result is
3400 ** true.
3401 */
3402 if( eType==IN_INDEX_ROWID ){
3403 /* In this case, the RHS is the ROWID of table b-tree and so we also
3404 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3405 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003406 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003407 VdbeCoverage(v);
3408 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3409 }else{
3410 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3411 if( destIfFalse==destIfNull ){
3412 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003413 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003414 rLhs, nVector); VdbeCoverage(v);
3415 goto sqlite3ExprCodeIN_finished;
3416 }
3417 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003418 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003419 rLhs, nVector); VdbeCoverage(v);
3420 }
3421
3422 /* Step 4. If the RHS is known to be non-NULL and we did not find
3423 ** an match on the search above, then the result must be FALSE.
3424 */
3425 if( rRhsHasNull && nVector==1 ){
3426 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3427 VdbeCoverage(v);
3428 }
3429
3430 /* Step 5. If we do not care about the difference between NULL and
3431 ** FALSE, then just return false.
3432 */
3433 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3434
3435 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3436 ** If any comparison is NULL, then the result is NULL. If all
3437 ** comparisons are FALSE then the final result is FALSE.
3438 **
3439 ** For a scalar LHS, it is sufficient to check just the first row
3440 ** of the RHS.
3441 */
3442 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003443 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003444 VdbeCoverage(v);
3445 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003446 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003447 }else{
3448 /* For nVector==1, combine steps 6 and 7 by immediately returning
3449 ** FALSE if the first comparison is not NULL */
3450 destNotNull = destIfFalse;
3451 }
3452 for(i=0; i<nVector; i++){
3453 Expr *p;
3454 CollSeq *pColl;
3455 int r3 = sqlite3GetTempReg(pParse);
3456 p = sqlite3VectorFieldSubexpr(pLeft, i);
3457 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003458 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003459 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3460 (void*)pColl, P4_COLLSEQ);
3461 VdbeCoverage(v);
3462 sqlite3ReleaseTempReg(pParse, r3);
3463 }
3464 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3465 if( nVector>1 ){
3466 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003467 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003468 VdbeCoverage(v);
3469
3470 /* Step 7: If we reach this point, we know that the result must
3471 ** be false. */
3472 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3473 }
3474
3475 /* Jumps here in order to return true. */
3476 sqlite3VdbeJumpHere(v, addrTruthOp);
3477
3478sqlite3ExprCodeIN_finished:
3479 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003480 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003481sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003482 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003483 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003484}
3485#endif /* SQLITE_OMIT_SUBQUERY */
3486
drh13573c72010-01-12 17:04:07 +00003487#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003488/*
3489** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003490** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003491**
3492** The z[] string will probably not be zero-terminated. But the
3493** z[n] character is guaranteed to be something that does not look
3494** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003495*/
drhb7916a72009-05-27 10:31:29 +00003496static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003497 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003498 double value;
drh9339da12010-09-30 00:50:49 +00003499 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003500 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3501 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003502 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003503 }
3504}
drh13573c72010-01-12 17:04:07 +00003505#endif
drh598f1342007-10-23 15:39:45 +00003506
3507
3508/*
drhfec19aa2004-05-19 20:41:03 +00003509** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003510** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003511**
shaneh5f1d6b62010-09-30 16:51:25 +00003512** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003513*/
drh13573c72010-01-12 17:04:07 +00003514static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3515 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003516 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003517 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003518 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003519 if( negFlag ) i = -i;
3520 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003521 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003522 int c;
3523 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003524 const char *z = pExpr->u.zToken;
3525 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003526 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003527 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003528#ifdef SQLITE_OMIT_FLOATING_POINT
3529 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3530#else
drh1b7ddc52014-07-23 14:52:05 +00003531#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003532 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003533 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003534 }else
3535#endif
3536 {
drh9296c182014-07-23 13:40:49 +00003537 codeReal(v, z, negFlag, iMem);
3538 }
drh13573c72010-01-12 17:04:07 +00003539#endif
drh77320ea2016-11-30 14:47:37 +00003540 }else{
drh84d4f1a2017-09-20 10:47:10 +00003541 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003542 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003543 }
drhfec19aa2004-05-19 20:41:03 +00003544 }
3545}
3546
drh5cd79232009-05-25 11:46:29 +00003547
drh1f9ca2c2015-08-25 16:57:52 +00003548/* Generate code that will load into register regOut a value that is
3549** appropriate for the iIdxCol-th column of index pIdx.
3550*/
3551void sqlite3ExprCodeLoadIndexColumn(
3552 Parse *pParse, /* The parsing context */
3553 Index *pIdx, /* The index whose column is to be loaded */
3554 int iTabCur, /* Cursor pointing to a table row */
3555 int iIdxCol, /* The column of the index to be loaded */
3556 int regOut /* Store the index column value in this register */
3557){
3558 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003559 if( iTabCol==XN_EXPR ){
3560 assert( pIdx->aColExpr );
3561 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003562 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003563 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003564 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003565 }else{
drh6df9c4b2019-10-18 12:52:08 +00003566 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003567 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003568 }
drh1f9ca2c2015-08-25 16:57:52 +00003569}
3570
drhe70fa7f2019-10-22 21:01:34 +00003571#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3572/*
3573** Generate code that will compute the value of generated column pCol
3574** and store the result in register regOut
3575*/
3576void sqlite3ExprCodeGeneratedColumn(
3577 Parse *pParse,
3578 Column *pCol,
3579 int regOut
3580){
drh4dad7ed2019-12-16 16:52:22 +00003581 int iAddr;
3582 Vdbe *v = pParse->pVdbe;
3583 assert( v!=0 );
3584 assert( pParse->iSelfTab!=0 );
3585 if( pParse->iSelfTab>0 ){
3586 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3587 }else{
3588 iAddr = 0;
3589 }
drh24e39902020-03-10 13:35:04 +00003590 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003591 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003592 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003593 }
drh4dad7ed2019-12-16 16:52:22 +00003594 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003595}
3596#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3597
drh5cd79232009-05-25 11:46:29 +00003598/*
drh5c092e82010-05-14 19:24:02 +00003599** Generate code to extract the value of the iCol-th column of a table.
3600*/
3601void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003602 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003603 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003604 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003605 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003606 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003607){
drhab45fc02019-10-16 22:01:56 +00003608 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003609 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003610 if( pTab==0 ){
3611 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3612 return;
3613 }
drh5c092e82010-05-14 19:24:02 +00003614 if( iCol<0 || iCol==pTab->iPKey ){
3615 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3616 }else{
drh81f7b372019-10-16 12:18:59 +00003617 int op;
3618 int x;
3619 if( IsVirtual(pTab) ){
3620 op = OP_VColumn;
3621 x = iCol;
3622#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003623 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003624 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003625 if( pCol->colFlags & COLFLAG_BUSY ){
3626 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3627 }else{
3628 int savedSelfTab = pParse->iSelfTab;
3629 pCol->colFlags |= COLFLAG_BUSY;
3630 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003631 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003632 pParse->iSelfTab = savedSelfTab;
3633 pCol->colFlags &= ~COLFLAG_BUSY;
3634 }
drh81f7b372019-10-16 12:18:59 +00003635 return;
3636#endif
3637 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003638 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003639 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003640 op = OP_Column;
3641 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003642 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003643 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003644 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003645 }
3646 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003647 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3648 }
3649}
3650
3651/*
drh945498f2007-02-24 11:52:52 +00003652** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003653** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003654**
3655** There must be an open cursor to pTab in iTable when this routine
3656** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003657*/
drhe55cbd72008-03-31 23:48:03 +00003658int sqlite3ExprCodeGetColumn(
3659 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003660 Table *pTab, /* Description of the table we are reading from */
3661 int iColumn, /* Index of the table column */
3662 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003663 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003664 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003665){
drh81f7b372019-10-16 12:18:59 +00003666 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003667 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003668 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003669 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3670 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003671 }
drhe55cbd72008-03-31 23:48:03 +00003672 return iReg;
3673}
drhe55cbd72008-03-31 23:48:03 +00003674
3675/*
drhb21e7c72008-06-22 12:37:57 +00003676** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003677** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003678*/
drhb21e7c72008-06-22 12:37:57 +00003679void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003680 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003681}
3682
drh652fbf52008-04-01 01:42:41 +00003683/*
drh12abf402016-08-22 14:30:05 +00003684** Convert a scalar expression node to a TK_REGISTER referencing
3685** register iReg. The caller must ensure that iReg already contains
3686** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003687*/
dan069d1b12019-06-16 08:58:14 +00003688static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003689 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003690 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003691 p->op2 = p->op;
3692 p->op = TK_REGISTER;
3693 p->iTable = iReg;
3694 ExprClearProperty(p, EP_Skip);
3695}
3696
drh12abf402016-08-22 14:30:05 +00003697/*
3698** Evaluate an expression (either a vector or a scalar expression) and store
3699** the result in continguous temporary registers. Return the index of
3700** the first register used to store the result.
3701**
3702** If the returned result register is a temporary scalar, then also write
3703** that register number into *piFreeable. If the returned result register
3704** is not a temporary or if the expression is a vector set *piFreeable
3705** to 0.
3706*/
3707static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3708 int iResult;
3709 int nResult = sqlite3ExprVectorSize(p);
3710 if( nResult==1 ){
3711 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3712 }else{
3713 *piFreeable = 0;
3714 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003715#if SQLITE_OMIT_SUBQUERY
3716 iResult = 0;
3717#else
drh85bcdce2018-12-23 21:27:29 +00003718 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003719#endif
drh12abf402016-08-22 14:30:05 +00003720 }else{
3721 int i;
3722 iResult = pParse->nMem+1;
3723 pParse->nMem += nResult;
3724 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003725 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003726 }
3727 }
3728 }
3729 return iResult;
3730}
3731
drh25c42962020-01-01 13:55:08 +00003732/*
drh92a27f72020-02-04 01:41:44 +00003733** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3734** so that a subsequent copy will not be merged into this one.
3735*/
3736static void setDoNotMergeFlagOnCopy(Vdbe *v){
3737 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3738 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3739 }
3740}
3741
3742/*
drh25c42962020-01-01 13:55:08 +00003743** Generate code to implement special SQL functions that are implemented
3744** in-line rather than by using the usual callbacks.
3745*/
3746static int exprCodeInlineFunction(
3747 Parse *pParse, /* Parsing context */
3748 ExprList *pFarg, /* List of function arguments */
3749 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3750 int target /* Store function result in this register */
3751){
3752 int nFarg;
3753 Vdbe *v = pParse->pVdbe;
3754 assert( v!=0 );
3755 assert( pFarg!=0 );
3756 nFarg = pFarg->nExpr;
3757 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3758 switch( iFuncId ){
3759 case INLINEFUNC_coalesce: {
3760 /* Attempt a direct implementation of the built-in COALESCE() and
3761 ** IFNULL() functions. This avoids unnecessary evaluation of
3762 ** arguments past the first non-NULL argument.
3763 */
3764 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3765 int i;
3766 assert( nFarg>=2 );
3767 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3768 for(i=1; i<nFarg; i++){
3769 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3770 VdbeCoverage(v);
3771 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3772 }
drh92a27f72020-02-04 01:41:44 +00003773 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003774 sqlite3VdbeResolveLabel(v, endCoalesce);
3775 break;
3776 }
drh3c0e6062020-05-13 18:03:34 +00003777 case INLINEFUNC_iif: {
3778 Expr caseExpr;
3779 memset(&caseExpr, 0, sizeof(caseExpr));
3780 caseExpr.op = TK_CASE;
3781 caseExpr.x.pList = pFarg;
3782 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3783 }
drh25c42962020-01-01 13:55:08 +00003784
drh171c50e2020-01-01 15:43:30 +00003785 default: {
drh25c42962020-01-01 13:55:08 +00003786 /* The UNLIKELY() function is a no-op. The result is the value
3787 ** of the first argument.
3788 */
drh171c50e2020-01-01 15:43:30 +00003789 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003790 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3791 break;
3792 }
3793
drh171c50e2020-01-01 15:43:30 +00003794 /***********************************************************************
3795 ** Test-only SQL functions that are only usable if enabled
3796 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3797 */
3798 case INLINEFUNC_expr_compare: {
3799 /* Compare two expressions using sqlite3ExprCompare() */
3800 assert( nFarg==2 );
3801 sqlite3VdbeAddOp2(v, OP_Integer,
3802 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3803 target);
3804 break;
3805 }
3806
3807 case INLINEFUNC_expr_implies_expr: {
3808 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3809 assert( nFarg==2 );
3810 sqlite3VdbeAddOp2(v, OP_Integer,
3811 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3812 target);
3813 break;
3814 }
3815
3816 case INLINEFUNC_implies_nonnull_row: {
3817 /* REsult of sqlite3ExprImpliesNonNullRow() */
3818 Expr *pA1;
3819 assert( nFarg==2 );
3820 pA1 = pFarg->a[1].pExpr;
3821 if( pA1->op==TK_COLUMN ){
3822 sqlite3VdbeAddOp2(v, OP_Integer,
3823 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3824 target);
3825 }else{
3826 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3827 }
3828 break;
3829 }
3830
drh25c42962020-01-01 13:55:08 +00003831#ifdef SQLITE_DEBUG
3832 case INLINEFUNC_affinity: {
3833 /* The AFFINITY() function evaluates to a string that describes
3834 ** the type affinity of the argument. This is used for testing of
3835 ** the SQLite type logic.
3836 */
3837 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3838 char aff;
3839 assert( nFarg==1 );
3840 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3841 sqlite3VdbeLoadString(v, target,
3842 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3843 break;
3844 }
3845#endif
3846 }
3847 return target;
3848}
3849
dan71c57db2016-07-09 20:23:55 +00003850
drha4c3c872013-09-12 17:29:25 +00003851/*
drhcce7d172000-05-31 15:34:51 +00003852** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003853** expression. Attempt to store the results in register "target".
3854** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003855**
drh8b213892008-08-29 02:14:02 +00003856** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003857** be stored in target. The result might be stored in some other
3858** register if it is convenient to do so. The calling function
3859** must check the return code and move the results to the desired
3860** register.
drhcce7d172000-05-31 15:34:51 +00003861*/
drh678ccce2008-03-31 18:19:54 +00003862int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003863 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3864 int op; /* The opcode being coded */
3865 int inReg = target; /* Results stored in register inReg */
3866 int regFree1 = 0; /* If non-zero free this temporary register */
3867 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003868 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003869 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003870 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003871
drh9cbf3422008-01-17 16:22:13 +00003872 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003873 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003874
drh1efa8022018-04-28 04:16:43 +00003875expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003876 if( pExpr==0 ){
3877 op = TK_NULL;
3878 }else{
drhe7375bf2020-03-10 19:24:38 +00003879 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003880 op = pExpr->op;
3881 }
drhf2bc0132004-10-04 13:19:23 +00003882 switch( op ){
drh13449892005-09-07 21:22:45 +00003883 case TK_AGG_COLUMN: {
3884 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003885 struct AggInfo_col *pCol;
3886 assert( pAggInfo!=0 );
3887 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3888 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003889 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003890 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003891 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003892 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003893 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003894 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003895 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003896 if( pCol->iColumn<0 ){
3897 VdbeComment((v,"%s.rowid",pTab->zName));
3898 }else{
3899 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3900 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3901 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3902 }
drh0c76e892020-03-10 11:50:43 +00003903 }
drhc332cc32016-09-19 10:24:19 +00003904 return target;
drh13449892005-09-07 21:22:45 +00003905 }
3906 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00003907 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00003908 }
drh967e8b72000-06-21 13:59:10 +00003909 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003910 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003911 int iReg;
drhefad2e22018-07-27 16:57:11 +00003912 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003913 /* This COLUMN expression is really a constant due to WHERE clause
3914 ** constraints, and that constant is coded by the pExpr->pLeft
3915 ** expresssion. However, make sure the constant has the correct
3916 ** datatype by applying the Affinity of the table column to the
3917 ** constant.
3918 */
drh57f7ece2019-11-21 18:28:44 +00003919 int aff;
drh67b9ba12019-12-20 20:45:02 +00003920 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003921 if( pExpr->y.pTab ){
3922 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3923 }else{
3924 aff = pExpr->affExpr;
3925 }
drh96fb16e2019-08-06 14:37:24 +00003926 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003927 static const char zAff[] = "B\000C\000D\000E";
3928 assert( SQLITE_AFF_BLOB=='A' );
3929 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003930 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3931 &zAff[(aff-'B')*2], P4_STATIC);
3932 }
3933 return iReg;
drhefad2e22018-07-27 16:57:11 +00003934 }
drhb2b9d3d2013-08-01 01:14:43 +00003935 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003936 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003937 /* Other columns in the same row for CHECK constraints or
3938 ** generated columns or for inserting into partial index.
3939 ** The row is unpacked into registers beginning at
3940 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3941 ** immediately prior to the first column.
3942 */
3943 Column *pCol;
3944 Table *pTab = pExpr->y.pTab;
3945 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003946 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003947 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003948 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003949 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003950 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003951 return -1-pParse->iSelfTab;
3952 }
drhc5f808d2019-10-19 15:01:52 +00003953 pCol = pTab->aCol + iCol;
3954 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3955 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003956#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3957 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003958 if( pCol->colFlags & COLFLAG_BUSY ){
3959 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3960 pCol->zName);
3961 return 0;
3962 }
3963 pCol->colFlags |= COLFLAG_BUSY;
3964 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3965 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3966 }
3967 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003968 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003969 }else
3970#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3971 if( pCol->affinity==SQLITE_AFF_REAL ){
3972 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003973 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3974 return target;
3975 }else{
drh9942ef02019-10-18 02:19:18 +00003976 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003977 }
drhb2b9d3d2013-08-01 01:14:43 +00003978 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003979 /* Coding an expression that is part of an index where column names
3980 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003981 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003982 }
drh22827922000-06-06 17:27:05 +00003983 }
drh67b9ba12019-12-20 20:45:02 +00003984 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003985 pExpr->iColumn, iTab, target,
3986 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003987 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3988 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3989 }
3990 return iReg;
drhcce7d172000-05-31 15:34:51 +00003991 }
3992 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003993 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003994 return target;
drhfec19aa2004-05-19 20:41:03 +00003995 }
drh8abed7b2018-02-26 18:49:05 +00003996 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003997 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003998 return target;
3999 }
drh13573c72010-01-12 17:04:07 +00004000#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004001 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004002 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4003 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004004 return target;
drh598f1342007-10-23 15:39:45 +00004005 }
drh13573c72010-01-12 17:04:07 +00004006#endif
drhfec19aa2004-05-19 20:41:03 +00004007 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004008 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004009 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004010 return target;
drhcce7d172000-05-31 15:34:51 +00004011 }
drhaac30f92019-12-14 15:01:55 +00004012 default: {
drhc29af652019-12-18 21:22:40 +00004013 /* Make NULL the default case so that if a bug causes an illegal
4014 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004015 ** sanely and not crash. But keep the assert() to bring the problem
4016 ** to the attention of the developers. */
4017 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00004018 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004019 return target;
drhf0863fe2005-06-12 21:35:51 +00004020 }
danielk19775338a5f2005-01-20 13:03:10 +00004021#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004022 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004023 int n;
4024 const char *z;
drhca48c902008-01-18 14:08:24 +00004025 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00004026 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4027 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4028 assert( pExpr->u.zToken[1]=='\'' );
4029 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004030 n = sqlite3Strlen30(z) - 1;
4031 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004032 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4033 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004034 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004035 }
danielk19775338a5f2005-01-20 13:03:10 +00004036#endif
drh50457892003-09-06 01:10:47 +00004037 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004038 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4039 assert( pExpr->u.zToken!=0 );
4040 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004041 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4042 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004043 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004044 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004045 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004046 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004047 }
drhc332cc32016-09-19 10:24:19 +00004048 return target;
drh50457892003-09-06 01:10:47 +00004049 }
drh4e0cff62004-11-05 05:10:28 +00004050 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004051 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004052 }
drh487e2622005-06-25 18:42:14 +00004053#ifndef SQLITE_OMIT_CAST
4054 case TK_CAST: {
4055 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004056 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004057 if( inReg!=target ){
4058 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4059 inReg = target;
4060 }
drh4169e432014-08-25 20:11:52 +00004061 sqlite3VdbeAddOp2(v, OP_Cast, target,
4062 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004063 return inReg;
drh487e2622005-06-25 18:42:14 +00004064 }
4065#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004066 case TK_IS:
4067 case TK_ISNOT:
4068 op = (op==TK_IS) ? TK_EQ : TK_NE;
4069 p5 = SQLITE_NULLEQ;
4070 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004071 case TK_LT:
4072 case TK_LE:
4073 case TK_GT:
4074 case TK_GE:
4075 case TK_NE:
4076 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004077 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004078 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004079 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004080 }else{
4081 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4082 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004083 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4084 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4085 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004086 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004087 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4088 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4089 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4090 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4091 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4092 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004093 if( p5==SQLITE_NULLEQ ){
4094 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4095 }else{
4096 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4097 }
dan71c57db2016-07-09 20:23:55 +00004098 testcase( regFree1==0 );
4099 testcase( regFree2==0 );
4100 }
drh6a2fe092009-09-23 02:29:36 +00004101 break;
4102 }
drhcce7d172000-05-31 15:34:51 +00004103 case TK_AND:
4104 case TK_OR:
4105 case TK_PLUS:
4106 case TK_STAR:
4107 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004108 case TK_REM:
4109 case TK_BITAND:
4110 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004111 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004112 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004113 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004114 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004115 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4116 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4117 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4118 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4119 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4120 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4121 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4122 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4123 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4124 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4125 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004126 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4127 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004128 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004129 testcase( regFree1==0 );
4130 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004131 break;
4132 }
drhcce7d172000-05-31 15:34:51 +00004133 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004134 Expr *pLeft = pExpr->pLeft;
4135 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004136 if( pLeft->op==TK_INTEGER ){
4137 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004138 return target;
drh13573c72010-01-12 17:04:07 +00004139#ifndef SQLITE_OMIT_FLOATING_POINT
4140 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004141 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4142 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004143 return target;
drh13573c72010-01-12 17:04:07 +00004144#endif
drh3c84ddf2008-01-09 02:15:38 +00004145 }else{
drh10d1edf2013-11-15 15:52:39 +00004146 tempX.op = TK_INTEGER;
4147 tempX.flags = EP_IntValue|EP_TokenOnly;
4148 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004149 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004150 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004151 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004152 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004153 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004154 }
drh3c84ddf2008-01-09 02:15:38 +00004155 break;
drh6e142f52000-06-08 13:36:40 +00004156 }
drhbf4133c2001-10-13 02:59:08 +00004157 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004158 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004159 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4160 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004161 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4162 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004163 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004164 break;
4165 }
drh8abed7b2018-02-26 18:49:05 +00004166 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004167 int isTrue; /* IS TRUE or IS NOT TRUE */
4168 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004169 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4170 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004171 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4172 bNormal = pExpr->op2==TK_IS;
4173 testcase( isTrue && bNormal);
4174 testcase( !isTrue && bNormal);
4175 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004176 break;
4177 }
drhcce7d172000-05-31 15:34:51 +00004178 case TK_ISNULL:
4179 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004180 int addr;
drh7d176102014-02-18 03:07:12 +00004181 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4182 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004183 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004184 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004185 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004186 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004187 VdbeCoverageIf(v, op==TK_ISNULL);
4188 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004189 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004190 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004191 break;
drhcce7d172000-05-31 15:34:51 +00004192 }
drh22827922000-06-06 17:27:05 +00004193 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004194 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004195 if( pInfo==0
4196 || NEVER(pExpr->iAgg<0)
4197 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4198 ){
drh33e619f2009-05-28 01:00:55 +00004199 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4200 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004201 }else{
drhc332cc32016-09-19 10:24:19 +00004202 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004203 }
drh22827922000-06-06 17:27:05 +00004204 break;
4205 }
drhcce7d172000-05-31 15:34:51 +00004206 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004207 ExprList *pFarg; /* List of function arguments */
4208 int nFarg; /* Number of function arguments */
4209 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004210 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004211 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004212 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004213 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004214 u8 enc = ENC(db); /* The text encoding used by this database */
4215 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004216
dan67a9b8e2018-06-22 20:51:35 +00004217#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004218 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4219 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004220 }
dan67a9b8e2018-06-22 20:51:35 +00004221#endif
dan86fb6e12018-05-16 20:58:07 +00004222
drh1e9b53f2017-01-04 01:07:24 +00004223 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004224 /* SQL functions can be expensive. So try to avoid running them
4225 ** multiple times if we know they always give the same result */
4226 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004227 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004228 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004229 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4230 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004231 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004232 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4233 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004234 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004235#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4236 if( pDef==0 && pParse->explain ){
4237 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4238 }
4239#endif
danb6e9f7a2018-05-19 14:15:29 +00004240 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004241 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004242 break;
4243 }
drh25c42962020-01-01 13:55:08 +00004244 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004245 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4246 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004247 return exprCodeInlineFunction(pParse, pFarg,
4248 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004249 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4250 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004251 }
4252
drhd1a01ed2013-11-21 16:08:52 +00004253 for(i=0; i<nFarg; i++){
4254 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004255 testcase( i==31 );
4256 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004257 }
4258 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4259 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4260 }
4261 }
drh12ffee82009-04-08 13:51:51 +00004262 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004263 if( constMask ){
4264 r1 = pParse->nMem+1;
4265 pParse->nMem += nFarg;
4266 }else{
4267 r1 = sqlite3GetTempRange(pParse, nFarg);
4268 }
drha748fdc2012-03-28 01:34:47 +00004269
4270 /* For length() and typeof() functions with a column argument,
4271 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4272 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4273 ** loading.
4274 */
drhd36e1042013-09-06 13:10:12 +00004275 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004276 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004277 assert( nFarg==1 );
4278 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004279 exprOp = pFarg->a[0].pExpr->op;
4280 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004281 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4282 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004283 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4284 pFarg->a[0].pExpr->op2 =
4285 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004286 }
4287 }
4288
drh5579d592015-08-26 14:01:41 +00004289 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004290 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004291 }else{
drh12ffee82009-04-08 13:51:51 +00004292 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004293 }
drhb7f6f682006-07-08 17:06:43 +00004294#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004295 /* Possibly overload the function if the first argument is
4296 ** a virtual table column.
4297 **
4298 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4299 ** second argument, not the first, as the argument to test to
4300 ** see if it is a column in a virtual table. This is done because
4301 ** the left operand of infix functions (the operand we want to
4302 ** control overloading) ends up as the second argument to the
4303 ** function. The expression "A glob B" is equivalent to
4304 ** "glob(B,A). We want to use the A in "A glob B" to test
4305 ** for function overloading. But we use the B term in "glob(B,A)".
4306 */
drh59155062018-05-26 18:03:48 +00004307 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004308 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4309 }else if( nFarg>0 ){
4310 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004311 }
4312#endif
drhd36e1042013-09-06 13:10:12 +00004313 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004314 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004315 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004316 }
drh092457b2017-12-29 15:04:49 +00004317#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4318 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004319 Expr *pArg = pFarg->a[0].pExpr;
4320 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004321 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004322 }else{
4323 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4324 }
drh092457b2017-12-29 15:04:49 +00004325 }else
4326#endif
4327 {
drh920cf592019-10-30 16:29:02 +00004328 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004329 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004330 }
drh13d79502019-12-23 02:18:49 +00004331 if( nFarg ){
4332 if( constMask==0 ){
4333 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4334 }else{
drh3aef2fb2020-01-02 17:46:02 +00004335 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004336 }
drh2dcef112008-01-12 19:03:48 +00004337 }
drhc332cc32016-09-19 10:24:19 +00004338 return target;
drhcce7d172000-05-31 15:34:51 +00004339 }
drhfe2093d2005-01-20 22:48:47 +00004340#ifndef SQLITE_OMIT_SUBQUERY
4341 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004342 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004343 int nCol;
drhc5499be2008-04-01 15:06:33 +00004344 testcase( op==TK_EXISTS );
4345 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004346 if( pParse->db->mallocFailed ){
4347 return 0;
4348 }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
dan8da209b2016-07-26 18:06:08 +00004349 sqlite3SubselectError(pParse, nCol, 1);
4350 }else{
drh85bcdce2018-12-23 21:27:29 +00004351 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004352 }
drh19a775c2000-06-05 18:54:46 +00004353 break;
4354 }
drhfc7f27b2016-08-20 00:07:01 +00004355 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004356 int n;
drhfc7f27b2016-08-20 00:07:01 +00004357 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004358 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004359 }
drh966e2912017-01-03 02:58:01 +00004360 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004361 if( pExpr->iTable!=0
4362 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004363 ){
4364 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4365 pExpr->iTable, n);
4366 }
drhc332cc32016-09-19 10:24:19 +00004367 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004368 }
drhfef52082000-06-06 01:50:43 +00004369 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004370 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4371 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004372 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4373 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4374 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4375 sqlite3VdbeResolveLabel(v, destIfFalse);
4376 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4377 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004378 return target;
drhfef52082000-06-06 01:50:43 +00004379 }
drhe3365e62009-11-12 17:52:24 +00004380#endif /* SQLITE_OMIT_SUBQUERY */
4381
4382
drh2dcef112008-01-12 19:03:48 +00004383 /*
4384 ** x BETWEEN y AND z
4385 **
4386 ** This is equivalent to
4387 **
4388 ** x>=y AND x<=z
4389 **
4390 ** X is stored in pExpr->pLeft.
4391 ** Y is stored in pExpr->pList->a[0].pExpr.
4392 ** Z is stored in pExpr->pList->a[1].pExpr.
4393 */
drhfef52082000-06-06 01:50:43 +00004394 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004395 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004396 return target;
drhfef52082000-06-06 01:50:43 +00004397 }
drh94fa9c42016-02-27 21:16:04 +00004398 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004399 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004400 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004401 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004402 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004403 }
drh2dcef112008-01-12 19:03:48 +00004404
dan165921a2009-08-28 18:53:45 +00004405 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004406 /* If the opcode is TK_TRIGGER, then the expression is a reference
4407 ** to a column in the new.* or old.* pseudo-tables available to
4408 ** trigger programs. In this case Expr.iTable is set to 1 for the
4409 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4410 ** is set to the column of the pseudo-table to read, or to -1 to
4411 ** read the rowid field.
4412 **
4413 ** The expression is implemented using an OP_Param opcode. The p1
4414 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4415 ** to reference another column of the old.* pseudo-table, where
4416 ** i is the index of the column. For a new.rowid reference, p1 is
4417 ** set to (n+1), where n is the number of columns in each pseudo-table.
4418 ** For a reference to any other column in the new.* pseudo-table, p1
4419 ** is set to (n+2+i), where n and i are as defined previously. For
4420 ** example, if the table on which triggers are being fired is
4421 ** declared as:
4422 **
4423 ** CREATE TABLE t1(a, b);
4424 **
4425 ** Then p1 is interpreted as follows:
4426 **
4427 ** p1==0 -> old.rowid p1==3 -> new.rowid
4428 ** p1==1 -> old.a p1==4 -> new.a
4429 ** p1==2 -> old.b p1==5 -> new.b
4430 */
drheda079c2018-09-20 19:02:15 +00004431 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004432 int iCol = pExpr->iColumn;
4433 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004434 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004435
4436 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004437 assert( iCol>=-1 && iCol<pTab->nCol );
4438 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004439 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4440
4441 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004442 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004443 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004444 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004445 ));
dan65a7cd12009-09-01 12:16:01 +00004446
drh44dbca82010-01-13 04:22:20 +00004447#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004448 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004449 ** integer. Use OP_RealAffinity to make sure it is really real.
4450 **
4451 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4452 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004453 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004454 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4455 }
drh44dbca82010-01-13 04:22:20 +00004456#endif
dan165921a2009-08-28 18:53:45 +00004457 break;
4458 }
4459
dan71c57db2016-07-09 20:23:55 +00004460 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004461 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004462 break;
4463 }
4464
drh9e9a67a2019-08-17 17:07:15 +00004465 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4466 ** that derive from the right-hand table of a LEFT JOIN. The
4467 ** Expr.iTable value is the table number for the right-hand table.
4468 ** The expression is only evaluated if that table is not currently
4469 ** on a LEFT JOIN NULL row.
4470 */
drh31d6fd52017-04-14 19:03:10 +00004471 case TK_IF_NULL_ROW: {
4472 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004473 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004474 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004475 /* Temporarily disable factoring of constant expressions, since
4476 ** even though expressions may appear to be constant, they are not
4477 ** really constant because they originate from the right-hand side
4478 ** of a LEFT JOIN. */
4479 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004480 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004481 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004482 sqlite3VdbeJumpHere(v, addrINR);
4483 sqlite3VdbeChangeP3(v, addrINR, inReg);
4484 break;
4485 }
4486
drh2dcef112008-01-12 19:03:48 +00004487 /*
4488 ** Form A:
4489 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4490 **
4491 ** Form B:
4492 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4493 **
4494 ** Form A is can be transformed into the equivalent form B as follows:
4495 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4496 ** WHEN x=eN THEN rN ELSE y END
4497 **
4498 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004499 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4500 ** odd. The Y is also optional. If the number of elements in x.pList
4501 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004502 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4503 **
4504 ** The result of the expression is the Ri for the first matching Ei,
4505 ** or if there is no matching Ei, the ELSE term Y, or if there is
4506 ** no ELSE term, NULL.
4507 */
drhaac30f92019-12-14 15:01:55 +00004508 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004509 int endLabel; /* GOTO label for end of CASE stmt */
4510 int nextCase; /* GOTO label for next WHEN clause */
4511 int nExpr; /* 2x number of WHEN terms */
4512 int i; /* Loop counter */
4513 ExprList *pEList; /* List of WHEN terms */
4514 struct ExprList_item *aListelem; /* Array of WHEN terms */
4515 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004516 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004517 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004518 Expr *pDel = 0;
4519 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004520
danielk19776ab3a2e2009-02-19 14:39:25 +00004521 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004522 assert(pExpr->x.pList->nExpr > 0);
4523 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004524 aListelem = pEList->a;
4525 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004526 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004527 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004528 pDel = sqlite3ExprDup(db, pX, 0);
4529 if( db->mallocFailed ){
4530 sqlite3ExprDelete(db, pDel);
4531 break;
4532 }
drh33cd4902009-05-30 20:49:20 +00004533 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004534 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004535 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004536 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004537 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004538 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004539 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004540 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4541 ** The value in regFree1 might get SCopy-ed into the file result.
4542 ** So make sure that the regFree1 register is not reused for other
4543 ** purposes and possibly overwritten. */
4544 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004545 }
drhc5cd1242013-09-12 16:50:49 +00004546 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004547 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004548 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004549 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004550 }else{
drh2dcef112008-01-12 19:03:48 +00004551 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004552 }
drhec4ccdb2018-12-29 02:26:59 +00004553 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004554 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004555 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004556 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004557 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004558 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004559 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004560 }
drhc5cd1242013-09-12 16:50:49 +00004561 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004562 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004563 }else{
drh9de221d2008-01-05 06:51:30 +00004564 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004565 }
dan8b65e592019-07-17 14:34:17 +00004566 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004567 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004568 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004569 break;
4570 }
danielk19775338a5f2005-01-20 13:03:10 +00004571#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004572 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004573 assert( pExpr->affExpr==OE_Rollback
4574 || pExpr->affExpr==OE_Abort
4575 || pExpr->affExpr==OE_Fail
4576 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004577 );
drh9e5fdc42020-05-08 19:02:21 +00004578 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004579 sqlite3ErrorMsg(pParse,
4580 "RAISE() may only be used within a trigger-program");
4581 return 0;
4582 }
drh11949042019-08-05 18:01:42 +00004583 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004584 sqlite3MayAbort(pParse);
4585 }
dan165921a2009-08-28 18:53:45 +00004586 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004587 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004588 sqlite3VdbeAddOp4(
4589 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004590 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004591 }else{
drh9e5fdc42020-05-08 19:02:21 +00004592 sqlite3HaltConstraint(pParse,
4593 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4594 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004595 }
4596
drhffe07b22005-11-03 00:41:17 +00004597 break;
drh17a7f8d2002-03-24 13:13:27 +00004598 }
danielk19775338a5f2005-01-20 13:03:10 +00004599#endif
drhffe07b22005-11-03 00:41:17 +00004600 }
drh2dcef112008-01-12 19:03:48 +00004601 sqlite3ReleaseTempReg(pParse, regFree1);
4602 sqlite3ReleaseTempReg(pParse, regFree2);
4603 return inReg;
4604}
4605
4606/*
drh9b258c52020-03-11 19:41:49 +00004607** Generate code that will evaluate expression pExpr just one time
4608** per prepared statement execution.
4609**
4610** If the expression uses functions (that might throw an exception) then
4611** guard them with an OP_Once opcode to ensure that the code is only executed
4612** once. If no functions are involved, then factor the code out and put it at
4613** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004614**
drhad879ff2017-01-04 04:10:02 +00004615** If regDest>=0 then the result is always stored in that register and the
4616** result is not reusable. If regDest<0 then this routine is free to
4617** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004618** is stored is returned. When regDest<0, two identical expressions might
4619** code to the same register, if they do not contain function calls and hence
4620** are factored out into the initialization section at the end of the
4621** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004622*/
drh9b258c52020-03-11 19:41:49 +00004623int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004624 Parse *pParse, /* Parsing context */
4625 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004626 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004627){
drhd1a01ed2013-11-21 16:08:52 +00004628 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004629 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004630 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004631 if( regDest<0 && p ){
4632 struct ExprList_item *pItem;
4633 int i;
4634 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004635 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004636 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004637 }
4638 }
drh1e9b53f2017-01-04 01:07:24 +00004639 }
drhd1a01ed2013-11-21 16:08:52 +00004640 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004641 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4642 Vdbe *v = pParse->pVdbe;
4643 int addr;
4644 assert( v );
4645 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4646 pParse->okConstFactor = 0;
4647 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004648 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004649 sqlite3ExprCode(pParse, pExpr, regDest);
4650 }
4651 pParse->okConstFactor = 1;
4652 sqlite3ExprDelete(pParse->db, pExpr);
4653 sqlite3VdbeJumpHere(v, addr);
4654 }else{
4655 p = sqlite3ExprListAppend(pParse, p, pExpr);
4656 if( p ){
4657 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4658 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004659 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004660 pItem->u.iConstExprReg = regDest;
4661 }
4662 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004663 }
drh1e9b53f2017-01-04 01:07:24 +00004664 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004665}
4666
4667/*
drh2dcef112008-01-12 19:03:48 +00004668** Generate code to evaluate an expression and store the results
4669** into a register. Return the register number where the results
4670** are stored.
4671**
4672** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004673** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004674** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004675**
4676** If pExpr is a constant, then this routine might generate this
4677** code to fill the register in the initialization section of the
4678** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004679*/
4680int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004681 int r2;
drh0d950af2019-08-22 16:38:42 +00004682 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004683 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004684 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004685 && pExpr->op!=TK_REGISTER
4686 && sqlite3ExprIsConstantNotJoin(pExpr)
4687 ){
drhf30a9692013-11-15 01:10:18 +00004688 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004689 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004690 }else{
drhf30a9692013-11-15 01:10:18 +00004691 int r1 = sqlite3GetTempReg(pParse);
4692 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4693 if( r2==r1 ){
4694 *pReg = r1;
4695 }else{
4696 sqlite3ReleaseTempReg(pParse, r1);
4697 *pReg = 0;
4698 }
drh2dcef112008-01-12 19:03:48 +00004699 }
4700 return r2;
4701}
4702
4703/*
4704** Generate code that will evaluate expression pExpr and store the
4705** results in register target. The results are guaranteed to appear
4706** in register target.
4707*/
drh05a86c52014-02-16 01:55:49 +00004708void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004709 int inReg;
4710
drhe7375bf2020-03-10 19:24:38 +00004711 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004712 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004713 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004714 if( pParse->pVdbe==0 ) return;
4715 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4716 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004717 u8 op;
4718 if( ExprHasProperty(pExpr,EP_Subquery) ){
4719 op = OP_Copy;
4720 }else{
4721 op = OP_SCopy;
4722 }
4723 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004724 }
drhcce7d172000-05-31 15:34:51 +00004725}
4726
4727/*
drh1c75c9d2015-12-21 15:22:13 +00004728** Make a transient copy of expression pExpr and then code it using
4729** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4730** except that the input expression is guaranteed to be unchanged.
4731*/
4732void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4733 sqlite3 *db = pParse->db;
4734 pExpr = sqlite3ExprDup(db, pExpr, 0);
4735 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4736 sqlite3ExprDelete(db, pExpr);
4737}
4738
4739/*
drh05a86c52014-02-16 01:55:49 +00004740** Generate code that will evaluate expression pExpr and store the
4741** results in register target. The results are guaranteed to appear
4742** in register target. If the expression is constant, then this routine
4743** might choose to code the expression at initialization time.
4744*/
4745void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004746 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004747 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004748 }else{
drh088489e2020-03-10 02:57:37 +00004749 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004750 }
drhcce7d172000-05-31 15:34:51 +00004751}
4752
4753/*
drh268380c2004-02-25 13:47:31 +00004754** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004755** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004756**
drh3df6c3b2017-09-15 15:38:01 +00004757** Return the number of elements evaluated. The number returned will
4758** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4759** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004760**
4761** The SQLITE_ECEL_DUP flag prevents the arguments from being
4762** filled using OP_SCopy. OP_Copy must be used instead.
4763**
4764** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4765** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004766**
4767** The SQLITE_ECEL_REF flag means that expressions in the list with
4768** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4769** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004770** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4771** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004772*/
danielk19774adee202004-05-08 08:23:19 +00004773int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004774 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004775 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004776 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004777 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004778 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004779){
4780 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004781 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004782 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004783 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004784 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004785 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004786 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004787 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004788 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004789 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004790 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004791#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4792 if( pItem->bSorterRef ){
4793 i--;
4794 n--;
4795 }else
4796#endif
dan257c13f2016-11-10 20:14:06 +00004797 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4798 if( flags & SQLITE_ECEL_OMITREF ){
4799 i--;
4800 n--;
4801 }else{
4802 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4803 }
drhb8b06692018-08-04 15:16:20 +00004804 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4805 && sqlite3ExprIsConstantNotJoin(pExpr)
4806 ){
drh9b258c52020-03-11 19:41:49 +00004807 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004808 }else{
4809 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4810 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004811 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004812 if( copyOp==OP_Copy
4813 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4814 && pOp->p1+pOp->p3+1==inReg
4815 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004816 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004817 ){
4818 pOp->p3++;
4819 }else{
4820 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4821 }
drhd1a01ed2013-11-21 16:08:52 +00004822 }
drhd1766112008-09-17 00:13:12 +00004823 }
drh268380c2004-02-25 13:47:31 +00004824 }
drhf9b596e2004-05-26 16:54:42 +00004825 return n;
drh268380c2004-02-25 13:47:31 +00004826}
4827
4828/*
drh36c563a2009-11-12 13:32:22 +00004829** Generate code for a BETWEEN operator.
4830**
4831** x BETWEEN y AND z
4832**
4833** The above is equivalent to
4834**
4835** x>=y AND x<=z
4836**
4837** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004838** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004839**
4840** The xJumpIf parameter determines details:
4841**
4842** NULL: Store the boolean result in reg[dest]
4843** sqlite3ExprIfTrue: Jump to dest if true
4844** sqlite3ExprIfFalse: Jump to dest if false
4845**
4846** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004847*/
4848static void exprCodeBetween(
4849 Parse *pParse, /* Parsing and code generating context */
4850 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004851 int dest, /* Jump destination or storage location */
4852 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004853 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4854){
dan8b65e592019-07-17 14:34:17 +00004855 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004856 Expr compLeft; /* The x>=y term */
4857 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004858 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004859 Expr *pDel = 0;
4860 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004861
dan71c57db2016-07-09 20:23:55 +00004862 memset(&compLeft, 0, sizeof(Expr));
4863 memset(&compRight, 0, sizeof(Expr));
4864 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004865
4866 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004867 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4868 if( db->mallocFailed==0 ){
4869 exprAnd.op = TK_AND;
4870 exprAnd.pLeft = &compLeft;
4871 exprAnd.pRight = &compRight;
4872 compLeft.op = TK_GE;
4873 compLeft.pLeft = pDel;
4874 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4875 compRight.op = TK_LE;
4876 compRight.pLeft = pDel;
4877 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4878 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4879 if( xJump ){
4880 xJump(pParse, &exprAnd, dest, jumpIfNull);
4881 }else{
4882 /* Mark the expression is being from the ON or USING clause of a join
4883 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4884 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4885 ** for clarity, but we are out of bits in the Expr.flags field so we
4886 ** have to reuse the EP_FromJoin bit. Bummer. */
4887 pDel->flags |= EP_FromJoin;
4888 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4889 }
4890 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004891 }
dan8b65e592019-07-17 14:34:17 +00004892 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004893
4894 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004895 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4896 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4897 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4898 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4899 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4900 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4901 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4902 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004903 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004904}
4905
4906/*
drhcce7d172000-05-31 15:34:51 +00004907** Generate code for a boolean expression such that a jump is made
4908** to the label "dest" if the expression is true but execution
4909** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004910**
4911** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004912** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004913**
4914** This code depends on the fact that certain token values (ex: TK_EQ)
4915** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4916** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4917** the make process cause these values to align. Assert()s in the code
4918** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004919*/
danielk19774adee202004-05-08 08:23:19 +00004920void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004921 Vdbe *v = pParse->pVdbe;
4922 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004923 int regFree1 = 0;
4924 int regFree2 = 0;
4925 int r1, r2;
4926
drh35573352008-01-08 23:54:25 +00004927 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004928 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004929 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004930 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004931 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004932 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004933 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004934 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004935 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4936 if( pAlt!=pExpr ){
4937 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4938 }else if( op==TK_AND ){
4939 int d2 = sqlite3VdbeMakeLabel(pParse);
4940 testcase( jumpIfNull==0 );
4941 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4942 jumpIfNull^SQLITE_JUMPIFNULL);
4943 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4944 sqlite3VdbeResolveLabel(v, d2);
4945 }else{
4946 testcase( jumpIfNull==0 );
4947 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4948 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4949 }
drhcce7d172000-05-31 15:34:51 +00004950 break;
4951 }
4952 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004953 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004954 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004955 break;
4956 }
drh8abed7b2018-02-26 18:49:05 +00004957 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004958 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4959 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004960 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004961 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004962 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004963 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004964 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004965 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004966 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4967 isNot ? SQLITE_JUMPIFNULL : 0);
4968 }else{
4969 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4970 isNot ? SQLITE_JUMPIFNULL : 0);
4971 }
drh007c8432018-02-26 03:20:18 +00004972 break;
4973 }
drhde845c22016-03-17 19:07:52 +00004974 case TK_IS:
4975 case TK_ISNOT:
4976 testcase( op==TK_IS );
4977 testcase( op==TK_ISNOT );
4978 op = (op==TK_IS) ? TK_EQ : TK_NE;
4979 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00004980 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00004981 case TK_LT:
4982 case TK_LE:
4983 case TK_GT:
4984 case TK_GE:
4985 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004986 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004987 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004988 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004989 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4990 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004991 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004992 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004993 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4994 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4995 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4996 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004997 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4998 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4999 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5000 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5001 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5002 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005003 testcase( regFree1==0 );
5004 testcase( regFree2==0 );
5005 break;
5006 }
drhcce7d172000-05-31 15:34:51 +00005007 case TK_ISNULL:
5008 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005009 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5010 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005011 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5012 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005013 VdbeCoverageIf(v, op==TK_ISNULL);
5014 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005015 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005016 break;
5017 }
drhfef52082000-06-06 01:50:43 +00005018 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005019 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005020 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005021 break;
5022 }
drh84e30ca2011-02-10 17:46:14 +00005023#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005024 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005025 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005026 int destIfNull = jumpIfNull ? dest : destIfFalse;
5027 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005028 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005029 sqlite3VdbeResolveLabel(v, destIfFalse);
5030 break;
5031 }
shanehbb201342011-02-09 19:55:20 +00005032#endif
drhcce7d172000-05-31 15:34:51 +00005033 default: {
dan7b35a772016-07-28 19:47:15 +00005034 default_expr:
drhad317272019-04-19 16:21:51 +00005035 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005036 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005037 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005038 /* No-op */
5039 }else{
5040 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5041 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005042 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005043 testcase( regFree1==0 );
5044 testcase( jumpIfNull==0 );
5045 }
drhcce7d172000-05-31 15:34:51 +00005046 break;
5047 }
5048 }
drh2dcef112008-01-12 19:03:48 +00005049 sqlite3ReleaseTempReg(pParse, regFree1);
5050 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005051}
5052
5053/*
drh66b89c82000-11-28 20:47:17 +00005054** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005055** to the label "dest" if the expression is false but execution
5056** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005057**
5058** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005059** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5060** is 0.
drhcce7d172000-05-31 15:34:51 +00005061*/
danielk19774adee202004-05-08 08:23:19 +00005062void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005063 Vdbe *v = pParse->pVdbe;
5064 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005065 int regFree1 = 0;
5066 int regFree2 = 0;
5067 int r1, r2;
5068
drh35573352008-01-08 23:54:25 +00005069 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005070 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005071 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005072 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005073
5074 /* The value of pExpr->op and op are related as follows:
5075 **
5076 ** pExpr->op op
5077 ** --------- ----------
5078 ** TK_ISNULL OP_NotNull
5079 ** TK_NOTNULL OP_IsNull
5080 ** TK_NE OP_Eq
5081 ** TK_EQ OP_Ne
5082 ** TK_GT OP_Le
5083 ** TK_LE OP_Gt
5084 ** TK_GE OP_Lt
5085 ** TK_LT OP_Ge
5086 **
5087 ** For other values of pExpr->op, op is undefined and unused.
5088 ** The value of TK_ and OP_ constants are arranged such that we
5089 ** can compute the mapping above using the following expression.
5090 ** Assert()s verify that the computation is correct.
5091 */
5092 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5093
5094 /* Verify correct alignment of TK_ and OP_ constants
5095 */
5096 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5097 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5098 assert( pExpr->op!=TK_NE || op==OP_Eq );
5099 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5100 assert( pExpr->op!=TK_LT || op==OP_Ge );
5101 assert( pExpr->op!=TK_LE || op==OP_Gt );
5102 assert( pExpr->op!=TK_GT || op==OP_Le );
5103 assert( pExpr->op!=TK_GE || op==OP_Lt );
5104
danba00e302016-07-23 20:24:06 +00005105 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005106 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005107 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005108 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5109 if( pAlt!=pExpr ){
5110 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5111 }else if( pExpr->op==TK_AND ){
5112 testcase( jumpIfNull==0 );
5113 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5114 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5115 }else{
5116 int d2 = sqlite3VdbeMakeLabel(pParse);
5117 testcase( jumpIfNull==0 );
5118 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5119 jumpIfNull^SQLITE_JUMPIFNULL);
5120 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5121 sqlite3VdbeResolveLabel(v, d2);
5122 }
drhcce7d172000-05-31 15:34:51 +00005123 break;
5124 }
5125 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005126 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005127 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005128 break;
5129 }
drh8abed7b2018-02-26 18:49:05 +00005130 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005131 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5132 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005133 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005134 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005135 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005136 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005137 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005138 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005139 /* IS TRUE and IS NOT FALSE */
5140 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5141 isNot ? 0 : SQLITE_JUMPIFNULL);
5142
5143 }else{
5144 /* IS FALSE and IS NOT TRUE */
5145 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005146 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005147 }
drh007c8432018-02-26 03:20:18 +00005148 break;
5149 }
drhde845c22016-03-17 19:07:52 +00005150 case TK_IS:
5151 case TK_ISNOT:
5152 testcase( pExpr->op==TK_IS );
5153 testcase( pExpr->op==TK_ISNOT );
5154 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5155 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005156 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005157 case TK_LT:
5158 case TK_LE:
5159 case TK_GT:
5160 case TK_GE:
5161 case TK_NE:
5162 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005163 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005164 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005165 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5166 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005167 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005168 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005169 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5170 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5171 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5172 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005173 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5174 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5175 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5176 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5177 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5178 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005179 testcase( regFree1==0 );
5180 testcase( regFree2==0 );
5181 break;
5182 }
drhcce7d172000-05-31 15:34:51 +00005183 case TK_ISNULL:
5184 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005185 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5186 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005187 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5188 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005189 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005190 break;
5191 }
drhfef52082000-06-06 01:50:43 +00005192 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005193 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005194 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005195 break;
5196 }
drh84e30ca2011-02-10 17:46:14 +00005197#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005198 case TK_IN: {
5199 if( jumpIfNull ){
5200 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5201 }else{
drhec4ccdb2018-12-29 02:26:59 +00005202 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005203 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5204 sqlite3VdbeResolveLabel(v, destIfNull);
5205 }
5206 break;
5207 }
shanehbb201342011-02-09 19:55:20 +00005208#endif
drhcce7d172000-05-31 15:34:51 +00005209 default: {
danba00e302016-07-23 20:24:06 +00005210 default_expr:
drhad317272019-04-19 16:21:51 +00005211 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005212 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005213 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005214 /* no-op */
5215 }else{
5216 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5217 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005218 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005219 testcase( regFree1==0 );
5220 testcase( jumpIfNull==0 );
5221 }
drhcce7d172000-05-31 15:34:51 +00005222 break;
5223 }
5224 }
drh2dcef112008-01-12 19:03:48 +00005225 sqlite3ReleaseTempReg(pParse, regFree1);
5226 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005227}
drh22827922000-06-06 17:27:05 +00005228
5229/*
drh72bc8202015-06-11 13:58:35 +00005230** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5231** code generation, and that copy is deleted after code generation. This
5232** ensures that the original pExpr is unchanged.
5233*/
5234void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5235 sqlite3 *db = pParse->db;
5236 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5237 if( db->mallocFailed==0 ){
5238 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5239 }
5240 sqlite3ExprDelete(db, pCopy);
5241}
5242
dan5aa550c2017-06-24 18:10:29 +00005243/*
5244** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5245** type of expression.
5246**
5247** If pExpr is a simple SQL value - an integer, real, string, blob
5248** or NULL value - then the VDBE currently being prepared is configured
5249** to re-prepare each time a new value is bound to variable pVar.
5250**
5251** Additionally, if pExpr is a simple SQL value and the value is the
5252** same as that currently bound to variable pVar, non-zero is returned.
5253** Otherwise, if the values are not the same or if pExpr is not a simple
5254** SQL value, zero is returned.
5255*/
5256static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5257 int res = 0;
drhc0804222017-06-28 21:47:16 +00005258 int iVar;
5259 sqlite3_value *pL, *pR = 0;
5260
5261 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5262 if( pR ){
5263 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005264 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005265 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005266 if( pL ){
5267 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5268 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5269 }
5270 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005271 }
drhc0804222017-06-28 21:47:16 +00005272 sqlite3ValueFree(pR);
5273 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005274 }
5275
5276 return res;
5277}
drh72bc8202015-06-11 13:58:35 +00005278
5279/*
drh1d9da702010-01-07 15:17:02 +00005280** Do a deep comparison of two expression trees. Return 0 if the two
5281** expressions are completely identical. Return 1 if they differ only
5282** by a COLLATE operator at the top level. Return 2 if there are differences
5283** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005284**
drh619a1302013-08-01 13:04:46 +00005285** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5286** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5287**
drh66518ca2013-08-01 15:09:57 +00005288** The pA side might be using TK_REGISTER. If that is the case and pB is
5289** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5290**
drh1d9da702010-01-07 15:17:02 +00005291** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005292** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005293** identical, we return 2 just to be safe. So if this routine
5294** returns 2, then you do not really know for certain if the two
5295** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005296** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005297** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005298** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005299** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005300**
drhc0804222017-06-28 21:47:16 +00005301** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5302** pParse->pReprepare can be matched against literals in pB. The
5303** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5304** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5305** Argument pParse should normally be NULL. If it is not NULL and pA or
5306** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005307*/
dan5aa550c2017-06-24 18:10:29 +00005308int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005309 u32 combinedFlags;
5310 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005311 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005312 }
dan5aa550c2017-06-24 18:10:29 +00005313 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5314 return 0;
5315 }
drh10d1edf2013-11-15 15:52:39 +00005316 combinedFlags = pA->flags | pB->flags;
5317 if( combinedFlags & EP_IntValue ){
5318 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5319 return 0;
5320 }
drh1d9da702010-01-07 15:17:02 +00005321 return 2;
drh22827922000-06-06 17:27:05 +00005322 }
dan16dd3982018-12-20 15:04:38 +00005323 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005324 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005325 return 1;
5326 }
dan5aa550c2017-06-24 18:10:29 +00005327 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005328 return 1;
5329 }
5330 return 2;
5331 }
drh2edc5fd2015-11-24 02:10:52 +00005332 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005333 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005334 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005335#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005336 assert( pA->op==pB->op );
5337 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5338 return 2;
5339 }
drheda079c2018-09-20 19:02:15 +00005340 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005341 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5342 return 2;
5343 }
drheda079c2018-09-20 19:02:15 +00005344 }
5345#endif
drhf20bbc52019-01-17 01:06:00 +00005346 }else if( pA->op==TK_NULL ){
5347 return 0;
drhd5af5422018-04-13 14:27:01 +00005348 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005349 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005350 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005351 return 2;
drh2646da72005-12-09 20:02:05 +00005352 }
drh22827922000-06-06 17:27:05 +00005353 }
drh898c5272019-10-22 00:03:41 +00005354 if( (pA->flags & (EP_Distinct|EP_Commuted))
5355 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005356 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005357 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005358 if( (combinedFlags & EP_FixedCol)==0
5359 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005360 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005361 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005362 if( pA->op!=TK_STRING
5363 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005364 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005365 ){
drh10d1edf2013-11-15 15:52:39 +00005366 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005367 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005368 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5369 return 2;
5370 }
drh10d1edf2013-11-15 15:52:39 +00005371 }
5372 }
drh1d9da702010-01-07 15:17:02 +00005373 return 0;
drh22827922000-06-06 17:27:05 +00005374}
5375
drh8c6f6662010-04-26 19:17:26 +00005376/*
danfbb6e9f2020-01-09 20:11:29 +00005377** Compare two ExprList objects. Return 0 if they are identical, 1
5378** if they are certainly different, or 2 if it is not possible to
5379** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005380**
drh619a1302013-08-01 13:04:46 +00005381** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5382** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5383**
drh8c6f6662010-04-26 19:17:26 +00005384** This routine might return non-zero for equivalent ExprLists. The
5385** only consequence will be disabled optimizations. But this routine
5386** must never return 0 if the two ExprList objects are different, or
5387** a malfunction will result.
5388**
5389** Two NULL pointers are considered to be the same. But a NULL pointer
5390** always differs from a non-NULL pointer.
5391*/
drh619a1302013-08-01 13:04:46 +00005392int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005393 int i;
5394 if( pA==0 && pB==0 ) return 0;
5395 if( pA==0 || pB==0 ) return 1;
5396 if( pA->nExpr!=pB->nExpr ) return 1;
5397 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005398 int res;
drh8c6f6662010-04-26 19:17:26 +00005399 Expr *pExprA = pA->a[i].pExpr;
5400 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005401 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005402 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005403 }
5404 return 0;
5405}
drh13449892005-09-07 21:22:45 +00005406
drh22827922000-06-06 17:27:05 +00005407/*
drhf9463df2017-02-11 14:59:58 +00005408** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5409** are ignored.
5410*/
5411int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005412 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005413 sqlite3ExprSkipCollateAndLikely(pA),
5414 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005415 iTab);
5416}
5417
5418/*
drhc51cf862019-05-11 19:36:03 +00005419** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005420**
5421** Or if seenNot is true, return non-zero if Expr p can only be
5422** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005423*/
5424static int exprImpliesNotNull(
5425 Parse *pParse, /* Parsing context */
5426 Expr *p, /* The expression to be checked */
5427 Expr *pNN, /* The expression that is NOT NULL */
5428 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005429 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005430){
5431 assert( p );
5432 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005433 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5434 return pNN->op!=TK_NULL;
5435 }
drhc51cf862019-05-11 19:36:03 +00005436 switch( p->op ){
5437 case TK_IN: {
5438 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5439 assert( ExprHasProperty(p,EP_xIsSelect)
5440 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005441 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005442 }
5443 case TK_BETWEEN: {
5444 ExprList *pList = p->x.pList;
5445 assert( pList!=0 );
5446 assert( pList->nExpr==2 );
5447 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005448 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5449 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005450 ){
5451 return 1;
5452 }
drh7a231b42019-08-30 15:11:08 +00005453 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005454 }
5455 case TK_EQ:
5456 case TK_NE:
5457 case TK_LT:
5458 case TK_LE:
5459 case TK_GT:
5460 case TK_GE:
5461 case TK_PLUS:
5462 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005463 case TK_BITOR:
5464 case TK_LSHIFT:
5465 case TK_RSHIFT:
5466 case TK_CONCAT:
5467 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005468 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005469 case TK_STAR:
5470 case TK_REM:
5471 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005472 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005473 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005474 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005475 }
5476 case TK_SPAN:
5477 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005478 case TK_UPLUS:
5479 case TK_UMINUS: {
5480 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5481 }
5482 case TK_TRUTH: {
5483 if( seenNot ) return 0;
5484 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005485 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005486 }
dan1cd382e2019-08-29 15:06:35 +00005487 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005488 case TK_NOT: {
5489 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5490 }
5491 }
5492 return 0;
5493}
5494
5495/*
drh4bd5f732013-07-31 23:22:39 +00005496** Return true if we can prove the pE2 will always be true if pE1 is
5497** true. Return false if we cannot complete the proof or if pE2 might
5498** be false. Examples:
5499**
drh619a1302013-08-01 13:04:46 +00005500** pE1: x==5 pE2: x==5 Result: true
5501** pE1: x>0 pE2: x==5 Result: false
5502** pE1: x=21 pE2: x=21 OR y=43 Result: true
5503** pE1: x!=123 pE2: x IS NOT NULL Result: true
5504** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5505** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5506** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005507**
5508** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5509** Expr.iTable<0 then assume a table number given by iTab.
5510**
drhc0804222017-06-28 21:47:16 +00005511** If pParse is not NULL, then the values of bound variables in pE1 are
5512** compared against literal values in pE2 and pParse->pVdbe->expmask is
5513** modified to record which bound variables are referenced. If pParse
5514** is NULL, then false will be returned if pE1 contains any bound variables.
5515**
drh4bd5f732013-07-31 23:22:39 +00005516** When in doubt, return false. Returning true might give a performance
5517** improvement. Returning false might cause a performance reduction, but
5518** it will always give the correct answer and is hence always safe.
5519*/
dan5aa550c2017-06-24 18:10:29 +00005520int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5521 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005522 return 1;
5523 }
5524 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005525 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5526 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005527 ){
5528 return 1;
5529 }
drh664d6d12019-05-04 17:32:07 +00005530 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005531 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005532 ){
drhc51cf862019-05-11 19:36:03 +00005533 return 1;
drh619a1302013-08-01 13:04:46 +00005534 }
5535 return 0;
drh4bd5f732013-07-31 23:22:39 +00005536}
5537
5538/*
drh6c68d752019-11-04 02:05:52 +00005539** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005540** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005541** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5542**
5543** This routine controls an optimization. False positives (setting
5544** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5545** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005546*/
5547static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005548 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005549 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005550 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5551 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005552 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005553 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005554 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005555 case TK_IS:
5556 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005557 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005558 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005559 case TK_IN:
drh25897872018-03-20 21:16:15 +00005560 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005561 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005562 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005563 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005564 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005565 testcase( pExpr->op==TK_IS );
5566 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005567 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005568 testcase( pExpr->op==TK_CASE );
5569 testcase( pExpr->op==TK_IN );
5570 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005571 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005572 return WRC_Prune;
5573 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005574 if( pWalker->u.iCur==pExpr->iTable ){
5575 pWalker->eCode = 1;
5576 return WRC_Abort;
5577 }
5578 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005579
dan9d23ea72019-08-29 19:34:29 +00005580 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005581 if( pWalker->eCode==0 ){
5582 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5583 if( pWalker->eCode ){
5584 pWalker->eCode = 0;
5585 sqlite3WalkExpr(pWalker, pExpr->pRight);
5586 }
dan9d23ea72019-08-29 19:34:29 +00005587 }
5588 return WRC_Prune;
5589
5590 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005591 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5592 assert( pWalker->eCode );
5593 return WRC_Abort;
5594 }
dan9d23ea72019-08-29 19:34:29 +00005595 return WRC_Prune;
5596
drh98811552018-04-03 14:04:48 +00005597 /* Virtual tables are allowed to use constraints like x=NULL. So
5598 ** a term of the form x=y does not prove that y is not null if x
5599 ** is the column of a virtual table */
5600 case TK_EQ:
5601 case TK_NE:
5602 case TK_LT:
5603 case TK_LE:
5604 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005605 case TK_GE: {
5606 Expr *pLeft = pExpr->pLeft;
5607 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005608 testcase( pExpr->op==TK_EQ );
5609 testcase( pExpr->op==TK_NE );
5610 testcase( pExpr->op==TK_LT );
5611 testcase( pExpr->op==TK_LE );
5612 testcase( pExpr->op==TK_GT );
5613 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005614 /* The y.pTab=0 assignment in wherecode.c always happens after the
5615 ** impliesNotNullRow() test */
5616 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5617 && IsVirtual(pLeft->y.pTab))
5618 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5619 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005620 ){
drh78d1d222020-02-17 19:25:07 +00005621 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005622 }
drh08b92082020-08-10 14:18:00 +00005623 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005624 }
drh25897872018-03-20 21:16:15 +00005625 default:
5626 return WRC_Continue;
5627 }
5628}
5629
5630/*
5631** Return true (non-zero) if expression p can only be true if at least
5632** one column of table iTab is non-null. In other words, return true
5633** if expression p will always be NULL or false if every column of iTab
5634** is NULL.
5635**
drh821b6102018-03-24 18:01:51 +00005636** False negatives are acceptable. In other words, it is ok to return
5637** zero even if expression p will never be true of every column of iTab
5638** is NULL. A false negative is merely a missed optimization opportunity.
5639**
5640** False positives are not allowed, however. A false positive may result
5641** in an incorrect answer.
5642**
drh25897872018-03-20 21:16:15 +00005643** Terms of p that are marked with EP_FromJoin (and hence that come from
5644** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5645**
5646** This routine is used to check if a LEFT JOIN can be converted into
5647** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5648** clause requires that some column of the right table of the LEFT JOIN
5649** be non-NULL, then the LEFT JOIN can be safely converted into an
5650** ordinary join.
5651*/
5652int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5653 Walker w;
drh0d950af2019-08-22 16:38:42 +00005654 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005655 if( p==0 ) return 0;
5656 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005657 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005658 }else{
5659 while( p->op==TK_AND ){
5660 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5661 p = p->pRight;
5662 }
drhd6db6592019-04-01 19:42:42 +00005663 }
drh25897872018-03-20 21:16:15 +00005664 w.xExprCallback = impliesNotNullRow;
5665 w.xSelectCallback = 0;
5666 w.xSelectCallback2 = 0;
5667 w.eCode = 0;
5668 w.u.iCur = iTab;
5669 sqlite3WalkExpr(&w, p);
5670 return w.eCode;
5671}
5672
5673/*
drh030796d2012-08-23 16:18:10 +00005674** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005675** to determine if an expression can be evaluated by reference to the
5676** index only, without having to do a search for the corresponding
5677** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5678** is the cursor for the table.
5679*/
5680struct IdxCover {
5681 Index *pIdx; /* The index to be tested for coverage */
5682 int iCur; /* Cursor number for the table corresponding to the index */
5683};
5684
5685/*
5686** Check to see if there are references to columns in table
5687** pWalker->u.pIdxCover->iCur can be satisfied using the index
5688** pWalker->u.pIdxCover->pIdx.
5689*/
5690static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5691 if( pExpr->op==TK_COLUMN
5692 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005693 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005694 ){
5695 pWalker->eCode = 1;
5696 return WRC_Abort;
5697 }
5698 return WRC_Continue;
5699}
5700
5701/*
drhe604ec02016-07-27 19:20:58 +00005702** Determine if an index pIdx on table with cursor iCur contains will
5703** the expression pExpr. Return true if the index does cover the
5704** expression and false if the pExpr expression references table columns
5705** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005706**
5707** An index covering an expression means that the expression can be
5708** evaluated using only the index and without having to lookup the
5709** corresponding table entry.
5710*/
5711int sqlite3ExprCoveredByIndex(
5712 Expr *pExpr, /* The index to be tested */
5713 int iCur, /* The cursor number for the corresponding table */
5714 Index *pIdx /* The index that might be used for coverage */
5715){
5716 Walker w;
5717 struct IdxCover xcov;
5718 memset(&w, 0, sizeof(w));
5719 xcov.iCur = iCur;
5720 xcov.pIdx = pIdx;
5721 w.xExprCallback = exprIdxCover;
5722 w.u.pIdxCover = &xcov;
5723 sqlite3WalkExpr(&w, pExpr);
5724 return !w.eCode;
5725}
5726
5727
5728/*
5729** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005730** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005731** aggregate function, in order to implement the
5732** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005733*/
drh030796d2012-08-23 16:18:10 +00005734struct SrcCount {
5735 SrcList *pSrc; /* One particular FROM clause in a nested query */
daned41a962020-06-09 17:45:48 +00005736 int iSrcInner; /* Smallest cursor number in this context */
drh030796d2012-08-23 16:18:10 +00005737 int nThis; /* Number of references to columns in pSrcList */
5738 int nOther; /* Number of references to columns in other FROM clauses */
5739};
5740
5741/*
daned41a962020-06-09 17:45:48 +00005742** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5743** SELECT with a FROM clause encountered during this iteration, set
5744** SrcCount.iSrcInner to the cursor number of the leftmost object in
5745** the FROM cause.
5746*/
5747static int selectSrcCount(Walker *pWalker, Select *pSel){
5748 struct SrcCount *p = pWalker->u.pSrcCount;
drhbc050b82020-06-09 22:11:06 +00005749 if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
daned41a962020-06-09 17:45:48 +00005750 pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5751 }
5752 return WRC_Continue;
5753}
5754
5755/*
drh030796d2012-08-23 16:18:10 +00005756** Count the number of references to columns.
5757*/
5758static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005759 /* There was once a NEVER() on the second term on the grounds that
5760 ** sqlite3FunctionUsesThisSrc() was always called before
5761 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5762 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5763 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5764 ** FunctionUsesThisSrc() when creating a new sub-select. */
5765 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005766 int i;
drh030796d2012-08-23 16:18:10 +00005767 struct SrcCount *p = pWalker->u.pSrcCount;
5768 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005769 int nSrc = pSrc ? pSrc->nSrc : 0;
5770 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005771 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005772 }
drh655814d2015-01-09 01:27:29 +00005773 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005774 p->nThis++;
daned41a962020-06-09 17:45:48 +00005775 }else if( pExpr->iTable<p->iSrcInner ){
drh80f6bfc2019-08-31 20:13:30 +00005776 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005777 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005778 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005779 p->nOther++;
5780 }
drh374fdce2012-04-17 16:38:53 +00005781 }
drh030796d2012-08-23 16:18:10 +00005782 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005783}
5784
5785/*
drh030796d2012-08-23 16:18:10 +00005786** Determine if any of the arguments to the pExpr Function reference
5787** pSrcList. Return true if they do. Also return true if the function
5788** has no arguments or has only constant arguments. Return false if pExpr
5789** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005790*/
drh030796d2012-08-23 16:18:10 +00005791int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005792 Walker w;
drh030796d2012-08-23 16:18:10 +00005793 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005794 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005795 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005796 w.xExprCallback = exprSrcCount;
daned41a962020-06-09 17:45:48 +00005797 w.xSelectCallback = selectSrcCount;
drh030796d2012-08-23 16:18:10 +00005798 w.u.pSrcCount = &cnt;
5799 cnt.pSrc = pSrcList;
daned41a962020-06-09 17:45:48 +00005800 cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
drh030796d2012-08-23 16:18:10 +00005801 cnt.nThis = 0;
5802 cnt.nOther = 0;
5803 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005804#ifndef SQLITE_OMIT_WINDOWFUNC
5805 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5806 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5807 }
5808#endif
drh030796d2012-08-23 16:18:10 +00005809 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005810}
5811
5812/*
drh89636622020-06-07 17:33:18 +00005813** This is a Walker expression node callback.
5814**
5815** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
5816** object that is referenced does not refer directly to the Expr. If
5817** it does, make a copy. This is done because the pExpr argument is
5818** subject to change.
5819**
5820** The copy is stored on pParse->pConstExpr with a register number of 0.
5821** This will cause the expression to be deleted automatically when the
5822** Parse object is destroyed, but the zero register number means that it
5823** will not generate any code in the preamble.
5824*/
5825static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00005826 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00005827 && pExpr->pAggInfo!=0
5828 ){
5829 AggInfo *pAggInfo = pExpr->pAggInfo;
5830 int iAgg = pExpr->iAgg;
5831 Parse *pParse = pWalker->pParse;
5832 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00005833 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
5834 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00005835 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00005836 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005837 pExpr = sqlite3ExprDup(db, pExpr, 0);
5838 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005839 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00005840 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00005841 }
5842 }
5843 }else{
5844 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00005845 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005846 pExpr = sqlite3ExprDup(db, pExpr, 0);
5847 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005848 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00005849 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00005850 }
5851 }
5852 }
5853 }
5854 return WRC_Continue;
5855}
5856
5857/*
5858** Initialize a Walker object so that will persist AggInfo entries referenced
5859** by the tree that is walked.
5860*/
5861void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
5862 memset(pWalker, 0, sizeof(*pWalker));
5863 pWalker->pParse = pParse;
5864 pWalker->xExprCallback = agginfoPersistExprCb;
5865 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
5866}
5867
5868/*
drh13449892005-09-07 21:22:45 +00005869** Add a new element to the pAggInfo->aCol[] array. Return the index of
5870** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005871*/
drh17435752007-08-16 04:30:38 +00005872static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005873 int i;
drhcf643722007-03-27 13:36:37 +00005874 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005875 db,
drhcf643722007-03-27 13:36:37 +00005876 pInfo->aCol,
5877 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005878 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005879 &i
5880 );
drh13449892005-09-07 21:22:45 +00005881 return i;
5882}
5883
5884/*
5885** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5886** the new element. Return a negative number if malloc fails.
5887*/
drh17435752007-08-16 04:30:38 +00005888static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005889 int i;
drhcf643722007-03-27 13:36:37 +00005890 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005891 db,
drhcf643722007-03-27 13:36:37 +00005892 pInfo->aFunc,
5893 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005894 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005895 &i
5896 );
drh13449892005-09-07 21:22:45 +00005897 return i;
drh89636622020-06-07 17:33:18 +00005898}
drh22827922000-06-06 17:27:05 +00005899
5900/*
drh7d10d5a2008-08-20 16:35:10 +00005901** This is the xExprCallback for a tree walker. It is used to
5902** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005903** for additional information.
drh22827922000-06-06 17:27:05 +00005904*/
drh7d10d5a2008-08-20 16:35:10 +00005905static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005906 int i;
drh7d10d5a2008-08-20 16:35:10 +00005907 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005908 Parse *pParse = pNC->pParse;
5909 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005910 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005911
drh25c3b8c2018-04-16 10:34:13 +00005912 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005913 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005914 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005915 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005916 testcase( pExpr->op==TK_AGG_COLUMN );
5917 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005918 /* Check to see if the column is in one of the tables in the FROM
5919 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005920 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00005921 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00005922 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5923 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005924 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005925 if( pExpr->iTable==pItem->iCursor ){
5926 /* If we reach this point, it means that pExpr refers to a table
5927 ** that is in the FROM clause of the aggregate query.
5928 **
5929 ** Make an entry for the column in pAggInfo->aCol[] if there
5930 ** is not an entry there already.
5931 */
drh7f906d62007-03-12 23:48:52 +00005932 int k;
drh13449892005-09-07 21:22:45 +00005933 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005934 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005935 if( pCol->iTable==pExpr->iTable &&
5936 pCol->iColumn==pExpr->iColumn ){
5937 break;
5938 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005939 }
danielk19771e536952007-08-16 10:09:01 +00005940 if( (k>=pAggInfo->nColumn)
5941 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5942 ){
drh7f906d62007-03-12 23:48:52 +00005943 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005944 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005945 pCol->iTable = pExpr->iTable;
5946 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005947 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005948 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00005949 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005950 if( pAggInfo->pGroupBy ){
5951 int j, n;
5952 ExprList *pGB = pAggInfo->pGroupBy;
5953 struct ExprList_item *pTerm = pGB->a;
5954 n = pGB->nExpr;
5955 for(j=0; j<n; j++, pTerm++){
5956 Expr *pE = pTerm->pExpr;
5957 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5958 pE->iColumn==pExpr->iColumn ){
5959 pCol->iSorterColumn = j;
5960 break;
5961 }
5962 }
5963 }
5964 if( pCol->iSorterColumn<0 ){
5965 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5966 }
5967 }
5968 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5969 ** because it was there before or because we just created it).
5970 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5971 ** pAggInfo->aCol[] entry.
5972 */
drhebb6a652013-09-12 23:42:22 +00005973 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005974 pExpr->pAggInfo = pAggInfo;
5975 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005976 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005977 break;
5978 } /* endif pExpr->iTable==pItem->iCursor */
5979 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005980 }
drh7d10d5a2008-08-20 16:35:10 +00005981 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005982 }
5983 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005984 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005985 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005986 ){
drh13449892005-09-07 21:22:45 +00005987 /* Check to see if pExpr is a duplicate of another aggregate
5988 ** function that is already in the pAggInfo structure
5989 */
5990 struct AggInfo_func *pItem = pAggInfo->aFunc;
5991 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh81185a52020-06-09 13:38:12 +00005992 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005993 break;
5994 }
drh22827922000-06-06 17:27:05 +00005995 }
drh13449892005-09-07 21:22:45 +00005996 if( i>=pAggInfo->nFunc ){
5997 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5998 */
danielk197714db2662006-01-09 16:12:04 +00005999 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006000 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006001 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006002 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006003 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006004 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00006005 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00006006 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00006007 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006008 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006009 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006010 if( pExpr->flags & EP_Distinct ){
6011 pItem->iDistinct = pParse->nTab++;
6012 }else{
6013 pItem->iDistinct = -1;
6014 }
drh13449892005-09-07 21:22:45 +00006015 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006016 }
drh13449892005-09-07 21:22:45 +00006017 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6018 */
drhc5cd1242013-09-12 16:50:49 +00006019 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006020 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006021 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006022 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006023 return WRC_Prune;
6024 }else{
6025 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006026 }
drh22827922000-06-06 17:27:05 +00006027 }
6028 }
drh7d10d5a2008-08-20 16:35:10 +00006029 return WRC_Continue;
6030}
drh626a8792005-01-17 22:08:19 +00006031
6032/*
drhe8abb4c2012-11-02 18:24:57 +00006033** Analyze the pExpr expression looking for aggregate functions and
6034** for variables that need to be added to AggInfo object that pNC->pAggInfo
6035** points to. Additional entries are made on the AggInfo object as
6036** necessary.
drh626a8792005-01-17 22:08:19 +00006037**
6038** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006039** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006040*/
drhd2b3e232008-01-23 14:51:49 +00006041void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006042 Walker w;
6043 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006044 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6045 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006046 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006047 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006048 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006049 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006050 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006051}
drh5d9a4af2005-08-30 00:54:01 +00006052
6053/*
6054** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6055** expression list. Return the number of errors.
6056**
6057** If an error is found, the analysis is cut short.
6058*/
drhd2b3e232008-01-23 14:51:49 +00006059void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006060 struct ExprList_item *pItem;
6061 int i;
drh5d9a4af2005-08-30 00:54:01 +00006062 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006063 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6064 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006065 }
6066 }
drh5d9a4af2005-08-30 00:54:01 +00006067}
drh892d3172008-01-10 03:46:36 +00006068
6069/*
drhceea3322009-04-23 13:22:42 +00006070** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006071*/
6072int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006073 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006074 return ++pParse->nMem;
6075 }
danielk19772f425f62008-07-04 09:41:39 +00006076 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006077}
drhceea3322009-04-23 13:22:42 +00006078
6079/*
6080** Deallocate a register, making available for reuse for some other
6081** purpose.
drhceea3322009-04-23 13:22:42 +00006082*/
drh892d3172008-01-10 03:46:36 +00006083void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006084 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006085 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006086 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6087 pParse->aTempReg[pParse->nTempReg++] = iReg;
6088 }
drh892d3172008-01-10 03:46:36 +00006089 }
6090}
6091
6092/*
drhed24da42016-09-06 14:37:05 +00006093** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006094*/
6095int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006096 int i, n;
drhed24da42016-09-06 14:37:05 +00006097 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006098 i = pParse->iRangeReg;
6099 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006100 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006101 pParse->iRangeReg += nReg;
6102 pParse->nRangeReg -= nReg;
6103 }else{
6104 i = pParse->nMem+1;
6105 pParse->nMem += nReg;
6106 }
6107 return i;
6108}
6109void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006110 if( nReg==1 ){
6111 sqlite3ReleaseTempReg(pParse, iReg);
6112 return;
6113 }
drh3aef2fb2020-01-02 17:46:02 +00006114 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006115 if( nReg>pParse->nRangeReg ){
6116 pParse->nRangeReg = nReg;
6117 pParse->iRangeReg = iReg;
6118 }
6119}
drhcdc69552011-12-06 13:24:59 +00006120
6121/*
6122** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006123**
6124** Always invoke this procedure after coding a subroutine or co-routine
6125** that might be invoked from other parts of the code, to ensure that
6126** the sub/co-routine does not use registers in common with the code that
6127** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006128*/
6129void sqlite3ClearTempRegCache(Parse *pParse){
6130 pParse->nTempReg = 0;
6131 pParse->nRangeReg = 0;
6132}
drhbb9b5f22016-03-19 00:35:02 +00006133
6134/*
6135** Validate that no temporary register falls within the range of
6136** iFirst..iLast, inclusive. This routine is only call from within assert()
6137** statements.
6138*/
6139#ifdef SQLITE_DEBUG
6140int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6141 int i;
6142 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006143 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6144 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006145 ){
6146 return 0;
6147 }
6148 for(i=0; i<pParse->nTempReg; i++){
6149 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6150 return 0;
6151 }
6152 }
6153 return 1;
6154}
6155#endif /* SQLITE_DEBUG */