blob: 7a4e59f28dfa4554ca25c978117ecd977d37f340 [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*/
drhb6dad522021-09-24 16:14:47 +000024char sqlite3TableColumnAffinity(const Table *pTab, int iCol){
drh6d64b4a2021-11-07 23:33:01 +000025 if( iCol<0 || NEVER(iCol>=pTab->nCol) ) return SQLITE_AFF_INTEGER;
26 return pTab->aCol[iCol].affinity;
drh0dfa4f62016-08-26 13:19:49 +000027}
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;
drhde0e1b12021-04-16 22:53:57 +000055 if( op==TK_REGISTER ) op = pExpr->op2;
drh477572b2021-10-07 20:46:29 +000056 if( op==TK_COLUMN || op==TK_AGG_COLUMN ){
57 assert( ExprUseYTab(pExpr) );
drh63b3a642022-10-20 13:36:32 +000058 assert( pExpr->y.pTab!=0 );
59 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhde0e1b12021-04-16 22:53:57 +000060 }
drh487e2622005-06-25 18:42:14 +000061 if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +000062 assert( ExprUseXSelect(pExpr) );
drh6af305d2020-07-10 21:43:53 +000063 assert( pExpr->x.pSelect!=0 );
64 assert( pExpr->x.pSelect->pEList!=0 );
65 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
66 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000067 }
drh487e2622005-06-25 18:42:14 +000068#ifndef SQLITE_OMIT_CAST
69 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000070 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000071 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000072 }
73#endif
dan80aa5452016-09-03 19:52:12 +000074 if( op==TK_SELECT_COLUMN ){
drha4eeccd2021-10-07 17:43:30 +000075 assert( pExpr->pLeft!=0 && ExprUseXSelect(pExpr->pLeft) );
drh10f08272021-07-05 01:11:26 +000076 assert( pExpr->iColumn < pExpr->iTable );
77 assert( pExpr->iTable==pExpr->pLeft->x.pSelect->pEList->nExpr );
dan80aa5452016-09-03 19:52:12 +000078 return sqlite3ExprAffinity(
79 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
80 );
81 }
drhdb36e252019-10-22 19:51:29 +000082 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +000083 assert( ExprUseXList(pExpr) );
drhdb36e252019-10-22 19:51:29 +000084 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
85 }
drh11949042019-08-05 18:01:42 +000086 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000087}
88
drh53db1452004-05-20 13:54:53 +000089/*
drh8b4c40d2007-02-01 23:02:45 +000090** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000091** sequence named by pToken. Return a pointer to a new Expr node that
92** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000093**
94** If a memory allocation error occurs, that fact is recorded in pParse->db
95** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000096*/
drh4ef7efa2014-03-20 15:14:08 +000097Expr *sqlite3ExprAddCollateToken(
drhb6dad522021-09-24 16:14:47 +000098 const Parse *pParse, /* Parsing context */
drh4ef7efa2014-03-20 15:14:08 +000099 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +0000100 const Token *pCollName, /* Name of collating sequence */
101 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +0000102){
drh433a3e92021-05-04 12:07:16 +0000103 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +0000104 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000105 if( pNew ){
106 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000107 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000108 pExpr = pNew;
109 }
drhae80dde2012-12-06 21:16:43 +0000110 }
drh0a8a4062012-12-07 18:38:16 +0000111 return pExpr;
112}
drhb6dad522021-09-24 16:14:47 +0000113Expr *sqlite3ExprAddCollateString(
114 const Parse *pParse, /* Parsing context */
115 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
116 const char *zC /* The collating sequence name */
117){
drh261d8a52012-12-08 21:36:26 +0000118 Token s;
119 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000120 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000121 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000122}
123
124/*
drh0d950af2019-08-22 16:38:42 +0000125** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000126*/
127Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000128 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000129 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000130 pExpr = pExpr->pLeft;
131 }
132 return pExpr;
133}
134
135/*
136** Skip over any TK_COLLATE operators and/or any unlikely()
137** or likelihood() or likely() functions at the root of an
138** expression.
139*/
140Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000141 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000142 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drha4eeccd2021-10-07 17:43:30 +0000143 assert( ExprUseXList(pExpr) );
drhcca9f3d2013-09-06 15:23:29 +0000144 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000145 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000146 pExpr = pExpr->x.pList->a[0].pExpr;
147 }else{
drh46fe1382020-08-19 23:32:06 +0000148 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000149 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000150 }
drha4c3c872013-09-12 17:29:25 +0000151 }
drh0a8a4062012-12-07 18:38:16 +0000152 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000153}
154
155/*
drhae80dde2012-12-06 21:16:43 +0000156** Return the collation sequence for the expression pExpr. If
157** there is no defined collating sequence, return NULL.
158**
drh70efa842017-09-28 01:58:23 +0000159** See also: sqlite3ExprNNCollSeq()
160**
161** The sqlite3ExprNNCollSeq() works the same exact that it returns the
162** default collation if pExpr has no defined collation.
163**
drhae80dde2012-12-06 21:16:43 +0000164** The collating sequence might be determined by a COLLATE operator
165** or by the presence of a column with a defined collating sequence.
166** COLLATE operators take first precedence. Left operands take
167** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000168*/
drhe7375bf2020-03-10 19:24:38 +0000169CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000170 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000171 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000172 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000173 while( p ){
drhae80dde2012-12-06 21:16:43 +0000174 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000175 if( op==TK_REGISTER ) op = p->op2;
drh477572b2021-10-07 20:46:29 +0000176 if( op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER ){
drh63b3a642022-10-20 13:36:32 +0000177 int j;
drh477572b2021-10-07 20:46:29 +0000178 assert( ExprUseYTab(p) );
drh63b3a642022-10-20 13:36:32 +0000179 assert( p->y.pTab!=0 );
180 if( (j = p->iColumn)>=0 ){
181 const char *zColl = sqlite3ColumnColl(&p->y.pTab->aCol[j]);
182 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000183 }
drh63b3a642022-10-20 13:36:32 +0000184 break;
danielk19770202b292004-06-09 09:55:16 +0000185 }
drhe081d732018-07-27 18:19:12 +0000186 if( op==TK_CAST || op==TK_UPLUS ){
187 p = p->pLeft;
188 continue;
189 }
drh269d3222019-10-23 18:09:39 +0000190 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000191 assert( ExprUseXList(p) );
drh269d3222019-10-23 18:09:39 +0000192 p = p->x.pList->a[0].pExpr;
193 continue;
194 }
drhcb0e04f2018-12-12 21:34:17 +0000195 if( op==TK_COLLATE ){
drhf9751072021-10-07 13:40:29 +0000196 assert( !ExprHasProperty(p, EP_IntValue) );
drhe081d732018-07-27 18:19:12 +0000197 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
198 break;
199 }
drhae80dde2012-12-06 21:16:43 +0000200 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000201 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000202 p = p->pLeft;
203 }else{
drh2308ed32015-02-09 16:09:34 +0000204 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000205 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +0000206 assert( ExprUseXList(p) );
drh6728cd92015-02-09 18:28:03 +0000207 assert( p->x.pList==0 || p->pRight==0 );
drhb32b3092022-01-24 20:16:37 +0000208 if( p->x.pList!=0 && !db->mallocFailed ){
drh2308ed32015-02-09 16:09:34 +0000209 int i;
drh5b107652020-07-13 15:35:08 +0000210 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000211 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
212 pNext = p->x.pList->a[i].pExpr;
213 break;
214 }
215 }
216 }
217 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000218 }
219 }else{
drh7d10d5a2008-08-20 16:35:10 +0000220 break;
221 }
danielk19770202b292004-06-09 09:55:16 +0000222 }
danielk19777cedc8d2004-06-10 10:50:08 +0000223 if( sqlite3CheckCollSeq(pParse, pColl) ){
224 pColl = 0;
225 }
226 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000227}
228
229/*
drh70efa842017-09-28 01:58:23 +0000230** Return the collation sequence for the expression pExpr. If
231** there is no defined collating sequence, return a pointer to the
232** defautl collation sequence.
233**
234** See also: sqlite3ExprCollSeq()
235**
236** The sqlite3ExprCollSeq() routine works the same except that it
237** returns NULL if there is no defined collation.
238*/
drhe7375bf2020-03-10 19:24:38 +0000239CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000240 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
241 if( p==0 ) p = pParse->db->pDfltColl;
242 assert( p!=0 );
243 return p;
244}
245
246/*
247** Return TRUE if the two expressions have equivalent collating sequences.
248*/
drhe7375bf2020-03-10 19:24:38 +0000249int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000250 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
251 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
252 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
253}
254
255/*
drh626a8792005-01-17 22:08:19 +0000256** pExpr is an operand of a comparison operator. aff2 is the
257** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000258** type affinity that should be used for the comparison operator.
259*/
drhe7375bf2020-03-10 19:24:38 +0000260char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000261 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000262 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000263 /* Both sides of the comparison are columns. If one has numeric
264 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000265 */
drh8a512562005-11-14 22:29:05 +0000266 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000267 return SQLITE_AFF_NUMERIC;
268 }else{
drh05883a32015-06-02 15:32:08 +0000269 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000270 }
danielk1977e014a832004-05-17 10:48:57 +0000271 }else{
272 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000273 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
274 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000275 }
276}
277
drh53db1452004-05-20 13:54:53 +0000278/*
279** pExpr is a comparison operator. Return the type affinity that should
280** be applied to both operands prior to doing the comparison.
281*/
drhe7375bf2020-03-10 19:24:38 +0000282static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000283 char aff;
284 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
285 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000286 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000287 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000288 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000289 if( pExpr->pRight ){
290 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
drha4eeccd2021-10-07 17:43:30 +0000291 }else if( ExprUseXSelect(pExpr) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000292 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000293 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000294 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000295 }
296 return aff;
297}
298
299/*
300** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
301** idx_affinity is the affinity of an indexed column. Return true
302** if the index with affinity idx_affinity may be used to implement
303** the comparison in pExpr.
304*/
drhe7375bf2020-03-10 19:24:38 +0000305int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000306 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000307 if( aff<SQLITE_AFF_TEXT ){
308 return 1;
drh8a512562005-11-14 22:29:05 +0000309 }
drh915e4342019-08-06 15:18:15 +0000310 if( aff==SQLITE_AFF_TEXT ){
311 return idx_affinity==SQLITE_AFF_TEXT;
312 }
313 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000314}
315
danielk1977a37cdde2004-05-16 11:15:36 +0000316/*
drh35573352008-01-08 23:54:25 +0000317** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000318** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000319*/
drhe7375bf2020-03-10 19:24:38 +0000320static u8 binaryCompareP5(
321 const Expr *pExpr1, /* Left operand */
322 const Expr *pExpr2, /* Right operand */
323 int jumpIfNull /* Extra flags added to P5 */
324){
drh35573352008-01-08 23:54:25 +0000325 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000326 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000327 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000328}
329
drha2e00042002-01-22 03:13:42 +0000330/*
danielk19770202b292004-06-09 09:55:16 +0000331** Return a pointer to the collation sequence that should be used by
332** a binary comparison operator comparing pLeft and pRight.
333**
334** If the left hand expression has a collating sequence type, then it is
335** used. Otherwise the collation sequence for the right hand expression
336** is used, or the default (BINARY) if neither expression has a collating
337** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000338**
339** Argument pRight (but not pLeft) may be a null pointer. In this case,
340** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000341*/
drh0a0e1312007-08-07 17:04:59 +0000342CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000343 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000344 const Expr *pLeft,
345 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000346){
drhec41dda2007-02-07 13:09:45 +0000347 CollSeq *pColl;
348 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000349 if( pLeft->flags & EP_Collate ){
350 pColl = sqlite3ExprCollSeq(pParse, pLeft);
351 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
352 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000353 }else{
354 pColl = sqlite3ExprCollSeq(pParse, pLeft);
355 if( !pColl ){
356 pColl = sqlite3ExprCollSeq(pParse, pRight);
357 }
danielk19770202b292004-06-09 09:55:16 +0000358 }
359 return pColl;
360}
361
drh898c5272019-10-22 00:03:41 +0000362/* Expresssion p is a comparison operator. Return a collation sequence
363** appropriate for the comparison operator.
364**
365** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
366** However, if the OP_Commuted flag is set, then the order of the operands
367** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
368** correct collating sequence is found.
369*/
drhe7375bf2020-03-10 19:24:38 +0000370CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000371 if( ExprHasProperty(p, EP_Commuted) ){
372 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
373 }else{
374 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
375 }
376}
377
danielk19770202b292004-06-09 09:55:16 +0000378/*
drhbe5c89a2004-07-26 00:31:09 +0000379** Generate code for a comparison operator.
380*/
381static int codeCompare(
382 Parse *pParse, /* The parsing (and code generating) context */
383 Expr *pLeft, /* The left operand */
384 Expr *pRight, /* The right operand */
385 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000386 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000387 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000388 int jumpIfNull, /* If true, jump if either operand is NULL */
389 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000390){
drh35573352008-01-08 23:54:25 +0000391 int p5;
392 int addr;
393 CollSeq *p4;
394
drh86541862019-12-19 20:37:32 +0000395 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000396 if( isCommuted ){
397 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
398 }else{
399 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
400 }
drh35573352008-01-08 23:54:25 +0000401 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
402 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
403 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000404 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000405 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000406}
407
dancfbb5e82016-07-13 19:48:13 +0000408/*
dan870a0702016-08-01 16:37:43 +0000409** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000410**
411** A vector is defined as any expression that results in two or more
412** columns of result. Every TK_VECTOR node is an vector because the
413** parser will not generate a TK_VECTOR with fewer than two entries.
414** But a TK_SELECT might be either a vector or a scalar. It is only
415** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000416*/
drhb6dad522021-09-24 16:14:47 +0000417int sqlite3ExprIsVector(const Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000418 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000419}
420
421/*
dancfbb5e82016-07-13 19:48:13 +0000422** If the expression passed as the only argument is of type TK_VECTOR
423** return the number of expressions in the vector. Or, if the expression
424** is a sub-select, return the number of columns in the sub-select. For
425** any other type of expression, return 1.
426*/
drhb6dad522021-09-24 16:14:47 +0000427int sqlite3ExprVectorSize(const Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000428 u8 op = pExpr->op;
429 if( op==TK_REGISTER ) op = pExpr->op2;
430 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000431 assert( ExprUseXList(pExpr) );
drh76dbe7a2016-08-20 21:02:38 +0000432 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000433 }else if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000434 assert( ExprUseXSelect(pExpr) );
dan71c57db2016-07-09 20:23:55 +0000435 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000436 }else{
437 return 1;
dan71c57db2016-07-09 20:23:55 +0000438 }
dan71c57db2016-07-09 20:23:55 +0000439}
440
danba00e302016-07-23 20:24:06 +0000441/*
drhfc7f27b2016-08-20 00:07:01 +0000442** Return a pointer to a subexpression of pVector that is the i-th
443** column of the vector (numbered starting with 0). The caller must
444** ensure that i is within range.
445**
drh76dbe7a2016-08-20 21:02:38 +0000446** If pVector is really a scalar (and "scalar" here includes subqueries
447** that return a single column!) then return pVector unmodified.
448**
drhfc7f27b2016-08-20 00:07:01 +0000449** pVector retains ownership of the returned subexpression.
450**
451** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000452** just the expression for the i-th term of the result set, and may
453** not be ready for evaluation because the table cursor has not yet
454** been positioned.
danba00e302016-07-23 20:24:06 +0000455*/
drhfc7f27b2016-08-20 00:07:01 +0000456Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
drhbf7f3a02021-05-24 11:35:16 +0000457 assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
dan870a0702016-08-01 16:37:43 +0000458 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000459 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
460 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000461 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000462 return pVector->x.pSelect->pEList->a[i].pExpr;
463 }else{
drha4eeccd2021-10-07 17:43:30 +0000464 assert( ExprUseXList(pVector) );
dan870a0702016-08-01 16:37:43 +0000465 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 */
drh10f08272021-07-05 01:11:26 +0000495 int iField, /* Which column of the vector to return */
496 int nField /* Total number of columns in the vector */
drhfc7f27b2016-08-20 00:07:01 +0000497){
498 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000499 if( pVector->op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000500 assert( ExprUseXSelect(pVector) );
drhfc7f27b2016-08-20 00:07:01 +0000501 /* The TK_SELECT_COLUMN Expr node:
502 **
drh966e2912017-01-03 02:58:01 +0000503 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000504 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000505 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000506 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000507 ** pLeft->iTable: First in an array of register holding result, or 0
508 ** if the result is not yet computed.
509 **
510 ** sqlite3ExprDelete() specifically skips the recursive delete of
511 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000512 ** can be attached to pRight to cause this node to take ownership of
513 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
514 ** with the same pLeft pointer to the pVector, but only one of them
515 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000516 */
drhabfd35e2016-12-06 22:47:23 +0000517 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000518 if( pRet ){
drh10f08272021-07-05 01:11:26 +0000519 pRet->iTable = nField;
drh8bd0d582016-08-20 18:06:14 +0000520 pRet->iColumn = iField;
521 pRet->pLeft = pVector;
522 }
drhfc7f27b2016-08-20 00:07:01 +0000523 }else{
danab632bc2021-09-29 18:33:26 +0000524 if( pVector->op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000525 Expr **ppVector;
526 assert( ExprUseXList(pVector) );
527 ppVector = &pVector->x.pList->a[iField].pExpr;
danab632bc2021-09-29 18:33:26 +0000528 pVector = *ppVector;
529 if( IN_RENAME_OBJECT ){
530 /* This must be a vector UPDATE inside a trigger */
531 *ppVector = 0;
532 return pVector;
533 }
dan5a69d192021-09-27 15:44:03 +0000534 }
danab632bc2021-09-29 18:33:26 +0000535 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
drhfc7f27b2016-08-20 00:07:01 +0000536 }
537 return pRet;
538}
dan71c57db2016-07-09 20:23:55 +0000539
dan5c288b92016-07-30 21:02:33 +0000540/*
541** If expression pExpr is of type TK_SELECT, generate code to evaluate
542** it. Return the register in which the result is stored (or, if the
543** sub-select returns more than one column, the first in an array
544** of registers in which the result is stored).
545**
546** If pExpr is not a TK_SELECT expression, return 0.
547*/
548static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000549 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000550#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000551 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000552 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000553 }
danf9b2e052016-08-02 17:45:00 +0000554#endif
dan8da209b2016-07-26 18:06:08 +0000555 return reg;
556}
557
dan5c288b92016-07-30 21:02:33 +0000558/*
559** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000560** or TK_SELECT that returns more than one column. This function returns
561** the register number of a register that contains the value of
562** element iField of the vector.
563**
564** If pVector is a TK_SELECT expression, then code for it must have
565** already been generated using the exprCodeSubselect() routine. In this
566** case parameter regSelect should be the first in an array of registers
567** containing the results of the sub-select.
568**
569** If pVector is of type TK_VECTOR, then code for the requested field
570** is generated. In this case (*pRegFree) may be set to the number of
571** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000572**
573** Before returning, output parameter (*ppExpr) is set to point to the
574** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000575*/
576static int exprVectorRegister(
577 Parse *pParse, /* Parse context */
578 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000579 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000580 int regSelect, /* First in array of registers */
581 Expr **ppExpr, /* OUT: Expression element */
582 int *pRegFree /* OUT: Temp register to free */
583){
drh12abf402016-08-22 14:30:05 +0000584 u8 op = pVector->op;
drh05428122021-05-24 00:17:04 +0000585 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
drh12abf402016-08-22 14:30:05 +0000586 if( op==TK_REGISTER ){
587 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
588 return pVector->iTable+iField;
589 }
590 if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000591 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000592 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
593 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000594 }
drh05428122021-05-24 00:17:04 +0000595 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000596 assert( ExprUseXList(pVector) );
drh05428122021-05-24 00:17:04 +0000597 *ppExpr = pVector->x.pList->a[iField].pExpr;
598 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
599 }
600 return 0;
dan5c288b92016-07-30 21:02:33 +0000601}
602
603/*
604** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000605** the result of the comparison (1, 0, or NULL) and write that
606** result into register dest.
607**
608** The caller must satisfy the following preconditions:
609**
610** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
611** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
612** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000613*/
drh79752b62016-08-13 10:02:17 +0000614static void codeVectorCompare(
615 Parse *pParse, /* Code generator context */
616 Expr *pExpr, /* The comparison operation */
617 int dest, /* Write results into this register */
618 u8 op, /* Comparison operator */
619 u8 p5 /* SQLITE_NULLEQ or zero */
620){
dan71c57db2016-07-09 20:23:55 +0000621 Vdbe *v = pParse->pVdbe;
622 Expr *pLeft = pExpr->pLeft;
623 Expr *pRight = pExpr->pRight;
624 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000625 int i;
626 int regLeft = 0;
627 int regRight = 0;
628 u8 opx = op;
drh4bc20452021-03-29 18:53:47 +0000629 int addrCmp = 0;
drhec4ccdb2018-12-29 02:26:59 +0000630 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000631 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000632
drhe7375bf2020-03-10 19:24:38 +0000633 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh340fd0b2021-03-19 16:29:40 +0000634 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000635 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
636 sqlite3ErrorMsg(pParse, "row value misused");
637 return;
638 }
drhb29e60c2016-09-05 12:02:34 +0000639 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
640 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
641 || pExpr->op==TK_LT || pExpr->op==TK_GT
642 || pExpr->op==TK_LE || pExpr->op==TK_GE
643 );
644 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
645 || (pExpr->op==TK_ISNOT && op==TK_NE) );
646 assert( p5==0 || pExpr->op!=op );
647 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000648
drh4bc20452021-03-29 18:53:47 +0000649 if( op==TK_LE ) opx = TK_LT;
650 if( op==TK_GE ) opx = TK_GT;
651 if( op==TK_NE ) opx = TK_EQ;
dan71c57db2016-07-09 20:23:55 +0000652
drhb29e60c2016-09-05 12:02:34 +0000653 regLeft = exprCodeSubselect(pParse, pLeft);
654 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000655
drh4bc20452021-03-29 18:53:47 +0000656 sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
drhb29e60c2016-09-05 12:02:34 +0000657 for(i=0; 1 /*Loop exits by "break"*/; i++){
658 int regFree1 = 0, regFree2 = 0;
drhabc15f12021-06-04 16:11:19 +0000659 Expr *pL = 0, *pR = 0;
drhb29e60c2016-09-05 12:02:34 +0000660 int r1, r2;
661 assert( i>=0 && i<nLeft );
drh4bc20452021-03-29 18:53:47 +0000662 if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000663 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
664 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh4bc20452021-03-29 18:53:47 +0000665 addrCmp = sqlite3VdbeCurrentAddr(v);
666 codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000667 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
668 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
669 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
670 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
671 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
672 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
673 sqlite3ReleaseTempReg(pParse, regFree1);
674 sqlite3ReleaseTempReg(pParse, regFree2);
drh4bc20452021-03-29 18:53:47 +0000675 if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
676 addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
677 testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
678 testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
679 }
680 if( p5==SQLITE_NULLEQ ){
681 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
682 }else{
683 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
684 }
drhb29e60c2016-09-05 12:02:34 +0000685 if( i==nLeft-1 ){
686 break;
dan71c57db2016-07-09 20:23:55 +0000687 }
drhb29e60c2016-09-05 12:02:34 +0000688 if( opx==TK_EQ ){
drh4bc20452021-03-29 18:53:47 +0000689 sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
drhb29e60c2016-09-05 12:02:34 +0000690 }else{
691 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
drh4bc20452021-03-29 18:53:47 +0000692 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
drhb29e60c2016-09-05 12:02:34 +0000693 if( i==nLeft-2 ) opx = op;
694 }
dan71c57db2016-07-09 20:23:55 +0000695 }
drh4bc20452021-03-29 18:53:47 +0000696 sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000697 sqlite3VdbeResolveLabel(v, addrDone);
drh4bc20452021-03-29 18:53:47 +0000698 if( op==TK_NE ){
699 sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
700 }
dan71c57db2016-07-09 20:23:55 +0000701}
702
danielk19774b5255a2008-06-05 16:47:39 +0000703#if SQLITE_MAX_EXPR_DEPTH>0
704/*
705** Check that argument nHeight is less than or equal to the maximum
706** expression depth allowed. If it is not, leave an error message in
707** pParse.
708*/
drh7d10d5a2008-08-20 16:35:10 +0000709int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000710 int rc = SQLITE_OK;
711 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
712 if( nHeight>mxHeight ){
713 sqlite3ErrorMsg(pParse,
714 "Expression tree is too large (maximum depth %d)", mxHeight
715 );
716 rc = SQLITE_ERROR;
717 }
718 return rc;
719}
720
721/* The following three functions, heightOfExpr(), heightOfExprList()
722** and heightOfSelect(), are used to determine the maximum height
723** of any expression tree referenced by the structure passed as the
724** first argument.
725**
726** If this maximum height is greater than the current value pointed
727** to by pnHeight, the second parameter, then set *pnHeight to that
728** value.
729*/
drhb6dad522021-09-24 16:14:47 +0000730static void heightOfExpr(const Expr *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000731 if( p ){
732 if( p->nHeight>*pnHeight ){
733 *pnHeight = p->nHeight;
734 }
735 }
736}
drhb6dad522021-09-24 16:14:47 +0000737static void heightOfExprList(const ExprList *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000738 if( p ){
739 int i;
740 for(i=0; i<p->nExpr; i++){
741 heightOfExpr(p->a[i].pExpr, pnHeight);
742 }
743 }
744}
drhb6dad522021-09-24 16:14:47 +0000745static void heightOfSelect(const Select *pSelect, int *pnHeight){
746 const Select *p;
dan1a3a3082018-01-18 19:00:54 +0000747 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000748 heightOfExpr(p->pWhere, pnHeight);
749 heightOfExpr(p->pHaving, pnHeight);
750 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000751 heightOfExprList(p->pEList, pnHeight);
752 heightOfExprList(p->pGroupBy, pnHeight);
753 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000754 }
755}
756
757/*
758** Set the Expr.nHeight variable in the structure passed as an
759** argument. An expression with no children, Expr.pList or
760** Expr.pSelect member has a height of 1. Any other expression
761** has a height equal to the maximum height of any other
762** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000763**
764** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
765** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000766*/
767static void exprSetHeight(Expr *p){
drh2ef11112022-02-06 11:51:23 +0000768 int nHeight = p->pLeft ? p->pLeft->nHeight : 0;
drh47e2fe32022-07-25 20:21:57 +0000769 if( NEVER(p->pRight) && p->pRight->nHeight>nHeight ){
770 nHeight = p->pRight->nHeight;
771 }
drha4eeccd2021-10-07 17:43:30 +0000772 if( ExprUseXSelect(p) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000773 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000774 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000775 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000776 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000777 }
danielk19774b5255a2008-06-05 16:47:39 +0000778 p->nHeight = nHeight + 1;
779}
780
781/*
782** Set the Expr.nHeight variable using the exprSetHeight() function. If
783** the height is greater than the maximum allowed expression depth,
784** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000785**
786** Also propagate all EP_Propagate flags from the Expr.x.pList into
787** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000788*/
drh2308ed32015-02-09 16:09:34 +0000789void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000790 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000791 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000792 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000793}
794
795/*
796** Return the maximum height of any expression tree referenced
797** by the select statement passed as an argument.
798*/
drhb6dad522021-09-24 16:14:47 +0000799int sqlite3SelectExprHeight(const Select *p){
danielk19774b5255a2008-06-05 16:47:39 +0000800 int nHeight = 0;
801 heightOfSelect(p, &nHeight);
802 return nHeight;
803}
drh2308ed32015-02-09 16:09:34 +0000804#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
805/*
806** Propagate all EP_Propagate flags from the Expr.x.pList into
807** Expr.flags.
808*/
809void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000810 if( pParse->nErr ) return;
drha4eeccd2021-10-07 17:43:30 +0000811 if( p && ExprUseXList(p) && p->x.pList ){
drh2308ed32015-02-09 16:09:34 +0000812 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
813 }
814}
815#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000816#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
817
drhbe5c89a2004-07-26 00:31:09 +0000818/*
drhb7916a72009-05-27 10:31:29 +0000819** This routine is the core allocator for Expr nodes.
820**
drha76b5df2002-02-23 02:32:10 +0000821** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000822** for this node and for the pToken argument is a single allocation
823** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000824** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000825**
826** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000827** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000828** parameter is ignored if pToken is NULL or if the token does not
829** appear to be quoted. If the quotes were of the form "..." (double-quotes)
830** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000831**
832** Special case: If op==TK_INTEGER and pToken points to a string that
833** can be translated into a 32-bit integer, then the token is not
834** stored in u.zToken. Instead, the integer values is written
835** into u.iValue and the EP_IntValue flag is set. No extra storage
836** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000837*/
drhb7916a72009-05-27 10:31:29 +0000838Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000839 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000840 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000841 const Token *pToken, /* Token argument. Might be NULL */
842 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000843){
drha76b5df2002-02-23 02:32:10 +0000844 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000845 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000846 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000847
drh575fad62016-02-05 13:38:36 +0000848 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000849 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000850 if( op!=TK_INTEGER || pToken->z==0
851 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
852 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000853 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000854 }
drhb7916a72009-05-27 10:31:29 +0000855 }
drh575fad62016-02-05 13:38:36 +0000856 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000857 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000858 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000859 pNew->op = (u8)op;
860 pNew->iAgg = -1;
861 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000862 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000863 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000864 pNew->u.iValue = iValue;
865 }else{
drh33e619f2009-05-28 01:00:55 +0000866 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000867 assert( pToken->z!=0 || pToken->n==0 );
868 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000869 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000870 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000871 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000872 }
drhb7916a72009-05-27 10:31:29 +0000873 }
874 }
875#if SQLITE_MAX_EXPR_DEPTH>0
876 pNew->nHeight = 1;
877#endif
878 }
drha76b5df2002-02-23 02:32:10 +0000879 return pNew;
880}
881
882/*
drhb7916a72009-05-27 10:31:29 +0000883** Allocate a new expression node from a zero-terminated token that has
884** already been dequoted.
885*/
886Expr *sqlite3Expr(
887 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
888 int op, /* Expression opcode */
889 const char *zToken /* Token argument. Might be NULL */
890){
891 Token x;
892 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000893 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000894 return sqlite3ExprAlloc(db, op, &x, 0);
895}
896
897/*
898** Attach subtrees pLeft and pRight to the Expr node pRoot.
899**
900** If pRoot==NULL that means that a memory allocation error has occurred.
901** In that case, delete the subtrees pLeft and pRight.
902*/
903void sqlite3ExprAttachSubtrees(
904 sqlite3 *db,
905 Expr *pRoot,
906 Expr *pLeft,
907 Expr *pRight
908){
909 if( pRoot==0 ){
910 assert( db->mallocFailed );
911 sqlite3ExprDelete(db, pLeft);
912 sqlite3ExprDelete(db, pRight);
913 }else{
drh47e2fe32022-07-25 20:21:57 +0000914 assert( ExprUseXList(pRoot) );
915 assert( pRoot->x.pSelect==0 );
drhb7916a72009-05-27 10:31:29 +0000916 if( pRight ){
917 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000918 pRoot->flags |= EP_Propagate & pRight->flags;
drh47e2fe32022-07-25 20:21:57 +0000919#if SQLITE_MAX_EXPR_DEPTH>0
920 pRoot->nHeight = pRight->nHeight+1;
921 }else{
922 pRoot->nHeight = 1;
923#endif
drhb7916a72009-05-27 10:31:29 +0000924 }
925 if( pLeft ){
926 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000927 pRoot->flags |= EP_Propagate & pLeft->flags;
drh47e2fe32022-07-25 20:21:57 +0000928#if SQLITE_MAX_EXPR_DEPTH>0
929 if( pLeft->nHeight>=pRoot->nHeight ){
930 pRoot->nHeight = pLeft->nHeight+1;
931 }
932#endif
drhb7916a72009-05-27 10:31:29 +0000933 }
drhb7916a72009-05-27 10:31:29 +0000934 }
935}
936
937/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000938** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000939**
drhbf664462009-06-19 18:32:54 +0000940** One or both of the subtrees can be NULL. Return a pointer to the new
941** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
942** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000943*/
drh17435752007-08-16 04:30:38 +0000944Expr *sqlite3PExpr(
945 Parse *pParse, /* Parsing context */
946 int op, /* Expression opcode */
947 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000948 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000949){
drh5fb52ca2012-03-31 02:34:35 +0000950 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000951 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
952 if( p ){
953 memset(p, 0, sizeof(Expr));
954 p->op = op & 0xff;
955 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000956 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000957 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000958 }else{
959 sqlite3ExprDelete(pParse->db, pLeft);
960 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000961 }
drh4e0cff62004-11-05 05:10:28 +0000962 return p;
963}
964
965/*
drh08de4f72016-04-11 01:06:47 +0000966** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
967** do a memory allocation failure) then delete the pSelect object.
968*/
969void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
970 if( pExpr ){
971 pExpr->x.pSelect = pSelect;
972 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
973 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
974 }else{
975 assert( pParse->db->mallocFailed );
976 sqlite3SelectDelete(pParse->db, pSelect);
977 }
978}
979
dan9289f512021-07-06 20:44:32 +0000980/*
981** Expression list pEList is a list of vector values. This function
982** converts the contents of pEList to a VALUES(...) Select statement
dan74777f92021-07-07 13:53:55 +0000983** returning 1 row for each element of the list. For example, the
984** expression list:
dan9289f512021-07-06 20:44:32 +0000985**
dan74777f92021-07-07 13:53:55 +0000986** ( (1,2), (3,4) (5,6) )
dan9289f512021-07-06 20:44:32 +0000987**
dan74777f92021-07-07 13:53:55 +0000988** is translated to the equivalent of:
dan9289f512021-07-06 20:44:32 +0000989**
dan74777f92021-07-07 13:53:55 +0000990** VALUES(1,2), (3,4), (5,6)
dan9289f512021-07-06 20:44:32 +0000991**
dan74777f92021-07-07 13:53:55 +0000992** Each of the vector values in pEList must contain exactly nElem terms.
993** If a list element that is not a vector or does not contain nElem terms,
994** an error message is left in pParse.
dan9289f512021-07-06 20:44:32 +0000995**
996** This is used as part of processing IN(...) expressions with a list
997** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
998*/
dan74777f92021-07-07 13:53:55 +0000999Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
dan9289f512021-07-06 20:44:32 +00001000 int ii;
1001 Select *pRet = 0;
dan2931a662021-07-07 15:52:44 +00001002 assert( nElem>1 );
dan9289f512021-07-06 20:44:32 +00001003 for(ii=0; ii<pEList->nExpr; ii++){
1004 Select *pSel;
dan9289f512021-07-06 20:44:32 +00001005 Expr *pExpr = pEList->a[ii].pExpr;
drha4eeccd2021-10-07 17:43:30 +00001006 int nExprElem;
1007 if( pExpr->op==TK_VECTOR ){
1008 assert( ExprUseXList(pExpr) );
1009 nExprElem = pExpr->x.pList->nExpr;
1010 }else{
1011 nExprElem = 1;
1012 }
dan74777f92021-07-07 13:53:55 +00001013 if( nExprElem!=nElem ){
1014 sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
1015 nExprElem, nExprElem>1?"s":"", nElem
1016 );
1017 break;
dan9289f512021-07-06 20:44:32 +00001018 }
drha4eeccd2021-10-07 17:43:30 +00001019 assert( ExprUseXList(pExpr) );
dan74777f92021-07-07 13:53:55 +00001020 pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
1021 pExpr->x.pList = 0;
dan9289f512021-07-06 20:44:32 +00001022 if( pSel ){
1023 if( pRet ){
1024 pSel->op = TK_ALL;
1025 pSel->pPrior = pRet;
1026 }
1027 pRet = pSel;
1028 }
1029 }
1030
1031 if( pRet && pRet->pPrior ){
1032 pRet->selFlags |= SF_MultiValue;
1033 }
1034 sqlite3ExprListDelete(pParse->db, pEList);
1035 return pRet;
1036}
drh08de4f72016-04-11 01:06:47 +00001037
1038/*
drh91bb0ee2004-09-01 03:06:34 +00001039** Join two expressions using an AND operator. If either expression is
1040** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +00001041**
1042** If one side or the other of the AND is known to be false, then instead
1043** of returning an AND expression, just return a constant expression with
1044** a value of false.
drh91bb0ee2004-09-01 03:06:34 +00001045*/
drhd5c851c2019-04-19 13:38:34 +00001046Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1047 sqlite3 *db = pParse->db;
1048 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +00001049 return pRight;
1050 }else if( pRight==0 ){
1051 return pLeft;
dan2b6e6702019-12-30 06:55:31 +00001052 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
1053 && !IN_RENAME_OBJECT
1054 ){
drhb3ad4e62021-03-31 13:31:33 +00001055 sqlite3ExprDeferredDelete(pParse, pLeft);
1056 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +00001057 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +00001058 }else{
drhd5c851c2019-04-19 13:38:34 +00001059 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +00001060 }
1061}
1062
1063/*
1064** Construct a new expression node for a function with multiple
1065** arguments.
1066*/
drh954733b2018-07-27 23:33:16 +00001067Expr *sqlite3ExprFunction(
1068 Parse *pParse, /* Parsing context */
1069 ExprList *pList, /* Argument list */
drhb6dad522021-09-24 16:14:47 +00001070 const Token *pToken, /* Name of the function */
drh954733b2018-07-27 23:33:16 +00001071 int eDistinct /* SF_Distinct or SF_ALL or 0 */
1072){
drha76b5df2002-02-23 02:32:10 +00001073 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +00001074 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +00001075 assert( pToken );
drhb7916a72009-05-27 10:31:29 +00001076 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +00001077 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +00001078 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +00001079 return 0;
1080 }
drha6e8ee12022-05-13 16:38:40 +00001081 assert( !ExprHasProperty(pNew, EP_InnerON|EP_OuterON) );
drh62fc0692022-02-06 00:30:04 +00001082 pNew->w.iOfst = (int)(pToken->z - pParse->zTail);
drh14a1b1c2021-06-30 11:53:21 +00001083 if( pList
1084 && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
1085 && !pParse->nested
1086 ){
drh954733b2018-07-27 23:33:16 +00001087 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1088 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001089 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +00001090 ExprSetProperty(pNew, EP_HasFunc);
drha4eeccd2021-10-07 17:43:30 +00001091 assert( ExprUseXList(pNew) );
drh2308ed32015-02-09 16:09:34 +00001092 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +00001093 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +00001094 return pNew;
1095}
1096
1097/*
drh0dfa5252020-01-08 17:28:19 +00001098** Check to see if a function is usable according to current access
1099** rules:
1100**
1101** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1102**
1103** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1104** top-level SQL
1105**
1106** If the function is not usable, create an error.
1107*/
1108void sqlite3ExprFunctionUsable(
1109 Parse *pParse, /* Parsing and code generating context */
drhb6dad522021-09-24 16:14:47 +00001110 const Expr *pExpr, /* The function invocation */
1111 const FuncDef *pDef /* The function being invoked */
drh0dfa5252020-01-08 17:28:19 +00001112){
1113 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001114 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1115 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001116 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1117 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1118 ){
1119 /* Functions prohibited in triggers and views if:
1120 ** (1) tagged with SQLITE_DIRECTONLY
1121 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1122 ** is tagged with SQLITE_FUNC_UNSAFE) and
1123 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1124 ** that the schema is possibly tainted).
1125 */
drh62fc0692022-02-06 00:30:04 +00001126 sqlite3ErrorMsg(pParse, "unsafe use of %#T()", pExpr);
drh0dfa5252020-01-08 17:28:19 +00001127 }
1128 }
1129}
1130
1131/*
drhfa6bc002004-09-07 16:19:52 +00001132** Assign a variable number to an expression that encodes a wildcard
1133** in the original SQL statement.
1134**
1135** Wildcards consisting of a single "?" are assigned the next sequential
1136** variable number.
1137**
1138** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001139** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001140** the SQL statement comes from an external source.
1141**
drh51f49f12009-05-21 20:41:32 +00001142** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001143** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001144** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001145** assigned.
1146*/
drhde25a882016-10-03 15:28:24 +00001147void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001148 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001149 const char *z;
drhf326d662016-12-23 13:30:53 +00001150 ynVar x;
drh17435752007-08-16 04:30:38 +00001151
drhfa6bc002004-09-07 16:19:52 +00001152 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001153 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001154 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001155 assert( z!=0 );
1156 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001157 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001158 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001159 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001160 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001161 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001162 }else{
drhf326d662016-12-23 13:30:53 +00001163 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001164 if( z[0]=='?' ){
1165 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1166 ** use it as the variable number */
1167 i64 i;
drh18814df2017-01-31 03:52:34 +00001168 int bOk;
1169 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1170 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1171 bOk = 1;
1172 }else{
1173 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1174 }
drh124c0b42011-06-01 18:15:55 +00001175 testcase( i==0 );
1176 testcase( i==1 );
1177 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1178 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1179 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1180 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1181 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drh62fc0692022-02-06 00:30:04 +00001182 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
drhc9b39282016-10-03 16:33:14 +00001183 return;
drhfa6bc002004-09-07 16:19:52 +00001184 }
drh8e74e7b2017-01-31 12:41:48 +00001185 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001186 if( x>pParse->nVar ){
1187 pParse->nVar = (int)x;
1188 doAdd = 1;
1189 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1190 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001191 }
1192 }else{
1193 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1194 ** number as the prior appearance of the same name, or if the name
1195 ** has never appeared before, reuse the same variable number
1196 */
drh9bf755c2016-12-23 03:59:31 +00001197 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1198 if( x==0 ){
1199 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001200 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001201 }
drhfa6bc002004-09-07 16:19:52 +00001202 }
drhf326d662016-12-23 13:30:53 +00001203 if( doAdd ){
1204 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1205 }
1206 }
1207 pExpr->iColumn = x;
1208 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001209 sqlite3ErrorMsg(pParse, "too many SQL variables");
drh62fc0692022-02-06 00:30:04 +00001210 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
danielk1977832b2662007-05-09 11:37:22 +00001211 }
drhfa6bc002004-09-07 16:19:52 +00001212}
1213
1214/*
danf6963f92009-11-23 14:39:14 +00001215** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001216*/
drh4f0010b2016-04-11 14:49:39 +00001217static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1218 assert( p!=0 );
drh41ce47c2022-08-22 02:00:26 +00001219 assert( db!=0 );
drh477572b2021-10-07 20:46:29 +00001220 assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1221 assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1222 assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1223 assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
drh209bc522016-09-23 21:36:24 +00001224#ifdef SQLITE_DEBUG
1225 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1226 assert( p->pLeft==0 );
1227 assert( p->pRight==0 );
drha4eeccd2021-10-07 17:43:30 +00001228 assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1229 assert( !ExprUseXList(p) || p->x.pList==0 );
drh209bc522016-09-23 21:36:24 +00001230 }
1231#endif
1232 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001233 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +00001234 assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001235 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001236 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001237 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001238 sqlite3ExprDeleteNN(db, p->pRight);
drha4eeccd2021-10-07 17:43:30 +00001239 }else if( ExprUseXSelect(p) ){
dan4f9adee2019-07-13 16:22:50 +00001240 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001241 sqlite3SelectDelete(db, p->x.pSelect);
1242 }else{
1243 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001244#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001245 if( ExprHasProperty(p, EP_WinFunc) ){
1246 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001247 }
dan6ba7ab02019-07-02 11:56:47 +00001248#endif
dan8117f112019-07-10 20:16:53 +00001249 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001250 }
drh33e619f2009-05-28 01:00:55 +00001251 if( !ExprHasProperty(p, EP_Static) ){
drh41ce47c2022-08-22 02:00:26 +00001252 sqlite3DbNNFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001253 }
drha2e00042002-01-22 03:13:42 +00001254}
drh4f0010b2016-04-11 14:49:39 +00001255void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1256 if( p ) sqlite3ExprDeleteNN(db, p);
1257}
drha2e00042002-01-22 03:13:42 +00001258
drhd44f8b22022-04-07 01:11:13 +00001259/*
1260** Clear both elements of an OnOrUsing object
1261*/
1262void sqlite3ClearOnOrUsing(sqlite3 *db, OnOrUsing *p){
1263 if( p==0 ){
1264 /* Nothing to clear */
1265 }else if( p->pOn ){
1266 sqlite3ExprDeleteNN(db, p->pOn);
1267 }else if( p->pUsing ){
1268 sqlite3IdListDelete(db, p->pUsing);
1269 }
1270}
drhb3ad4e62021-03-31 13:31:33 +00001271
1272/*
1273** Arrange to cause pExpr to be deleted when the pParse is deleted.
1274** This is similar to sqlite3ExprDelete() except that the delete is
1275** deferred untilthe pParse is deleted.
1276**
1277** The pExpr might be deleted immediately on an OOM error.
1278**
1279** The deferred delete is (currently) implemented by adding the
1280** pExpr to the pParse->pConstExpr list with a register number of 0.
1281*/
1282void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
drhee6b80c2022-07-23 00:44:44 +00001283 sqlite3ParserAddCleanup(pParse,
1284 (void(*)(sqlite3*,void*))sqlite3ExprDelete,
1285 pExpr);
drhb3ad4e62021-03-31 13:31:33 +00001286}
1287
drh8e34e402019-06-11 10:43:56 +00001288/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1289** expression.
1290*/
1291void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1292 if( p ){
1293 if( IN_RENAME_OBJECT ){
1294 sqlite3RenameExprUnmap(pParse, p);
1295 }
1296 sqlite3ExprDeleteNN(pParse->db, p);
1297 }
1298}
1299
drhd2687b72005-08-12 22:56:09 +00001300/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001301** Return the number of bytes allocated for the expression structure
1302** passed as the first argument. This is always one of EXPR_FULLSIZE,
1303** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1304*/
drhb6dad522021-09-24 16:14:47 +00001305static int exprStructSize(const Expr *p){
danielk19776ab3a2e2009-02-19 14:39:25 +00001306 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001307 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1308 return EXPR_FULLSIZE;
1309}
1310
1311/*
drh33e619f2009-05-28 01:00:55 +00001312** The dupedExpr*Size() routines each return the number of bytes required
1313** to store a copy of an expression or expression tree. They differ in
1314** how much of the tree is measured.
1315**
1316** dupedExprStructSize() Size of only the Expr structure
1317** dupedExprNodeSize() Size of Expr + space for token
1318** dupedExprSize() Expr + token + subtree components
1319**
1320***************************************************************************
1321**
1322** The dupedExprStructSize() function returns two values OR-ed together:
1323** (1) the space required for a copy of the Expr structure only and
1324** (2) the EP_xxx flags that indicate what the structure size should be.
1325** The return values is always one of:
1326**
1327** EXPR_FULLSIZE
1328** EXPR_REDUCEDSIZE | EP_Reduced
1329** EXPR_TOKENONLYSIZE | EP_TokenOnly
1330**
1331** The size of the structure can be found by masking the return value
1332** of this routine with 0xfff. The flags can be found by masking the
1333** return value with EP_Reduced|EP_TokenOnly.
1334**
1335** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1336** (unreduced) Expr objects as they or originally constructed by the parser.
1337** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001338** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001339** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001340** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001341** to reduce a pristine expression tree from the parser. The implementation
1342** of dupedExprStructSize() contain multiple assert() statements that attempt
1343** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001344*/
drhb6dad522021-09-24 16:14:47 +00001345static int dupedExprStructSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001346 int nSize;
drh33e619f2009-05-28 01:00:55 +00001347 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001348 assert( EXPR_FULLSIZE<=0xfff );
1349 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001350 if( 0==flags || p->op==TK_SELECT_COLUMN
1351#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001352 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001353#endif
1354 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001355 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001356 }else{
drhc5cd1242013-09-12 16:50:49 +00001357 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh67a99db2022-05-13 14:52:04 +00001358 assert( !ExprHasProperty(p, EP_OuterON) );
drhe7375bf2020-03-10 19:24:38 +00001359 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001360 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001361 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1362 }else{
drhaecd8022013-09-13 18:15:15 +00001363 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001364 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1365 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001366 }
1367 return nSize;
1368}
1369
1370/*
drh33e619f2009-05-28 01:00:55 +00001371** This function returns the space in bytes required to store the copy
1372** of the Expr structure and a copy of the Expr.u.zToken string (if that
1373** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001374*/
drhb6dad522021-09-24 16:14:47 +00001375static int dupedExprNodeSize(const Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001376 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1377 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001378 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001379 }
danielk1977bc739712009-03-23 04:33:32 +00001380 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001381}
1382
1383/*
1384** Return the number of bytes required to create a duplicate of the
1385** expression passed as the first argument. The second argument is a
1386** mask containing EXPRDUP_XXX flags.
1387**
1388** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001389** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001390**
1391** If the EXPRDUP_REDUCE flag is set, then the return value includes
1392** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1393** and Expr.pRight variables (but not for any structures pointed to or
1394** descended from the Expr.x.pList or Expr.x.pSelect variables).
1395*/
drhb6dad522021-09-24 16:14:47 +00001396static int dupedExprSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001397 int nByte = 0;
1398 if( p ){
1399 nByte = dupedExprNodeSize(p, flags);
1400 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001401 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001402 }
1403 }
1404 return nByte;
1405}
1406
1407/*
1408** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1409** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001410** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001411** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001412** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001413** portion of the buffer copied into by this function.
1414*/
drhb6dad522021-09-24 16:14:47 +00001415static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
drh3c194692016-04-11 16:43:43 +00001416 Expr *pNew; /* Value to return */
1417 u8 *zAlloc; /* Memory space from which to build Expr object */
1418 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1419
drh575fad62016-02-05 13:38:36 +00001420 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001421 assert( p );
1422 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1423 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001424
drh3c194692016-04-11 16:43:43 +00001425 /* Figure out where to write the new Expr structure. */
1426 if( pzBuffer ){
1427 zAlloc = *pzBuffer;
1428 staticFlag = EP_Static;
drh3c6edc82021-04-26 15:28:06 +00001429 assert( zAlloc!=0 );
drh3c194692016-04-11 16:43:43 +00001430 }else{
1431 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1432 staticFlag = 0;
1433 }
1434 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001435
drh3c194692016-04-11 16:43:43 +00001436 if( pNew ){
1437 /* Set nNewSize to the size allocated for the structure pointed to
1438 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1439 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1440 ** by the copy of the p->u.zToken string (if any).
1441 */
1442 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1443 const int nNewSize = nStructSize & 0xfff;
1444 int nToken;
1445 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1446 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001447 }else{
drh3c194692016-04-11 16:43:43 +00001448 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001449 }
drh3c194692016-04-11 16:43:43 +00001450 if( dupFlags ){
1451 assert( ExprHasProperty(p, EP_Reduced)==0 );
1452 memcpy(zAlloc, p, nNewSize);
1453 }else{
1454 u32 nSize = (u32)exprStructSize(p);
1455 memcpy(zAlloc, p, nSize);
1456 if( nSize<EXPR_FULLSIZE ){
1457 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1458 }
1459 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001460
drh3c194692016-04-11 16:43:43 +00001461 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
drh825fa172022-07-22 19:28:04 +00001462 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
drh3c194692016-04-11 16:43:43 +00001463 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1464 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001465 ExprClearVVAProperties(pNew);
1466 if( dupFlags ){
1467 ExprSetVVAProperty(pNew, EP_Immutable);
1468 }
drh3c194692016-04-11 16:43:43 +00001469
1470 /* Copy the p->u.zToken string, if any. */
1471 if( nToken ){
1472 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1473 memcpy(zToken, p->u.zToken, nToken);
1474 }
1475
drh209bc522016-09-23 21:36:24 +00001476 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001477 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
drha4eeccd2021-10-07 17:43:30 +00001478 if( ExprUseXSelect(p) ){
drh3c194692016-04-11 16:43:43 +00001479 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001480 }else{
drh3c194692016-04-11 16:43:43 +00001481 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001482 }
drh3c194692016-04-11 16:43:43 +00001483 }
1484
1485 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001486 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001487 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001488 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001489 pNew->pLeft = p->pLeft ?
1490 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1491 pNew->pRight = p->pRight ?
1492 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001493 }
dan67a9b8e2018-06-22 20:51:35 +00001494#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001495 if( ExprHasProperty(p, EP_WinFunc) ){
1496 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1497 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001498 }
dan67a9b8e2018-06-22 20:51:35 +00001499#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001500 if( pzBuffer ){
1501 *pzBuffer = zAlloc;
1502 }
1503 }else{
drh209bc522016-09-23 21:36:24 +00001504 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001505 if( pNew->op==TK_SELECT_COLUMN ){
1506 pNew->pLeft = p->pLeft;
drh5cc9daf2021-04-12 23:18:18 +00001507 assert( p->pRight==0 || p->pRight==p->pLeft
1508 || ExprHasProperty(p->pLeft, EP_Subquery) );
drh98542602016-08-20 17:00:16 +00001509 }else{
1510 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1511 }
drh3c194692016-04-11 16:43:43 +00001512 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001513 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001514 }
1515 }
1516 return pNew;
1517}
1518
1519/*
danbfe31e72014-01-15 14:17:31 +00001520** Create and return a deep copy of the object passed as the second
1521** argument. If an OOM condition is encountered, NULL is returned
1522** and the db->mallocFailed flag set.
1523*/
daneede6a52014-01-15 19:42:23 +00001524#ifndef SQLITE_OMIT_CTE
dan26d61e52021-06-11 11:14:24 +00001525With *sqlite3WithDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001526 With *pRet = 0;
1527 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001528 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001529 pRet = sqlite3DbMallocZero(db, nByte);
1530 if( pRet ){
1531 int i;
1532 pRet->nCte = p->nCte;
1533 for(i=0; i<p->nCte; i++){
1534 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1535 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1536 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
drh67f70be2022-04-22 16:15:48 +00001537 pRet->a[i].eM10d = p->a[i].eM10d;
dan4e9119d2014-01-13 15:12:23 +00001538 }
1539 }
1540 }
1541 return pRet;
1542}
daneede6a52014-01-15 19:42:23 +00001543#else
dan26d61e52021-06-11 11:14:24 +00001544# define sqlite3WithDup(x,y) 0
daneede6a52014-01-15 19:42:23 +00001545#endif
dan4e9119d2014-01-13 15:12:23 +00001546
drha8389972018-12-06 22:04:19 +00001547#ifndef SQLITE_OMIT_WINDOWFUNC
1548/*
1549** The gatherSelectWindows() procedure and its helper routine
1550** gatherSelectWindowsCallback() are used to scan all the expressions
1551** an a newly duplicated SELECT statement and gather all of the Window
1552** objects found there, assembling them onto the linked list at Select->pWin.
1553*/
1554static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001555 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001556 Select *pSelect = pWalker->u.pSelect;
1557 Window *pWin = pExpr->y.pWin;
1558 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001559 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001560 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001561 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001562 }
1563 return WRC_Continue;
1564}
drha37b6a52018-12-06 22:12:18 +00001565static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1566 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1567}
drha8389972018-12-06 22:04:19 +00001568static void gatherSelectWindows(Select *p){
1569 Walker w;
1570 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001571 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1572 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001573 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001574 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001575 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001576}
1577#endif
1578
1579
drha76b5df2002-02-23 02:32:10 +00001580/*
drhff78bd22002-02-27 01:47:11 +00001581** The following group of routines make deep copies of expressions,
1582** expression lists, ID lists, and select statements. The copies can
1583** be deleted (by being passed to their respective ...Delete() routines)
1584** without effecting the originals.
1585**
danielk19774adee202004-05-08 08:23:19 +00001586** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1587** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001588** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001589**
drhad3cab52002-05-24 02:04:32 +00001590** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001591**
drhb7916a72009-05-27 10:31:29 +00001592** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001593** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1594** truncated version of the usual Expr structure that will be stored as
1595** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001596*/
drhb6dad522021-09-24 16:14:47 +00001597Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001598 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001599 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001600}
drhb6dad522021-09-24 16:14:47 +00001601ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001602 ExprList *pNew;
drhb6dad522021-09-24 16:14:47 +00001603 struct ExprList_item *pItem;
1604 const struct ExprList_item *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001605 int i;
drhe46292a2021-07-05 02:40:29 +00001606 Expr *pPriorSelectColOld = 0;
1607 Expr *pPriorSelectColNew = 0;
drh575fad62016-02-05 13:38:36 +00001608 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001609 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001610 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001611 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001612 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001613 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001614 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001615 pOldItem = p->a;
1616 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001617 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001618 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001619 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001620 if( pOldExpr
1621 && pOldExpr->op==TK_SELECT_COLUMN
1622 && (pNewExpr = pItem->pExpr)!=0
1623 ){
drhe46292a2021-07-05 02:40:29 +00001624 if( pNewExpr->pRight ){
1625 pPriorSelectColOld = pOldExpr->pRight;
1626 pPriorSelectColNew = pNewExpr->pRight;
1627 pNewExpr->pLeft = pNewExpr->pRight;
drhb1637482017-01-03 00:27:16 +00001628 }else{
drhe46292a2021-07-05 02:40:29 +00001629 if( pOldExpr->pLeft!=pPriorSelectColOld ){
1630 pPriorSelectColOld = pOldExpr->pLeft;
1631 pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1632 pNewExpr->pRight = pPriorSelectColNew;
1633 }
1634 pNewExpr->pLeft = pPriorSelectColNew;
drh47073f62017-01-02 22:36:32 +00001635 }
1636 }
drh41cee662019-12-12 20:22:34 +00001637 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
drhd88fd532022-05-02 20:49:30 +00001638 pItem->fg = pOldItem->fg;
1639 pItem->fg.done = 0;
drhc2acc4e2013-11-15 18:15:19 +00001640 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001641 }
1642 return pNew;
1643}
danielk197793758c82005-01-21 08:13:14 +00001644
1645/*
1646** If cursors, triggers, views and subqueries are all omitted from
1647** the build, then none of the following routines, except for
1648** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1649** called with a NULL argument.
1650*/
danielk19776a67fe82005-02-04 04:07:16 +00001651#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1652 || !defined(SQLITE_OMIT_SUBQUERY)
drhb6dad522021-09-24 16:14:47 +00001653SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001654 SrcList *pNew;
1655 int i;
drh113088e2003-03-20 01:16:58 +00001656 int nByte;
drh575fad62016-02-05 13:38:36 +00001657 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001658 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001659 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001660 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001661 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001662 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001663 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001664 SrcItem *pNewItem = &pNew->a[i];
drhb6dad522021-09-24 16:14:47 +00001665 const SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001666 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001667 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001668 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1669 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1670 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001671 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001672 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001673 pNewItem->addrFillSub = pOldItem->addrFillSub;
1674 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001675 if( pNewItem->fg.isIndexedBy ){
1676 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1677 }
drha79e2a22021-02-21 23:44:14 +00001678 pNewItem->u2 = pOldItem->u2;
1679 if( pNewItem->fg.isCte ){
1680 pNewItem->u2.pCteUse->nUse++;
1681 }
drh8a48b9c2015-08-19 15:20:00 +00001682 if( pNewItem->fg.isTabFunc ){
1683 pNewItem->u1.pFuncArg =
1684 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1685 }
drhed8a3bb2005-06-06 21:19:56 +00001686 pTab = pNewItem->pTab = pOldItem->pTab;
1687 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001688 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001689 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001690 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
drhd44f8b22022-04-07 01:11:13 +00001691 if( pOldItem->fg.isUsing ){
1692 assert( pNewItem->fg.isUsing );
1693 pNewItem->u3.pUsing = sqlite3IdListDup(db, pOldItem->u3.pUsing);
1694 }else{
1695 pNewItem->u3.pOn = sqlite3ExprDup(db, pOldItem->u3.pOn, flags);
1696 }
danielk19776c18b6e2005-01-30 09:17:58 +00001697 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001698 }
1699 return pNew;
1700}
drhb6dad522021-09-24 16:14:47 +00001701IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
drhff78bd22002-02-27 01:47:11 +00001702 IdList *pNew;
1703 int i;
drh575fad62016-02-05 13:38:36 +00001704 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001705 if( p==0 ) return 0;
drha99e3252022-04-15 15:47:14 +00001706 assert( p->eU4!=EU4_EXPR );
1707 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew)+(p->nId-1)*sizeof(p->a[0]) );
drhff78bd22002-02-27 01:47:11 +00001708 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001709 pNew->nId = p->nId;
drha99e3252022-04-15 15:47:14 +00001710 pNew->eU4 = p->eU4;
drhff78bd22002-02-27 01:47:11 +00001711 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001712 struct IdList_item *pNewItem = &pNew->a[i];
drha99e3252022-04-15 15:47:14 +00001713 const struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001714 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drha99e3252022-04-15 15:47:14 +00001715 pNewItem->u4 = pOldItem->u4;
drhff78bd22002-02-27 01:47:11 +00001716 }
1717 return pNew;
1718}
drhb6dad522021-09-24 16:14:47 +00001719Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
dana7466202017-02-03 14:44:52 +00001720 Select *pRet = 0;
1721 Select *pNext = 0;
1722 Select **pp = &pRet;
drhb6dad522021-09-24 16:14:47 +00001723 const Select *p;
dana7466202017-02-03 14:44:52 +00001724
drh575fad62016-02-05 13:38:36 +00001725 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001726 for(p=pDup; p; p=p->pPrior){
1727 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1728 if( pNew==0 ) break;
1729 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1730 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1731 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1732 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1733 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1734 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1735 pNew->op = p->op;
1736 pNew->pNext = pNext;
1737 pNew->pPrior = 0;
1738 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001739 pNew->iLimit = 0;
1740 pNew->iOffset = 0;
1741 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1742 pNew->addrOpenEphm[0] = -1;
1743 pNew->addrOpenEphm[1] = -1;
1744 pNew->nSelectRow = p->nSelectRow;
dan26d61e52021-06-11 11:14:24 +00001745 pNew->pWith = sqlite3WithDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001746#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001747 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001748 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001749 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001750#endif
drhfef37762018-07-10 19:48:35 +00001751 pNew->selId = p->selId;
drh9da977f2021-04-20 12:14:12 +00001752 if( db->mallocFailed ){
1753 /* Any prior OOM might have left the Select object incomplete.
1754 ** Delete the whole thing rather than allow an incomplete Select
1755 ** to be used by the code generator. */
1756 pNew->pNext = 0;
1757 sqlite3SelectDelete(db, pNew);
1758 break;
1759 }
dana7466202017-02-03 14:44:52 +00001760 *pp = pNew;
1761 pp = &pNew->pPrior;
1762 pNext = pNew;
1763 }
1764
1765 return pRet;
drhff78bd22002-02-27 01:47:11 +00001766}
danielk197793758c82005-01-21 08:13:14 +00001767#else
drhf76d2872021-10-27 17:15:08 +00001768Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001769 assert( p==0 );
1770 return 0;
1771}
1772#endif
drhff78bd22002-02-27 01:47:11 +00001773
1774
1775/*
drha76b5df2002-02-23 02:32:10 +00001776** Add a new element to the end of an expression list. If pList is
1777** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001778**
drha19543f2017-09-15 15:17:48 +00001779** The pList argument must be either NULL or a pointer to an ExprList
1780** obtained from a prior call to sqlite3ExprListAppend(). This routine
1781** may not be used with an ExprList obtained from sqlite3ExprListDup().
1782** Reason: This routine assumes that the number of slots in pList->a[]
1783** is a power of two. That is true for sqlite3ExprListAppend() returns
1784** but is not necessarily true from the return value of sqlite3ExprListDup().
1785**
drhb7916a72009-05-27 10:31:29 +00001786** If a memory allocation error occurs, the entire list is freed and
1787** NULL is returned. If non-NULL is returned, then it is guaranteed
1788** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001789*/
larrybrdabada62021-04-04 12:52:58 +00001790static const struct ExprList_item zeroItem = {0};
drh50e43c52021-03-23 14:27:35 +00001791SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1792 sqlite3 *db, /* Database handle. Used for memory allocation */
1793 Expr *pExpr /* Expression to be appended. Might be NULL */
1794){
1795 struct ExprList_item *pItem;
1796 ExprList *pList;
1797
1798 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1799 if( pList==0 ){
1800 sqlite3ExprDelete(db, pExpr);
1801 return 0;
1802 }
1803 pList->nAlloc = 4;
1804 pList->nExpr = 1;
1805 pItem = &pList->a[0];
1806 *pItem = zeroItem;
1807 pItem->pExpr = pExpr;
1808 return pList;
1809}
1810SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1811 sqlite3 *db, /* Database handle. Used for memory allocation */
1812 ExprList *pList, /* List to which to append. Might be NULL */
1813 Expr *pExpr /* Expression to be appended. Might be NULL */
1814){
1815 struct ExprList_item *pItem;
1816 ExprList *pNew;
1817 pList->nAlloc *= 2;
1818 pNew = sqlite3DbRealloc(db, pList,
1819 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1820 if( pNew==0 ){
1821 sqlite3ExprListDelete(db, pList);
1822 sqlite3ExprDelete(db, pExpr);
1823 return 0;
1824 }else{
1825 pList = pNew;
1826 }
1827 pItem = &pList->a[pList->nExpr++];
1828 *pItem = zeroItem;
1829 pItem->pExpr = pExpr;
1830 return pList;
1831}
drh17435752007-08-16 04:30:38 +00001832ExprList *sqlite3ExprListAppend(
1833 Parse *pParse, /* Parsing context */
1834 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001835 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001836){
drh43606172017-04-05 11:32:13 +00001837 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001838 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001839 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1840 }
1841 if( pList->nAlloc<pList->nExpr+1 ){
1842 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001843 }
drh43606172017-04-05 11:32:13 +00001844 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001845 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001846 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001847 return pList;
1848}
1849
1850/*
drh8762ec12016-08-20 01:06:22 +00001851** pColumns and pExpr form a vector assignment which is part of the SET
1852** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001853**
1854** (a,b,c) = (expr1,expr2,expr3)
1855** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1856**
1857** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001858** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001859** TK_SELECT_COLUMN expressions.
1860*/
1861ExprList *sqlite3ExprListAppendVector(
1862 Parse *pParse, /* Parsing context */
1863 ExprList *pList, /* List to which to append. Might be NULL */
1864 IdList *pColumns, /* List of names of LHS of the assignment */
1865 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1866){
1867 sqlite3 *db = pParse->db;
1868 int n;
1869 int i;
drh66860af2016-08-23 18:30:10 +00001870 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001871 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1872 ** exit prior to this routine being invoked */
1873 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001874 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001875
1876 /* If the RHS is a vector, then we can immediately check to see that
1877 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1878 ** wildcards ("*") in the result set of the SELECT must be expanded before
1879 ** we can do the size check, so defer the size check until code generation.
1880 */
1881 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001882 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1883 pColumns->nId, n);
1884 goto vector_append_error;
1885 }
drh966e2912017-01-03 02:58:01 +00001886
1887 for(i=0; i<pColumns->nId; i++){
drh10f08272021-07-05 01:11:26 +00001888 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
drh554a9dc2019-08-26 14:18:28 +00001889 assert( pSubExpr!=0 || db->mallocFailed );
drh554a9dc2019-08-26 14:18:28 +00001890 if( pSubExpr==0 ) continue;
drha1251bc2016-08-20 00:51:37 +00001891 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1892 if( pList ){
drh66860af2016-08-23 18:30:10 +00001893 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001894 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001895 pColumns->a[i].zName = 0;
1896 }
1897 }
drh966e2912017-01-03 02:58:01 +00001898
drhffe28052017-05-06 18:09:36 +00001899 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001900 Expr *pFirst = pList->a[iFirst].pExpr;
1901 assert( pFirst!=0 );
1902 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001903
drhf4dd26c2017-04-05 11:49:06 +00001904 /* Store the SELECT statement in pRight so it will be deleted when
1905 ** sqlite3ExprListDelete() is called */
1906 pFirst->pRight = pExpr;
1907 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001908
drhf4dd26c2017-04-05 11:49:06 +00001909 /* Remember the size of the LHS in iTable so that we can check that
1910 ** the RHS and LHS sizes match during code generation. */
1911 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001912 }
1913
1914vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001915 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001916 sqlite3IdListDelete(db, pColumns);
1917 return pList;
1918}
1919
1920/*
drhbc622bc2015-08-24 15:39:42 +00001921** Set the sort order for the last element on the given ExprList.
1922*/
dan6e118922019-08-12 16:36:38 +00001923void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001924 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001925 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001926 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001927
1928 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1929 assert( iSortOrder==SQLITE_SO_UNDEFINED
1930 || iSortOrder==SQLITE_SO_ASC
1931 || iSortOrder==SQLITE_SO_DESC
1932 );
1933 assert( eNulls==SQLITE_SO_UNDEFINED
1934 || eNulls==SQLITE_SO_ASC
1935 || eNulls==SQLITE_SO_DESC
1936 );
1937
dan9105fd52019-08-19 17:26:32 +00001938 pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00001939 assert( pItem->fg.bNulls==0 );
dan9105fd52019-08-19 17:26:32 +00001940 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1941 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001942 }
drhd88fd532022-05-02 20:49:30 +00001943 pItem->fg.sortFlags = (u8)iSortOrder;
dan9105fd52019-08-19 17:26:32 +00001944
1945 if( eNulls!=SQLITE_SO_UNDEFINED ){
drhd88fd532022-05-02 20:49:30 +00001946 pItem->fg.bNulls = 1;
dan9105fd52019-08-19 17:26:32 +00001947 if( iSortOrder!=eNulls ){
drhd88fd532022-05-02 20:49:30 +00001948 pItem->fg.sortFlags |= KEYINFO_ORDER_BIGNULL;
dan9105fd52019-08-19 17:26:32 +00001949 }
drhbc622bc2015-08-24 15:39:42 +00001950 }
drhbc622bc2015-08-24 15:39:42 +00001951}
1952
1953/*
drh41cee662019-12-12 20:22:34 +00001954** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001955** on the expression list.
1956**
1957** pList might be NULL following an OOM error. But pName should never be
1958** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1959** is set.
1960*/
1961void sqlite3ExprListSetName(
1962 Parse *pParse, /* Parsing context */
1963 ExprList *pList, /* List to which to add the span. */
drhb6dad522021-09-24 16:14:47 +00001964 const Token *pName, /* Name to be added */
drhb7916a72009-05-27 10:31:29 +00001965 int dequote /* True to cause the name to be dequoted */
1966){
1967 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001968 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001969 if( pList ){
1970 struct ExprList_item *pItem;
1971 assert( pList->nExpr>0 );
1972 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001973 assert( pItem->zEName==0 );
drhd88fd532022-05-02 20:49:30 +00001974 assert( pItem->fg.eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001975 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001976 if( dequote ){
1977 /* If dequote==0, then pName->z does not point to part of a DDL
1978 ** statement handled by the parser. And so no token need be added
1979 ** to the token-map. */
1980 sqlite3Dequote(pItem->zEName);
1981 if( IN_RENAME_OBJECT ){
drhb6dad522021-09-24 16:14:47 +00001982 sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
dan85f2c762020-04-06 16:37:05 +00001983 }
dan5be60c52018-08-15 20:28:39 +00001984 }
drhb7916a72009-05-27 10:31:29 +00001985 }
1986}
1987
1988/*
1989** Set the ExprList.a[].zSpan element of the most recently added item
1990** on the expression list.
1991**
1992** pList might be NULL following an OOM error. But pSpan should never be
1993** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1994** is set.
1995*/
1996void sqlite3ExprListSetSpan(
1997 Parse *pParse, /* Parsing context */
1998 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001999 const char *zStart, /* Start of the span */
2000 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00002001){
2002 sqlite3 *db = pParse->db;
2003 assert( pList!=0 || db->mallocFailed!=0 );
2004 if( pList ){
2005 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
2006 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00002007 if( pItem->zEName==0 ){
2008 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
drhd88fd532022-05-02 20:49:30 +00002009 pItem->fg.eEName = ENAME_SPAN;
drhcbb9da32019-12-12 22:11:33 +00002010 }
drhb7916a72009-05-27 10:31:29 +00002011 }
2012}
2013
2014/*
danielk19777a15a4b2007-05-08 17:54:43 +00002015** If the expression list pEList contains more than iLimit elements,
2016** leave an error message in pParse.
2017*/
2018void sqlite3ExprListCheckLength(
2019 Parse *pParse,
2020 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00002021 const char *zObject
2022){
drhb1a6c3c2008-03-20 16:30:17 +00002023 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00002024 testcase( pEList && pEList->nExpr==mx );
2025 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00002026 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00002027 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
2028 }
2029}
2030
2031/*
drha76b5df2002-02-23 02:32:10 +00002032** Delete an entire expression list.
2033*/
drhaffa8552016-04-11 18:25:05 +00002034static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00002035 int i = pList->nExpr;
2036 struct ExprList_item *pItem = pList->a;
2037 assert( pList->nExpr>0 );
drh41ce47c2022-08-22 02:00:26 +00002038 assert( db!=0 );
drhac48b752017-04-05 11:57:56 +00002039 do{
drh633e6d52008-07-28 19:34:53 +00002040 sqlite3ExprDelete(db, pItem->pExpr);
drh41ce47c2022-08-22 02:00:26 +00002041 if( pItem->zEName ) sqlite3DbNNFreeNN(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00002042 pItem++;
2043 }while( --i>0 );
drh41ce47c2022-08-22 02:00:26 +00002044 sqlite3DbNNFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00002045}
drhaffa8552016-04-11 18:25:05 +00002046void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2047 if( pList ) exprListDeleteNN(db, pList);
2048}
drha76b5df2002-02-23 02:32:10 +00002049
2050/*
drh2308ed32015-02-09 16:09:34 +00002051** Return the bitwise-OR of all Expr.flags fields in the given
2052** ExprList.
drh885a5b02015-02-09 15:21:36 +00002053*/
drh2308ed32015-02-09 16:09:34 +00002054u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00002055 int i;
drh2308ed32015-02-09 16:09:34 +00002056 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00002057 assert( pList!=0 );
2058 for(i=0; i<pList->nExpr; i++){
2059 Expr *pExpr = pList->a[i].pExpr;
2060 assert( pExpr!=0 );
2061 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00002062 }
drh2308ed32015-02-09 16:09:34 +00002063 return m;
drh885a5b02015-02-09 15:21:36 +00002064}
2065
2066/*
drh7e6f9802017-09-04 00:33:04 +00002067** This is a SELECT-node callback for the expression walker that
2068** always "fails". By "fail" in this case, we mean set
2069** pWalker->eCode to zero and abort.
2070**
2071** This callback is used by multiple expression walkers.
2072*/
2073int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
2074 UNUSED_PARAMETER(NotUsed);
2075 pWalker->eCode = 0;
2076 return WRC_Abort;
2077}
2078
2079/*
drh0cbec592020-01-03 02:20:37 +00002080** Check the input string to see if it is "true" or "false" (in any case).
2081**
2082** If the string is.... Return
2083** "true" EP_IsTrue
2084** "false" EP_IsFalse
2085** anything else 0
2086*/
2087u32 sqlite3IsTrueOrFalse(const char *zIn){
2088 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
2089 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
2090 return 0;
2091}
2092
2093
2094/*
drh171d16b2018-02-26 20:15:54 +00002095** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00002096** then convert it into an TK_TRUEFALSE term. Return non-zero if
2097** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00002098*/
2099int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00002100 u32 v;
drh171d16b2018-02-26 20:15:54 +00002101 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drhf9751072021-10-07 13:40:29 +00002102 if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
drh0cbec592020-01-03 02:20:37 +00002103 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00002104 ){
2105 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00002106 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00002107 return 1;
2108 }
2109 return 0;
2110}
2111
drh43c4ac82018-02-26 21:26:27 +00002112/*
drh96acafb2018-02-27 14:49:25 +00002113** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002114** and 0 if it is FALSE.
2115*/
drh96acafb2018-02-27 14:49:25 +00002116int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002117 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002118 assert( pExpr->op==TK_TRUEFALSE );
drhf9751072021-10-07 13:40:29 +00002119 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh43c4ac82018-02-26 21:26:27 +00002120 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2121 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2122 return pExpr->u.zToken[4]==0;
2123}
2124
drh17180fc2019-04-19 17:26:19 +00002125/*
2126** If pExpr is an AND or OR expression, try to simplify it by eliminating
2127** terms that are always true or false. Return the simplified expression.
2128** Or return the original expression if no simplification is possible.
2129**
2130** Examples:
2131**
2132** (x<10) AND true => (x<10)
2133** (x<10) AND false => false
2134** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2135** (x<10) AND (y=22 OR true) => (x<10)
2136** (y=22) OR true => true
2137*/
2138Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2139 assert( pExpr!=0 );
2140 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2141 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2142 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2143 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2144 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2145 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2146 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2147 }
2148 }
2149 return pExpr;
2150}
2151
drh171d16b2018-02-26 20:15:54 +00002152
2153/*
drh059b2d52014-10-24 19:28:09 +00002154** These routines are Walker callbacks used to check expressions to
2155** see if they are "constant" for some definition of constant. The
2156** Walker.eCode value determines the type of "constant" we are looking
2157** for.
drh73b211a2005-01-18 04:00:42 +00002158**
drh7d10d5a2008-08-20 16:35:10 +00002159** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002160**
drh059b2d52014-10-24 19:28:09 +00002161** sqlite3ExprIsConstant() pWalker->eCode==1
2162** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002163** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002164** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002165**
drh059b2d52014-10-24 19:28:09 +00002166** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2167** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002168**
drh014fff22020-01-08 22:22:36 +00002169** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2170** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002171** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002172** when processing a new CREATE TABLE statement. A bound parameter raises
2173** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002174** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002175** contain a bound parameter because they were generated by older versions
2176** of SQLite to be parsed by newer versions of SQLite without raising a
2177** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002178*/
drh7d10d5a2008-08-20 16:35:10 +00002179static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002180
drh059b2d52014-10-24 19:28:09 +00002181 /* If pWalker->eCode is 2 then any term of the expression that comes from
drhb77c07a2022-04-11 11:59:25 +00002182 ** the ON or USING clauses of an outer join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002183 ** from being considered constant. */
drh67a99db2022-05-13 14:52:04 +00002184 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_OuterON) ){
drh059b2d52014-10-24 19:28:09 +00002185 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002186 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002187 }
2188
drh626a8792005-01-17 22:08:19 +00002189 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002190 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002191 ** and either pWalker->eCode==4 or 5 or the function has the
2192 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002193 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002194 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2195 && !ExprHasProperty(pExpr, EP_WinFunc)
2196 ){
drh014fff22020-01-08 22:22:36 +00002197 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002198 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002199 }else{
2200 pWalker->eCode = 0;
2201 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002202 }
drh626a8792005-01-17 22:08:19 +00002203 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002204 /* Convert "true" or "false" in a DEFAULT clause into the
2205 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002206 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002207 return WRC_Prune;
2208 }
drh08b92082020-08-10 14:18:00 +00002209 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002210 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002211 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002212 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002213 testcase( pExpr->op==TK_ID );
2214 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002215 testcase( pExpr->op==TK_AGG_FUNCTION );
2216 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002217 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002218 return WRC_Continue;
2219 }
drh059b2d52014-10-24 19:28:09 +00002220 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2221 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002222 }
drh08b92082020-08-10 14:18:00 +00002223 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002224 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002225 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002226 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002227 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002228 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002229 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002230 pWalker->eCode = 0;
2231 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002232 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002233 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002234 /* Silently convert bound parameters that appear inside of CREATE
2235 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002236 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002237 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002238 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002239 /* A bound parameter in a CREATE statement that originates from
2240 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002241 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002242 return WRC_Abort;
2243 }
drh08b92082020-08-10 14:18:00 +00002244 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002245 default:
drh6e341b92018-04-17 18:50:40 +00002246 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2247 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002248 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002249 }
2250}
drh059b2d52014-10-24 19:28:09 +00002251static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002252 Walker w;
drh059b2d52014-10-24 19:28:09 +00002253 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002254 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002255 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002256#ifdef SQLITE_DEBUG
2257 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2258#endif
drh059b2d52014-10-24 19:28:09 +00002259 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002260 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002261 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002262}
drh626a8792005-01-17 22:08:19 +00002263
2264/*
drh059b2d52014-10-24 19:28:09 +00002265** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002266** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002267**
2268** For the purposes of this function, a double-quoted string (ex: "abc")
2269** is considered a variable but a single-quoted string (ex: 'abc') is
2270** a constant.
drhfef52082000-06-06 01:50:43 +00002271*/
danielk19774adee202004-05-08 08:23:19 +00002272int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002273 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002274}
2275
2276/*
drh07aded62018-07-28 16:24:08 +00002277** Walk an expression tree. Return non-zero if
2278**
2279** (1) the expression is constant, and
2280** (2) the expression does originate in the ON or USING clause
2281** of a LEFT JOIN, and
2282** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2283** operands created by the constant propagation optimization.
2284**
2285** When this routine returns true, it indicates that the expression
2286** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002287** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002288*/
2289int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002290 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002291}
2292
2293/*
drhfcb9f4f2015-06-01 18:13:16 +00002294** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002295** for any single row of the table with cursor iCur. In other words, the
2296** expression must not refer to any non-deterministic function nor any
2297** table other than iCur.
2298*/
2299int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2300 return exprIsConst(p, 3, iCur);
2301}
2302
drha9cdb902022-04-25 19:40:33 +00002303/*
2304** Check pExpr to see if it is an invariant constraint on data source pSrc.
2305** This is an optimization. False negatives will perhaps cause slower
2306** queries, but false positives will yield incorrect answers. So when in
drh22b541b2022-04-27 18:38:46 +00002307** doubt, return 0.
drha9cdb902022-04-25 19:40:33 +00002308**
2309** To be an invariant constraint, the following must be true:
2310**
2311** (1) pExpr cannot refer to any table other than pSrc->iCursor.
2312**
2313** (2) pExpr cannot use subqueries or non-deterministic functions.
2314**
2315** (3) pSrc cannot be part of the left operand for a RIGHT JOIN.
2316** (Is there some way to relax this constraint?)
2317**
2318** (4) If pSrc is the right operand of a LEFT JOIN, then...
2319** (4a) pExpr must come from an ON clause..
2320 (4b) and specifically the ON clause associated with the LEFT JOIN.
2321**
2322** (5) If pSrc is not the right operand of a LEFT JOIN or the left
2323** operand of a RIGHT JOIN, then pExpr must be from the WHERE
2324** clause, not an ON clause.
2325*/
2326int sqlite3ExprIsTableConstraint(Expr *pExpr, const SrcItem *pSrc){
2327 if( pSrc->fg.jointype & JT_LTORJ ){
2328 return 0; /* rule (3) */
2329 }
2330 if( pSrc->fg.jointype & JT_LEFT ){
drh67a99db2022-05-13 14:52:04 +00002331 if( !ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (4a) */
drha9cdb902022-04-25 19:40:33 +00002332 if( pExpr->w.iJoin!=pSrc->iCursor ) return 0; /* rule (4b) */
2333 }else{
drh67a99db2022-05-13 14:52:04 +00002334 if( ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (5) */
drha9cdb902022-04-25 19:40:33 +00002335 }
2336 return sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor); /* rules (1), (2) */
2337}
2338
danab31a842017-04-29 20:53:09 +00002339
2340/*
2341** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2342*/
2343static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2344 ExprList *pGroupBy = pWalker->u.pGroupBy;
2345 int i;
2346
2347 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2348 ** it constant. */
2349 for(i=0; i<pGroupBy->nExpr; i++){
2350 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002351 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002352 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002353 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002354 return WRC_Prune;
2355 }
2356 }
2357 }
2358
2359 /* Check if pExpr is a sub-select. If so, consider it variable. */
drha4eeccd2021-10-07 17:43:30 +00002360 if( ExprUseXSelect(pExpr) ){
danab31a842017-04-29 20:53:09 +00002361 pWalker->eCode = 0;
2362 return WRC_Abort;
2363 }
2364
2365 return exprNodeIsConstant(pWalker, pExpr);
2366}
2367
2368/*
2369** Walk the expression tree passed as the first argument. Return non-zero
2370** if the expression consists entirely of constants or copies of terms
2371** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002372**
2373** This routine is used to determine if a term of the HAVING clause can
2374** be promoted into the WHERE clause. In order for such a promotion to work,
2375** the value of the HAVING clause term must be the same for all members of
2376** a "group". The requirement that the GROUP BY term must be BINARY
2377** assumes that no other collating sequence will have a finer-grained
2378** grouping than binary. In other words (A=B COLLATE binary) implies
2379** A=B in every other collating sequence. The requirement that the
2380** GROUP BY be BINARY is stricter than necessary. It would also work
2381** to promote HAVING clauses that use the same alternative collating
2382** sequence as the GROUP BY term, but that is much harder to check,
2383** alternative collating sequences are uncommon, and this is only an
2384** optimization, so we take the easy way out and simply require the
2385** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002386*/
2387int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2388 Walker w;
danab31a842017-04-29 20:53:09 +00002389 w.eCode = 1;
2390 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002391 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002392 w.u.pGroupBy = pGroupBy;
2393 w.pParse = pParse;
2394 sqlite3WalkExpr(&w, p);
2395 return w.eCode;
2396}
2397
drh059b2d52014-10-24 19:28:09 +00002398/*
drh014fff22020-01-08 22:22:36 +00002399** Walk an expression tree for the DEFAULT field of a column definition
2400** in a CREATE TABLE statement. Return non-zero if the expression is
2401** acceptable for use as a DEFAULT. That is to say, return non-zero if
2402** the expression is constant or a function call with constant arguments.
2403** Return and 0 if there are any variables.
2404**
drh1e32bed2020-06-19 13:33:53 +00002405** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002406** processing a new CREATE TABLE statement. When isInit is true, parameters
2407** (such as ? or $abc) in the expression are converted into NULL. When
2408** isInit is false, parameters raise an error. Parameters should not be
2409** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002410** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002411** backwards compatibility.
2412**
2413** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002414**
2415** For the purposes of this function, a double-quoted string (ex: "abc")
2416** is considered a variable but a single-quoted string (ex: 'abc') is
2417** a constant.
2418*/
drhfeada2d2014-09-24 13:20:22 +00002419int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2420 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002421 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002422}
2423
drh5b88bc42013-12-07 23:35:21 +00002424#ifdef SQLITE_ENABLE_CURSOR_HINTS
2425/*
2426** Walk an expression tree. Return 1 if the expression contains a
2427** subquery of some kind. Return 0 if there are no subqueries.
2428*/
2429int sqlite3ExprContainsSubquery(Expr *p){
2430 Walker w;
drhbec24762015-08-13 20:07:13 +00002431 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002432 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002433 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002434#ifdef SQLITE_DEBUG
2435 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2436#endif
drh5b88bc42013-12-07 23:35:21 +00002437 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002438 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002439}
2440#endif
2441
drheb55bd22005-06-30 17:04:21 +00002442/*
drh73b211a2005-01-18 04:00:42 +00002443** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002444** to fit in a 32-bit integer, return 1 and put the value of the integer
2445** in *pValue. If the expression is not an integer or if it is too big
2446** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002447*/
drhb6dad522021-09-24 16:14:47 +00002448int sqlite3ExprIsInteger(const Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002449 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002450 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002451
2452 /* If an expression is an integer literal that fits in a signed 32-bit
2453 ** integer, then the EP_IntValue flag will have already been set */
2454 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2455 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2456
drh92b01d52008-06-24 00:32:35 +00002457 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002458 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002459 return 1;
2460 }
drhe4de1fe2002-06-02 16:09:01 +00002461 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002462 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002463 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002464 break;
drh4b59ab52002-08-24 18:24:51 +00002465 }
drhe4de1fe2002-06-02 16:09:01 +00002466 case TK_UMINUS: {
drhc59ffa82021-10-04 15:08:49 +00002467 int v = 0;
danielk19774adee202004-05-08 08:23:19 +00002468 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
drhc59ffa82021-10-04 15:08:49 +00002469 assert( ((unsigned int)v)!=0x80000000 );
drhe4de1fe2002-06-02 16:09:01 +00002470 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002471 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002472 }
2473 break;
2474 }
2475 default: break;
2476 }
drh92b01d52008-06-24 00:32:35 +00002477 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002478}
2479
2480/*
drh039fc322009-11-17 18:31:47 +00002481** Return FALSE if there is no chance that the expression can be NULL.
2482**
2483** If the expression might be NULL or if the expression is too complex
2484** to tell return TRUE.
2485**
2486** This routine is used as an optimization, to skip OP_IsNull opcodes
2487** when we know that a value cannot be NULL. Hence, a false positive
2488** (returning TRUE when in fact the expression can never be NULL) might
2489** be a small performance hit but is otherwise harmless. On the other
2490** hand, a false negative (returning FALSE when the result could be NULL)
2491** will likely result in an incorrect answer. So when in doubt, return
2492** TRUE.
2493*/
2494int sqlite3ExprCanBeNull(const Expr *p){
2495 u8 op;
drh3c6edc82021-04-26 15:28:06 +00002496 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002497 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2498 p = p->pLeft;
drh3c6edc82021-04-26 15:28:06 +00002499 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002500 }
drh039fc322009-11-17 18:31:47 +00002501 op = p->op;
2502 if( op==TK_REGISTER ) op = p->op2;
2503 switch( op ){
2504 case TK_INTEGER:
2505 case TK_STRING:
2506 case TK_FLOAT:
2507 case TK_BLOB:
2508 return 0;
drh7248a8b2014-08-04 18:50:54 +00002509 case TK_COLUMN:
drh477572b2021-10-07 20:46:29 +00002510 assert( ExprUseYTab(p) );
drh72673a22014-12-04 16:27:17 +00002511 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002512 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002513 (p->iColumn>=0
drh6df8c0c2021-11-28 19:54:38 +00002514 && p->y.pTab->aCol!=0 /* Possible due to prior error */
drh4eac5f02019-12-24 15:01:17 +00002515 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002516 default:
2517 return 1;
2518 }
2519}
2520
2521/*
2522** Return TRUE if the given expression is a constant which would be
2523** unchanged by OP_Affinity with the affinity given in the second
2524** argument.
2525**
2526** This routine is used to determine if the OP_Affinity operation
2527** can be omitted. When in doubt return FALSE. A false negative
2528** is harmless. A false positive, however, can result in the wrong
2529** answer.
2530*/
2531int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2532 u8 op;
drhaf866402019-08-22 11:11:28 +00002533 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002534 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002535 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2536 if( p->op==TK_UMINUS ) unaryMinus = 1;
2537 p = p->pLeft;
2538 }
drh039fc322009-11-17 18:31:47 +00002539 op = p->op;
2540 if( op==TK_REGISTER ) op = p->op2;
2541 switch( op ){
2542 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002543 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002544 }
2545 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002546 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002547 }
2548 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002549 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002550 }
2551 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002552 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002553 }
drh2f2855b2009-11-18 01:25:26 +00002554 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002555 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002556 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002557 }
drh039fc322009-11-17 18:31:47 +00002558 default: {
2559 return 0;
2560 }
2561 }
2562}
2563
2564/*
drhc4a3c772001-04-04 11:48:57 +00002565** Return TRUE if the given string is a row-id column name.
2566*/
danielk19774adee202004-05-08 08:23:19 +00002567int sqlite3IsRowid(const char *z){
2568 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2569 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2570 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002571 return 0;
2572}
2573
danielk19779a96b662007-11-29 17:05:18 +00002574/*
drh69c355b2016-03-09 15:34:51 +00002575** pX is the RHS of an IN operator. If pX is a SELECT statement
2576** that can be simplified to a direct table access, then return
2577** a pointer to the SELECT statement. If pX is not a SELECT statement,
2578** or if the SELECT statement needs to be manifested into a transient
2579** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002580*/
2581#ifndef SQLITE_OMIT_SUBQUERY
drhb6dad522021-09-24 16:14:47 +00002582static Select *isCandidateForInOpt(const Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002583 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002584 SrcList *pSrc;
2585 ExprList *pEList;
2586 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002587 int i;
drha4eeccd2021-10-07 17:43:30 +00002588 if( !ExprUseXSelect(pX) ) return 0; /* Not a subquery */
drh69c355b2016-03-09 15:34:51 +00002589 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2590 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002591 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002592 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002593 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2594 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2595 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002596 }
drh2e26a602020-01-06 18:59:46 +00002597 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002598 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002599 if( p->pWhere ) return 0; /* Has no WHERE clause */
2600 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002601 assert( pSrc!=0 );
2602 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002603 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002604 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002605 assert( pTab!=0 );
drhf38524d2021-08-02 16:41:57 +00002606 assert( !IsView(pTab) ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002607 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2608 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002609 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002610 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002611 for(i=0; i<pEList->nExpr; i++){
2612 Expr *pRes = pEList->a[i].pExpr;
2613 if( pRes->op!=TK_COLUMN ) return 0;
2614 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002615 }
drh69c355b2016-03-09 15:34:51 +00002616 return p;
drhb287f4b2008-04-25 00:08:38 +00002617}
2618#endif /* SQLITE_OMIT_SUBQUERY */
2619
danf9b2e052016-08-02 17:45:00 +00002620#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002621/*
drh4c259e92014-08-01 21:12:35 +00002622** Generate code that checks the left-most column of index table iCur to see if
2623** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002624** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2625** to be set to NULL if iCur contains one or more NULL values.
2626*/
2627static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002628 int addr1;
drh6be515e2014-08-01 21:00:53 +00002629 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002630 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002631 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2632 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002633 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002634 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002635}
danf9b2e052016-08-02 17:45:00 +00002636#endif
drh6be515e2014-08-01 21:00:53 +00002637
drhbb53ecb2014-08-02 21:03:33 +00002638
2639#ifndef SQLITE_OMIT_SUBQUERY
2640/*
2641** The argument is an IN operator with a list (not a subquery) on the
2642** right-hand side. Return TRUE if that list is constant.
2643*/
2644static int sqlite3InRhsIsConstant(Expr *pIn){
2645 Expr *pLHS;
2646 int res;
2647 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2648 pLHS = pIn->pLeft;
2649 pIn->pLeft = 0;
2650 res = sqlite3ExprIsConstant(pIn);
2651 pIn->pLeft = pLHS;
2652 return res;
2653}
2654#endif
2655
drh6be515e2014-08-01 21:00:53 +00002656/*
danielk19779a96b662007-11-29 17:05:18 +00002657** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002658** The pX parameter is the expression on the RHS of the IN operator, which
2659** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002660**
drhd4305ca2012-09-18 17:08:33 +00002661** The job of this routine is to find or create a b-tree object that can
2662** be used either to test for membership in the RHS set or to iterate through
2663** all members of the RHS set, skipping duplicates.
2664**
drh3a856252014-08-01 14:46:57 +00002665** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhb94182b2022-05-02 11:24:21 +00002666** and the *piTab parameter is set to the index of that cursor.
drhd4305ca2012-09-18 17:08:33 +00002667**
drhb74b1012009-05-28 21:04:37 +00002668** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002669**
drh1ccce442013-03-12 20:38:51 +00002670** IN_INDEX_ROWID - The cursor was opened on a database table.
2671** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2672** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2673** IN_INDEX_EPH - The cursor was opened on a specially created and
2674** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002675** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2676** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002677**
drhd4305ca2012-09-18 17:08:33 +00002678** An existing b-tree might be used if the RHS expression pX is a simple
2679** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002680**
dan553168c2016-08-01 20:14:31 +00002681** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002682**
drhd4305ca2012-09-18 17:08:33 +00002683** If the RHS of the IN operator is a list or a more complex subquery, then
2684** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002685** pX->iTable made to point to the ephemeral table instead of an
drhb94182b2022-05-02 11:24:21 +00002686** existing table. In this case, the creation and initialization of the
2687** ephmeral table might be put inside of a subroutine, the EP_Subrtn flag
2688** will be set on pX and the pX->y.sub fields will be set to show where
2689** the subroutine is coded.
drhd4305ca2012-09-18 17:08:33 +00002690**
drh7fc0ba02017-11-17 15:02:00 +00002691** The inFlags parameter must contain, at a minimum, one of the bits
2692** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2693** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2694** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2695** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002696**
2697** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2698** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002699** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002700** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2701** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002702**
drh3a856252014-08-01 14:46:57 +00002703** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2704** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002705** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2706** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002707**
drhbb53ecb2014-08-02 21:03:33 +00002708** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2709** if the RHS of the IN operator is a list (not a subquery) then this
2710** routine might decide that creating an ephemeral b-tree for membership
2711** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2712** calling routine should implement the IN operator using a sequence
2713** of Eq or Ne comparison operations.
2714**
drhb74b1012009-05-28 21:04:37 +00002715** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002716** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002717** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002718** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002719** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002720** to *prRhsHasNull. If there is no chance that the (...) contains a
2721** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002722**
drhe21a6e12014-08-01 18:00:24 +00002723** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002724** the value in that register will be NULL if the b-tree contains one or more
2725** NULL values, and it will be some non-NULL value if the b-tree contains no
2726** NULL values.
dan553168c2016-08-01 20:14:31 +00002727**
2728** If the aiMap parameter is not NULL, it must point to an array containing
2729** one element for each column returned by the SELECT statement on the RHS
2730** of the IN(...) operator. The i'th entry of the array is populated with the
2731** offset of the index column that matches the i'th column returned by the
2732** SELECT. For example, if the expression and selected index are:
2733**
2734** (?,?,?) IN (SELECT a, b, c FROM t1)
2735** CREATE INDEX i1 ON t1(b, c, a);
2736**
2737** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002738*/
danielk1977284f4ac2007-12-10 05:03:46 +00002739#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002740int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002741 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002742 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002743 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2744 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002745 int *aiMap, /* Mapping from Index fields to RHS fields */
2746 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002747){
drhb74b1012009-05-28 21:04:37 +00002748 Select *p; /* SELECT to the right of IN operator */
2749 int eType = 0; /* Type of RHS table. IN_INDEX_* */
drh3a45d302022-05-02 14:32:56 +00002750 int iTab; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002751 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002752 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002753
drh1450bc62009-10-30 13:25:56 +00002754 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002755 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drhf69dad82022-05-13 19:50:29 +00002756 iTab = pParse->nTab++;
drh1450bc62009-10-30 13:25:56 +00002757
dan7b35a772016-07-28 19:47:15 +00002758 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2759 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002760 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002761 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002762 ** set prRhsHasNull to 0 before continuing. */
drha4eeccd2021-10-07 17:43:30 +00002763 if( prRhsHasNull && ExprUseXSelect(pX) ){
dan7b35a772016-07-28 19:47:15 +00002764 int i;
2765 ExprList *pEList = pX->x.pSelect->pEList;
2766 for(i=0; i<pEList->nExpr; i++){
2767 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2768 }
2769 if( i==pEList->nExpr ){
2770 prRhsHasNull = 0;
2771 }
2772 }
2773
drhb74b1012009-05-28 21:04:37 +00002774 /* Check to see if an existing table or index can be used to
2775 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002776 ** ephemeral table. */
2777 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002778 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002779 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002780 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002781 ExprList *pEList = p->pEList;
2782 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002783
drhb07028f2011-10-14 21:49:18 +00002784 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2785 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2786 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2787 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002788
drhb22f7c82014-02-06 23:56:27 +00002789 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002790 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002791 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002792 sqlite3CodeVerifySchema(pParse, iDb);
2793 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002794
drha84a2832016-08-26 21:15:35 +00002795 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002796 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002797 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002798 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002799 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002800
2801 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2802 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002803 ExplainQueryPlan((pParse, 0,
2804 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002805 sqlite3VdbeJumpHere(v, iAddr);
2806 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002807 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002808 int affinity_ok = 1;
2809 int i;
2810
2811 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002812 ** comparison is the same as the affinity of each column in table
2813 ** on the RHS of the IN operator. If it not, it is not possible to
2814 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002815 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002816 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002817 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002818 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002819 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002820 testcase( cmpaff==SQLITE_AFF_BLOB );
2821 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002822 switch( cmpaff ){
2823 case SQLITE_AFF_BLOB:
2824 break;
2825 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002826 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2827 ** other has no affinity and the other side is TEXT. Hence,
2828 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2829 ** and for the term on the LHS of the IN to have no affinity. */
2830 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002831 break;
2832 default:
2833 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2834 }
2835 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002836
drha84a2832016-08-26 21:15:35 +00002837 if( affinity_ok ){
2838 /* Search for an existing index that will work for this IN operator */
2839 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2840 Bitmask colUsed; /* Columns of the index used */
2841 Bitmask mCol; /* Mask for the current column */
2842 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002843 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002844 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2845 ** BITMASK(nExpr) without overflowing */
2846 testcase( pIdx->nColumn==BMS-2 );
2847 testcase( pIdx->nColumn==BMS-1 );
2848 if( pIdx->nColumn>=BMS-1 ) continue;
2849 if( mustBeUnique ){
2850 if( pIdx->nKeyCol>nExpr
2851 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2852 ){
2853 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002854 }
danielk19770cdc0222008-06-26 18:04:03 +00002855 }
drha84a2832016-08-26 21:15:35 +00002856
2857 colUsed = 0; /* Columns of index used so far */
2858 for(i=0; i<nExpr; i++){
2859 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2860 Expr *pRhs = pEList->a[i].pExpr;
2861 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2862 int j;
2863
drh0c7d3d32022-01-24 16:47:12 +00002864 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
drha84a2832016-08-26 21:15:35 +00002865 for(j=0; j<nExpr; j++){
2866 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2867 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002868 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2869 continue;
2870 }
drha84a2832016-08-26 21:15:35 +00002871 break;
2872 }
2873 if( j==nExpr ) break;
2874 mCol = MASKBIT(j);
2875 if( mCol & colUsed ) break; /* Each column used only once */
2876 colUsed |= mCol;
2877 if( aiMap ) aiMap[i] = j;
2878 }
2879
2880 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2881 if( colUsed==(MASKBIT(nExpr)-1) ){
2882 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002883 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002884 ExplainQueryPlan((pParse, 0,
2885 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002886 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2887 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2888 VdbeComment((v, "%s", pIdx->zName));
2889 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2890 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2891
2892 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002893#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002894 i64 mask = (1<<nExpr)-1;
2895 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2896 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002897#endif
2898 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002899 if( nExpr==1 ){
2900 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2901 }
2902 }
2903 sqlite3VdbeJumpHere(v, iAddr);
2904 }
2905 } /* End loop over indexes */
2906 } /* End if( affinity_ok ) */
2907 } /* End if not an rowid index */
2908 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002909
drhbb53ecb2014-08-02 21:03:33 +00002910 /* If no preexisting index is available for the IN clause
2911 ** and IN_INDEX_NOOP is an allowed reply
2912 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002913 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002914 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002915 ** the IN operator so return IN_INDEX_NOOP.
2916 */
2917 if( eType==0
2918 && (inFlags & IN_INDEX_NOOP_OK)
drha4eeccd2021-10-07 17:43:30 +00002919 && ExprUseXList(pX)
drhbb53ecb2014-08-02 21:03:33 +00002920 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2921 ){
drhb94182b2022-05-02 11:24:21 +00002922 pParse->nTab--; /* Back out the allocation of the unused cursor */
2923 iTab = -1; /* Cursor is not allocated */
drhbb53ecb2014-08-02 21:03:33 +00002924 eType = IN_INDEX_NOOP;
2925 }
drhbb53ecb2014-08-02 21:03:33 +00002926
danielk19779a96b662007-11-29 17:05:18 +00002927 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002928 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002929 ** We will have to generate an ephemeral table to do the job.
2930 */
drh8e23daf2013-06-11 13:30:04 +00002931 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002932 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002933 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002934 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002935 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002936 }else if( prRhsHasNull ){
2937 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002938 }
drh85bcdce2018-12-23 21:27:29 +00002939 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002940 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002941 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002942 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002943 }
drhcf4d38a2010-07-28 02:53:36 +00002944 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002945 }
danba00e302016-07-23 20:24:06 +00002946
2947 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2948 int i, n;
2949 n = sqlite3ExprVectorSize(pX->pLeft);
2950 for(i=0; i<n; i++) aiMap[i] = i;
2951 }
drh2c041312018-12-24 02:34:49 +00002952 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002953 return eType;
2954}
danielk1977284f4ac2007-12-10 05:03:46 +00002955#endif
drh626a8792005-01-17 22:08:19 +00002956
danf9b2e052016-08-02 17:45:00 +00002957#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002958/*
2959** Argument pExpr is an (?, ?...) IN(...) expression. This
2960** function allocates and returns a nul-terminated string containing
2961** the affinities to be used for each column of the comparison.
2962**
2963** It is the responsibility of the caller to ensure that the returned
2964** string is eventually freed using sqlite3DbFree().
2965*/
drhb6dad522021-09-24 16:14:47 +00002966static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
dan71c57db2016-07-09 20:23:55 +00002967 Expr *pLeft = pExpr->pLeft;
2968 int nVal = sqlite3ExprVectorSize(pLeft);
drha4eeccd2021-10-07 17:43:30 +00002969 Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002970 char *zRet;
2971
dan553168c2016-08-01 20:14:31 +00002972 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002973 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002974 if( zRet ){
2975 int i;
2976 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002977 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002978 char a = sqlite3ExprAffinity(pA);
2979 if( pSelect ){
2980 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2981 }else{
2982 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002983 }
dan71c57db2016-07-09 20:23:55 +00002984 }
2985 zRet[nVal] = '\0';
2986 }
2987 return zRet;
2988}
danf9b2e052016-08-02 17:45:00 +00002989#endif
dan71c57db2016-07-09 20:23:55 +00002990
dan8da209b2016-07-26 18:06:08 +00002991#ifndef SQLITE_OMIT_SUBQUERY
2992/*
2993** Load the Parse object passed as the first argument with an error
2994** message of the form:
2995**
2996** "sub-select returns N columns - expected M"
2997*/
2998void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002999 if( pParse->nErr==0 ){
3000 const char *zFmt = "sub-select returns %d columns - expected %d";
3001 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
3002 }
dan8da209b2016-07-26 18:06:08 +00003003}
3004#endif
3005
drh626a8792005-01-17 22:08:19 +00003006/*
dan44c56042016-12-07 15:38:37 +00003007** Expression pExpr is a vector that has been used in a context where
3008** it is not permitted. If pExpr is a sub-select vector, this routine
3009** loads the Parse object with a message of the form:
3010**
3011** "sub-select returns N columns - expected 1"
3012**
3013** Or, if it is a regular scalar vector:
3014**
3015** "row value misused"
3016*/
3017void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
3018#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00003019 if( ExprUseXSelect(pExpr) ){
dan44c56042016-12-07 15:38:37 +00003020 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
3021 }else
3022#endif
3023 {
3024 sqlite3ErrorMsg(pParse, "row value misused");
3025 }
3026}
3027
drh85bcdce2018-12-23 21:27:29 +00003028#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00003029/*
drh85bcdce2018-12-23 21:27:29 +00003030** Generate code that will construct an ephemeral table containing all terms
3031** in the RHS of an IN operator. The IN operator can be in either of two
3032** forms:
drh626a8792005-01-17 22:08:19 +00003033**
drh9cbe6352005-11-29 03:13:21 +00003034** x IN (4,5,11) -- IN operator with list on right-hand side
3035** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00003036**
drh2c041312018-12-24 02:34:49 +00003037** The pExpr parameter is the IN operator. The cursor number for the
3038** constructed ephermeral table is returned. The first time the ephemeral
3039** table is computed, the cursor number is also stored in pExpr->iTable,
3040** however the cursor number returned might not be the same, as it might
3041** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00003042**
drh85bcdce2018-12-23 21:27:29 +00003043** If the LHS expression ("x" in the examples) is a column value, or
3044** the SELECT statement returns a column value, then the affinity of that
3045** column is used to build the index keys. If both 'x' and the
3046** SELECT... statement are columns, then numeric affinity is used
3047** if either column has NUMERIC or INTEGER affinity. If neither
3048** 'x' nor the SELECT... statement are columns, then numeric affinity
3049** is used.
drhcce7d172000-05-31 15:34:51 +00003050*/
drh85bcdce2018-12-23 21:27:29 +00003051void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00003052 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00003053 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00003054 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00003055){
drh2c041312018-12-24 02:34:49 +00003056 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00003057 int addr; /* Address of OP_OpenEphemeral instruction */
3058 Expr *pLeft; /* the LHS of the IN operator */
3059 KeyInfo *pKeyInfo = 0; /* Key information */
3060 int nVal; /* Size of vector pLeft */
3061 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00003062
drh2c041312018-12-24 02:34:49 +00003063 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003064 assert( v!=0 );
3065
drh2c041312018-12-24 02:34:49 +00003066 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00003067 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00003068 **
3069 ** * The right-hand side is a correlated subquery
3070 ** * The right-hand side is an expression list containing variables
3071 ** * We are inside a trigger
3072 **
drh2c041312018-12-24 02:34:49 +00003073 ** If all of the above are false, then we can compute the RHS just once
3074 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00003075 */
drhefb699f2018-12-24 11:55:44 +00003076 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00003077 /* Reuse of the RHS is allowed */
3078 /* If this routine has already been coded, but the previous code
3079 ** might not have been invoked yet, so invoke it now as a subroutine.
3080 */
3081 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00003082 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha4eeccd2021-10-07 17:43:30 +00003083 if( ExprUseXSelect(pExpr) ){
drhbd462bc2018-12-24 20:21:06 +00003084 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3085 pExpr->x.pSelect->selId));
3086 }
drh477572b2021-10-07 20:46:29 +00003087 assert( ExprUseYSub(pExpr) );
drh2c041312018-12-24 02:34:49 +00003088 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3089 pExpr->y.sub.iAddr);
drh086b8002022-05-13 23:01:28 +00003090 assert( iTab!=pExpr->iTable );
3091 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00003092 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00003093 return;
3094 }
3095
3096 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003097 assert( !ExprUseYWin(pExpr) );
drh2c041312018-12-24 02:34:49 +00003098 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00003099 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00003100 pExpr->y.sub.regReturn = ++pParse->nMem;
3101 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003102 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh2c041312018-12-24 02:34:49 +00003103
3104 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003105 }
3106
drh85bcdce2018-12-23 21:27:29 +00003107 /* Check to see if this is a vector IN operator */
3108 pLeft = pExpr->pLeft;
3109 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00003110
drh85bcdce2018-12-23 21:27:29 +00003111 /* Construct the ephemeral table that will contain the content of
3112 ** RHS of the IN operator.
3113 */
drh2c041312018-12-24 02:34:49 +00003114 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00003115 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00003116#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drha4eeccd2021-10-07 17:43:30 +00003117 if( ExprUseXSelect(pExpr) ){
drh2c041312018-12-24 02:34:49 +00003118 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
3119 }else{
3120 VdbeComment((v, "RHS of IN operator"));
3121 }
3122#endif
drh50ef6712019-02-22 23:29:56 +00003123 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00003124
drha4eeccd2021-10-07 17:43:30 +00003125 if( ExprUseXSelect(pExpr) ){
drh85bcdce2018-12-23 21:27:29 +00003126 /* Case 1: expr IN (SELECT ...)
3127 **
3128 ** Generate code to write the results of the select into the temporary
3129 ** table allocated and opened above.
3130 */
3131 Select *pSelect = pExpr->x.pSelect;
3132 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00003133
drh2c041312018-12-24 02:34:49 +00003134 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
3135 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00003136 ));
drh85bcdce2018-12-23 21:27:29 +00003137 /* If the LHS and RHS of the IN operator do not match, that
3138 ** error will have been caught long before we reach this point. */
3139 if( ALWAYS(pEList->nExpr==nVal) ){
drh14c4d422021-05-26 18:46:51 +00003140 Select *pCopy;
drh85bcdce2018-12-23 21:27:29 +00003141 SelectDest dest;
3142 int i;
drh14c4d422021-05-26 18:46:51 +00003143 int rc;
drhbd462bc2018-12-24 20:21:06 +00003144 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00003145 dest.zAffSdst = exprINAffinity(pParse, pExpr);
3146 pSelect->iLimit = 0;
3147 testcase( pSelect->selFlags & SF_Distinct );
3148 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh14c4d422021-05-26 18:46:51 +00003149 pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
3150 rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
3151 sqlite3SelectDelete(pParse->db, pCopy);
3152 sqlite3DbFree(pParse->db, dest.zAffSdst);
3153 if( rc ){
drh85bcdce2018-12-23 21:27:29 +00003154 sqlite3KeyInfoUnref(pKeyInfo);
3155 return;
drh14c4d422021-05-26 18:46:51 +00003156 }
drh85bcdce2018-12-23 21:27:29 +00003157 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
3158 assert( pEList!=0 );
3159 assert( pEList->nExpr>0 );
3160 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3161 for(i=0; i<nVal; i++){
3162 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3163 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3164 pParse, p, pEList->a[i].pExpr
3165 );
danielk197741a05b72008-10-02 13:50:55 +00003166 }
drh85bcdce2018-12-23 21:27:29 +00003167 }
3168 }else if( ALWAYS(pExpr->x.pList!=0) ){
3169 /* Case 2: expr IN (exprlist)
3170 **
3171 ** For each expression, build an index key from the evaluation and
3172 ** store it in the temporary table. If <expr> is a column, then use
3173 ** that columns affinity when building index keys. If <expr> is not
3174 ** a column, use numeric affinity.
3175 */
3176 char affinity; /* Affinity of the LHS of the IN */
3177 int i;
3178 ExprList *pList = pExpr->x.pList;
3179 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003180 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003181 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003182 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003183 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003184 }else if( affinity==SQLITE_AFF_REAL ){
3185 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003186 }
3187 if( pKeyInfo ){
3188 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3189 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003190 }
3191
drh85bcdce2018-12-23 21:27:29 +00003192 /* Loop through each expression in <exprlist>. */
3193 r1 = sqlite3GetTempReg(pParse);
3194 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003195 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3196 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003197
3198 /* If the expression is not constant then we will need to
3199 ** disable the test that was generated above that makes sure
3200 ** this code only executes once. Because for a non-constant
3201 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003202 */
drh2c041312018-12-24 02:34:49 +00003203 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
drh19025162022-03-03 15:00:44 +00003204 sqlite3VdbeChangeToNoop(v, addrOnce-1);
drh2c041312018-12-24 02:34:49 +00003205 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003206 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003207 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003208 }
drh1398ad32005-01-19 23:24:50 +00003209
drh85bcdce2018-12-23 21:27:29 +00003210 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003211 sqlite3ExprCode(pParse, pE2, r1);
3212 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3213 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003214 }
drh85bcdce2018-12-23 21:27:29 +00003215 sqlite3ReleaseTempReg(pParse, r1);
3216 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003217 }
drh85bcdce2018-12-23 21:27:29 +00003218 if( pKeyInfo ){
3219 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3220 }
drh2c041312018-12-24 02:34:49 +00003221 if( addrOnce ){
drh8b9a3d12022-09-20 19:22:17 +00003222 sqlite3VdbeAddOp1(v, OP_NullRow, iTab);
drh2c041312018-12-24 02:34:49 +00003223 sqlite3VdbeJumpHere(v, addrOnce);
3224 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003225 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003226 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3227 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003228 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3229 pExpr->y.sub.iAddr, 1);
3230 VdbeCoverage(v);
drh6d2566d2019-09-18 20:34:54 +00003231 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003232 }
3233}
3234#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003235
drh85bcdce2018-12-23 21:27:29 +00003236/*
3237** Generate code for scalar subqueries used as a subquery expression
3238** or EXISTS operator:
3239**
3240** (SELECT a FROM b) -- subquery
3241** EXISTS (SELECT a FROM b) -- EXISTS subquery
3242**
3243** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3244**
drhd86fe442019-08-26 13:45:49 +00003245** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003246** the result is stored in a contiguous array of registers and the
3247** return value is the register of the left-most result column.
3248** Return 0 if an error occurs.
3249*/
3250#ifndef SQLITE_OMIT_SUBQUERY
3251int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003252 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003253 int rReg = 0; /* Register storing resulting */
3254 Select *pSel; /* SELECT statement to encode */
3255 SelectDest dest; /* How to deal with SELECT result */
3256 int nReg; /* Registers to allocate */
3257 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003258
3259 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003260 assert( v!=0 );
drh05428122021-05-24 00:17:04 +00003261 if( pParse->nErr ) return 0;
drhbd462bc2018-12-24 20:21:06 +00003262 testcase( pExpr->op==TK_EXISTS );
3263 testcase( pExpr->op==TK_SELECT );
3264 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
drha4eeccd2021-10-07 17:43:30 +00003265 assert( ExprUseXSelect(pExpr) );
drhbd462bc2018-12-24 20:21:06 +00003266 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003267
drh14c4d422021-05-26 18:46:51 +00003268 /* If this routine has already been coded, then invoke it as a
3269 ** subroutine. */
3270 if( ExprHasProperty(pExpr, EP_Subrtn) ){
3271 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh477572b2021-10-07 20:46:29 +00003272 assert( ExprUseYSub(pExpr) );
drh14c4d422021-05-26 18:46:51 +00003273 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3274 pExpr->y.sub.iAddr);
3275 return pExpr->iTable;
3276 }
3277
3278 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003279 assert( !ExprUseYWin(pExpr) );
3280 assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
drh14c4d422021-05-26 18:46:51 +00003281 ExprSetProperty(pExpr, EP_Subrtn);
3282 pExpr->y.sub.regReturn = ++pParse->nMem;
3283 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003284 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh14c4d422021-05-26 18:46:51 +00003285
drh5198ff52018-12-24 12:09:47 +00003286 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003287 ** is encountered if any of the following is true:
3288 **
3289 ** * The right-hand side is a correlated subquery
3290 ** * The right-hand side is an expression list containing variables
3291 ** * We are inside a trigger
3292 **
3293 ** If all of the above are false, then we can run this code just once
3294 ** save the results, and reuse the same result on subsequent invocations.
3295 */
3296 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh2c041312018-12-24 02:34:49 +00003297 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003298 }
drh85bcdce2018-12-23 21:27:29 +00003299
3300 /* For a SELECT, generate code to put the values for all columns of
3301 ** the first row into an array of registers and return the index of
3302 ** the first register.
3303 **
3304 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3305 ** into a register and return that register number.
3306 **
3307 ** In both cases, the query is augmented with "LIMIT 1". Any
3308 ** preexisting limit is discarded in place of the new LIMIT 1.
3309 */
drhbd462bc2018-12-24 20:21:06 +00003310 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3311 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003312 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3313 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3314 pParse->nMem += nReg;
3315 if( pExpr->op==TK_SELECT ){
3316 dest.eDest = SRT_Mem;
3317 dest.iSdst = dest.iSDParm;
3318 dest.nSdst = nReg;
3319 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3320 VdbeComment((v, "Init subquery result"));
3321 }else{
3322 dest.eDest = SRT_Exists;
3323 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3324 VdbeComment((v, "Init EXISTS result"));
3325 }
drh85bcdce2018-12-23 21:27:29 +00003326 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003327 /* The subquery already has a limit. If the pre-existing limit is X
3328 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3329 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003330 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003331 if( pLimit ){
3332 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3333 pLimit = sqlite3PExpr(pParse, TK_NE,
3334 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3335 }
drh95530162022-07-20 20:36:26 +00003336 sqlite3ExprDeferredDelete(pParse, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003337 pSel->pLimit->pLeft = pLimit;
3338 }else{
drh7ca13472019-09-23 11:55:22 +00003339 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003340 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003341 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3342 }
3343 pSel->iLimit = 0;
3344 if( sqlite3Select(pParse, pSel, &dest) ){
drh1da88b52022-01-24 19:38:56 +00003345 pExpr->op2 = pExpr->op;
3346 pExpr->op = TK_ERROR;
drh85bcdce2018-12-23 21:27:29 +00003347 return 0;
3348 }
drh2c041312018-12-24 02:34:49 +00003349 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003350 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003351 if( addrOnce ){
3352 sqlite3VdbeJumpHere(v, addrOnce);
drh5198ff52018-12-24 12:09:47 +00003353 }
drh2c041312018-12-24 02:34:49 +00003354
drh14c4d422021-05-26 18:46:51 +00003355 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003356 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003357 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3358 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003359 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3360 pExpr->y.sub.iAddr, 1);
3361 VdbeCoverage(v);
drh14c4d422021-05-26 18:46:51 +00003362 sqlite3ClearTempRegCache(pParse);
drh1450bc62009-10-30 13:25:56 +00003363 return rReg;
drhcce7d172000-05-31 15:34:51 +00003364}
drh51522cd2005-01-20 13:36:19 +00003365#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003366
drhe3365e62009-11-12 17:52:24 +00003367#ifndef SQLITE_OMIT_SUBQUERY
3368/*
dan7b35a772016-07-28 19:47:15 +00003369** Expr pIn is an IN(...) expression. This function checks that the
3370** sub-select on the RHS of the IN() operator has the same number of
3371** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3372** a sub-query, that the LHS is a vector of size 1.
3373*/
3374int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3375 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
drha4eeccd2021-10-07 17:43:30 +00003376 if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
dan7b35a772016-07-28 19:47:15 +00003377 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3378 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3379 return 1;
3380 }
3381 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003382 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003383 return 1;
3384 }
3385 return 0;
3386}
3387#endif
3388
3389#ifndef SQLITE_OMIT_SUBQUERY
3390/*
drhe3365e62009-11-12 17:52:24 +00003391** Generate code for an IN expression.
3392**
3393** x IN (SELECT ...)
3394** x IN (value, value, ...)
3395**
drhecb87ac2016-08-25 15:46:25 +00003396** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003397** right-hand side (RHS) is an array of zero or more scalar values, or a
3398** subquery. If the RHS is a subquery, the number of result columns must
3399** match the number of columns in the vector on the LHS. If the RHS is
3400** a list of values, the LHS must be a scalar.
3401**
3402** The IN operator is true if the LHS value is contained within the RHS.
3403** The result is false if the LHS is definitely not in the RHS. The
3404** result is NULL if the presence of the LHS in the RHS cannot be
3405** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003406**
drh6be515e2014-08-01 21:00:53 +00003407** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003408** contained within the RHS. If due to NULLs we cannot determine if the LHS
3409** is contained in the RHS then jump to destIfNull. If the LHS is contained
3410** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003411**
3412** See the separate in-operator.md documentation file in the canonical
3413** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003414*/
3415static void sqlite3ExprCodeIN(
3416 Parse *pParse, /* Parsing and code generating context */
3417 Expr *pExpr, /* The IN expression */
3418 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3419 int destIfNull /* Jump here if the results are unknown due to NULLs */
3420){
3421 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003422 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003423 int rLhs; /* Register(s) holding the LHS values */
3424 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003425 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003426 int *aiMap = 0; /* Map from vector field to index column */
3427 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003428 int nVector; /* Size of vectors for this IN operator */
3429 int iDummy; /* Dummy parameter to exprCodeVector() */
3430 Expr *pLeft; /* The LHS of the IN operator */
3431 int i; /* loop counter */
3432 int destStep2; /* Where to jump when NULLs seen in step 2 */
3433 int destStep6 = 0; /* Start of code for Step 6 */
3434 int addrTruthOp; /* Address of opcode that determines the IN is true */
3435 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3436 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003437 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003438 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003439
drhe7375bf2020-03-10 19:24:38 +00003440 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003441 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003442 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003443 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003444 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3445 aiMap = (int*)sqlite3DbMallocZero(
3446 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3447 );
drhe347d3e2016-08-25 21:14:34 +00003448 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003449
danba00e302016-07-23 20:24:06 +00003450 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003451 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003452 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3453 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003454 v = pParse->pVdbe;
3455 assert( v!=0 ); /* OOM detected prior to this routine */
3456 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003457 eType = sqlite3FindInIndex(pParse, pExpr,
3458 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003459 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3460 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003461
danba00e302016-07-23 20:24:06 +00003462 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3463 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3464 );
drhecb87ac2016-08-25 15:46:25 +00003465#ifdef SQLITE_DEBUG
3466 /* Confirm that aiMap[] contains nVector integer values between 0 and
3467 ** nVector-1. */
3468 for(i=0; i<nVector; i++){
3469 int j, cnt;
3470 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3471 assert( cnt==1 );
3472 }
3473#endif
drhe3365e62009-11-12 17:52:24 +00003474
danba00e302016-07-23 20:24:06 +00003475 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3476 ** vector, then it is stored in an array of nVector registers starting
3477 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003478 **
3479 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3480 ** so that the fields are in the same order as an existing index. The
3481 ** aiMap[] array contains a mapping from the original LHS field order to
3482 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003483 **
3484 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3485 ** even if it is constant, as OP_Affinity may be used on the register
3486 ** by code generated below. */
3487 assert( pParse->okConstFactor==okConstFactor );
3488 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003489 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003490 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003491 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003492 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003493 /* LHS fields are not reordered */
3494 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003495 }else{
3496 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003497 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003498 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003499 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003500 }
danba00e302016-07-23 20:24:06 +00003501 }
drhe3365e62009-11-12 17:52:24 +00003502
drhbb53ecb2014-08-02 21:03:33 +00003503 /* If sqlite3FindInIndex() did not find or create an index that is
3504 ** suitable for evaluating the IN operator, then evaluate using a
3505 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003506 **
3507 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003508 */
drhbb53ecb2014-08-02 21:03:33 +00003509 if( eType==IN_INDEX_NOOP ){
drha4eeccd2021-10-07 17:43:30 +00003510 ExprList *pList;
3511 CollSeq *pColl;
drhec4ccdb2018-12-29 02:26:59 +00003512 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003513 int r2, regToFree;
3514 int regCkNull = 0;
3515 int ii;
drha4eeccd2021-10-07 17:43:30 +00003516 assert( ExprUseXList(pExpr) );
3517 pList = pExpr->x.pList;
3518 pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhbb53ecb2014-08-02 21:03:33 +00003519 if( destIfNull!=destIfFalse ){
3520 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003521 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003522 }
3523 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003524 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003525 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003526 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3527 }
drhf6ea97e2020-01-04 15:21:47 +00003528 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003529 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003530 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3531 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003532 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003533 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3534 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3535 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3536 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003537 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003538 }else{
drh47994882019-12-22 23:48:36 +00003539 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003540 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003541 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3542 (void*)pColl, P4_COLLSEQ);
3543 VdbeCoverageIf(v, op==OP_Ne);
3544 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003545 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003546 }
drhbb53ecb2014-08-02 21:03:33 +00003547 }
3548 if( regCkNull ){
3549 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003550 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003551 }
3552 sqlite3VdbeResolveLabel(v, labelOk);
3553 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003554 goto sqlite3ExprCodeIN_finished;
3555 }
3556
3557 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3558 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3559 ** We will then skip the binary search of the RHS.
3560 */
3561 if( destIfNull==destIfFalse ){
3562 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003563 }else{
drhec4ccdb2018-12-29 02:26:59 +00003564 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003565 }
3566 for(i=0; i<nVector; i++){
3567 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
drh1da88b52022-01-24 19:38:56 +00003568 if( pParse->nErr ) goto sqlite3ExprCodeIN_oom_error;
drhe347d3e2016-08-25 21:14:34 +00003569 if( sqlite3ExprCanBeNull(p) ){
3570 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003571 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003572 }
drhe3365e62009-11-12 17:52:24 +00003573 }
drhe347d3e2016-08-25 21:14:34 +00003574
3575 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3576 ** of the RHS using the LHS as a probe. If found, the result is
3577 ** true.
3578 */
3579 if( eType==IN_INDEX_ROWID ){
3580 /* In this case, the RHS is the ROWID of table b-tree and so we also
3581 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3582 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003583 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003584 VdbeCoverage(v);
3585 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3586 }else{
3587 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3588 if( destIfFalse==destIfNull ){
3589 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003590 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003591 rLhs, nVector); VdbeCoverage(v);
3592 goto sqlite3ExprCodeIN_finished;
3593 }
3594 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003595 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003596 rLhs, nVector); VdbeCoverage(v);
3597 }
3598
3599 /* Step 4. If the RHS is known to be non-NULL and we did not find
3600 ** an match on the search above, then the result must be FALSE.
3601 */
3602 if( rRhsHasNull && nVector==1 ){
3603 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3604 VdbeCoverage(v);
3605 }
3606
3607 /* Step 5. If we do not care about the difference between NULL and
3608 ** FALSE, then just return false.
3609 */
3610 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3611
3612 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3613 ** If any comparison is NULL, then the result is NULL. If all
3614 ** comparisons are FALSE then the final result is FALSE.
3615 **
3616 ** For a scalar LHS, it is sufficient to check just the first row
3617 ** of the RHS.
3618 */
3619 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003620 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003621 VdbeCoverage(v);
3622 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003623 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003624 }else{
3625 /* For nVector==1, combine steps 6 and 7 by immediately returning
3626 ** FALSE if the first comparison is not NULL */
3627 destNotNull = destIfFalse;
3628 }
3629 for(i=0; i<nVector; i++){
3630 Expr *p;
3631 CollSeq *pColl;
3632 int r3 = sqlite3GetTempReg(pParse);
3633 p = sqlite3VectorFieldSubexpr(pLeft, i);
3634 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003635 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003636 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3637 (void*)pColl, P4_COLLSEQ);
3638 VdbeCoverage(v);
3639 sqlite3ReleaseTempReg(pParse, r3);
3640 }
3641 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3642 if( nVector>1 ){
3643 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003644 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003645 VdbeCoverage(v);
3646
3647 /* Step 7: If we reach this point, we know that the result must
3648 ** be false. */
3649 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3650 }
3651
3652 /* Jumps here in order to return true. */
3653 sqlite3VdbeJumpHere(v, addrTruthOp);
3654
3655sqlite3ExprCodeIN_finished:
3656 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003657 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003658sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003659 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003660 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003661}
3662#endif /* SQLITE_OMIT_SUBQUERY */
3663
drh13573c72010-01-12 17:04:07 +00003664#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003665/*
3666** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003667** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003668**
3669** The z[] string will probably not be zero-terminated. But the
3670** z[n] character is guaranteed to be something that does not look
3671** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003672*/
drhb7916a72009-05-27 10:31:29 +00003673static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003674 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003675 double value;
drh9339da12010-09-30 00:50:49 +00003676 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003677 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3678 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003679 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003680 }
3681}
drh13573c72010-01-12 17:04:07 +00003682#endif
drh598f1342007-10-23 15:39:45 +00003683
3684
3685/*
drhfec19aa2004-05-19 20:41:03 +00003686** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003687** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003688**
shaneh5f1d6b62010-09-30 16:51:25 +00003689** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003690*/
drh13573c72010-01-12 17:04:07 +00003691static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3692 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003693 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003694 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003695 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003696 if( negFlag ) i = -i;
3697 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003698 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003699 int c;
3700 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003701 const char *z = pExpr->u.zToken;
3702 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003703 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003704 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003705#ifdef SQLITE_OMIT_FLOATING_POINT
drh62fc0692022-02-06 00:30:04 +00003706 sqlite3ErrorMsg(pParse, "oversized integer: %s%#T", negFlag?"-":"",pExpr);
drh13573c72010-01-12 17:04:07 +00003707#else
drh1b7ddc52014-07-23 14:52:05 +00003708#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003709 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh62fc0692022-02-06 00:30:04 +00003710 sqlite3ErrorMsg(pParse, "hex literal too big: %s%#T",
3711 negFlag?"-":"",pExpr);
drh1b7ddc52014-07-23 14:52:05 +00003712 }else
3713#endif
3714 {
drh9296c182014-07-23 13:40:49 +00003715 codeReal(v, z, negFlag, iMem);
3716 }
drh13573c72010-01-12 17:04:07 +00003717#endif
drh77320ea2016-11-30 14:47:37 +00003718 }else{
drh84d4f1a2017-09-20 10:47:10 +00003719 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003720 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003721 }
drhfec19aa2004-05-19 20:41:03 +00003722 }
3723}
3724
drh5cd79232009-05-25 11:46:29 +00003725
drh1f9ca2c2015-08-25 16:57:52 +00003726/* Generate code that will load into register regOut a value that is
3727** appropriate for the iIdxCol-th column of index pIdx.
3728*/
3729void sqlite3ExprCodeLoadIndexColumn(
3730 Parse *pParse, /* The parsing context */
3731 Index *pIdx, /* The index whose column is to be loaded */
3732 int iTabCur, /* Cursor pointing to a table row */
3733 int iIdxCol, /* The column of the index to be loaded */
3734 int regOut /* Store the index column value in this register */
3735){
3736 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003737 if( iTabCol==XN_EXPR ){
3738 assert( pIdx->aColExpr );
3739 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003740 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003741 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003742 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003743 }else{
drh6df9c4b2019-10-18 12:52:08 +00003744 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003745 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003746 }
drh1f9ca2c2015-08-25 16:57:52 +00003747}
3748
drhe70fa7f2019-10-22 21:01:34 +00003749#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3750/*
3751** Generate code that will compute the value of generated column pCol
3752** and store the result in register regOut
3753*/
3754void sqlite3ExprCodeGeneratedColumn(
drh79cf2b72021-07-31 20:30:41 +00003755 Parse *pParse, /* Parsing context */
3756 Table *pTab, /* Table containing the generated column */
3757 Column *pCol, /* The generated column */
3758 int regOut /* Put the result in this register */
drhe70fa7f2019-10-22 21:01:34 +00003759){
drh4dad7ed2019-12-16 16:52:22 +00003760 int iAddr;
3761 Vdbe *v = pParse->pVdbe;
3762 assert( v!=0 );
3763 assert( pParse->iSelfTab!=0 );
3764 if( pParse->iSelfTab>0 ){
3765 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3766 }else{
3767 iAddr = 0;
3768 }
drh79cf2b72021-07-31 20:30:41 +00003769 sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
drhe70fa7f2019-10-22 21:01:34 +00003770 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003771 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003772 }
drh4dad7ed2019-12-16 16:52:22 +00003773 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003774}
3775#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3776
drh5cd79232009-05-25 11:46:29 +00003777/*
drh5c092e82010-05-14 19:24:02 +00003778** Generate code to extract the value of the iCol-th column of a table.
3779*/
3780void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003781 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003782 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003783 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003784 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003785 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003786){
drhab45fc02019-10-16 22:01:56 +00003787 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003788 assert( v!=0 );
drh63b3a642022-10-20 13:36:32 +00003789 assert( pTab!=0 );
drh5c092e82010-05-14 19:24:02 +00003790 if( iCol<0 || iCol==pTab->iPKey ){
3791 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
drh088b6152022-04-18 13:57:57 +00003792 VdbeComment((v, "%s.rowid", pTab->zName));
drh5c092e82010-05-14 19:24:02 +00003793 }else{
drh81f7b372019-10-16 12:18:59 +00003794 int op;
3795 int x;
3796 if( IsVirtual(pTab) ){
3797 op = OP_VColumn;
3798 x = iCol;
3799#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003800 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003801 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003802 if( pCol->colFlags & COLFLAG_BUSY ){
drhcf9d36d2021-08-02 18:03:43 +00003803 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3804 pCol->zCnName);
drhab45fc02019-10-16 22:01:56 +00003805 }else{
3806 int savedSelfTab = pParse->iSelfTab;
3807 pCol->colFlags |= COLFLAG_BUSY;
3808 pParse->iSelfTab = iTabCur+1;
drh79cf2b72021-07-31 20:30:41 +00003809 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003810 pParse->iSelfTab = savedSelfTab;
3811 pCol->colFlags &= ~COLFLAG_BUSY;
3812 }
drh81f7b372019-10-16 12:18:59 +00003813 return;
3814#endif
3815 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003816 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003817 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003818 op = OP_Column;
3819 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003820 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003821 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003822 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003823 }
3824 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003825 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3826 }
3827}
3828
3829/*
drh945498f2007-02-24 11:52:52 +00003830** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003831** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003832**
3833** There must be an open cursor to pTab in iTable when this routine
3834** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003835*/
drhe55cbd72008-03-31 23:48:03 +00003836int sqlite3ExprCodeGetColumn(
3837 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003838 Table *pTab, /* Description of the table we are reading from */
3839 int iColumn, /* Index of the table column */
3840 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003841 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003842 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003843){
drh81f7b372019-10-16 12:18:59 +00003844 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003845 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003846 if( p5 ){
drh058e9952022-07-25 19:05:24 +00003847 VdbeOp *pOp = sqlite3VdbeGetLastOp(pParse->pVdbe);
drh99670ab2019-12-14 17:43:37 +00003848 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003849 }
drhe55cbd72008-03-31 23:48:03 +00003850 return iReg;
3851}
drhe55cbd72008-03-31 23:48:03 +00003852
3853/*
drhb21e7c72008-06-22 12:37:57 +00003854** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003855** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003856*/
drhb21e7c72008-06-22 12:37:57 +00003857void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003858 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003859}
3860
drh652fbf52008-04-01 01:42:41 +00003861/*
drh12abf402016-08-22 14:30:05 +00003862** Convert a scalar expression node to a TK_REGISTER referencing
3863** register iReg. The caller must ensure that iReg already contains
3864** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003865*/
dan069d1b12019-06-16 08:58:14 +00003866static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003867 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003868 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003869 p->op2 = p->op;
3870 p->op = TK_REGISTER;
3871 p->iTable = iReg;
3872 ExprClearProperty(p, EP_Skip);
3873}
3874
drh12abf402016-08-22 14:30:05 +00003875/*
3876** Evaluate an expression (either a vector or a scalar expression) and store
3877** the result in continguous temporary registers. Return the index of
3878** the first register used to store the result.
3879**
3880** If the returned result register is a temporary scalar, then also write
3881** that register number into *piFreeable. If the returned result register
3882** is not a temporary or if the expression is a vector set *piFreeable
3883** to 0.
3884*/
3885static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3886 int iResult;
3887 int nResult = sqlite3ExprVectorSize(p);
3888 if( nResult==1 ){
3889 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3890 }else{
3891 *piFreeable = 0;
3892 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003893#if SQLITE_OMIT_SUBQUERY
3894 iResult = 0;
3895#else
drh85bcdce2018-12-23 21:27:29 +00003896 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003897#endif
drh12abf402016-08-22 14:30:05 +00003898 }else{
3899 int i;
3900 iResult = pParse->nMem+1;
3901 pParse->nMem += nResult;
drha4eeccd2021-10-07 17:43:30 +00003902 assert( ExprUseXList(p) );
drh12abf402016-08-22 14:30:05 +00003903 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003904 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003905 }
3906 }
3907 }
3908 return iResult;
3909}
3910
drh25c42962020-01-01 13:55:08 +00003911/*
drh92a27f72020-02-04 01:41:44 +00003912** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3913** so that a subsequent copy will not be merged into this one.
3914*/
3915static void setDoNotMergeFlagOnCopy(Vdbe *v){
drh058e9952022-07-25 19:05:24 +00003916 if( sqlite3VdbeGetLastOp(v)->opcode==OP_Copy ){
drh92a27f72020-02-04 01:41:44 +00003917 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3918 }
3919}
3920
3921/*
drh25c42962020-01-01 13:55:08 +00003922** Generate code to implement special SQL functions that are implemented
3923** in-line rather than by using the usual callbacks.
3924*/
3925static int exprCodeInlineFunction(
3926 Parse *pParse, /* Parsing context */
3927 ExprList *pFarg, /* List of function arguments */
3928 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3929 int target /* Store function result in this register */
3930){
3931 int nFarg;
3932 Vdbe *v = pParse->pVdbe;
3933 assert( v!=0 );
3934 assert( pFarg!=0 );
3935 nFarg = pFarg->nExpr;
3936 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3937 switch( iFuncId ){
3938 case INLINEFUNC_coalesce: {
3939 /* Attempt a direct implementation of the built-in COALESCE() and
3940 ** IFNULL() functions. This avoids unnecessary evaluation of
3941 ** arguments past the first non-NULL argument.
3942 */
3943 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3944 int i;
3945 assert( nFarg>=2 );
3946 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3947 for(i=1; i<nFarg; i++){
3948 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3949 VdbeCoverage(v);
3950 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3951 }
drh92a27f72020-02-04 01:41:44 +00003952 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003953 sqlite3VdbeResolveLabel(v, endCoalesce);
3954 break;
3955 }
drh3c0e6062020-05-13 18:03:34 +00003956 case INLINEFUNC_iif: {
3957 Expr caseExpr;
3958 memset(&caseExpr, 0, sizeof(caseExpr));
3959 caseExpr.op = TK_CASE;
3960 caseExpr.x.pList = pFarg;
3961 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3962 }
drh6d013d82022-06-01 13:32:05 +00003963#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh645682a2022-06-01 11:05:59 +00003964 case INLINEFUNC_sqlite_offset: {
3965 Expr *pArg = pFarg->a[0].pExpr;
3966 if( pArg->op==TK_COLUMN && pArg->iTable>=0 ){
3967 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
3968 }else{
3969 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3970 }
3971 break;
3972 }
drh6d013d82022-06-01 13:32:05 +00003973#endif
drh171c50e2020-01-01 15:43:30 +00003974 default: {
drh25c42962020-01-01 13:55:08 +00003975 /* The UNLIKELY() function is a no-op. The result is the value
3976 ** of the first argument.
3977 */
drh171c50e2020-01-01 15:43:30 +00003978 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003979 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3980 break;
3981 }
3982
drh171c50e2020-01-01 15:43:30 +00003983 /***********************************************************************
3984 ** Test-only SQL functions that are only usable if enabled
3985 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3986 */
drh3780f9a2021-09-17 13:07:15 +00003987#if !defined(SQLITE_UNTESTABLE)
drh171c50e2020-01-01 15:43:30 +00003988 case INLINEFUNC_expr_compare: {
3989 /* Compare two expressions using sqlite3ExprCompare() */
3990 assert( nFarg==2 );
3991 sqlite3VdbeAddOp2(v, OP_Integer,
3992 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3993 target);
3994 break;
3995 }
3996
3997 case INLINEFUNC_expr_implies_expr: {
3998 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3999 assert( nFarg==2 );
4000 sqlite3VdbeAddOp2(v, OP_Integer,
4001 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
4002 target);
4003 break;
4004 }
4005
4006 case INLINEFUNC_implies_nonnull_row: {
4007 /* REsult of sqlite3ExprImpliesNonNullRow() */
4008 Expr *pA1;
4009 assert( nFarg==2 );
4010 pA1 = pFarg->a[1].pExpr;
4011 if( pA1->op==TK_COLUMN ){
4012 sqlite3VdbeAddOp2(v, OP_Integer,
4013 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
4014 target);
4015 }else{
4016 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4017 }
4018 break;
4019 }
4020
drh25c42962020-01-01 13:55:08 +00004021 case INLINEFUNC_affinity: {
4022 /* The AFFINITY() function evaluates to a string that describes
4023 ** the type affinity of the argument. This is used for testing of
4024 ** the SQLite type logic.
4025 */
4026 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
4027 char aff;
4028 assert( nFarg==1 );
4029 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
4030 sqlite3VdbeLoadString(v, target,
4031 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
4032 break;
4033 }
drh3780f9a2021-09-17 13:07:15 +00004034#endif /* !defined(SQLITE_UNTESTABLE) */
drh25c42962020-01-01 13:55:08 +00004035 }
4036 return target;
4037}
4038
drh4bc1cc12022-10-13 21:08:34 +00004039/*
drhe70d4582022-10-17 14:46:39 +00004040** Check to see if pExpr is one of the indexed expressions on pParse->pIdxExpr.
drh4bc1cc12022-10-13 21:08:34 +00004041** If it is, then resolve the expression by reading from the index and
drhe70d4582022-10-17 14:46:39 +00004042** return the register into which the value has been read. If pExpr is
4043** not an indexed expression, then return negative.
drh4bc1cc12022-10-13 21:08:34 +00004044*/
drhe70d4582022-10-17 14:46:39 +00004045static SQLITE_NOINLINE int sqlite3IndexedExprLookup(
drh4bc1cc12022-10-13 21:08:34 +00004046 Parse *pParse, /* The parsing context */
4047 Expr *pExpr, /* The expression to potentially bypass */
4048 int target /* Where to store the result of the expression */
4049){
drhe70d4582022-10-17 14:46:39 +00004050 IndexedExpr *p;
drh7a989372022-10-15 11:27:01 +00004051 Vdbe *v;
drh4bc1cc12022-10-13 21:08:34 +00004052 for(p=pParse->pIdxExpr; p; p=p->pIENext){
drha331cf72022-10-18 16:47:41 +00004053 int iDataCur = p->iDataCur;
4054 if( iDataCur<0 ) continue;
4055 if( pParse->iSelfTab ){
4056 if( p->iDataCur!=pParse->iSelfTab-1 ) continue;
4057 iDataCur = -1;
4058 }
4059 if( sqlite3ExprCompare(0, pExpr, p->pExpr, iDataCur)!=0 ) continue;
drh7a989372022-10-15 11:27:01 +00004060 v = pParse->pVdbe;
4061 assert( v!=0 );
4062 if( p->bMaybeNullRow ){
4063 /* If the index is on a NULL row due to an outer join, then we
4064 ** cannot extract the value from the index. The value must be
4065 ** computed using the original expression. */
4066 int addr = sqlite3VdbeCurrentAddr(v);
4067 sqlite3VdbeAddOp3(v, OP_IfNullRow, p->iIdxCur, addr+3, target);
4068 VdbeCoverage(v);
4069 sqlite3VdbeAddOp3(v, OP_Column, p->iIdxCur, p->iIdxCol, target);
drh7a2a8ce2022-10-18 20:27:02 +00004070 VdbeComment((v, "%s expr-column %d", p->zIdxName, p->iIdxCol));
drh7a989372022-10-15 11:27:01 +00004071 sqlite3VdbeGoto(v, 0);
4072 p = pParse->pIdxExpr;
4073 pParse->pIdxExpr = 0;
4074 sqlite3ExprCode(pParse, pExpr, target);
4075 pParse->pIdxExpr = p;
4076 sqlite3VdbeJumpHere(v, addr+2);
4077 }else{
4078 sqlite3VdbeAddOp3(v, OP_Column, p->iIdxCur, p->iIdxCol, target);
drh7a2a8ce2022-10-18 20:27:02 +00004079 VdbeComment((v, "%s expr-column %d", p->zIdxName, p->iIdxCol));
drh7a989372022-10-15 11:27:01 +00004080 }
drh4bc1cc12022-10-13 21:08:34 +00004081 return target;
4082 }
4083 return -1; /* Not found */
4084}
4085
dan71c57db2016-07-09 20:23:55 +00004086
drha4c3c872013-09-12 17:29:25 +00004087/*
drhcce7d172000-05-31 15:34:51 +00004088** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00004089** expression. Attempt to store the results in register "target".
4090** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00004091**
drh8b213892008-08-29 02:14:02 +00004092** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00004093** be stored in target. The result might be stored in some other
4094** register if it is convenient to do so. The calling function
4095** must check the return code and move the results to the desired
4096** register.
drhcce7d172000-05-31 15:34:51 +00004097*/
drh678ccce2008-03-31 18:19:54 +00004098int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00004099 Vdbe *v = pParse->pVdbe; /* The VM under construction */
4100 int op; /* The opcode being coded */
4101 int inReg = target; /* Results stored in register inReg */
4102 int regFree1 = 0; /* If non-zero free this temporary register */
4103 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00004104 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00004105 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00004106 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00004107
drh9cbf3422008-01-17 16:22:13 +00004108 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00004109 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00004110
drha331cf72022-10-18 16:47:41 +00004111expr_code_doover:
4112 if( pExpr==0 ){
4113 op = TK_NULL;
4114 }else if( pParse->pIdxExpr!=0
drh4bc1cc12022-10-13 21:08:34 +00004115 && !ExprHasProperty(pExpr, EP_Leaf)
drhe70d4582022-10-17 14:46:39 +00004116 && (r1 = sqlite3IndexedExprLookup(pParse, pExpr, target))>=0
drh4bc1cc12022-10-13 21:08:34 +00004117 ){
4118 return r1;
drh389a1ad2008-01-03 23:44:53 +00004119 }else{
drhe7375bf2020-03-10 19:24:38 +00004120 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00004121 op = pExpr->op;
4122 }
drhf2bc0132004-10-04 13:19:23 +00004123 switch( op ){
drh13449892005-09-07 21:22:45 +00004124 case TK_AGG_COLUMN: {
4125 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004126 struct AggInfo_col *pCol;
4127 assert( pAggInfo!=0 );
4128 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4129 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00004130 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00004131 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00004132 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00004133 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00004134 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00004135 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00004136 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00004137 if( pCol->iColumn<0 ){
4138 VdbeComment((v,"%s.rowid",pTab->zName));
drh4b1b65c2022-07-26 15:32:02 +00004139 }else if( ALWAYS(pTab!=0) ){
drhcf9d36d2021-08-02 18:03:43 +00004140 VdbeComment((v,"%s.%s",
4141 pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
drh8d5cea62020-03-11 02:04:15 +00004142 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
4143 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4144 }
drh0c76e892020-03-10 11:50:43 +00004145 }
drhc332cc32016-09-19 10:24:19 +00004146 return target;
drh13449892005-09-07 21:22:45 +00004147 }
4148 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00004149 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00004150 }
drh967e8b72000-06-21 13:59:10 +00004151 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00004152 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00004153 int iReg;
drhefad2e22018-07-27 16:57:11 +00004154 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00004155 /* This COLUMN expression is really a constant due to WHERE clause
4156 ** constraints, and that constant is coded by the pExpr->pLeft
4157 ** expresssion. However, make sure the constant has the correct
4158 ** datatype by applying the Affinity of the table column to the
4159 ** constant.
4160 */
drh57f7ece2019-11-21 18:28:44 +00004161 int aff;
drh67b9ba12019-12-20 20:45:02 +00004162 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh477572b2021-10-07 20:46:29 +00004163 assert( ExprUseYTab(pExpr) );
drh63b3a642022-10-20 13:36:32 +00004164 assert( pExpr->y.pTab!=0 );
4165 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00004166 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00004167 static const char zAff[] = "B\000C\000D\000E";
4168 assert( SQLITE_AFF_BLOB=='A' );
4169 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00004170 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4171 &zAff[(aff-'B')*2], P4_STATIC);
4172 }
4173 return iReg;
drhefad2e22018-07-27 16:57:11 +00004174 }
drhb2b9d3d2013-08-01 01:14:43 +00004175 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00004176 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00004177 /* Other columns in the same row for CHECK constraints or
4178 ** generated columns or for inserting into partial index.
4179 ** The row is unpacked into registers beginning at
4180 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
4181 ** immediately prior to the first column.
4182 */
4183 Column *pCol;
drh477572b2021-10-07 20:46:29 +00004184 Table *pTab;
drh9942ef02019-10-18 02:19:18 +00004185 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00004186 int iCol = pExpr->iColumn;
drh477572b2021-10-07 20:46:29 +00004187 assert( ExprUseYTab(pExpr) );
4188 pTab = pExpr->y.pTab;
drh9942ef02019-10-18 02:19:18 +00004189 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00004190 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00004191 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00004192 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00004193 return -1-pParse->iSelfTab;
4194 }
drhc5f808d2019-10-19 15:01:52 +00004195 pCol = pTab->aCol + iCol;
4196 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4197 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00004198#ifndef SQLITE_OMIT_GENERATED_COLUMNS
4199 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00004200 if( pCol->colFlags & COLFLAG_BUSY ){
4201 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
drhcf9d36d2021-08-02 18:03:43 +00004202 pCol->zCnName);
drh4e8e5332019-11-07 02:32:54 +00004203 return 0;
4204 }
4205 pCol->colFlags |= COLFLAG_BUSY;
4206 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
drh79cf2b72021-07-31 20:30:41 +00004207 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
drh4e8e5332019-11-07 02:32:54 +00004208 }
4209 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00004210 return iSrc;
drh9942ef02019-10-18 02:19:18 +00004211 }else
4212#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
4213 if( pCol->affinity==SQLITE_AFF_REAL ){
4214 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00004215 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4216 return target;
4217 }else{
drh9942ef02019-10-18 02:19:18 +00004218 return iSrc;
drhbffdd632019-09-02 00:58:44 +00004219 }
drhb2b9d3d2013-08-01 01:14:43 +00004220 }else{
drh1f9ca2c2015-08-25 16:57:52 +00004221 /* Coding an expression that is part of an index where column names
4222 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00004223 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00004224 }
drh22827922000-06-06 17:27:05 +00004225 }
drh477572b2021-10-07 20:46:29 +00004226 assert( ExprUseYTab(pExpr) );
drh63b3a642022-10-20 13:36:32 +00004227 assert( pExpr->y.pTab!=0 );
drh67b9ba12019-12-20 20:45:02 +00004228 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00004229 pExpr->iColumn, iTab, target,
4230 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00004231 return iReg;
drhcce7d172000-05-31 15:34:51 +00004232 }
4233 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00004234 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00004235 return target;
drhfec19aa2004-05-19 20:41:03 +00004236 }
drh8abed7b2018-02-26 18:49:05 +00004237 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00004238 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00004239 return target;
4240 }
drh13573c72010-01-12 17:04:07 +00004241#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004242 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004243 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4244 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004245 return target;
drh598f1342007-10-23 15:39:45 +00004246 }
drh13573c72010-01-12 17:04:07 +00004247#endif
drhfec19aa2004-05-19 20:41:03 +00004248 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004249 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004250 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004251 return target;
drhcce7d172000-05-31 15:34:51 +00004252 }
drhaac30f92019-12-14 15:01:55 +00004253 default: {
drhc29af652019-12-18 21:22:40 +00004254 /* Make NULL the default case so that if a bug causes an illegal
4255 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004256 ** sanely and not crash. But keep the assert() to bring the problem
4257 ** to the attention of the developers. */
drh05428122021-05-24 00:17:04 +00004258 assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
drh9de221d2008-01-05 06:51:30 +00004259 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004260 return target;
drhf0863fe2005-06-12 21:35:51 +00004261 }
danielk19775338a5f2005-01-20 13:03:10 +00004262#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004263 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004264 int n;
4265 const char *z;
drhca48c902008-01-18 14:08:24 +00004266 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00004267 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4268 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4269 assert( pExpr->u.zToken[1]=='\'' );
4270 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004271 n = sqlite3Strlen30(z) - 1;
4272 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004273 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4274 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004275 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004276 }
danielk19775338a5f2005-01-20 13:03:10 +00004277#endif
drh50457892003-09-06 01:10:47 +00004278 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004279 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4280 assert( pExpr->u.zToken!=0 );
4281 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004282 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4283 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004284 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004285 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004286 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004287 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004288 }
drhc332cc32016-09-19 10:24:19 +00004289 return target;
drh50457892003-09-06 01:10:47 +00004290 }
drh4e0cff62004-11-05 05:10:28 +00004291 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004292 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004293 }
drh487e2622005-06-25 18:42:14 +00004294#ifndef SQLITE_OMIT_CAST
4295 case TK_CAST: {
4296 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004297 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004298 if( inReg!=target ){
4299 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4300 inReg = target;
4301 }
drhf9751072021-10-07 13:40:29 +00004302 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh4169e432014-08-25 20:11:52 +00004303 sqlite3VdbeAddOp2(v, OP_Cast, target,
4304 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004305 return inReg;
drh487e2622005-06-25 18:42:14 +00004306 }
4307#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004308 case TK_IS:
4309 case TK_ISNOT:
4310 op = (op==TK_IS) ? TK_EQ : TK_NE;
4311 p5 = SQLITE_NULLEQ;
4312 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004313 case TK_LT:
4314 case TK_LE:
4315 case TK_GT:
4316 case TK_GE:
4317 case TK_NE:
4318 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004319 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004320 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004321 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004322 }else{
4323 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4324 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004325 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4326 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4327 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004328 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004329 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4330 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4331 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4332 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4333 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4334 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004335 if( p5==SQLITE_NULLEQ ){
4336 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4337 }else{
4338 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4339 }
dan71c57db2016-07-09 20:23:55 +00004340 testcase( regFree1==0 );
4341 testcase( regFree2==0 );
4342 }
drh6a2fe092009-09-23 02:29:36 +00004343 break;
4344 }
drhcce7d172000-05-31 15:34:51 +00004345 case TK_AND:
4346 case TK_OR:
4347 case TK_PLUS:
4348 case TK_STAR:
4349 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004350 case TK_REM:
4351 case TK_BITAND:
4352 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004353 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004354 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004355 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004356 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004357 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4358 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4359 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4360 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4361 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4362 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4363 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4364 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4365 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4366 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4367 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004368 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4369 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004370 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004371 testcase( regFree1==0 );
4372 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004373 break;
4374 }
drhcce7d172000-05-31 15:34:51 +00004375 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004376 Expr *pLeft = pExpr->pLeft;
4377 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004378 if( pLeft->op==TK_INTEGER ){
4379 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004380 return target;
drh13573c72010-01-12 17:04:07 +00004381#ifndef SQLITE_OMIT_FLOATING_POINT
4382 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004383 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4384 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004385 return target;
drh13573c72010-01-12 17:04:07 +00004386#endif
drh3c84ddf2008-01-09 02:15:38 +00004387 }else{
drh10d1edf2013-11-15 15:52:39 +00004388 tempX.op = TK_INTEGER;
4389 tempX.flags = EP_IntValue|EP_TokenOnly;
4390 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004391 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004392 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004393 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004394 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004395 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004396 }
drh3c84ddf2008-01-09 02:15:38 +00004397 break;
drh6e142f52000-06-08 13:36:40 +00004398 }
drhbf4133c2001-10-13 02:59:08 +00004399 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004400 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004401 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4402 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004403 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4404 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004405 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004406 break;
4407 }
drh8abed7b2018-02-26 18:49:05 +00004408 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004409 int isTrue; /* IS TRUE or IS NOT TRUE */
4410 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004411 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4412 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004413 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4414 bNormal = pExpr->op2==TK_IS;
4415 testcase( isTrue && bNormal);
4416 testcase( !isTrue && bNormal);
4417 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004418 break;
4419 }
drhcce7d172000-05-31 15:34:51 +00004420 case TK_ISNULL:
4421 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004422 int addr;
drh7d176102014-02-18 03:07:12 +00004423 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4424 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004425 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004426 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004427 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004428 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004429 VdbeCoverageIf(v, op==TK_ISNULL);
4430 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004431 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004432 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004433 break;
drhcce7d172000-05-31 15:34:51 +00004434 }
drh22827922000-06-06 17:27:05 +00004435 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004436 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004437 if( pInfo==0
4438 || NEVER(pExpr->iAgg<0)
4439 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4440 ){
drh33e619f2009-05-28 01:00:55 +00004441 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh62fc0692022-02-06 00:30:04 +00004442 sqlite3ErrorMsg(pParse, "misuse of aggregate: %#T()", pExpr);
drh7e56e712005-11-16 12:53:15 +00004443 }else{
drhc332cc32016-09-19 10:24:19 +00004444 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004445 }
drh22827922000-06-06 17:27:05 +00004446 break;
4447 }
drhcce7d172000-05-31 15:34:51 +00004448 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004449 ExprList *pFarg; /* List of function arguments */
4450 int nFarg; /* Number of function arguments */
4451 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004452 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004453 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004454 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004455 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004456 u8 enc = ENC(db); /* The text encoding used by this database */
4457 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004458
dan67a9b8e2018-06-22 20:51:35 +00004459#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004460 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4461 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004462 }
dan67a9b8e2018-06-22 20:51:35 +00004463#endif
dan86fb6e12018-05-16 20:58:07 +00004464
drh1e9b53f2017-01-04 01:07:24 +00004465 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004466 /* SQL functions can be expensive. So try to avoid running them
4467 ** multiple times if we know they always give the same result */
4468 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004469 }
drhe7375bf2020-03-10 19:24:38 +00004470 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
drha4eeccd2021-10-07 17:43:30 +00004471 assert( ExprUseXList(pExpr) );
drhe7375bf2020-03-10 19:24:38 +00004472 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004473 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004474 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4475 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004476 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004477#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4478 if( pDef==0 && pParse->explain ){
4479 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4480 }
4481#endif
danb6e9f7a2018-05-19 14:15:29 +00004482 if( pDef==0 || pDef->xFinalize!=0 ){
drh62fc0692022-02-06 00:30:04 +00004483 sqlite3ErrorMsg(pParse, "unknown function: %#T()", pExpr);
drhfeb306f2009-08-18 16:05:46 +00004484 break;
4485 }
drh25c42962020-01-01 13:55:08 +00004486 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004487 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4488 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004489 return exprCodeInlineFunction(pParse, pFarg,
4490 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004491 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4492 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004493 }
4494
drhd1a01ed2013-11-21 16:08:52 +00004495 for(i=0; i<nFarg; i++){
4496 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004497 testcase( i==31 );
4498 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004499 }
4500 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4501 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4502 }
4503 }
drh12ffee82009-04-08 13:51:51 +00004504 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004505 if( constMask ){
4506 r1 = pParse->nMem+1;
4507 pParse->nMem += nFarg;
4508 }else{
4509 r1 = sqlite3GetTempRange(pParse, nFarg);
4510 }
drha748fdc2012-03-28 01:34:47 +00004511
4512 /* For length() and typeof() functions with a column argument,
4513 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4514 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4515 ** loading.
4516 */
drhd36e1042013-09-06 13:10:12 +00004517 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004518 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004519 assert( nFarg==1 );
4520 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004521 exprOp = pFarg->a[0].pExpr->op;
4522 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004523 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4524 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004525 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4526 pFarg->a[0].pExpr->op2 =
4527 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004528 }
4529 }
4530
drh5579d592015-08-26 14:01:41 +00004531 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004532 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004533 }else{
drh12ffee82009-04-08 13:51:51 +00004534 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004535 }
drhb7f6f682006-07-08 17:06:43 +00004536#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004537 /* Possibly overload the function if the first argument is
4538 ** a virtual table column.
4539 **
4540 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4541 ** second argument, not the first, as the argument to test to
4542 ** see if it is a column in a virtual table. This is done because
4543 ** the left operand of infix functions (the operand we want to
4544 ** control overloading) ends up as the second argument to the
4545 ** function. The expression "A glob B" is equivalent to
4546 ** "glob(B,A). We want to use the A in "A glob B" to test
4547 ** for function overloading. But we use the B term in "glob(B,A)".
4548 */
drh59155062018-05-26 18:03:48 +00004549 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004550 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4551 }else if( nFarg>0 ){
4552 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004553 }
4554#endif
drhd36e1042013-09-06 13:10:12 +00004555 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004556 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004557 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004558 }
drh645682a2022-06-01 11:05:59 +00004559 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
4560 pDef, pExpr->op2);
drh13d79502019-12-23 02:18:49 +00004561 if( nFarg ){
4562 if( constMask==0 ){
4563 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4564 }else{
drh3aef2fb2020-01-02 17:46:02 +00004565 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004566 }
drh2dcef112008-01-12 19:03:48 +00004567 }
drhc332cc32016-09-19 10:24:19 +00004568 return target;
drhcce7d172000-05-31 15:34:51 +00004569 }
drhfe2093d2005-01-20 22:48:47 +00004570#ifndef SQLITE_OMIT_SUBQUERY
4571 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004572 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004573 int nCol;
drhc5499be2008-04-01 15:06:33 +00004574 testcase( op==TK_EXISTS );
4575 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004576 if( pParse->db->mallocFailed ){
4577 return 0;
drha4eeccd2021-10-07 17:43:30 +00004578 }else if( op==TK_SELECT
4579 && ALWAYS( ExprUseXSelect(pExpr) )
4580 && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4581 ){
dan8da209b2016-07-26 18:06:08 +00004582 sqlite3SubselectError(pParse, nCol, 1);
4583 }else{
drh85bcdce2018-12-23 21:27:29 +00004584 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004585 }
drh19a775c2000-06-05 18:54:46 +00004586 break;
4587 }
drhfc7f27b2016-08-20 00:07:01 +00004588 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004589 int n;
drh2c31c002022-04-14 16:34:07 +00004590 Expr *pLeft = pExpr->pLeft;
4591 if( pLeft->iTable==0 || pParse->withinRJSubrtn > pLeft->op2 ){
4592 pLeft->iTable = sqlite3CodeSubselect(pParse, pLeft);
4593 pLeft->op2 = pParse->withinRJSubrtn;
drhfc7f27b2016-08-20 00:07:01 +00004594 }
drh2c31c002022-04-14 16:34:07 +00004595 assert( pLeft->op==TK_SELECT || pLeft->op==TK_ERROR );
4596 n = sqlite3ExprVectorSize(pLeft);
drh10f08272021-07-05 01:11:26 +00004597 if( pExpr->iTable!=n ){
drh966e2912017-01-03 02:58:01 +00004598 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4599 pExpr->iTable, n);
4600 }
drh2c31c002022-04-14 16:34:07 +00004601 return pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004602 }
drhfef52082000-06-06 01:50:43 +00004603 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004604 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4605 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004606 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4607 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4608 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4609 sqlite3VdbeResolveLabel(v, destIfFalse);
4610 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4611 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004612 return target;
drhfef52082000-06-06 01:50:43 +00004613 }
drhe3365e62009-11-12 17:52:24 +00004614#endif /* SQLITE_OMIT_SUBQUERY */
4615
4616
drh2dcef112008-01-12 19:03:48 +00004617 /*
4618 ** x BETWEEN y AND z
4619 **
4620 ** This is equivalent to
4621 **
4622 ** x>=y AND x<=z
4623 **
4624 ** X is stored in pExpr->pLeft.
4625 ** Y is stored in pExpr->pList->a[0].pExpr.
4626 ** Z is stored in pExpr->pList->a[1].pExpr.
4627 */
drhfef52082000-06-06 01:50:43 +00004628 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004629 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004630 return target;
drhfef52082000-06-06 01:50:43 +00004631 }
drh8878f8a2022-06-09 16:19:01 +00004632 case TK_COLLATE: {
4633 if( !ExprHasProperty(pExpr, EP_Collate)
4634 && ALWAYS(pExpr->pLeft)
4635 && pExpr->pLeft->op==TK_FUNCTION
4636 ){
4637 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
4638 if( inReg!=target ){
4639 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4640 inReg = target;
4641 }
4642 sqlite3VdbeAddOp1(v, OP_ClrSubtype, inReg);
4643 return inReg;
4644 }else{
4645 pExpr = pExpr->pLeft;
4646 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. */
4647 }
4648 }
drh94fa9c42016-02-27 21:16:04 +00004649 case TK_SPAN:
drh4f07e5f2007-05-14 11:34:46 +00004650 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004651 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004652 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004653 }
drh2dcef112008-01-12 19:03:48 +00004654
dan165921a2009-08-28 18:53:45 +00004655 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004656 /* If the opcode is TK_TRIGGER, then the expression is a reference
4657 ** to a column in the new.* or old.* pseudo-tables available to
4658 ** trigger programs. In this case Expr.iTable is set to 1 for the
4659 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4660 ** is set to the column of the pseudo-table to read, or to -1 to
4661 ** read the rowid field.
4662 **
4663 ** The expression is implemented using an OP_Param opcode. The p1
4664 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4665 ** to reference another column of the old.* pseudo-table, where
4666 ** i is the index of the column. For a new.rowid reference, p1 is
4667 ** set to (n+1), where n is the number of columns in each pseudo-table.
4668 ** For a reference to any other column in the new.* pseudo-table, p1
4669 ** is set to (n+2+i), where n and i are as defined previously. For
4670 ** example, if the table on which triggers are being fired is
4671 ** declared as:
4672 **
4673 ** CREATE TABLE t1(a, b);
4674 **
4675 ** Then p1 is interpreted as follows:
4676 **
4677 ** p1==0 -> old.rowid p1==3 -> new.rowid
4678 ** p1==1 -> old.a p1==4 -> new.a
4679 ** p1==2 -> old.b p1==5 -> new.b
4680 */
drh477572b2021-10-07 20:46:29 +00004681 Table *pTab;
4682 int iCol;
4683 int p1;
4684
4685 assert( ExprUseYTab(pExpr) );
4686 pTab = pExpr->y.pTab;
4687 iCol = pExpr->iColumn;
4688 p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004689 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004690
4691 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004692 assert( iCol>=-1 && iCol<pTab->nCol );
4693 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004694 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4695
4696 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004697 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004698 (pExpr->iTable ? "new" : "old"),
drhcf9d36d2021-08-02 18:03:43 +00004699 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
dan165921a2009-08-28 18:53:45 +00004700 ));
dan65a7cd12009-09-01 12:16:01 +00004701
drh44dbca82010-01-13 04:22:20 +00004702#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004703 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004704 ** integer. Use OP_RealAffinity to make sure it is really real.
4705 **
4706 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4707 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004708 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004709 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4710 }
drh44dbca82010-01-13 04:22:20 +00004711#endif
dan165921a2009-08-28 18:53:45 +00004712 break;
4713 }
4714
dan71c57db2016-07-09 20:23:55 +00004715 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004716 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004717 break;
4718 }
4719
drh9e9a67a2019-08-17 17:07:15 +00004720 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4721 ** that derive from the right-hand table of a LEFT JOIN. The
4722 ** Expr.iTable value is the table number for the right-hand table.
4723 ** The expression is only evaluated if that table is not currently
4724 ** on a LEFT JOIN NULL row.
4725 */
drh31d6fd52017-04-14 19:03:10 +00004726 case TK_IF_NULL_ROW: {
4727 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004728 u8 okConstFactor = pParse->okConstFactor;
drhee373022022-07-25 15:54:23 +00004729 AggInfo *pAggInfo = pExpr->pAggInfo;
4730 if( pAggInfo ){
4731 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4732 if( !pAggInfo->directMode ){
4733 inReg = pAggInfo->aCol[pExpr->iAgg].iMem;
4734 break;
4735 }
4736 if( pExpr->pAggInfo->useSortingIdx ){
4737 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4738 pAggInfo->aCol[pExpr->iAgg].iSorterColumn,
4739 target);
4740 inReg = target;
4741 break;
4742 }
drh6b6d6c62022-07-25 14:05:11 +00004743 }
drh31d6fd52017-04-14 19:03:10 +00004744 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004745 /* Temporarily disable factoring of constant expressions, since
4746 ** even though expressions may appear to be constant, they are not
4747 ** really constant because they originate from the right-hand side
4748 ** of a LEFT JOIN. */
4749 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004750 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004751 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004752 sqlite3VdbeJumpHere(v, addrINR);
4753 sqlite3VdbeChangeP3(v, addrINR, inReg);
4754 break;
4755 }
4756
drh2dcef112008-01-12 19:03:48 +00004757 /*
4758 ** Form A:
4759 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4760 **
4761 ** Form B:
4762 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4763 **
4764 ** Form A is can be transformed into the equivalent form B as follows:
4765 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4766 ** WHEN x=eN THEN rN ELSE y END
4767 **
4768 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004769 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4770 ** odd. The Y is also optional. If the number of elements in x.pList
4771 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004772 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4773 **
4774 ** The result of the expression is the Ri for the first matching Ei,
4775 ** or if there is no matching Ei, the ELSE term Y, or if there is
4776 ** no ELSE term, NULL.
4777 */
drhaac30f92019-12-14 15:01:55 +00004778 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004779 int endLabel; /* GOTO label for end of CASE stmt */
4780 int nextCase; /* GOTO label for next WHEN clause */
4781 int nExpr; /* 2x number of WHEN terms */
4782 int i; /* Loop counter */
4783 ExprList *pEList; /* List of WHEN terms */
4784 struct ExprList_item *aListelem; /* Array of WHEN terms */
4785 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004786 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004787 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004788 Expr *pDel = 0;
4789 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004790
drha4eeccd2021-10-07 17:43:30 +00004791 assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00004792 assert(pExpr->x.pList->nExpr > 0);
4793 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004794 aListelem = pEList->a;
4795 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004796 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004797 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004798 pDel = sqlite3ExprDup(db, pX, 0);
4799 if( db->mallocFailed ){
4800 sqlite3ExprDelete(db, pDel);
4801 break;
4802 }
drh33cd4902009-05-30 20:49:20 +00004803 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004804 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004805 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004806 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004807 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004808 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004809 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004810 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4811 ** The value in regFree1 might get SCopy-ed into the file result.
4812 ** So make sure that the regFree1 register is not reused for other
4813 ** purposes and possibly overwritten. */
4814 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004815 }
drhc5cd1242013-09-12 16:50:49 +00004816 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004817 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004818 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004819 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004820 }else{
drh2dcef112008-01-12 19:03:48 +00004821 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004822 }
drhec4ccdb2018-12-29 02:26:59 +00004823 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004824 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004825 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004826 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004827 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004828 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004829 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004830 }
drhc5cd1242013-09-12 16:50:49 +00004831 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004832 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004833 }else{
drh9de221d2008-01-05 06:51:30 +00004834 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004835 }
dan8b65e592019-07-17 14:34:17 +00004836 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004837 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004838 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004839 break;
4840 }
danielk19775338a5f2005-01-20 13:03:10 +00004841#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004842 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004843 assert( pExpr->affExpr==OE_Rollback
4844 || pExpr->affExpr==OE_Abort
4845 || pExpr->affExpr==OE_Fail
4846 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004847 );
drh9e5fdc42020-05-08 19:02:21 +00004848 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004849 sqlite3ErrorMsg(pParse,
4850 "RAISE() may only be used within a trigger-program");
4851 return 0;
4852 }
drh11949042019-08-05 18:01:42 +00004853 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004854 sqlite3MayAbort(pParse);
4855 }
dan165921a2009-08-28 18:53:45 +00004856 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004857 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004858 sqlite3VdbeAddOp4(
4859 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004860 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004861 }else{
drh9e5fdc42020-05-08 19:02:21 +00004862 sqlite3HaltConstraint(pParse,
4863 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4864 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004865 }
4866
drhffe07b22005-11-03 00:41:17 +00004867 break;
drh17a7f8d2002-03-24 13:13:27 +00004868 }
danielk19775338a5f2005-01-20 13:03:10 +00004869#endif
drhffe07b22005-11-03 00:41:17 +00004870 }
drh2dcef112008-01-12 19:03:48 +00004871 sqlite3ReleaseTempReg(pParse, regFree1);
4872 sqlite3ReleaseTempReg(pParse, regFree2);
4873 return inReg;
4874}
4875
4876/*
drh9b258c52020-03-11 19:41:49 +00004877** Generate code that will evaluate expression pExpr just one time
4878** per prepared statement execution.
4879**
4880** If the expression uses functions (that might throw an exception) then
4881** guard them with an OP_Once opcode to ensure that the code is only executed
4882** once. If no functions are involved, then factor the code out and put it at
4883** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004884**
drhad879ff2017-01-04 04:10:02 +00004885** If regDest>=0 then the result is always stored in that register and the
4886** result is not reusable. If regDest<0 then this routine is free to
4887** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004888** is stored is returned. When regDest<0, two identical expressions might
4889** code to the same register, if they do not contain function calls and hence
4890** are factored out into the initialization section at the end of the
4891** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004892*/
drh9b258c52020-03-11 19:41:49 +00004893int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004894 Parse *pParse, /* Parsing context */
4895 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004896 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004897){
drhd1a01ed2013-11-21 16:08:52 +00004898 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004899 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004900 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004901 if( regDest<0 && p ){
4902 struct ExprList_item *pItem;
4903 int i;
4904 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
drhd88fd532022-05-02 20:49:30 +00004905 if( pItem->fg.reusable
4906 && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0
4907 ){
drhad879ff2017-01-04 04:10:02 +00004908 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004909 }
4910 }
drh1e9b53f2017-01-04 01:07:24 +00004911 }
drhd1a01ed2013-11-21 16:08:52 +00004912 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004913 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4914 Vdbe *v = pParse->pVdbe;
4915 int addr;
4916 assert( v );
4917 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4918 pParse->okConstFactor = 0;
4919 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004920 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004921 sqlite3ExprCode(pParse, pExpr, regDest);
4922 }
4923 pParse->okConstFactor = 1;
4924 sqlite3ExprDelete(pParse->db, pExpr);
4925 sqlite3VdbeJumpHere(v, addr);
4926 }else{
4927 p = sqlite3ExprListAppend(pParse, p, pExpr);
4928 if( p ){
4929 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00004930 pItem->fg.reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004931 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004932 pItem->u.iConstExprReg = regDest;
4933 }
4934 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004935 }
drh1e9b53f2017-01-04 01:07:24 +00004936 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004937}
4938
4939/*
drh2dcef112008-01-12 19:03:48 +00004940** Generate code to evaluate an expression and store the results
4941** into a register. Return the register number where the results
4942** are stored.
4943**
4944** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004945** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004946** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004947**
4948** If pExpr is a constant, then this routine might generate this
4949** code to fill the register in the initialization section of the
4950** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004951*/
4952int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004953 int r2;
drh0d950af2019-08-22 16:38:42 +00004954 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004955 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004956 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004957 && pExpr->op!=TK_REGISTER
4958 && sqlite3ExprIsConstantNotJoin(pExpr)
4959 ){
drhf30a9692013-11-15 01:10:18 +00004960 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004961 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004962 }else{
drhf30a9692013-11-15 01:10:18 +00004963 int r1 = sqlite3GetTempReg(pParse);
4964 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4965 if( r2==r1 ){
4966 *pReg = r1;
4967 }else{
4968 sqlite3ReleaseTempReg(pParse, r1);
4969 *pReg = 0;
4970 }
drh2dcef112008-01-12 19:03:48 +00004971 }
4972 return r2;
4973}
4974
4975/*
4976** Generate code that will evaluate expression pExpr and store the
4977** results in register target. The results are guaranteed to appear
4978** in register target.
4979*/
drh05a86c52014-02-16 01:55:49 +00004980void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004981 int inReg;
4982
drhe7375bf2020-03-10 19:24:38 +00004983 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004984 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004985 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004986 if( pParse->pVdbe==0 ) return;
4987 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4988 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004989 u8 op;
drh952f35b2021-10-02 17:46:24 +00004990 if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
drh629b88c2020-01-02 02:50:45 +00004991 op = OP_Copy;
4992 }else{
4993 op = OP_SCopy;
4994 }
4995 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004996 }
drhcce7d172000-05-31 15:34:51 +00004997}
4998
4999/*
drh1c75c9d2015-12-21 15:22:13 +00005000** Make a transient copy of expression pExpr and then code it using
5001** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
5002** except that the input expression is guaranteed to be unchanged.
5003*/
5004void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
5005 sqlite3 *db = pParse->db;
5006 pExpr = sqlite3ExprDup(db, pExpr, 0);
5007 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
5008 sqlite3ExprDelete(db, pExpr);
5009}
5010
5011/*
drh05a86c52014-02-16 01:55:49 +00005012** Generate code that will evaluate expression pExpr and store the
5013** results in register target. The results are guaranteed to appear
5014** in register target. If the expression is constant, then this routine
5015** might choose to code the expression at initialization time.
5016*/
5017void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00005018 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00005019 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00005020 }else{
drh088489e2020-03-10 02:57:37 +00005021 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00005022 }
drhcce7d172000-05-31 15:34:51 +00005023}
5024
5025/*
drh268380c2004-02-25 13:47:31 +00005026** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00005027** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00005028**
drh3df6c3b2017-09-15 15:38:01 +00005029** Return the number of elements evaluated. The number returned will
5030** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
5031** is defined.
drhd1a01ed2013-11-21 16:08:52 +00005032**
5033** The SQLITE_ECEL_DUP flag prevents the arguments from being
5034** filled using OP_SCopy. OP_Copy must be used instead.
5035**
5036** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
5037** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00005038**
5039** The SQLITE_ECEL_REF flag means that expressions in the list with
5040** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
5041** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00005042** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
5043** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00005044*/
danielk19774adee202004-05-08 08:23:19 +00005045int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00005046 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00005047 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00005048 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00005049 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00005050 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00005051){
5052 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00005053 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00005054 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00005055 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00005056 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00005057 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00005058 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00005059 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00005060 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00005061 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00005062 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00005063#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00005064 if( pItem->fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00005065 i--;
5066 n--;
5067 }else
5068#endif
dan257c13f2016-11-10 20:14:06 +00005069 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
5070 if( flags & SQLITE_ECEL_OMITREF ){
5071 i--;
5072 n--;
5073 }else{
5074 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
5075 }
drhb8b06692018-08-04 15:16:20 +00005076 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
5077 && sqlite3ExprIsConstantNotJoin(pExpr)
5078 ){
drh9b258c52020-03-11 19:41:49 +00005079 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00005080 }else{
5081 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
5082 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00005083 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00005084 if( copyOp==OP_Copy
drh058e9952022-07-25 19:05:24 +00005085 && (pOp=sqlite3VdbeGetLastOp(v))->opcode==OP_Copy
drh4eded602013-12-20 15:59:20 +00005086 && pOp->p1+pOp->p3+1==inReg
5087 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00005088 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00005089 ){
5090 pOp->p3++;
5091 }else{
5092 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
5093 }
drhd1a01ed2013-11-21 16:08:52 +00005094 }
drhd1766112008-09-17 00:13:12 +00005095 }
drh268380c2004-02-25 13:47:31 +00005096 }
drhf9b596e2004-05-26 16:54:42 +00005097 return n;
drh268380c2004-02-25 13:47:31 +00005098}
5099
5100/*
drh36c563a2009-11-12 13:32:22 +00005101** Generate code for a BETWEEN operator.
5102**
5103** x BETWEEN y AND z
5104**
5105** The above is equivalent to
5106**
5107** x>=y AND x<=z
5108**
5109** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00005110** elimination of x.
drh84b19a32016-08-20 22:49:28 +00005111**
5112** The xJumpIf parameter determines details:
5113**
5114** NULL: Store the boolean result in reg[dest]
5115** sqlite3ExprIfTrue: Jump to dest if true
5116** sqlite3ExprIfFalse: Jump to dest if false
5117**
5118** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00005119*/
5120static void exprCodeBetween(
5121 Parse *pParse, /* Parsing and code generating context */
5122 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00005123 int dest, /* Jump destination or storage location */
5124 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00005125 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
5126){
dan8b65e592019-07-17 14:34:17 +00005127 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00005128 Expr compLeft; /* The x>=y term */
5129 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00005130 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00005131 Expr *pDel = 0;
5132 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00005133
dan71c57db2016-07-09 20:23:55 +00005134 memset(&compLeft, 0, sizeof(Expr));
5135 memset(&compRight, 0, sizeof(Expr));
5136 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00005137
drha4eeccd2021-10-07 17:43:30 +00005138 assert( ExprUseXList(pExpr) );
dan8b65e592019-07-17 14:34:17 +00005139 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
5140 if( db->mallocFailed==0 ){
5141 exprAnd.op = TK_AND;
5142 exprAnd.pLeft = &compLeft;
5143 exprAnd.pRight = &compRight;
5144 compLeft.op = TK_GE;
5145 compLeft.pLeft = pDel;
5146 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
5147 compRight.op = TK_LE;
5148 compRight.pLeft = pDel;
5149 compRight.pRight = pExpr->x.pList->a[1].pExpr;
5150 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
5151 if( xJump ){
5152 xJump(pParse, &exprAnd, dest, jumpIfNull);
5153 }else{
5154 /* Mark the expression is being from the ON or USING clause of a join
5155 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
5156 ** it into the Parse.pConstExpr list. We should use a new bit for this,
5157 ** for clarity, but we are out of bits in the Expr.flags field so we
drh67a99db2022-05-13 14:52:04 +00005158 ** have to reuse the EP_OuterON bit. Bummer. */
5159 pDel->flags |= EP_OuterON;
dan8b65e592019-07-17 14:34:17 +00005160 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
5161 }
5162 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00005163 }
dan8b65e592019-07-17 14:34:17 +00005164 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00005165
5166 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00005167 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
5168 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
5169 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
5170 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
5171 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5172 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5173 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5174 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00005175 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00005176}
5177
5178/*
drhcce7d172000-05-31 15:34:51 +00005179** Generate code for a boolean expression such that a jump is made
5180** to the label "dest" if the expression is true but execution
5181** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00005182**
5183** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00005184** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00005185**
5186** This code depends on the fact that certain token values (ex: TK_EQ)
5187** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5188** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
5189** the make process cause these values to align. Assert()s in the code
5190** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00005191*/
danielk19774adee202004-05-08 08:23:19 +00005192void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005193 Vdbe *v = pParse->pVdbe;
5194 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005195 int regFree1 = 0;
5196 int regFree2 = 0;
5197 int r1, r2;
5198
drh35573352008-01-08 23:54:25 +00005199 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005200 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005201 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00005202 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005203 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00005204 switch( op ){
drh17180fc2019-04-19 17:26:19 +00005205 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005206 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005207 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5208 if( pAlt!=pExpr ){
5209 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
5210 }else if( op==TK_AND ){
5211 int d2 = sqlite3VdbeMakeLabel(pParse);
5212 testcase( jumpIfNull==0 );
5213 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
5214 jumpIfNull^SQLITE_JUMPIFNULL);
5215 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5216 sqlite3VdbeResolveLabel(v, d2);
5217 }else{
5218 testcase( jumpIfNull==0 );
5219 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5220 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5221 }
drhcce7d172000-05-31 15:34:51 +00005222 break;
5223 }
5224 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00005225 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005226 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005227 break;
5228 }
drh8abed7b2018-02-26 18:49:05 +00005229 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005230 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5231 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00005232 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005233 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005234 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005235 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005236 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005237 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005238 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
5239 isNot ? SQLITE_JUMPIFNULL : 0);
5240 }else{
5241 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5242 isNot ? SQLITE_JUMPIFNULL : 0);
5243 }
drh007c8432018-02-26 03:20:18 +00005244 break;
5245 }
drhde845c22016-03-17 19:07:52 +00005246 case TK_IS:
5247 case TK_ISNOT:
5248 testcase( op==TK_IS );
5249 testcase( op==TK_ISNOT );
5250 op = (op==TK_IS) ? TK_EQ : TK_NE;
5251 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005252 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005253 case TK_LT:
5254 case TK_LE:
5255 case TK_GT:
5256 case TK_GE:
5257 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00005258 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005259 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005260 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005261 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5262 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005263 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005264 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005265 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5266 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5267 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5268 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005269 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5270 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5271 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5272 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5273 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5274 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005275 testcase( regFree1==0 );
5276 testcase( regFree2==0 );
5277 break;
5278 }
drhcce7d172000-05-31 15:34:51 +00005279 case TK_ISNULL:
5280 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005281 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5282 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005283 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhe995d2c2022-10-13 12:47:33 +00005284 sqlite3VdbeTypeofColumn(v, r1);
drh2dcef112008-01-12 19:03:48 +00005285 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005286 VdbeCoverageIf(v, op==TK_ISNULL);
5287 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005288 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005289 break;
5290 }
drhfef52082000-06-06 01:50:43 +00005291 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005292 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005293 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005294 break;
5295 }
drh84e30ca2011-02-10 17:46:14 +00005296#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005297 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005298 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005299 int destIfNull = jumpIfNull ? dest : destIfFalse;
5300 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005301 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005302 sqlite3VdbeResolveLabel(v, destIfFalse);
5303 break;
5304 }
shanehbb201342011-02-09 19:55:20 +00005305#endif
drhcce7d172000-05-31 15:34:51 +00005306 default: {
dan7b35a772016-07-28 19:47:15 +00005307 default_expr:
drhad317272019-04-19 16:21:51 +00005308 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005309 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005310 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005311 /* No-op */
5312 }else{
5313 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5314 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005315 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005316 testcase( regFree1==0 );
5317 testcase( jumpIfNull==0 );
5318 }
drhcce7d172000-05-31 15:34:51 +00005319 break;
5320 }
5321 }
drh2dcef112008-01-12 19:03:48 +00005322 sqlite3ReleaseTempReg(pParse, regFree1);
5323 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005324}
5325
5326/*
drh66b89c82000-11-28 20:47:17 +00005327** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005328** to the label "dest" if the expression is false but execution
5329** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005330**
5331** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005332** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5333** is 0.
drhcce7d172000-05-31 15:34:51 +00005334*/
danielk19774adee202004-05-08 08:23:19 +00005335void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005336 Vdbe *v = pParse->pVdbe;
5337 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005338 int regFree1 = 0;
5339 int regFree2 = 0;
5340 int r1, r2;
5341
drh35573352008-01-08 23:54:25 +00005342 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005343 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005344 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005345 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005346
5347 /* The value of pExpr->op and op are related as follows:
5348 **
5349 ** pExpr->op op
5350 ** --------- ----------
5351 ** TK_ISNULL OP_NotNull
5352 ** TK_NOTNULL OP_IsNull
5353 ** TK_NE OP_Eq
5354 ** TK_EQ OP_Ne
5355 ** TK_GT OP_Le
5356 ** TK_LE OP_Gt
5357 ** TK_GE OP_Lt
5358 ** TK_LT OP_Ge
5359 **
5360 ** For other values of pExpr->op, op is undefined and unused.
5361 ** The value of TK_ and OP_ constants are arranged such that we
5362 ** can compute the mapping above using the following expression.
5363 ** Assert()s verify that the computation is correct.
5364 */
5365 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5366
5367 /* Verify correct alignment of TK_ and OP_ constants
5368 */
5369 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5370 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5371 assert( pExpr->op!=TK_NE || op==OP_Eq );
5372 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5373 assert( pExpr->op!=TK_LT || op==OP_Ge );
5374 assert( pExpr->op!=TK_LE || op==OP_Gt );
5375 assert( pExpr->op!=TK_GT || op==OP_Le );
5376 assert( pExpr->op!=TK_GE || op==OP_Lt );
5377
danba00e302016-07-23 20:24:06 +00005378 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005379 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005380 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005381 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5382 if( pAlt!=pExpr ){
5383 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5384 }else if( pExpr->op==TK_AND ){
5385 testcase( jumpIfNull==0 );
5386 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5387 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5388 }else{
5389 int d2 = sqlite3VdbeMakeLabel(pParse);
5390 testcase( jumpIfNull==0 );
5391 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5392 jumpIfNull^SQLITE_JUMPIFNULL);
5393 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5394 sqlite3VdbeResolveLabel(v, d2);
5395 }
drhcce7d172000-05-31 15:34:51 +00005396 break;
5397 }
5398 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005399 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005400 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005401 break;
5402 }
drh8abed7b2018-02-26 18:49:05 +00005403 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005404 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5405 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005406 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005407 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005408 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005409 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005410 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005411 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005412 /* IS TRUE and IS NOT FALSE */
5413 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5414 isNot ? 0 : SQLITE_JUMPIFNULL);
5415
5416 }else{
5417 /* IS FALSE and IS NOT TRUE */
5418 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005419 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005420 }
drh007c8432018-02-26 03:20:18 +00005421 break;
5422 }
drhde845c22016-03-17 19:07:52 +00005423 case TK_IS:
5424 case TK_ISNOT:
5425 testcase( pExpr->op==TK_IS );
5426 testcase( pExpr->op==TK_ISNOT );
5427 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5428 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005429 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005430 case TK_LT:
5431 case TK_LE:
5432 case TK_GT:
5433 case TK_GE:
5434 case TK_NE:
5435 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005436 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005437 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005438 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5439 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005440 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005441 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005442 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5443 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5444 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5445 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005446 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5447 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5448 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5449 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5450 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5451 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005452 testcase( regFree1==0 );
5453 testcase( regFree2==0 );
5454 break;
5455 }
drhcce7d172000-05-31 15:34:51 +00005456 case TK_ISNULL:
5457 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005458 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhe995d2c2022-10-13 12:47:33 +00005459 sqlite3VdbeTypeofColumn(v, r1);
drh2dcef112008-01-12 19:03:48 +00005460 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005461 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5462 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005463 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005464 break;
5465 }
drhfef52082000-06-06 01:50:43 +00005466 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005467 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005468 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005469 break;
5470 }
drh84e30ca2011-02-10 17:46:14 +00005471#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005472 case TK_IN: {
5473 if( jumpIfNull ){
5474 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5475 }else{
drhec4ccdb2018-12-29 02:26:59 +00005476 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005477 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5478 sqlite3VdbeResolveLabel(v, destIfNull);
5479 }
5480 break;
5481 }
shanehbb201342011-02-09 19:55:20 +00005482#endif
drhcce7d172000-05-31 15:34:51 +00005483 default: {
danba00e302016-07-23 20:24:06 +00005484 default_expr:
drhad317272019-04-19 16:21:51 +00005485 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005486 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005487 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005488 /* no-op */
5489 }else{
5490 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5491 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005492 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005493 testcase( regFree1==0 );
5494 testcase( jumpIfNull==0 );
5495 }
drhcce7d172000-05-31 15:34:51 +00005496 break;
5497 }
5498 }
drh2dcef112008-01-12 19:03:48 +00005499 sqlite3ReleaseTempReg(pParse, regFree1);
5500 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005501}
drh22827922000-06-06 17:27:05 +00005502
5503/*
drh72bc8202015-06-11 13:58:35 +00005504** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5505** code generation, and that copy is deleted after code generation. This
5506** ensures that the original pExpr is unchanged.
5507*/
5508void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5509 sqlite3 *db = pParse->db;
5510 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5511 if( db->mallocFailed==0 ){
5512 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5513 }
5514 sqlite3ExprDelete(db, pCopy);
5515}
5516
dan5aa550c2017-06-24 18:10:29 +00005517/*
5518** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5519** type of expression.
5520**
5521** If pExpr is a simple SQL value - an integer, real, string, blob
5522** or NULL value - then the VDBE currently being prepared is configured
5523** to re-prepare each time a new value is bound to variable pVar.
5524**
5525** Additionally, if pExpr is a simple SQL value and the value is the
5526** same as that currently bound to variable pVar, non-zero is returned.
5527** Otherwise, if the values are not the same or if pExpr is not a simple
5528** SQL value, zero is returned.
5529*/
drh1580d502021-09-25 17:07:57 +00005530static int exprCompareVariable(
5531 const Parse *pParse,
5532 const Expr *pVar,
5533 const Expr *pExpr
5534){
dan5aa550c2017-06-24 18:10:29 +00005535 int res = 0;
drhc0804222017-06-28 21:47:16 +00005536 int iVar;
5537 sqlite3_value *pL, *pR = 0;
5538
5539 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5540 if( pR ){
5541 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005542 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005543 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005544 if( pL ){
5545 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5546 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5547 }
5548 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005549 }
drhc0804222017-06-28 21:47:16 +00005550 sqlite3ValueFree(pR);
5551 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005552 }
5553
5554 return res;
5555}
drh72bc8202015-06-11 13:58:35 +00005556
5557/*
drh1d9da702010-01-07 15:17:02 +00005558** Do a deep comparison of two expression trees. Return 0 if the two
5559** expressions are completely identical. Return 1 if they differ only
5560** by a COLLATE operator at the top level. Return 2 if there are differences
5561** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005562**
drh619a1302013-08-01 13:04:46 +00005563** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5564** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5565**
drh66518ca2013-08-01 15:09:57 +00005566** The pA side might be using TK_REGISTER. If that is the case and pB is
5567** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5568**
drh1d9da702010-01-07 15:17:02 +00005569** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005570** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005571** identical, we return 2 just to be safe. So if this routine
5572** returns 2, then you do not really know for certain if the two
5573** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005574** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005575** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005576** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005577** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005578**
drhc0804222017-06-28 21:47:16 +00005579** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5580** pParse->pReprepare can be matched against literals in pB. The
5581** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5582** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5583** Argument pParse should normally be NULL. If it is not NULL and pA or
5584** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005585*/
drh1580d502021-09-25 17:07:57 +00005586int sqlite3ExprCompare(
5587 const Parse *pParse,
5588 const Expr *pA,
5589 const Expr *pB,
5590 int iTab
5591){
drh10d1edf2013-11-15 15:52:39 +00005592 u32 combinedFlags;
5593 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005594 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005595 }
dan5aa550c2017-06-24 18:10:29 +00005596 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5597 return 0;
5598 }
drh10d1edf2013-11-15 15:52:39 +00005599 combinedFlags = pA->flags | pB->flags;
5600 if( combinedFlags & EP_IntValue ){
5601 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5602 return 0;
5603 }
drh1d9da702010-01-07 15:17:02 +00005604 return 2;
drh22827922000-06-06 17:27:05 +00005605 }
dan16dd3982018-12-20 15:04:38 +00005606 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005607 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005608 return 1;
5609 }
dan5aa550c2017-06-24 18:10:29 +00005610 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005611 return 1;
5612 }
drhf3adb7c2022-10-15 12:01:40 +00005613 if( pA->op==TK_AGG_COLUMN && pB->op==TK_COLUMN
5614 && pB->iTable<0 && pA->iTable==iTab
5615 ){
5616 /* fall through */
5617 }else{
5618 return 2;
5619 }
drhae80dde2012-12-06 21:16:43 +00005620 }
drha51e6002021-11-19 19:11:58 +00005621 assert( !ExprHasProperty(pA, EP_IntValue) );
5622 assert( !ExprHasProperty(pB, EP_IntValue) );
5623 if( pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005624 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005625 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005626#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005627 assert( pA->op==pB->op );
5628 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5629 return 2;
5630 }
drheda079c2018-09-20 19:02:15 +00005631 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005632 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5633 return 2;
5634 }
drheda079c2018-09-20 19:02:15 +00005635 }
5636#endif
drhf20bbc52019-01-17 01:06:00 +00005637 }else if( pA->op==TK_NULL ){
5638 return 0;
drhd5af5422018-04-13 14:27:01 +00005639 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005640 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drha51e6002021-11-19 19:11:58 +00005641 }else
5642 if( pB->u.zToken!=0
5643 && pA->op!=TK_COLUMN
5644 && pA->op!=TK_AGG_COLUMN
5645 && strcmp(pA->u.zToken,pB->u.zToken)!=0
5646 ){
drhd5af5422018-04-13 14:27:01 +00005647 return 2;
drh2646da72005-12-09 20:02:05 +00005648 }
drh22827922000-06-06 17:27:05 +00005649 }
drh898c5272019-10-22 00:03:41 +00005650 if( (pA->flags & (EP_Distinct|EP_Commuted))
5651 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005652 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005653 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005654 if( (combinedFlags & EP_FixedCol)==0
5655 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005656 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005657 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005658 if( pA->op!=TK_STRING
5659 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005660 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005661 ){
drh10d1edf2013-11-15 15:52:39 +00005662 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005663 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005664 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5665 return 2;
5666 }
drh10d1edf2013-11-15 15:52:39 +00005667 }
5668 }
drh1d9da702010-01-07 15:17:02 +00005669 return 0;
drh22827922000-06-06 17:27:05 +00005670}
5671
drh8c6f6662010-04-26 19:17:26 +00005672/*
danfbb6e9f2020-01-09 20:11:29 +00005673** Compare two ExprList objects. Return 0 if they are identical, 1
5674** if they are certainly different, or 2 if it is not possible to
5675** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005676**
drh619a1302013-08-01 13:04:46 +00005677** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5678** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5679**
drh8c6f6662010-04-26 19:17:26 +00005680** This routine might return non-zero for equivalent ExprLists. The
5681** only consequence will be disabled optimizations. But this routine
5682** must never return 0 if the two ExprList objects are different, or
5683** a malfunction will result.
5684**
5685** Two NULL pointers are considered to be the same. But a NULL pointer
5686** always differs from a non-NULL pointer.
5687*/
drh1580d502021-09-25 17:07:57 +00005688int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005689 int i;
5690 if( pA==0 && pB==0 ) return 0;
5691 if( pA==0 || pB==0 ) return 1;
5692 if( pA->nExpr!=pB->nExpr ) return 1;
5693 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005694 int res;
drh8c6f6662010-04-26 19:17:26 +00005695 Expr *pExprA = pA->a[i].pExpr;
5696 Expr *pExprB = pB->a[i].pExpr;
drhd88fd532022-05-02 20:49:30 +00005697 if( pA->a[i].fg.sortFlags!=pB->a[i].fg.sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005698 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005699 }
5700 return 0;
5701}
drh13449892005-09-07 21:22:45 +00005702
drh22827922000-06-06 17:27:05 +00005703/*
drhf9463df2017-02-11 14:59:58 +00005704** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5705** are ignored.
5706*/
drh1580d502021-09-25 17:07:57 +00005707int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005708 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005709 sqlite3ExprSkipCollateAndLikely(pA),
5710 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005711 iTab);
5712}
5713
5714/*
drhc51cf862019-05-11 19:36:03 +00005715** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005716**
5717** Or if seenNot is true, return non-zero if Expr p can only be
5718** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005719*/
5720static int exprImpliesNotNull(
drh1580d502021-09-25 17:07:57 +00005721 const Parse *pParse,/* Parsing context */
5722 const Expr *p, /* The expression to be checked */
5723 const Expr *pNN, /* The expression that is NOT NULL */
drhc51cf862019-05-11 19:36:03 +00005724 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005725 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005726){
5727 assert( p );
5728 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005729 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5730 return pNN->op!=TK_NULL;
5731 }
drhc51cf862019-05-11 19:36:03 +00005732 switch( p->op ){
5733 case TK_IN: {
5734 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
drha4eeccd2021-10-07 17:43:30 +00005735 assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005736 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005737 }
5738 case TK_BETWEEN: {
drha4eeccd2021-10-07 17:43:30 +00005739 ExprList *pList;
5740 assert( ExprUseXList(p) );
5741 pList = p->x.pList;
drhc51cf862019-05-11 19:36:03 +00005742 assert( pList!=0 );
5743 assert( pList->nExpr==2 );
5744 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005745 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5746 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005747 ){
5748 return 1;
5749 }
drh7a231b42019-08-30 15:11:08 +00005750 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005751 }
5752 case TK_EQ:
5753 case TK_NE:
5754 case TK_LT:
5755 case TK_LE:
5756 case TK_GT:
5757 case TK_GE:
5758 case TK_PLUS:
5759 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005760 case TK_BITOR:
5761 case TK_LSHIFT:
5762 case TK_RSHIFT:
5763 case TK_CONCAT:
5764 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005765 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005766 case TK_STAR:
5767 case TK_REM:
5768 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005769 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005770 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005771 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005772 }
5773 case TK_SPAN:
5774 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005775 case TK_UPLUS:
5776 case TK_UMINUS: {
5777 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5778 }
5779 case TK_TRUTH: {
5780 if( seenNot ) return 0;
5781 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005782 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005783 }
dan1cd382e2019-08-29 15:06:35 +00005784 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005785 case TK_NOT: {
5786 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5787 }
5788 }
5789 return 0;
5790}
5791
5792/*
drh4bd5f732013-07-31 23:22:39 +00005793** Return true if we can prove the pE2 will always be true if pE1 is
5794** true. Return false if we cannot complete the proof or if pE2 might
5795** be false. Examples:
5796**
drh619a1302013-08-01 13:04:46 +00005797** pE1: x==5 pE2: x==5 Result: true
5798** pE1: x>0 pE2: x==5 Result: false
5799** pE1: x=21 pE2: x=21 OR y=43 Result: true
5800** pE1: x!=123 pE2: x IS NOT NULL Result: true
5801** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5802** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5803** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005804**
5805** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5806** Expr.iTable<0 then assume a table number given by iTab.
5807**
drhc0804222017-06-28 21:47:16 +00005808** If pParse is not NULL, then the values of bound variables in pE1 are
5809** compared against literal values in pE2 and pParse->pVdbe->expmask is
5810** modified to record which bound variables are referenced. If pParse
5811** is NULL, then false will be returned if pE1 contains any bound variables.
5812**
drh4bd5f732013-07-31 23:22:39 +00005813** When in doubt, return false. Returning true might give a performance
5814** improvement. Returning false might cause a performance reduction, but
5815** it will always give the correct answer and is hence always safe.
5816*/
drh1580d502021-09-25 17:07:57 +00005817int sqlite3ExprImpliesExpr(
5818 const Parse *pParse,
5819 const Expr *pE1,
5820 const Expr *pE2,
5821 int iTab
5822){
dan5aa550c2017-06-24 18:10:29 +00005823 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005824 return 1;
5825 }
5826 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005827 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5828 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005829 ){
5830 return 1;
5831 }
drh664d6d12019-05-04 17:32:07 +00005832 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005833 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005834 ){
drhc51cf862019-05-11 19:36:03 +00005835 return 1;
drh619a1302013-08-01 13:04:46 +00005836 }
5837 return 0;
drh4bd5f732013-07-31 23:22:39 +00005838}
5839
5840/*
drh6c68d752019-11-04 02:05:52 +00005841** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005842** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005843** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5844**
5845** This routine controls an optimization. False positives (setting
5846** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5847** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005848*/
5849static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005850 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005851 testcase( pExpr->op==TK_AGG_FUNCTION );
drh67a99db2022-05-13 14:52:04 +00005852 if( ExprHasProperty(pExpr, EP_OuterON) ) return WRC_Prune;
drh25897872018-03-20 21:16:15 +00005853 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005854 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005855 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005856 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005857 case TK_IS:
5858 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005859 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005860 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005861 case TK_IN:
drh25897872018-03-20 21:16:15 +00005862 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005863 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005864 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005865 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005866 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005867 testcase( pExpr->op==TK_IS );
5868 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005869 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005870 testcase( pExpr->op==TK_CASE );
5871 testcase( pExpr->op==TK_IN );
5872 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005873 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005874 return WRC_Prune;
5875 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005876 if( pWalker->u.iCur==pExpr->iTable ){
5877 pWalker->eCode = 1;
5878 return WRC_Abort;
5879 }
5880 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005881
dan9d23ea72019-08-29 19:34:29 +00005882 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005883 if( pWalker->eCode==0 ){
5884 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5885 if( pWalker->eCode ){
5886 pWalker->eCode = 0;
5887 sqlite3WalkExpr(pWalker, pExpr->pRight);
5888 }
dan9d23ea72019-08-29 19:34:29 +00005889 }
5890 return WRC_Prune;
5891
5892 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005893 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5894 assert( pWalker->eCode );
5895 return WRC_Abort;
5896 }
dan9d23ea72019-08-29 19:34:29 +00005897 return WRC_Prune;
5898
drh98811552018-04-03 14:04:48 +00005899 /* Virtual tables are allowed to use constraints like x=NULL. So
5900 ** a term of the form x=y does not prove that y is not null if x
5901 ** is the column of a virtual table */
5902 case TK_EQ:
5903 case TK_NE:
5904 case TK_LT:
5905 case TK_LE:
5906 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005907 case TK_GE: {
5908 Expr *pLeft = pExpr->pLeft;
5909 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005910 testcase( pExpr->op==TK_EQ );
5911 testcase( pExpr->op==TK_NE );
5912 testcase( pExpr->op==TK_LT );
5913 testcase( pExpr->op==TK_LE );
5914 testcase( pExpr->op==TK_GT );
5915 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005916 /* The y.pTab=0 assignment in wherecode.c always happens after the
5917 ** impliesNotNullRow() test */
drh477572b2021-10-07 20:46:29 +00005918 assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
5919 assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
5920 if( (pLeft->op==TK_COLUMN
drh63b3a642022-10-20 13:36:32 +00005921 && ALWAYS(pLeft->y.pTab!=0)
drh477572b2021-10-07 20:46:29 +00005922 && IsVirtual(pLeft->y.pTab))
5923 || (pRight->op==TK_COLUMN
drh63b3a642022-10-20 13:36:32 +00005924 && ALWAYS(pRight->y.pTab!=0)
drh477572b2021-10-07 20:46:29 +00005925 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005926 ){
drh78d1d222020-02-17 19:25:07 +00005927 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005928 }
drh08b92082020-08-10 14:18:00 +00005929 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005930 }
drh25897872018-03-20 21:16:15 +00005931 default:
5932 return WRC_Continue;
5933 }
5934}
5935
5936/*
5937** Return true (non-zero) if expression p can only be true if at least
5938** one column of table iTab is non-null. In other words, return true
5939** if expression p will always be NULL or false if every column of iTab
5940** is NULL.
5941**
drh821b6102018-03-24 18:01:51 +00005942** False negatives are acceptable. In other words, it is ok to return
5943** zero even if expression p will never be true of every column of iTab
5944** is NULL. A false negative is merely a missed optimization opportunity.
5945**
5946** False positives are not allowed, however. A false positive may result
5947** in an incorrect answer.
5948**
drh67a99db2022-05-13 14:52:04 +00005949** Terms of p that are marked with EP_OuterON (and hence that come from
drhb77c07a2022-04-11 11:59:25 +00005950** the ON or USING clauses of OUTER JOINS) are excluded from the analysis.
drh25897872018-03-20 21:16:15 +00005951**
5952** This routine is used to check if a LEFT JOIN can be converted into
5953** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5954** clause requires that some column of the right table of the LEFT JOIN
5955** be non-NULL, then the LEFT JOIN can be safely converted into an
5956** ordinary join.
5957*/
5958int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5959 Walker w;
drh0d950af2019-08-22 16:38:42 +00005960 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005961 if( p==0 ) return 0;
5962 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005963 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005964 }else{
5965 while( p->op==TK_AND ){
5966 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5967 p = p->pRight;
5968 }
drhd6db6592019-04-01 19:42:42 +00005969 }
drh25897872018-03-20 21:16:15 +00005970 w.xExprCallback = impliesNotNullRow;
5971 w.xSelectCallback = 0;
5972 w.xSelectCallback2 = 0;
5973 w.eCode = 0;
5974 w.u.iCur = iTab;
5975 sqlite3WalkExpr(&w, p);
5976 return w.eCode;
5977}
5978
5979/*
drh030796d2012-08-23 16:18:10 +00005980** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005981** to determine if an expression can be evaluated by reference to the
5982** index only, without having to do a search for the corresponding
5983** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5984** is the cursor for the table.
5985*/
5986struct IdxCover {
5987 Index *pIdx; /* The index to be tested for coverage */
5988 int iCur; /* Cursor number for the table corresponding to the index */
5989};
5990
5991/*
5992** Check to see if there are references to columns in table
5993** pWalker->u.pIdxCover->iCur can be satisfied using the index
5994** pWalker->u.pIdxCover->pIdx.
5995*/
5996static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5997 if( pExpr->op==TK_COLUMN
5998 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005999 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00006000 ){
6001 pWalker->eCode = 1;
6002 return WRC_Abort;
6003 }
6004 return WRC_Continue;
6005}
6006
6007/*
drhe604ec02016-07-27 19:20:58 +00006008** Determine if an index pIdx on table with cursor iCur contains will
6009** the expression pExpr. Return true if the index does cover the
6010** expression and false if the pExpr expression references table columns
6011** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00006012**
6013** An index covering an expression means that the expression can be
6014** evaluated using only the index and without having to lookup the
6015** corresponding table entry.
6016*/
6017int sqlite3ExprCoveredByIndex(
6018 Expr *pExpr, /* The index to be tested */
6019 int iCur, /* The cursor number for the corresponding table */
6020 Index *pIdx /* The index that might be used for coverage */
6021){
6022 Walker w;
6023 struct IdxCover xcov;
6024 memset(&w, 0, sizeof(w));
6025 xcov.iCur = iCur;
6026 xcov.pIdx = pIdx;
6027 w.xExprCallback = exprIdxCover;
6028 w.u.pIdxCover = &xcov;
6029 sqlite3WalkExpr(&w, pExpr);
6030 return !w.eCode;
6031}
6032
6033
drh90cf38b2021-11-08 23:24:00 +00006034/* Structure used to pass information throught the Walker in order to
6035** implement sqlite3ReferencesSrcList().
drh374fdce2012-04-17 16:38:53 +00006036*/
drh90cf38b2021-11-08 23:24:00 +00006037struct RefSrcList {
6038 sqlite3 *db; /* Database connection used for sqlite3DbRealloc() */
6039 SrcList *pRef; /* Looking for references to these tables */
drh913306a2021-11-26 17:10:18 +00006040 i64 nExclude; /* Number of tables to exclude from the search */
drh90cf38b2021-11-08 23:24:00 +00006041 int *aiExclude; /* Cursor IDs for tables to exclude from the search */
drh030796d2012-08-23 16:18:10 +00006042};
6043
6044/*
drh90cf38b2021-11-08 23:24:00 +00006045** Walker SELECT callbacks for sqlite3ReferencesSrcList().
6046**
6047** When entering a new subquery on the pExpr argument, add all FROM clause
6048** entries for that subquery to the exclude list.
6049**
6050** When leaving the subquery, remove those entries from the exclude list.
daned41a962020-06-09 17:45:48 +00006051*/
drh90cf38b2021-11-08 23:24:00 +00006052static int selectRefEnter(Walker *pWalker, Select *pSelect){
6053 struct RefSrcList *p = pWalker->u.pRefSrcList;
6054 SrcList *pSrc = pSelect->pSrc;
drh913306a2021-11-26 17:10:18 +00006055 i64 i, j;
6056 int *piNew;
drh90cf38b2021-11-08 23:24:00 +00006057 if( pSrc->nSrc==0 ) return WRC_Continue;
6058 j = p->nExclude;
6059 p->nExclude += pSrc->nSrc;
6060 piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
6061 if( piNew==0 ){
6062 p->nExclude = 0;
6063 return WRC_Abort;
6064 }else{
6065 p->aiExclude = piNew;
6066 }
6067 for(i=0; i<pSrc->nSrc; i++, j++){
6068 p->aiExclude[j] = pSrc->a[i].iCursor;
daned41a962020-06-09 17:45:48 +00006069 }
6070 return WRC_Continue;
6071}
drh90cf38b2021-11-08 23:24:00 +00006072static void selectRefLeave(Walker *pWalker, Select *pSelect){
6073 struct RefSrcList *p = pWalker->u.pRefSrcList;
6074 SrcList *pSrc = pSelect->pSrc;
6075 if( p->nExclude ){
6076 assert( p->nExclude>=pSrc->nSrc );
6077 p->nExclude -= pSrc->nSrc;
6078 }
6079}
daned41a962020-06-09 17:45:48 +00006080
drh90cf38b2021-11-08 23:24:00 +00006081/* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
6082**
6083** Set the 0x01 bit of pWalker->eCode if there is a reference to any
6084** of the tables shown in RefSrcList.pRef.
6085**
6086** Set the 0x02 bit of pWalker->eCode if there is a reference to a
6087** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
drh030796d2012-08-23 16:18:10 +00006088*/
drh90cf38b2021-11-08 23:24:00 +00006089static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
6090 if( pExpr->op==TK_COLUMN
6091 || pExpr->op==TK_AGG_COLUMN
6092 ){
drh374fdce2012-04-17 16:38:53 +00006093 int i;
drh90cf38b2021-11-08 23:24:00 +00006094 struct RefSrcList *p = pWalker->u.pRefSrcList;
6095 SrcList *pSrc = p->pRef;
drh655814d2015-01-09 01:27:29 +00006096 int nSrc = pSrc ? pSrc->nSrc : 0;
6097 for(i=0; i<nSrc; i++){
drh90cf38b2021-11-08 23:24:00 +00006098 if( pExpr->iTable==pSrc->a[i].iCursor ){
6099 pWalker->eCode |= 1;
6100 return WRC_Continue;
6101 }
drh374fdce2012-04-17 16:38:53 +00006102 }
drh90cf38b2021-11-08 23:24:00 +00006103 for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
6104 if( i>=p->nExclude ){
6105 pWalker->eCode |= 2;
drh030796d2012-08-23 16:18:10 +00006106 }
drh374fdce2012-04-17 16:38:53 +00006107 }
drh030796d2012-08-23 16:18:10 +00006108 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00006109}
6110
6111/*
drh90cf38b2021-11-08 23:24:00 +00006112** Check to see if pExpr references any tables in pSrcList.
6113** Possible return values:
6114**
6115** 1 pExpr does references a table in pSrcList.
6116**
6117** 0 pExpr references some table that is not defined in either
6118** pSrcList or in subqueries of pExpr itself.
6119**
6120** -1 pExpr only references no tables at all, or it only
6121** references tables defined in subqueries of pExpr itself.
6122**
6123** As currently used, pExpr is always an aggregate function call. That
6124** fact is exploited for efficiency.
drh374fdce2012-04-17 16:38:53 +00006125*/
drh90cf38b2021-11-08 23:24:00 +00006126int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00006127 Walker w;
drh90cf38b2021-11-08 23:24:00 +00006128 struct RefSrcList x;
drh41ce47c2022-08-22 02:00:26 +00006129 assert( pParse->db!=0 );
drh80f6bfc2019-08-31 20:13:30 +00006130 memset(&w, 0, sizeof(w));
drh90cf38b2021-11-08 23:24:00 +00006131 memset(&x, 0, sizeof(x));
6132 w.xExprCallback = exprRefToSrcList;
6133 w.xSelectCallback = selectRefEnter;
6134 w.xSelectCallback2 = selectRefLeave;
6135 w.u.pRefSrcList = &x;
6136 x.db = pParse->db;
6137 x.pRef = pSrcList;
6138 assert( pExpr->op==TK_AGG_FUNCTION );
drha4eeccd2021-10-07 17:43:30 +00006139 assert( ExprUseXList(pExpr) );
drh030796d2012-08-23 16:18:10 +00006140 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00006141#ifndef SQLITE_OMIT_WINDOWFUNC
6142 if( ExprHasProperty(pExpr, EP_WinFunc) ){
6143 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
6144 }
6145#endif
drh41ce47c2022-08-22 02:00:26 +00006146 if( x.aiExclude ) sqlite3DbNNFreeNN(pParse->db, x.aiExclude);
drh90cf38b2021-11-08 23:24:00 +00006147 if( w.eCode & 0x01 ){
6148 return 1;
6149 }else if( w.eCode ){
6150 return 0;
6151 }else{
6152 return -1;
6153 }
drh374fdce2012-04-17 16:38:53 +00006154}
6155
6156/*
drh89636622020-06-07 17:33:18 +00006157** This is a Walker expression node callback.
6158**
6159** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
6160** object that is referenced does not refer directly to the Expr. If
6161** it does, make a copy. This is done because the pExpr argument is
6162** subject to change.
6163**
6164** The copy is stored on pParse->pConstExpr with a register number of 0.
6165** This will cause the expression to be deleted automatically when the
6166** Parse object is destroyed, but the zero register number means that it
6167** will not generate any code in the preamble.
6168*/
6169static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00006170 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00006171 && pExpr->pAggInfo!=0
6172 ){
6173 AggInfo *pAggInfo = pExpr->pAggInfo;
6174 int iAgg = pExpr->iAgg;
6175 Parse *pParse = pWalker->pParse;
6176 sqlite3 *db = pParse->db;
drhfe888bc2022-07-25 23:34:14 +00006177 if( pExpr->op!=TK_AGG_FUNCTION ){
6178 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_IF_NULL_ROW );
drh89636622020-06-07 17:33:18 +00006179 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00006180 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006181 pExpr = sqlite3ExprDup(db, pExpr, 0);
6182 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006183 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006184 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006185 }
6186 }
6187 }else{
drhfe888bc2022-07-25 23:34:14 +00006188 assert( pExpr->op==TK_AGG_FUNCTION );
drh89636622020-06-07 17:33:18 +00006189 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00006190 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006191 pExpr = sqlite3ExprDup(db, pExpr, 0);
6192 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006193 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006194 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006195 }
6196 }
6197 }
6198 }
6199 return WRC_Continue;
6200}
6201
6202/*
6203** Initialize a Walker object so that will persist AggInfo entries referenced
6204** by the tree that is walked.
6205*/
6206void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
6207 memset(pWalker, 0, sizeof(*pWalker));
6208 pWalker->pParse = pParse;
6209 pWalker->xExprCallback = agginfoPersistExprCb;
6210 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
6211}
6212
6213/*
drh13449892005-09-07 21:22:45 +00006214** Add a new element to the pAggInfo->aCol[] array. Return the index of
6215** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00006216*/
drh17435752007-08-16 04:30:38 +00006217static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006218 int i;
drhcf643722007-03-27 13:36:37 +00006219 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006220 db,
drhcf643722007-03-27 13:36:37 +00006221 pInfo->aCol,
6222 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00006223 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00006224 &i
6225 );
drh13449892005-09-07 21:22:45 +00006226 return i;
6227}
6228
6229/*
6230** Add a new element to the pAggInfo->aFunc[] array. Return the index of
6231** the new element. Return a negative number if malloc fails.
6232*/
drh17435752007-08-16 04:30:38 +00006233static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006234 int i;
drhcf643722007-03-27 13:36:37 +00006235 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006236 db,
drhcf643722007-03-27 13:36:37 +00006237 pInfo->aFunc,
6238 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00006239 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00006240 &i
6241 );
drh13449892005-09-07 21:22:45 +00006242 return i;
drh89636622020-06-07 17:33:18 +00006243}
drh22827922000-06-06 17:27:05 +00006244
6245/*
drh7d10d5a2008-08-20 16:35:10 +00006246** This is the xExprCallback for a tree walker. It is used to
6247** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00006248** for additional information.
drh22827922000-06-06 17:27:05 +00006249*/
drh7d10d5a2008-08-20 16:35:10 +00006250static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00006251 int i;
drh7d10d5a2008-08-20 16:35:10 +00006252 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00006253 Parse *pParse = pNC->pParse;
6254 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00006255 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00006256
drh25c3b8c2018-04-16 10:34:13 +00006257 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00006258 switch( pExpr->op ){
drh6b6d6c62022-07-25 14:05:11 +00006259 case TK_IF_NULL_ROW:
drh89c69d02007-01-04 01:20:28 +00006260 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00006261 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00006262 testcase( pExpr->op==TK_AGG_COLUMN );
6263 testcase( pExpr->op==TK_COLUMN );
drhee373022022-07-25 15:54:23 +00006264 testcase( pExpr->op==TK_IF_NULL_ROW );
drh13449892005-09-07 21:22:45 +00006265 /* Check to see if the column is in one of the tables in the FROM
6266 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00006267 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00006268 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00006269 for(i=0; i<pSrcList->nSrc; i++, pItem++){
6270 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00006271 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00006272 if( pExpr->iTable==pItem->iCursor ){
6273 /* If we reach this point, it means that pExpr refers to a table
6274 ** that is in the FROM clause of the aggregate query.
6275 **
6276 ** Make an entry for the column in pAggInfo->aCol[] if there
6277 ** is not an entry there already.
6278 */
drh7f906d62007-03-12 23:48:52 +00006279 int k;
drh13449892005-09-07 21:22:45 +00006280 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00006281 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh4b1b65c2022-07-26 15:32:02 +00006282 if( pCol->iTable==pExpr->iTable
6283 && pCol->iColumn==pExpr->iColumn
6284 && pExpr->op!=TK_IF_NULL_ROW
6285 ){
drh13449892005-09-07 21:22:45 +00006286 break;
6287 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006288 }
danielk19771e536952007-08-16 10:09:01 +00006289 if( (k>=pAggInfo->nColumn)
6290 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
6291 ){
drh7f906d62007-03-12 23:48:52 +00006292 pCol = &pAggInfo->aCol[k];
drh477572b2021-10-07 20:46:29 +00006293 assert( ExprUseYTab(pExpr) );
drheda079c2018-09-20 19:02:15 +00006294 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00006295 pCol->iTable = pExpr->iTable;
6296 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00006297 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00006298 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00006299 pCol->pCExpr = pExpr;
drh4b1b65c2022-07-26 15:32:02 +00006300 if( pAggInfo->pGroupBy && pExpr->op!=TK_IF_NULL_ROW ){
drh13449892005-09-07 21:22:45 +00006301 int j, n;
6302 ExprList *pGB = pAggInfo->pGroupBy;
6303 struct ExprList_item *pTerm = pGB->a;
6304 n = pGB->nExpr;
6305 for(j=0; j<n; j++, pTerm++){
6306 Expr *pE = pTerm->pExpr;
drh4b1b65c2022-07-26 15:32:02 +00006307 if( pE->op==TK_COLUMN
6308 && pE->iTable==pExpr->iTable
6309 && pE->iColumn==pExpr->iColumn
6310 ){
drh13449892005-09-07 21:22:45 +00006311 pCol->iSorterColumn = j;
6312 break;
6313 }
6314 }
6315 }
6316 if( pCol->iSorterColumn<0 ){
6317 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
6318 }
6319 }
6320 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
6321 ** because it was there before or because we just created it).
6322 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
6323 ** pAggInfo->aCol[] entry.
6324 */
drhebb6a652013-09-12 23:42:22 +00006325 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00006326 pExpr->pAggInfo = pAggInfo;
drhee373022022-07-25 15:54:23 +00006327 if( pExpr->op==TK_COLUMN ){
6328 pExpr->op = TK_AGG_COLUMN;
6329 }
shanecf697392009-06-01 16:53:09 +00006330 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00006331 break;
6332 } /* endif pExpr->iTable==pItem->iCursor */
6333 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00006334 }
drh7d10d5a2008-08-20 16:35:10 +00006335 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00006336 }
6337 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00006338 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00006339 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00006340 ){
drh13449892005-09-07 21:22:45 +00006341 /* Check to see if pExpr is a duplicate of another aggregate
6342 ** function that is already in the pAggInfo structure
6343 */
6344 struct AggInfo_func *pItem = pAggInfo->aFunc;
6345 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan19e4eef2021-06-03 18:56:42 +00006346 if( pItem->pFExpr==pExpr ) break;
drh81185a52020-06-09 13:38:12 +00006347 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00006348 break;
6349 }
drh22827922000-06-06 17:27:05 +00006350 }
drh13449892005-09-07 21:22:45 +00006351 if( i>=pAggInfo->nFunc ){
6352 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
6353 */
danielk197714db2662006-01-09 16:12:04 +00006354 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006355 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006356 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006357 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006358 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006359 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00006360 pItem->iMem = ++pParse->nMem;
drha4eeccd2021-10-07 17:43:30 +00006361 assert( ExprUseUToken(pExpr) );
drh13449892005-09-07 21:22:45 +00006362 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006363 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006364 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006365 if( pExpr->flags & EP_Distinct ){
6366 pItem->iDistinct = pParse->nTab++;
6367 }else{
6368 pItem->iDistinct = -1;
6369 }
drh13449892005-09-07 21:22:45 +00006370 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006371 }
drh13449892005-09-07 21:22:45 +00006372 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6373 */
drhc5cd1242013-09-12 16:50:49 +00006374 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006375 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006376 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006377 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006378 return WRC_Prune;
6379 }else{
6380 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006381 }
drh22827922000-06-06 17:27:05 +00006382 }
6383 }
drh7d10d5a2008-08-20 16:35:10 +00006384 return WRC_Continue;
6385}
drh626a8792005-01-17 22:08:19 +00006386
6387/*
drhe8abb4c2012-11-02 18:24:57 +00006388** Analyze the pExpr expression looking for aggregate functions and
6389** for variables that need to be added to AggInfo object that pNC->pAggInfo
6390** points to. Additional entries are made on the AggInfo object as
6391** necessary.
drh626a8792005-01-17 22:08:19 +00006392**
6393** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006394** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006395*/
drhd2b3e232008-01-23 14:51:49 +00006396void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006397 Walker w;
6398 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006399 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6400 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006401 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006402 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006403 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006404 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006405 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006406}
drh5d9a4af2005-08-30 00:54:01 +00006407
6408/*
6409** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6410** expression list. Return the number of errors.
6411**
6412** If an error is found, the analysis is cut short.
6413*/
drhd2b3e232008-01-23 14:51:49 +00006414void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006415 struct ExprList_item *pItem;
6416 int i;
drh5d9a4af2005-08-30 00:54:01 +00006417 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006418 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6419 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006420 }
6421 }
drh5d9a4af2005-08-30 00:54:01 +00006422}
drh892d3172008-01-10 03:46:36 +00006423
6424/*
drhceea3322009-04-23 13:22:42 +00006425** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006426*/
6427int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006428 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006429 return ++pParse->nMem;
6430 }
danielk19772f425f62008-07-04 09:41:39 +00006431 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006432}
drhceea3322009-04-23 13:22:42 +00006433
6434/*
6435** Deallocate a register, making available for reuse for some other
6436** purpose.
drhceea3322009-04-23 13:22:42 +00006437*/
drh892d3172008-01-10 03:46:36 +00006438void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006439 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006440 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006441 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6442 pParse->aTempReg[pParse->nTempReg++] = iReg;
6443 }
drh892d3172008-01-10 03:46:36 +00006444 }
6445}
6446
6447/*
drhed24da42016-09-06 14:37:05 +00006448** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006449*/
6450int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006451 int i, n;
drhed24da42016-09-06 14:37:05 +00006452 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006453 i = pParse->iRangeReg;
6454 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006455 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006456 pParse->iRangeReg += nReg;
6457 pParse->nRangeReg -= nReg;
6458 }else{
6459 i = pParse->nMem+1;
6460 pParse->nMem += nReg;
6461 }
6462 return i;
6463}
6464void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006465 if( nReg==1 ){
6466 sqlite3ReleaseTempReg(pParse, iReg);
6467 return;
6468 }
drh3aef2fb2020-01-02 17:46:02 +00006469 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006470 if( nReg>pParse->nRangeReg ){
6471 pParse->nRangeReg = nReg;
6472 pParse->iRangeReg = iReg;
6473 }
6474}
drhcdc69552011-12-06 13:24:59 +00006475
6476/*
6477** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006478**
6479** Always invoke this procedure after coding a subroutine or co-routine
6480** that might be invoked from other parts of the code, to ensure that
6481** the sub/co-routine does not use registers in common with the code that
6482** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006483*/
6484void sqlite3ClearTempRegCache(Parse *pParse){
6485 pParse->nTempReg = 0;
6486 pParse->nRangeReg = 0;
6487}
drhbb9b5f22016-03-19 00:35:02 +00006488
6489/*
6490** Validate that no temporary register falls within the range of
6491** iFirst..iLast, inclusive. This routine is only call from within assert()
6492** statements.
6493*/
6494#ifdef SQLITE_DEBUG
6495int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6496 int i;
6497 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006498 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6499 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006500 ){
6501 return 0;
6502 }
6503 for(i=0; i<pParse->nTempReg; i++){
6504 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6505 return 0;
6506 }
6507 }
6508 return 1;
6509}
6510#endif /* SQLITE_DEBUG */