blob: 3801fb98f4a34fb82b683f777d1694d22e7b763e [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) );
58 if( pExpr->y.pTab ){
59 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
60 }
drhde0e1b12021-04-16 22:53:57 +000061 }
drh487e2622005-06-25 18:42:14 +000062 if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +000063 assert( ExprUseXSelect(pExpr) );
drh6af305d2020-07-10 21:43:53 +000064 assert( pExpr->x.pSelect!=0 );
65 assert( pExpr->x.pSelect->pEList!=0 );
66 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
67 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000068 }
drh487e2622005-06-25 18:42:14 +000069#ifndef SQLITE_OMIT_CAST
70 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000071 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000072 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000073 }
74#endif
dan80aa5452016-09-03 19:52:12 +000075 if( op==TK_SELECT_COLUMN ){
drha4eeccd2021-10-07 17:43:30 +000076 assert( pExpr->pLeft!=0 && ExprUseXSelect(pExpr->pLeft) );
drh10f08272021-07-05 01:11:26 +000077 assert( pExpr->iColumn < pExpr->iTable );
78 assert( pExpr->iTable==pExpr->pLeft->x.pSelect->pEList->nExpr );
dan80aa5452016-09-03 19:52:12 +000079 return sqlite3ExprAffinity(
80 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
81 );
82 }
drhdb36e252019-10-22 19:51:29 +000083 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +000084 assert( ExprUseXList(pExpr) );
drhdb36e252019-10-22 19:51:29 +000085 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
86 }
drh11949042019-08-05 18:01:42 +000087 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000088}
89
drh53db1452004-05-20 13:54:53 +000090/*
drh8b4c40d2007-02-01 23:02:45 +000091** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000092** sequence named by pToken. Return a pointer to a new Expr node that
93** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000094**
95** If a memory allocation error occurs, that fact is recorded in pParse->db
96** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000097*/
drh4ef7efa2014-03-20 15:14:08 +000098Expr *sqlite3ExprAddCollateToken(
drhb6dad522021-09-24 16:14:47 +000099 const Parse *pParse, /* Parsing context */
drh4ef7efa2014-03-20 15:14:08 +0000100 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +0000101 const Token *pCollName, /* Name of collating sequence */
102 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +0000103){
drh433a3e92021-05-04 12:07:16 +0000104 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +0000105 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000106 if( pNew ){
107 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000108 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000109 pExpr = pNew;
110 }
drhae80dde2012-12-06 21:16:43 +0000111 }
drh0a8a4062012-12-07 18:38:16 +0000112 return pExpr;
113}
drhb6dad522021-09-24 16:14:47 +0000114Expr *sqlite3ExprAddCollateString(
115 const Parse *pParse, /* Parsing context */
116 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
117 const char *zC /* The collating sequence name */
118){
drh261d8a52012-12-08 21:36:26 +0000119 Token s;
120 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000121 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000122 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000123}
124
125/*
drh0d950af2019-08-22 16:38:42 +0000126** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000127*/
128Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000129 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000130 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000131 pExpr = pExpr->pLeft;
132 }
133 return pExpr;
134}
135
136/*
137** Skip over any TK_COLLATE operators and/or any unlikely()
138** or likelihood() or likely() functions at the root of an
139** expression.
140*/
141Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000142 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000143 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drha4eeccd2021-10-07 17:43:30 +0000144 assert( ExprUseXList(pExpr) );
drhcca9f3d2013-09-06 15:23:29 +0000145 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000146 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000147 pExpr = pExpr->x.pList->a[0].pExpr;
148 }else{
drh46fe1382020-08-19 23:32:06 +0000149 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000150 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000151 }
drha4c3c872013-09-12 17:29:25 +0000152 }
drh0a8a4062012-12-07 18:38:16 +0000153 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000154}
155
156/*
drhae80dde2012-12-06 21:16:43 +0000157** Return the collation sequence for the expression pExpr. If
158** there is no defined collating sequence, return NULL.
159**
drh70efa842017-09-28 01:58:23 +0000160** See also: sqlite3ExprNNCollSeq()
161**
162** The sqlite3ExprNNCollSeq() works the same exact that it returns the
163** default collation if pExpr has no defined collation.
164**
drhae80dde2012-12-06 21:16:43 +0000165** The collating sequence might be determined by a COLLATE operator
166** or by the presence of a column with a defined collating sequence.
167** COLLATE operators take first precedence. Left operands take
168** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000169*/
drhe7375bf2020-03-10 19:24:38 +0000170CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000171 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000172 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000173 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000174 while( p ){
drhae80dde2012-12-06 21:16:43 +0000175 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000176 if( op==TK_REGISTER ) op = p->op2;
drh477572b2021-10-07 20:46:29 +0000177 if( op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER ){
178 assert( ExprUseYTab(p) );
179 if( p->y.pTab!=0 ){
180 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
181 ** a TK_COLUMN but was previously evaluated and cached in a register */
182 int j = p->iColumn;
183 if( j>=0 ){
184 const char *zColl = sqlite3ColumnColl(&p->y.pTab->aCol[j]);
185 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
186 }
187 break;
drh7d10d5a2008-08-20 16:35:10 +0000188 }
danielk19770202b292004-06-09 09:55:16 +0000189 }
drhe081d732018-07-27 18:19:12 +0000190 if( op==TK_CAST || op==TK_UPLUS ){
191 p = p->pLeft;
192 continue;
193 }
drh269d3222019-10-23 18:09:39 +0000194 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000195 assert( ExprUseXList(p) );
drh269d3222019-10-23 18:09:39 +0000196 p = p->x.pList->a[0].pExpr;
197 continue;
198 }
drhcb0e04f2018-12-12 21:34:17 +0000199 if( op==TK_COLLATE ){
drhf9751072021-10-07 13:40:29 +0000200 assert( !ExprHasProperty(p, EP_IntValue) );
drhe081d732018-07-27 18:19:12 +0000201 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
202 break;
203 }
drhae80dde2012-12-06 21:16:43 +0000204 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000205 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000206 p = p->pLeft;
207 }else{
drh2308ed32015-02-09 16:09:34 +0000208 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000209 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +0000210 assert( ExprUseXList(p) );
drh6728cd92015-02-09 18:28:03 +0000211 assert( p->x.pList==0 || p->pRight==0 );
drhb32b3092022-01-24 20:16:37 +0000212 if( p->x.pList!=0 && !db->mallocFailed ){
drh2308ed32015-02-09 16:09:34 +0000213 int i;
drh5b107652020-07-13 15:35:08 +0000214 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000215 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
216 pNext = p->x.pList->a[i].pExpr;
217 break;
218 }
219 }
220 }
221 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000222 }
223 }else{
drh7d10d5a2008-08-20 16:35:10 +0000224 break;
225 }
danielk19770202b292004-06-09 09:55:16 +0000226 }
danielk19777cedc8d2004-06-10 10:50:08 +0000227 if( sqlite3CheckCollSeq(pParse, pColl) ){
228 pColl = 0;
229 }
230 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000231}
232
233/*
drh70efa842017-09-28 01:58:23 +0000234** Return the collation sequence for the expression pExpr. If
235** there is no defined collating sequence, return a pointer to the
236** defautl collation sequence.
237**
238** See also: sqlite3ExprCollSeq()
239**
240** The sqlite3ExprCollSeq() routine works the same except that it
241** returns NULL if there is no defined collation.
242*/
drhe7375bf2020-03-10 19:24:38 +0000243CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000244 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
245 if( p==0 ) p = pParse->db->pDfltColl;
246 assert( p!=0 );
247 return p;
248}
249
250/*
251** Return TRUE if the two expressions have equivalent collating sequences.
252*/
drhe7375bf2020-03-10 19:24:38 +0000253int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000254 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
255 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
256 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
257}
258
259/*
drh626a8792005-01-17 22:08:19 +0000260** pExpr is an operand of a comparison operator. aff2 is the
261** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000262** type affinity that should be used for the comparison operator.
263*/
drhe7375bf2020-03-10 19:24:38 +0000264char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000265 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000266 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000267 /* Both sides of the comparison are columns. If one has numeric
268 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000269 */
drh8a512562005-11-14 22:29:05 +0000270 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000271 return SQLITE_AFF_NUMERIC;
272 }else{
drh05883a32015-06-02 15:32:08 +0000273 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000274 }
danielk1977e014a832004-05-17 10:48:57 +0000275 }else{
276 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000277 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
278 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000279 }
280}
281
drh53db1452004-05-20 13:54:53 +0000282/*
283** pExpr is a comparison operator. Return the type affinity that should
284** be applied to both operands prior to doing the comparison.
285*/
drhe7375bf2020-03-10 19:24:38 +0000286static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000287 char aff;
288 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
289 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000290 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000291 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000292 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000293 if( pExpr->pRight ){
294 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
drha4eeccd2021-10-07 17:43:30 +0000295 }else if( ExprUseXSelect(pExpr) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000296 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000297 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000298 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000299 }
300 return aff;
301}
302
303/*
304** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
305** idx_affinity is the affinity of an indexed column. Return true
306** if the index with affinity idx_affinity may be used to implement
307** the comparison in pExpr.
308*/
drhe7375bf2020-03-10 19:24:38 +0000309int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000310 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000311 if( aff<SQLITE_AFF_TEXT ){
312 return 1;
drh8a512562005-11-14 22:29:05 +0000313 }
drh915e4342019-08-06 15:18:15 +0000314 if( aff==SQLITE_AFF_TEXT ){
315 return idx_affinity==SQLITE_AFF_TEXT;
316 }
317 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000318}
319
danielk1977a37cdde2004-05-16 11:15:36 +0000320/*
drh35573352008-01-08 23:54:25 +0000321** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000322** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000323*/
drhe7375bf2020-03-10 19:24:38 +0000324static u8 binaryCompareP5(
325 const Expr *pExpr1, /* Left operand */
326 const Expr *pExpr2, /* Right operand */
327 int jumpIfNull /* Extra flags added to P5 */
328){
drh35573352008-01-08 23:54:25 +0000329 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000330 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000331 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000332}
333
drha2e00042002-01-22 03:13:42 +0000334/*
danielk19770202b292004-06-09 09:55:16 +0000335** Return a pointer to the collation sequence that should be used by
336** a binary comparison operator comparing pLeft and pRight.
337**
338** If the left hand expression has a collating sequence type, then it is
339** used. Otherwise the collation sequence for the right hand expression
340** is used, or the default (BINARY) if neither expression has a collating
341** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000342**
343** Argument pRight (but not pLeft) may be a null pointer. In this case,
344** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000345*/
drh0a0e1312007-08-07 17:04:59 +0000346CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000347 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000348 const Expr *pLeft,
349 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000350){
drhec41dda2007-02-07 13:09:45 +0000351 CollSeq *pColl;
352 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000353 if( pLeft->flags & EP_Collate ){
354 pColl = sqlite3ExprCollSeq(pParse, pLeft);
355 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
356 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000357 }else{
358 pColl = sqlite3ExprCollSeq(pParse, pLeft);
359 if( !pColl ){
360 pColl = sqlite3ExprCollSeq(pParse, pRight);
361 }
danielk19770202b292004-06-09 09:55:16 +0000362 }
363 return pColl;
364}
365
drh898c5272019-10-22 00:03:41 +0000366/* Expresssion p is a comparison operator. Return a collation sequence
367** appropriate for the comparison operator.
368**
369** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
370** However, if the OP_Commuted flag is set, then the order of the operands
371** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
372** correct collating sequence is found.
373*/
drhe7375bf2020-03-10 19:24:38 +0000374CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000375 if( ExprHasProperty(p, EP_Commuted) ){
376 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
377 }else{
378 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
379 }
380}
381
danielk19770202b292004-06-09 09:55:16 +0000382/*
drhbe5c89a2004-07-26 00:31:09 +0000383** Generate code for a comparison operator.
384*/
385static int codeCompare(
386 Parse *pParse, /* The parsing (and code generating) context */
387 Expr *pLeft, /* The left operand */
388 Expr *pRight, /* The right operand */
389 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000390 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000391 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000392 int jumpIfNull, /* If true, jump if either operand is NULL */
393 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000394){
drh35573352008-01-08 23:54:25 +0000395 int p5;
396 int addr;
397 CollSeq *p4;
398
drh86541862019-12-19 20:37:32 +0000399 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000400 if( isCommuted ){
401 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
402 }else{
403 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
404 }
drh35573352008-01-08 23:54:25 +0000405 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
406 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
407 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000408 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000409 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000410}
411
dancfbb5e82016-07-13 19:48:13 +0000412/*
dan870a0702016-08-01 16:37:43 +0000413** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000414**
415** A vector is defined as any expression that results in two or more
416** columns of result. Every TK_VECTOR node is an vector because the
417** parser will not generate a TK_VECTOR with fewer than two entries.
418** But a TK_SELECT might be either a vector or a scalar. It is only
419** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000420*/
drhb6dad522021-09-24 16:14:47 +0000421int sqlite3ExprIsVector(const Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000422 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000423}
424
425/*
dancfbb5e82016-07-13 19:48:13 +0000426** If the expression passed as the only argument is of type TK_VECTOR
427** return the number of expressions in the vector. Or, if the expression
428** is a sub-select, return the number of columns in the sub-select. For
429** any other type of expression, return 1.
430*/
drhb6dad522021-09-24 16:14:47 +0000431int sqlite3ExprVectorSize(const Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000432 u8 op = pExpr->op;
433 if( op==TK_REGISTER ) op = pExpr->op2;
434 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000435 assert( ExprUseXList(pExpr) );
drh76dbe7a2016-08-20 21:02:38 +0000436 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000437 }else if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000438 assert( ExprUseXSelect(pExpr) );
dan71c57db2016-07-09 20:23:55 +0000439 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000440 }else{
441 return 1;
dan71c57db2016-07-09 20:23:55 +0000442 }
dan71c57db2016-07-09 20:23:55 +0000443}
444
danba00e302016-07-23 20:24:06 +0000445/*
drhfc7f27b2016-08-20 00:07:01 +0000446** Return a pointer to a subexpression of pVector that is the i-th
447** column of the vector (numbered starting with 0). The caller must
448** ensure that i is within range.
449**
drh76dbe7a2016-08-20 21:02:38 +0000450** If pVector is really a scalar (and "scalar" here includes subqueries
451** that return a single column!) then return pVector unmodified.
452**
drhfc7f27b2016-08-20 00:07:01 +0000453** pVector retains ownership of the returned subexpression.
454**
455** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000456** just the expression for the i-th term of the result set, and may
457** not be ready for evaluation because the table cursor has not yet
458** been positioned.
danba00e302016-07-23 20:24:06 +0000459*/
drhfc7f27b2016-08-20 00:07:01 +0000460Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
drhbf7f3a02021-05-24 11:35:16 +0000461 assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
dan870a0702016-08-01 16:37:43 +0000462 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000463 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
464 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000465 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000466 return pVector->x.pSelect->pEList->a[i].pExpr;
467 }else{
drha4eeccd2021-10-07 17:43:30 +0000468 assert( ExprUseXList(pVector) );
dan870a0702016-08-01 16:37:43 +0000469 return pVector->x.pList->a[i].pExpr;
470 }
dan71c57db2016-07-09 20:23:55 +0000471 }
dan870a0702016-08-01 16:37:43 +0000472 return pVector;
dan71c57db2016-07-09 20:23:55 +0000473}
drhfc7f27b2016-08-20 00:07:01 +0000474
drhfc7f27b2016-08-20 00:07:01 +0000475/*
476** Compute and return a new Expr object which when passed to
477** sqlite3ExprCode() will generate all necessary code to compute
478** the iField-th column of the vector expression pVector.
479**
drh8762ec12016-08-20 01:06:22 +0000480** It is ok for pVector to be a scalar (as long as iField==0).
481** In that case, this routine works like sqlite3ExprDup().
482**
drhfc7f27b2016-08-20 00:07:01 +0000483** The caller owns the returned Expr object and is responsible for
484** ensuring that the returned value eventually gets freed.
485**
drh8762ec12016-08-20 01:06:22 +0000486** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000487** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000488** valid for the life of the returned object. If pVector is a TK_VECTOR
489** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000490** returns.
drh8762ec12016-08-20 01:06:22 +0000491**
492** A trick to cause a TK_SELECT pVector to be deleted together with
493** the returned Expr object is to attach the pVector to the pRight field
494** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000495*/
496Expr *sqlite3ExprForVectorField(
497 Parse *pParse, /* Parsing context */
498 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drh10f08272021-07-05 01:11:26 +0000499 int iField, /* Which column of the vector to return */
500 int nField /* Total number of columns in the vector */
drhfc7f27b2016-08-20 00:07:01 +0000501){
502 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000503 if( pVector->op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000504 assert( ExprUseXSelect(pVector) );
drhfc7f27b2016-08-20 00:07:01 +0000505 /* The TK_SELECT_COLUMN Expr node:
506 **
drh966e2912017-01-03 02:58:01 +0000507 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000508 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000509 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000510 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000511 ** pLeft->iTable: First in an array of register holding result, or 0
512 ** if the result is not yet computed.
513 **
514 ** sqlite3ExprDelete() specifically skips the recursive delete of
515 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000516 ** can be attached to pRight to cause this node to take ownership of
517 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
518 ** with the same pLeft pointer to the pVector, but only one of them
519 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000520 */
drhabfd35e2016-12-06 22:47:23 +0000521 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000522 if( pRet ){
drh10f08272021-07-05 01:11:26 +0000523 pRet->iTable = nField;
drh8bd0d582016-08-20 18:06:14 +0000524 pRet->iColumn = iField;
525 pRet->pLeft = pVector;
526 }
drhfc7f27b2016-08-20 00:07:01 +0000527 }else{
danab632bc2021-09-29 18:33:26 +0000528 if( pVector->op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000529 Expr **ppVector;
530 assert( ExprUseXList(pVector) );
531 ppVector = &pVector->x.pList->a[iField].pExpr;
danab632bc2021-09-29 18:33:26 +0000532 pVector = *ppVector;
533 if( IN_RENAME_OBJECT ){
534 /* This must be a vector UPDATE inside a trigger */
535 *ppVector = 0;
536 return pVector;
537 }
dan5a69d192021-09-27 15:44:03 +0000538 }
danab632bc2021-09-29 18:33:26 +0000539 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
drhfc7f27b2016-08-20 00:07:01 +0000540 }
541 return pRet;
542}
dan71c57db2016-07-09 20:23:55 +0000543
dan5c288b92016-07-30 21:02:33 +0000544/*
545** If expression pExpr is of type TK_SELECT, generate code to evaluate
546** it. Return the register in which the result is stored (or, if the
547** sub-select returns more than one column, the first in an array
548** of registers in which the result is stored).
549**
550** If pExpr is not a TK_SELECT expression, return 0.
551*/
552static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000553 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000554#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000555 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000556 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000557 }
danf9b2e052016-08-02 17:45:00 +0000558#endif
dan8da209b2016-07-26 18:06:08 +0000559 return reg;
560}
561
dan5c288b92016-07-30 21:02:33 +0000562/*
563** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000564** or TK_SELECT that returns more than one column. This function returns
565** the register number of a register that contains the value of
566** element iField of the vector.
567**
568** If pVector is a TK_SELECT expression, then code for it must have
569** already been generated using the exprCodeSubselect() routine. In this
570** case parameter regSelect should be the first in an array of registers
571** containing the results of the sub-select.
572**
573** If pVector is of type TK_VECTOR, then code for the requested field
574** is generated. In this case (*pRegFree) may be set to the number of
575** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000576**
577** Before returning, output parameter (*ppExpr) is set to point to the
578** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000579*/
580static int exprVectorRegister(
581 Parse *pParse, /* Parse context */
582 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000583 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000584 int regSelect, /* First in array of registers */
585 Expr **ppExpr, /* OUT: Expression element */
586 int *pRegFree /* OUT: Temp register to free */
587){
drh12abf402016-08-22 14:30:05 +0000588 u8 op = pVector->op;
drh05428122021-05-24 00:17:04 +0000589 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
drh12abf402016-08-22 14:30:05 +0000590 if( op==TK_REGISTER ){
591 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
592 return pVector->iTable+iField;
593 }
594 if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000595 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000596 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
597 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000598 }
drh05428122021-05-24 00:17:04 +0000599 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000600 assert( ExprUseXList(pVector) );
drh05428122021-05-24 00:17:04 +0000601 *ppExpr = pVector->x.pList->a[iField].pExpr;
602 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
603 }
604 return 0;
dan5c288b92016-07-30 21:02:33 +0000605}
606
607/*
608** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000609** the result of the comparison (1, 0, or NULL) and write that
610** result into register dest.
611**
612** The caller must satisfy the following preconditions:
613**
614** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
615** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
616** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000617*/
drh79752b62016-08-13 10:02:17 +0000618static void codeVectorCompare(
619 Parse *pParse, /* Code generator context */
620 Expr *pExpr, /* The comparison operation */
621 int dest, /* Write results into this register */
622 u8 op, /* Comparison operator */
623 u8 p5 /* SQLITE_NULLEQ or zero */
624){
dan71c57db2016-07-09 20:23:55 +0000625 Vdbe *v = pParse->pVdbe;
626 Expr *pLeft = pExpr->pLeft;
627 Expr *pRight = pExpr->pRight;
628 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000629 int i;
630 int regLeft = 0;
631 int regRight = 0;
632 u8 opx = op;
drh4bc20452021-03-29 18:53:47 +0000633 int addrCmp = 0;
drhec4ccdb2018-12-29 02:26:59 +0000634 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000635 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000636
drhe7375bf2020-03-10 19:24:38 +0000637 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh340fd0b2021-03-19 16:29:40 +0000638 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000639 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
640 sqlite3ErrorMsg(pParse, "row value misused");
641 return;
642 }
drhb29e60c2016-09-05 12:02:34 +0000643 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
644 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
645 || pExpr->op==TK_LT || pExpr->op==TK_GT
646 || pExpr->op==TK_LE || pExpr->op==TK_GE
647 );
648 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
649 || (pExpr->op==TK_ISNOT && op==TK_NE) );
650 assert( p5==0 || pExpr->op!=op );
651 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000652
drh4bc20452021-03-29 18:53:47 +0000653 if( op==TK_LE ) opx = TK_LT;
654 if( op==TK_GE ) opx = TK_GT;
655 if( op==TK_NE ) opx = TK_EQ;
dan71c57db2016-07-09 20:23:55 +0000656
drhb29e60c2016-09-05 12:02:34 +0000657 regLeft = exprCodeSubselect(pParse, pLeft);
658 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000659
drh4bc20452021-03-29 18:53:47 +0000660 sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
drhb29e60c2016-09-05 12:02:34 +0000661 for(i=0; 1 /*Loop exits by "break"*/; i++){
662 int regFree1 = 0, regFree2 = 0;
drhabc15f12021-06-04 16:11:19 +0000663 Expr *pL = 0, *pR = 0;
drhb29e60c2016-09-05 12:02:34 +0000664 int r1, r2;
665 assert( i>=0 && i<nLeft );
drh4bc20452021-03-29 18:53:47 +0000666 if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000667 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
668 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh4bc20452021-03-29 18:53:47 +0000669 addrCmp = sqlite3VdbeCurrentAddr(v);
670 codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000671 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
672 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
673 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
674 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
675 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
676 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
677 sqlite3ReleaseTempReg(pParse, regFree1);
678 sqlite3ReleaseTempReg(pParse, regFree2);
drh4bc20452021-03-29 18:53:47 +0000679 if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
680 addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
681 testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
682 testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
683 }
684 if( p5==SQLITE_NULLEQ ){
685 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
686 }else{
687 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
688 }
drhb29e60c2016-09-05 12:02:34 +0000689 if( i==nLeft-1 ){
690 break;
dan71c57db2016-07-09 20:23:55 +0000691 }
drhb29e60c2016-09-05 12:02:34 +0000692 if( opx==TK_EQ ){
drh4bc20452021-03-29 18:53:47 +0000693 sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
drhb29e60c2016-09-05 12:02:34 +0000694 }else{
695 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
drh4bc20452021-03-29 18:53:47 +0000696 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
drhb29e60c2016-09-05 12:02:34 +0000697 if( i==nLeft-2 ) opx = op;
698 }
dan71c57db2016-07-09 20:23:55 +0000699 }
drh4bc20452021-03-29 18:53:47 +0000700 sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000701 sqlite3VdbeResolveLabel(v, addrDone);
drh4bc20452021-03-29 18:53:47 +0000702 if( op==TK_NE ){
703 sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
704 }
dan71c57db2016-07-09 20:23:55 +0000705}
706
danielk19774b5255a2008-06-05 16:47:39 +0000707#if SQLITE_MAX_EXPR_DEPTH>0
708/*
709** Check that argument nHeight is less than or equal to the maximum
710** expression depth allowed. If it is not, leave an error message in
711** pParse.
712*/
drh7d10d5a2008-08-20 16:35:10 +0000713int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000714 int rc = SQLITE_OK;
715 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
716 if( nHeight>mxHeight ){
717 sqlite3ErrorMsg(pParse,
718 "Expression tree is too large (maximum depth %d)", mxHeight
719 );
720 rc = SQLITE_ERROR;
721 }
722 return rc;
723}
724
725/* The following three functions, heightOfExpr(), heightOfExprList()
726** and heightOfSelect(), are used to determine the maximum height
727** of any expression tree referenced by the structure passed as the
728** first argument.
729**
730** If this maximum height is greater than the current value pointed
731** to by pnHeight, the second parameter, then set *pnHeight to that
732** value.
733*/
drhb6dad522021-09-24 16:14:47 +0000734static void heightOfExpr(const Expr *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000735 if( p ){
736 if( p->nHeight>*pnHeight ){
737 *pnHeight = p->nHeight;
738 }
739 }
740}
drhb6dad522021-09-24 16:14:47 +0000741static void heightOfExprList(const ExprList *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000742 if( p ){
743 int i;
744 for(i=0; i<p->nExpr; i++){
745 heightOfExpr(p->a[i].pExpr, pnHeight);
746 }
747 }
748}
drhb6dad522021-09-24 16:14:47 +0000749static void heightOfSelect(const Select *pSelect, int *pnHeight){
750 const Select *p;
dan1a3a3082018-01-18 19:00:54 +0000751 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000752 heightOfExpr(p->pWhere, pnHeight);
753 heightOfExpr(p->pHaving, pnHeight);
754 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000755 heightOfExprList(p->pEList, pnHeight);
756 heightOfExprList(p->pGroupBy, pnHeight);
757 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000758 }
759}
760
761/*
762** Set the Expr.nHeight variable in the structure passed as an
763** argument. An expression with no children, Expr.pList or
764** Expr.pSelect member has a height of 1. Any other expression
765** has a height equal to the maximum height of any other
766** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000767**
768** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
769** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000770*/
771static void exprSetHeight(Expr *p){
drh2ef11112022-02-06 11:51:23 +0000772 int nHeight = p->pLeft ? p->pLeft->nHeight : 0;
773 if( p->pRight && p->pRight->nHeight>nHeight ) nHeight = p->pRight->nHeight;
drha4eeccd2021-10-07 17:43:30 +0000774 if( ExprUseXSelect(p) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000775 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000776 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000777 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000778 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000779 }
danielk19774b5255a2008-06-05 16:47:39 +0000780 p->nHeight = nHeight + 1;
781}
782
783/*
784** Set the Expr.nHeight variable using the exprSetHeight() function. If
785** the height is greater than the maximum allowed expression depth,
786** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000787**
788** Also propagate all EP_Propagate flags from the Expr.x.pList into
789** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000790*/
drh2308ed32015-02-09 16:09:34 +0000791void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000792 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000793 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000794 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000795}
796
797/*
798** Return the maximum height of any expression tree referenced
799** by the select statement passed as an argument.
800*/
drhb6dad522021-09-24 16:14:47 +0000801int sqlite3SelectExprHeight(const Select *p){
danielk19774b5255a2008-06-05 16:47:39 +0000802 int nHeight = 0;
803 heightOfSelect(p, &nHeight);
804 return nHeight;
805}
drh2308ed32015-02-09 16:09:34 +0000806#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
807/*
808** Propagate all EP_Propagate flags from the Expr.x.pList into
809** Expr.flags.
810*/
811void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000812 if( pParse->nErr ) return;
drha4eeccd2021-10-07 17:43:30 +0000813 if( p && ExprUseXList(p) && p->x.pList ){
drh2308ed32015-02-09 16:09:34 +0000814 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
815 }
816}
817#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000818#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
819
drhbe5c89a2004-07-26 00:31:09 +0000820/*
drhb7916a72009-05-27 10:31:29 +0000821** This routine is the core allocator for Expr nodes.
822**
drha76b5df2002-02-23 02:32:10 +0000823** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000824** for this node and for the pToken argument is a single allocation
825** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000826** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000827**
828** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000829** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000830** parameter is ignored if pToken is NULL or if the token does not
831** appear to be quoted. If the quotes were of the form "..." (double-quotes)
832** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000833**
834** Special case: If op==TK_INTEGER and pToken points to a string that
835** can be translated into a 32-bit integer, then the token is not
836** stored in u.zToken. Instead, the integer values is written
837** into u.iValue and the EP_IntValue flag is set. No extra storage
838** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000839*/
drhb7916a72009-05-27 10:31:29 +0000840Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000841 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000842 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000843 const Token *pToken, /* Token argument. Might be NULL */
844 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000845){
drha76b5df2002-02-23 02:32:10 +0000846 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000847 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000848 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000849
drh575fad62016-02-05 13:38:36 +0000850 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000851 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000852 if( op!=TK_INTEGER || pToken->z==0
853 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
854 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000855 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000856 }
drhb7916a72009-05-27 10:31:29 +0000857 }
drh575fad62016-02-05 13:38:36 +0000858 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000859 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000860 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000861 pNew->op = (u8)op;
862 pNew->iAgg = -1;
863 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000864 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000865 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000866 pNew->u.iValue = iValue;
867 }else{
drh33e619f2009-05-28 01:00:55 +0000868 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000869 assert( pToken->z!=0 || pToken->n==0 );
870 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000871 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000872 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000873 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000874 }
drhb7916a72009-05-27 10:31:29 +0000875 }
876 }
877#if SQLITE_MAX_EXPR_DEPTH>0
878 pNew->nHeight = 1;
879#endif
880 }
drha76b5df2002-02-23 02:32:10 +0000881 return pNew;
882}
883
884/*
drhb7916a72009-05-27 10:31:29 +0000885** Allocate a new expression node from a zero-terminated token that has
886** already been dequoted.
887*/
888Expr *sqlite3Expr(
889 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
890 int op, /* Expression opcode */
891 const char *zToken /* Token argument. Might be NULL */
892){
893 Token x;
894 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000895 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000896 return sqlite3ExprAlloc(db, op, &x, 0);
897}
898
899/*
900** Attach subtrees pLeft and pRight to the Expr node pRoot.
901**
902** If pRoot==NULL that means that a memory allocation error has occurred.
903** In that case, delete the subtrees pLeft and pRight.
904*/
905void sqlite3ExprAttachSubtrees(
906 sqlite3 *db,
907 Expr *pRoot,
908 Expr *pLeft,
909 Expr *pRight
910){
911 if( pRoot==0 ){
912 assert( db->mallocFailed );
913 sqlite3ExprDelete(db, pLeft);
914 sqlite3ExprDelete(db, pRight);
915 }else{
916 if( pRight ){
917 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000918 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000919 }
920 if( pLeft ){
921 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000922 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000923 }
924 exprSetHeight(pRoot);
925 }
926}
927
928/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000929** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000930**
drhbf664462009-06-19 18:32:54 +0000931** One or both of the subtrees can be NULL. Return a pointer to the new
932** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
933** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000934*/
drh17435752007-08-16 04:30:38 +0000935Expr *sqlite3PExpr(
936 Parse *pParse, /* Parsing context */
937 int op, /* Expression opcode */
938 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000939 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000940){
drh5fb52ca2012-03-31 02:34:35 +0000941 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000942 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
943 if( p ){
944 memset(p, 0, sizeof(Expr));
945 p->op = op & 0xff;
946 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000947 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000948 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000949 }else{
950 sqlite3ExprDelete(pParse->db, pLeft);
951 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000952 }
drh4e0cff62004-11-05 05:10:28 +0000953 return p;
954}
955
956/*
drh08de4f72016-04-11 01:06:47 +0000957** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
958** do a memory allocation failure) then delete the pSelect object.
959*/
960void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
961 if( pExpr ){
962 pExpr->x.pSelect = pSelect;
963 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
964 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
965 }else{
966 assert( pParse->db->mallocFailed );
967 sqlite3SelectDelete(pParse->db, pSelect);
968 }
969}
970
dan9289f512021-07-06 20:44:32 +0000971/*
972** Expression list pEList is a list of vector values. This function
973** converts the contents of pEList to a VALUES(...) Select statement
dan74777f92021-07-07 13:53:55 +0000974** returning 1 row for each element of the list. For example, the
975** expression list:
dan9289f512021-07-06 20:44:32 +0000976**
dan74777f92021-07-07 13:53:55 +0000977** ( (1,2), (3,4) (5,6) )
dan9289f512021-07-06 20:44:32 +0000978**
dan74777f92021-07-07 13:53:55 +0000979** is translated to the equivalent of:
dan9289f512021-07-06 20:44:32 +0000980**
dan74777f92021-07-07 13:53:55 +0000981** VALUES(1,2), (3,4), (5,6)
dan9289f512021-07-06 20:44:32 +0000982**
dan74777f92021-07-07 13:53:55 +0000983** Each of the vector values in pEList must contain exactly nElem terms.
984** If a list element that is not a vector or does not contain nElem terms,
985** an error message is left in pParse.
dan9289f512021-07-06 20:44:32 +0000986**
987** This is used as part of processing IN(...) expressions with a list
988** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
989*/
dan74777f92021-07-07 13:53:55 +0000990Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
dan9289f512021-07-06 20:44:32 +0000991 int ii;
992 Select *pRet = 0;
dan2931a662021-07-07 15:52:44 +0000993 assert( nElem>1 );
dan9289f512021-07-06 20:44:32 +0000994 for(ii=0; ii<pEList->nExpr; ii++){
995 Select *pSel;
dan9289f512021-07-06 20:44:32 +0000996 Expr *pExpr = pEList->a[ii].pExpr;
drha4eeccd2021-10-07 17:43:30 +0000997 int nExprElem;
998 if( pExpr->op==TK_VECTOR ){
999 assert( ExprUseXList(pExpr) );
1000 nExprElem = pExpr->x.pList->nExpr;
1001 }else{
1002 nExprElem = 1;
1003 }
dan74777f92021-07-07 13:53:55 +00001004 if( nExprElem!=nElem ){
1005 sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
1006 nExprElem, nExprElem>1?"s":"", nElem
1007 );
1008 break;
dan9289f512021-07-06 20:44:32 +00001009 }
drha4eeccd2021-10-07 17:43:30 +00001010 assert( ExprUseXList(pExpr) );
dan74777f92021-07-07 13:53:55 +00001011 pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
1012 pExpr->x.pList = 0;
dan9289f512021-07-06 20:44:32 +00001013 if( pSel ){
1014 if( pRet ){
1015 pSel->op = TK_ALL;
1016 pSel->pPrior = pRet;
1017 }
1018 pRet = pSel;
1019 }
1020 }
1021
1022 if( pRet && pRet->pPrior ){
1023 pRet->selFlags |= SF_MultiValue;
1024 }
1025 sqlite3ExprListDelete(pParse->db, pEList);
1026 return pRet;
1027}
drh08de4f72016-04-11 01:06:47 +00001028
1029/*
drh91bb0ee2004-09-01 03:06:34 +00001030** Join two expressions using an AND operator. If either expression is
1031** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +00001032**
1033** If one side or the other of the AND is known to be false, then instead
1034** of returning an AND expression, just return a constant expression with
1035** a value of false.
drh91bb0ee2004-09-01 03:06:34 +00001036*/
drhd5c851c2019-04-19 13:38:34 +00001037Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1038 sqlite3 *db = pParse->db;
1039 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +00001040 return pRight;
1041 }else if( pRight==0 ){
1042 return pLeft;
dan2b6e6702019-12-30 06:55:31 +00001043 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
1044 && !IN_RENAME_OBJECT
1045 ){
drhb3ad4e62021-03-31 13:31:33 +00001046 sqlite3ExprDeferredDelete(pParse, pLeft);
1047 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +00001048 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +00001049 }else{
drhd5c851c2019-04-19 13:38:34 +00001050 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +00001051 }
1052}
1053
1054/*
1055** Construct a new expression node for a function with multiple
1056** arguments.
1057*/
drh954733b2018-07-27 23:33:16 +00001058Expr *sqlite3ExprFunction(
1059 Parse *pParse, /* Parsing context */
1060 ExprList *pList, /* Argument list */
drhb6dad522021-09-24 16:14:47 +00001061 const Token *pToken, /* Name of the function */
drh954733b2018-07-27 23:33:16 +00001062 int eDistinct /* SF_Distinct or SF_ALL or 0 */
1063){
drha76b5df2002-02-23 02:32:10 +00001064 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +00001065 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +00001066 assert( pToken );
drhb7916a72009-05-27 10:31:29 +00001067 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +00001068 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +00001069 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +00001070 return 0;
1071 }
drha6e8ee12022-05-13 16:38:40 +00001072 assert( !ExprHasProperty(pNew, EP_InnerON|EP_OuterON) );
drh62fc0692022-02-06 00:30:04 +00001073 pNew->w.iOfst = (int)(pToken->z - pParse->zTail);
drh14a1b1c2021-06-30 11:53:21 +00001074 if( pList
1075 && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
1076 && !pParse->nested
1077 ){
drh954733b2018-07-27 23:33:16 +00001078 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1079 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001080 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +00001081 ExprSetProperty(pNew, EP_HasFunc);
drha4eeccd2021-10-07 17:43:30 +00001082 assert( ExprUseXList(pNew) );
drh2308ed32015-02-09 16:09:34 +00001083 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +00001084 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +00001085 return pNew;
1086}
1087
1088/*
drh0dfa5252020-01-08 17:28:19 +00001089** Check to see if a function is usable according to current access
1090** rules:
1091**
1092** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1093**
1094** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1095** top-level SQL
1096**
1097** If the function is not usable, create an error.
1098*/
1099void sqlite3ExprFunctionUsable(
1100 Parse *pParse, /* Parsing and code generating context */
drhb6dad522021-09-24 16:14:47 +00001101 const Expr *pExpr, /* The function invocation */
1102 const FuncDef *pDef /* The function being invoked */
drh0dfa5252020-01-08 17:28:19 +00001103){
1104 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001105 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1106 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001107 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1108 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1109 ){
1110 /* Functions prohibited in triggers and views if:
1111 ** (1) tagged with SQLITE_DIRECTONLY
1112 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1113 ** is tagged with SQLITE_FUNC_UNSAFE) and
1114 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1115 ** that the schema is possibly tainted).
1116 */
drh62fc0692022-02-06 00:30:04 +00001117 sqlite3ErrorMsg(pParse, "unsafe use of %#T()", pExpr);
drh0dfa5252020-01-08 17:28:19 +00001118 }
1119 }
1120}
1121
1122/*
drhfa6bc002004-09-07 16:19:52 +00001123** Assign a variable number to an expression that encodes a wildcard
1124** in the original SQL statement.
1125**
1126** Wildcards consisting of a single "?" are assigned the next sequential
1127** variable number.
1128**
1129** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001130** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001131** the SQL statement comes from an external source.
1132**
drh51f49f12009-05-21 20:41:32 +00001133** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001134** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001135** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001136** assigned.
1137*/
drhde25a882016-10-03 15:28:24 +00001138void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001139 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001140 const char *z;
drhf326d662016-12-23 13:30:53 +00001141 ynVar x;
drh17435752007-08-16 04:30:38 +00001142
drhfa6bc002004-09-07 16:19:52 +00001143 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001144 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001145 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001146 assert( z!=0 );
1147 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001148 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001149 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001150 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001151 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001152 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001153 }else{
drhf326d662016-12-23 13:30:53 +00001154 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001155 if( z[0]=='?' ){
1156 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1157 ** use it as the variable number */
1158 i64 i;
drh18814df2017-01-31 03:52:34 +00001159 int bOk;
1160 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1161 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1162 bOk = 1;
1163 }else{
1164 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1165 }
drh124c0b42011-06-01 18:15:55 +00001166 testcase( i==0 );
1167 testcase( i==1 );
1168 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1169 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1170 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1171 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1172 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drh62fc0692022-02-06 00:30:04 +00001173 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
drhc9b39282016-10-03 16:33:14 +00001174 return;
drhfa6bc002004-09-07 16:19:52 +00001175 }
drh8e74e7b2017-01-31 12:41:48 +00001176 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001177 if( x>pParse->nVar ){
1178 pParse->nVar = (int)x;
1179 doAdd = 1;
1180 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1181 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001182 }
1183 }else{
1184 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1185 ** number as the prior appearance of the same name, or if the name
1186 ** has never appeared before, reuse the same variable number
1187 */
drh9bf755c2016-12-23 03:59:31 +00001188 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1189 if( x==0 ){
1190 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001191 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001192 }
drhfa6bc002004-09-07 16:19:52 +00001193 }
drhf326d662016-12-23 13:30:53 +00001194 if( doAdd ){
1195 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1196 }
1197 }
1198 pExpr->iColumn = x;
1199 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001200 sqlite3ErrorMsg(pParse, "too many SQL variables");
drh62fc0692022-02-06 00:30:04 +00001201 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
danielk1977832b2662007-05-09 11:37:22 +00001202 }
drhfa6bc002004-09-07 16:19:52 +00001203}
1204
1205/*
danf6963f92009-11-23 14:39:14 +00001206** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001207*/
drh4f0010b2016-04-11 14:49:39 +00001208static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1209 assert( p!=0 );
drh477572b2021-10-07 20:46:29 +00001210 assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1211 assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1212 assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1213 assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
drh209bc522016-09-23 21:36:24 +00001214#ifdef SQLITE_DEBUG
1215 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1216 assert( p->pLeft==0 );
1217 assert( p->pRight==0 );
drha4eeccd2021-10-07 17:43:30 +00001218 assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1219 assert( !ExprUseXList(p) || p->x.pList==0 );
drh209bc522016-09-23 21:36:24 +00001220 }
1221#endif
1222 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001223 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +00001224 assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001225 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001226 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001227 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001228 sqlite3ExprDeleteNN(db, p->pRight);
drha4eeccd2021-10-07 17:43:30 +00001229 }else if( ExprUseXSelect(p) ){
dan4f9adee2019-07-13 16:22:50 +00001230 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001231 sqlite3SelectDelete(db, p->x.pSelect);
1232 }else{
1233 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001234#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001235 if( ExprHasProperty(p, EP_WinFunc) ){
1236 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001237 }
dan6ba7ab02019-07-02 11:56:47 +00001238#endif
dan8117f112019-07-10 20:16:53 +00001239 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001240 }
drh33e619f2009-05-28 01:00:55 +00001241 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001242 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001243 }
drha2e00042002-01-22 03:13:42 +00001244}
drh4f0010b2016-04-11 14:49:39 +00001245void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1246 if( p ) sqlite3ExprDeleteNN(db, p);
1247}
drha2e00042002-01-22 03:13:42 +00001248
drhd44f8b22022-04-07 01:11:13 +00001249/*
1250** Clear both elements of an OnOrUsing object
1251*/
1252void sqlite3ClearOnOrUsing(sqlite3 *db, OnOrUsing *p){
1253 if( p==0 ){
1254 /* Nothing to clear */
1255 }else if( p->pOn ){
1256 sqlite3ExprDeleteNN(db, p->pOn);
1257 }else if( p->pUsing ){
1258 sqlite3IdListDelete(db, p->pUsing);
1259 }
1260}
drhb3ad4e62021-03-31 13:31:33 +00001261
1262/*
1263** Arrange to cause pExpr to be deleted when the pParse is deleted.
1264** This is similar to sqlite3ExprDelete() except that the delete is
1265** deferred untilthe pParse is deleted.
1266**
1267** The pExpr might be deleted immediately on an OOM error.
1268**
1269** The deferred delete is (currently) implemented by adding the
1270** pExpr to the pParse->pConstExpr list with a register number of 0.
1271*/
1272void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1273 pParse->pConstExpr =
1274 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1275}
1276
drh8e34e402019-06-11 10:43:56 +00001277/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1278** expression.
1279*/
1280void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1281 if( p ){
1282 if( IN_RENAME_OBJECT ){
1283 sqlite3RenameExprUnmap(pParse, p);
1284 }
1285 sqlite3ExprDeleteNN(pParse->db, p);
1286 }
1287}
1288
drhd2687b72005-08-12 22:56:09 +00001289/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001290** Return the number of bytes allocated for the expression structure
1291** passed as the first argument. This is always one of EXPR_FULLSIZE,
1292** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1293*/
drhb6dad522021-09-24 16:14:47 +00001294static int exprStructSize(const Expr *p){
danielk19776ab3a2e2009-02-19 14:39:25 +00001295 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001296 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1297 return EXPR_FULLSIZE;
1298}
1299
1300/*
drh33e619f2009-05-28 01:00:55 +00001301** The dupedExpr*Size() routines each return the number of bytes required
1302** to store a copy of an expression or expression tree. They differ in
1303** how much of the tree is measured.
1304**
1305** dupedExprStructSize() Size of only the Expr structure
1306** dupedExprNodeSize() Size of Expr + space for token
1307** dupedExprSize() Expr + token + subtree components
1308**
1309***************************************************************************
1310**
1311** The dupedExprStructSize() function returns two values OR-ed together:
1312** (1) the space required for a copy of the Expr structure only and
1313** (2) the EP_xxx flags that indicate what the structure size should be.
1314** The return values is always one of:
1315**
1316** EXPR_FULLSIZE
1317** EXPR_REDUCEDSIZE | EP_Reduced
1318** EXPR_TOKENONLYSIZE | EP_TokenOnly
1319**
1320** The size of the structure can be found by masking the return value
1321** of this routine with 0xfff. The flags can be found by masking the
1322** return value with EP_Reduced|EP_TokenOnly.
1323**
1324** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1325** (unreduced) Expr objects as they or originally constructed by the parser.
1326** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001327** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001328** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001329** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001330** to reduce a pristine expression tree from the parser. The implementation
1331** of dupedExprStructSize() contain multiple assert() statements that attempt
1332** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001333*/
drhb6dad522021-09-24 16:14:47 +00001334static int dupedExprStructSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001335 int nSize;
drh33e619f2009-05-28 01:00:55 +00001336 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001337 assert( EXPR_FULLSIZE<=0xfff );
1338 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001339 if( 0==flags || p->op==TK_SELECT_COLUMN
1340#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001341 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001342#endif
1343 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001344 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001345 }else{
drhc5cd1242013-09-12 16:50:49 +00001346 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh67a99db2022-05-13 14:52:04 +00001347 assert( !ExprHasProperty(p, EP_OuterON) );
drhe7375bf2020-03-10 19:24:38 +00001348 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001349 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001350 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1351 }else{
drhaecd8022013-09-13 18:15:15 +00001352 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001353 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1354 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001355 }
1356 return nSize;
1357}
1358
1359/*
drh33e619f2009-05-28 01:00:55 +00001360** This function returns the space in bytes required to store the copy
1361** of the Expr structure and a copy of the Expr.u.zToken string (if that
1362** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001363*/
drhb6dad522021-09-24 16:14:47 +00001364static int dupedExprNodeSize(const Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001365 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1366 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001367 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001368 }
danielk1977bc739712009-03-23 04:33:32 +00001369 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001370}
1371
1372/*
1373** Return the number of bytes required to create a duplicate of the
1374** expression passed as the first argument. The second argument is a
1375** mask containing EXPRDUP_XXX flags.
1376**
1377** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001378** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001379**
1380** If the EXPRDUP_REDUCE flag is set, then the return value includes
1381** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1382** and Expr.pRight variables (but not for any structures pointed to or
1383** descended from the Expr.x.pList or Expr.x.pSelect variables).
1384*/
drhb6dad522021-09-24 16:14:47 +00001385static int dupedExprSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001386 int nByte = 0;
1387 if( p ){
1388 nByte = dupedExprNodeSize(p, flags);
1389 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001390 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001391 }
1392 }
1393 return nByte;
1394}
1395
1396/*
1397** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1398** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001399** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001400** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001401** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001402** portion of the buffer copied into by this function.
1403*/
drhb6dad522021-09-24 16:14:47 +00001404static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
drh3c194692016-04-11 16:43:43 +00001405 Expr *pNew; /* Value to return */
1406 u8 *zAlloc; /* Memory space from which to build Expr object */
1407 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1408
drh575fad62016-02-05 13:38:36 +00001409 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001410 assert( p );
1411 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1412 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001413
drh3c194692016-04-11 16:43:43 +00001414 /* Figure out where to write the new Expr structure. */
1415 if( pzBuffer ){
1416 zAlloc = *pzBuffer;
1417 staticFlag = EP_Static;
drh3c6edc82021-04-26 15:28:06 +00001418 assert( zAlloc!=0 );
drh3c194692016-04-11 16:43:43 +00001419 }else{
1420 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1421 staticFlag = 0;
1422 }
1423 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001424
drh3c194692016-04-11 16:43:43 +00001425 if( pNew ){
1426 /* Set nNewSize to the size allocated for the structure pointed to
1427 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1428 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1429 ** by the copy of the p->u.zToken string (if any).
1430 */
1431 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1432 const int nNewSize = nStructSize & 0xfff;
1433 int nToken;
1434 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1435 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001436 }else{
drh3c194692016-04-11 16:43:43 +00001437 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001438 }
drh3c194692016-04-11 16:43:43 +00001439 if( dupFlags ){
1440 assert( ExprHasProperty(p, EP_Reduced)==0 );
1441 memcpy(zAlloc, p, nNewSize);
1442 }else{
1443 u32 nSize = (u32)exprStructSize(p);
1444 memcpy(zAlloc, p, nSize);
1445 if( nSize<EXPR_FULLSIZE ){
1446 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1447 }
1448 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001449
drh3c194692016-04-11 16:43:43 +00001450 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
drh825fa172022-07-22 19:28:04 +00001451 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
drh3c194692016-04-11 16:43:43 +00001452 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1453 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001454 ExprClearVVAProperties(pNew);
1455 if( dupFlags ){
1456 ExprSetVVAProperty(pNew, EP_Immutable);
1457 }
drh3c194692016-04-11 16:43:43 +00001458
1459 /* Copy the p->u.zToken string, if any. */
1460 if( nToken ){
1461 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1462 memcpy(zToken, p->u.zToken, nToken);
1463 }
1464
drh209bc522016-09-23 21:36:24 +00001465 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001466 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
drha4eeccd2021-10-07 17:43:30 +00001467 if( ExprUseXSelect(p) ){
drh3c194692016-04-11 16:43:43 +00001468 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001469 }else{
drh3c194692016-04-11 16:43:43 +00001470 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001471 }
drh3c194692016-04-11 16:43:43 +00001472 }
1473
1474 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001475 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001476 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001477 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001478 pNew->pLeft = p->pLeft ?
1479 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1480 pNew->pRight = p->pRight ?
1481 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001482 }
dan67a9b8e2018-06-22 20:51:35 +00001483#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001484 if( ExprHasProperty(p, EP_WinFunc) ){
1485 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1486 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001487 }
dan67a9b8e2018-06-22 20:51:35 +00001488#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001489 if( pzBuffer ){
1490 *pzBuffer = zAlloc;
1491 }
1492 }else{
drh209bc522016-09-23 21:36:24 +00001493 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001494 if( pNew->op==TK_SELECT_COLUMN ){
1495 pNew->pLeft = p->pLeft;
drh5cc9daf2021-04-12 23:18:18 +00001496 assert( p->pRight==0 || p->pRight==p->pLeft
1497 || ExprHasProperty(p->pLeft, EP_Subquery) );
drh98542602016-08-20 17:00:16 +00001498 }else{
1499 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1500 }
drh3c194692016-04-11 16:43:43 +00001501 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001502 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001503 }
1504 }
1505 return pNew;
1506}
1507
1508/*
danbfe31e72014-01-15 14:17:31 +00001509** Create and return a deep copy of the object passed as the second
1510** argument. If an OOM condition is encountered, NULL is returned
1511** and the db->mallocFailed flag set.
1512*/
daneede6a52014-01-15 19:42:23 +00001513#ifndef SQLITE_OMIT_CTE
dan26d61e52021-06-11 11:14:24 +00001514With *sqlite3WithDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001515 With *pRet = 0;
1516 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001517 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001518 pRet = sqlite3DbMallocZero(db, nByte);
1519 if( pRet ){
1520 int i;
1521 pRet->nCte = p->nCte;
1522 for(i=0; i<p->nCte; i++){
1523 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1524 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1525 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
drh67f70be2022-04-22 16:15:48 +00001526 pRet->a[i].eM10d = p->a[i].eM10d;
dan4e9119d2014-01-13 15:12:23 +00001527 }
1528 }
1529 }
1530 return pRet;
1531}
daneede6a52014-01-15 19:42:23 +00001532#else
dan26d61e52021-06-11 11:14:24 +00001533# define sqlite3WithDup(x,y) 0
daneede6a52014-01-15 19:42:23 +00001534#endif
dan4e9119d2014-01-13 15:12:23 +00001535
drha8389972018-12-06 22:04:19 +00001536#ifndef SQLITE_OMIT_WINDOWFUNC
1537/*
1538** The gatherSelectWindows() procedure and its helper routine
1539** gatherSelectWindowsCallback() are used to scan all the expressions
1540** an a newly duplicated SELECT statement and gather all of the Window
1541** objects found there, assembling them onto the linked list at Select->pWin.
1542*/
1543static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001544 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001545 Select *pSelect = pWalker->u.pSelect;
1546 Window *pWin = pExpr->y.pWin;
1547 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001548 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001549 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001550 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001551 }
1552 return WRC_Continue;
1553}
drha37b6a52018-12-06 22:12:18 +00001554static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1555 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1556}
drha8389972018-12-06 22:04:19 +00001557static void gatherSelectWindows(Select *p){
1558 Walker w;
1559 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001560 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1561 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001562 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001563 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001564 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001565}
1566#endif
1567
1568
drha76b5df2002-02-23 02:32:10 +00001569/*
drhff78bd22002-02-27 01:47:11 +00001570** The following group of routines make deep copies of expressions,
1571** expression lists, ID lists, and select statements. The copies can
1572** be deleted (by being passed to their respective ...Delete() routines)
1573** without effecting the originals.
1574**
danielk19774adee202004-05-08 08:23:19 +00001575** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1576** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001577** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001578**
drhad3cab52002-05-24 02:04:32 +00001579** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001580**
drhb7916a72009-05-27 10:31:29 +00001581** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001582** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1583** truncated version of the usual Expr structure that will be stored as
1584** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001585*/
drhb6dad522021-09-24 16:14:47 +00001586Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001587 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001588 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001589}
drhb6dad522021-09-24 16:14:47 +00001590ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001591 ExprList *pNew;
drhb6dad522021-09-24 16:14:47 +00001592 struct ExprList_item *pItem;
1593 const struct ExprList_item *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001594 int i;
drhe46292a2021-07-05 02:40:29 +00001595 Expr *pPriorSelectColOld = 0;
1596 Expr *pPriorSelectColNew = 0;
drh575fad62016-02-05 13:38:36 +00001597 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001598 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001599 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001600 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001601 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001602 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001603 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001604 pOldItem = p->a;
1605 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001606 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001607 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001608 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001609 if( pOldExpr
1610 && pOldExpr->op==TK_SELECT_COLUMN
1611 && (pNewExpr = pItem->pExpr)!=0
1612 ){
drhe46292a2021-07-05 02:40:29 +00001613 if( pNewExpr->pRight ){
1614 pPriorSelectColOld = pOldExpr->pRight;
1615 pPriorSelectColNew = pNewExpr->pRight;
1616 pNewExpr->pLeft = pNewExpr->pRight;
drhb1637482017-01-03 00:27:16 +00001617 }else{
drhe46292a2021-07-05 02:40:29 +00001618 if( pOldExpr->pLeft!=pPriorSelectColOld ){
1619 pPriorSelectColOld = pOldExpr->pLeft;
1620 pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1621 pNewExpr->pRight = pPriorSelectColNew;
1622 }
1623 pNewExpr->pLeft = pPriorSelectColNew;
drh47073f62017-01-02 22:36:32 +00001624 }
1625 }
drh41cee662019-12-12 20:22:34 +00001626 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
drhd88fd532022-05-02 20:49:30 +00001627 pItem->fg = pOldItem->fg;
1628 pItem->fg.done = 0;
drhc2acc4e2013-11-15 18:15:19 +00001629 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001630 }
1631 return pNew;
1632}
danielk197793758c82005-01-21 08:13:14 +00001633
1634/*
1635** If cursors, triggers, views and subqueries are all omitted from
1636** the build, then none of the following routines, except for
1637** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1638** called with a NULL argument.
1639*/
danielk19776a67fe82005-02-04 04:07:16 +00001640#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1641 || !defined(SQLITE_OMIT_SUBQUERY)
drhb6dad522021-09-24 16:14:47 +00001642SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001643 SrcList *pNew;
1644 int i;
drh113088e2003-03-20 01:16:58 +00001645 int nByte;
drh575fad62016-02-05 13:38:36 +00001646 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001647 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001648 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001649 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001650 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001651 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001652 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001653 SrcItem *pNewItem = &pNew->a[i];
drhb6dad522021-09-24 16:14:47 +00001654 const SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001655 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001656 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001657 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1658 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1659 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001660 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001661 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001662 pNewItem->addrFillSub = pOldItem->addrFillSub;
1663 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001664 if( pNewItem->fg.isIndexedBy ){
1665 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1666 }
drha79e2a22021-02-21 23:44:14 +00001667 pNewItem->u2 = pOldItem->u2;
1668 if( pNewItem->fg.isCte ){
1669 pNewItem->u2.pCteUse->nUse++;
1670 }
drh8a48b9c2015-08-19 15:20:00 +00001671 if( pNewItem->fg.isTabFunc ){
1672 pNewItem->u1.pFuncArg =
1673 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1674 }
drhed8a3bb2005-06-06 21:19:56 +00001675 pTab = pNewItem->pTab = pOldItem->pTab;
1676 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001677 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001678 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001679 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
drhd44f8b22022-04-07 01:11:13 +00001680 if( pOldItem->fg.isUsing ){
1681 assert( pNewItem->fg.isUsing );
1682 pNewItem->u3.pUsing = sqlite3IdListDup(db, pOldItem->u3.pUsing);
1683 }else{
1684 pNewItem->u3.pOn = sqlite3ExprDup(db, pOldItem->u3.pOn, flags);
1685 }
danielk19776c18b6e2005-01-30 09:17:58 +00001686 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001687 }
1688 return pNew;
1689}
drhb6dad522021-09-24 16:14:47 +00001690IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
drhff78bd22002-02-27 01:47:11 +00001691 IdList *pNew;
1692 int i;
drh575fad62016-02-05 13:38:36 +00001693 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001694 if( p==0 ) return 0;
drha99e3252022-04-15 15:47:14 +00001695 assert( p->eU4!=EU4_EXPR );
1696 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew)+(p->nId-1)*sizeof(p->a[0]) );
drhff78bd22002-02-27 01:47:11 +00001697 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001698 pNew->nId = p->nId;
drha99e3252022-04-15 15:47:14 +00001699 pNew->eU4 = p->eU4;
drhff78bd22002-02-27 01:47:11 +00001700 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001701 struct IdList_item *pNewItem = &pNew->a[i];
drha99e3252022-04-15 15:47:14 +00001702 const struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001703 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drha99e3252022-04-15 15:47:14 +00001704 pNewItem->u4 = pOldItem->u4;
drhff78bd22002-02-27 01:47:11 +00001705 }
1706 return pNew;
1707}
drhb6dad522021-09-24 16:14:47 +00001708Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
dana7466202017-02-03 14:44:52 +00001709 Select *pRet = 0;
1710 Select *pNext = 0;
1711 Select **pp = &pRet;
drhb6dad522021-09-24 16:14:47 +00001712 const Select *p;
dana7466202017-02-03 14:44:52 +00001713
drh575fad62016-02-05 13:38:36 +00001714 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001715 for(p=pDup; p; p=p->pPrior){
1716 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1717 if( pNew==0 ) break;
1718 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1719 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1720 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1721 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1722 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1723 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1724 pNew->op = p->op;
1725 pNew->pNext = pNext;
1726 pNew->pPrior = 0;
1727 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001728 pNew->iLimit = 0;
1729 pNew->iOffset = 0;
1730 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1731 pNew->addrOpenEphm[0] = -1;
1732 pNew->addrOpenEphm[1] = -1;
1733 pNew->nSelectRow = p->nSelectRow;
dan26d61e52021-06-11 11:14:24 +00001734 pNew->pWith = sqlite3WithDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001735#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001736 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001737 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001738 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001739#endif
drhfef37762018-07-10 19:48:35 +00001740 pNew->selId = p->selId;
drh9da977f2021-04-20 12:14:12 +00001741 if( db->mallocFailed ){
1742 /* Any prior OOM might have left the Select object incomplete.
1743 ** Delete the whole thing rather than allow an incomplete Select
1744 ** to be used by the code generator. */
1745 pNew->pNext = 0;
1746 sqlite3SelectDelete(db, pNew);
1747 break;
1748 }
dana7466202017-02-03 14:44:52 +00001749 *pp = pNew;
1750 pp = &pNew->pPrior;
1751 pNext = pNew;
1752 }
1753
1754 return pRet;
drhff78bd22002-02-27 01:47:11 +00001755}
danielk197793758c82005-01-21 08:13:14 +00001756#else
drhf76d2872021-10-27 17:15:08 +00001757Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001758 assert( p==0 );
1759 return 0;
1760}
1761#endif
drhff78bd22002-02-27 01:47:11 +00001762
1763
1764/*
drha76b5df2002-02-23 02:32:10 +00001765** Add a new element to the end of an expression list. If pList is
1766** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001767**
drha19543f2017-09-15 15:17:48 +00001768** The pList argument must be either NULL or a pointer to an ExprList
1769** obtained from a prior call to sqlite3ExprListAppend(). This routine
1770** may not be used with an ExprList obtained from sqlite3ExprListDup().
1771** Reason: This routine assumes that the number of slots in pList->a[]
1772** is a power of two. That is true for sqlite3ExprListAppend() returns
1773** but is not necessarily true from the return value of sqlite3ExprListDup().
1774**
drhb7916a72009-05-27 10:31:29 +00001775** If a memory allocation error occurs, the entire list is freed and
1776** NULL is returned. If non-NULL is returned, then it is guaranteed
1777** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001778*/
larrybrdabada62021-04-04 12:52:58 +00001779static const struct ExprList_item zeroItem = {0};
drh50e43c52021-03-23 14:27:35 +00001780SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1781 sqlite3 *db, /* Database handle. Used for memory allocation */
1782 Expr *pExpr /* Expression to be appended. Might be NULL */
1783){
1784 struct ExprList_item *pItem;
1785 ExprList *pList;
1786
1787 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1788 if( pList==0 ){
1789 sqlite3ExprDelete(db, pExpr);
1790 return 0;
1791 }
1792 pList->nAlloc = 4;
1793 pList->nExpr = 1;
1794 pItem = &pList->a[0];
1795 *pItem = zeroItem;
1796 pItem->pExpr = pExpr;
1797 return pList;
1798}
1799SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1800 sqlite3 *db, /* Database handle. Used for memory allocation */
1801 ExprList *pList, /* List to which to append. Might be NULL */
1802 Expr *pExpr /* Expression to be appended. Might be NULL */
1803){
1804 struct ExprList_item *pItem;
1805 ExprList *pNew;
1806 pList->nAlloc *= 2;
1807 pNew = sqlite3DbRealloc(db, pList,
1808 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1809 if( pNew==0 ){
1810 sqlite3ExprListDelete(db, pList);
1811 sqlite3ExprDelete(db, pExpr);
1812 return 0;
1813 }else{
1814 pList = pNew;
1815 }
1816 pItem = &pList->a[pList->nExpr++];
1817 *pItem = zeroItem;
1818 pItem->pExpr = pExpr;
1819 return pList;
1820}
drh17435752007-08-16 04:30:38 +00001821ExprList *sqlite3ExprListAppend(
1822 Parse *pParse, /* Parsing context */
1823 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001824 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001825){
drh43606172017-04-05 11:32:13 +00001826 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001827 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001828 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1829 }
1830 if( pList->nAlloc<pList->nExpr+1 ){
1831 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001832 }
drh43606172017-04-05 11:32:13 +00001833 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001834 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001835 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001836 return pList;
1837}
1838
1839/*
drh8762ec12016-08-20 01:06:22 +00001840** pColumns and pExpr form a vector assignment which is part of the SET
1841** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001842**
1843** (a,b,c) = (expr1,expr2,expr3)
1844** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1845**
1846** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001847** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001848** TK_SELECT_COLUMN expressions.
1849*/
1850ExprList *sqlite3ExprListAppendVector(
1851 Parse *pParse, /* Parsing context */
1852 ExprList *pList, /* List to which to append. Might be NULL */
1853 IdList *pColumns, /* List of names of LHS of the assignment */
1854 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1855){
1856 sqlite3 *db = pParse->db;
1857 int n;
1858 int i;
drh66860af2016-08-23 18:30:10 +00001859 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001860 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1861 ** exit prior to this routine being invoked */
1862 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001863 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001864
1865 /* If the RHS is a vector, then we can immediately check to see that
1866 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1867 ** wildcards ("*") in the result set of the SELECT must be expanded before
1868 ** we can do the size check, so defer the size check until code generation.
1869 */
1870 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001871 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1872 pColumns->nId, n);
1873 goto vector_append_error;
1874 }
drh966e2912017-01-03 02:58:01 +00001875
1876 for(i=0; i<pColumns->nId; i++){
drh10f08272021-07-05 01:11:26 +00001877 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
drh554a9dc2019-08-26 14:18:28 +00001878 assert( pSubExpr!=0 || db->mallocFailed );
drh554a9dc2019-08-26 14:18:28 +00001879 if( pSubExpr==0 ) continue;
drha1251bc2016-08-20 00:51:37 +00001880 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1881 if( pList ){
drh66860af2016-08-23 18:30:10 +00001882 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001883 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001884 pColumns->a[i].zName = 0;
1885 }
1886 }
drh966e2912017-01-03 02:58:01 +00001887
drhffe28052017-05-06 18:09:36 +00001888 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001889 Expr *pFirst = pList->a[iFirst].pExpr;
1890 assert( pFirst!=0 );
1891 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001892
drhf4dd26c2017-04-05 11:49:06 +00001893 /* Store the SELECT statement in pRight so it will be deleted when
1894 ** sqlite3ExprListDelete() is called */
1895 pFirst->pRight = pExpr;
1896 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001897
drhf4dd26c2017-04-05 11:49:06 +00001898 /* Remember the size of the LHS in iTable so that we can check that
1899 ** the RHS and LHS sizes match during code generation. */
1900 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001901 }
1902
1903vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001904 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001905 sqlite3IdListDelete(db, pColumns);
1906 return pList;
1907}
1908
1909/*
drhbc622bc2015-08-24 15:39:42 +00001910** Set the sort order for the last element on the given ExprList.
1911*/
dan6e118922019-08-12 16:36:38 +00001912void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001913 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001914 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001915 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001916
1917 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1918 assert( iSortOrder==SQLITE_SO_UNDEFINED
1919 || iSortOrder==SQLITE_SO_ASC
1920 || iSortOrder==SQLITE_SO_DESC
1921 );
1922 assert( eNulls==SQLITE_SO_UNDEFINED
1923 || eNulls==SQLITE_SO_ASC
1924 || eNulls==SQLITE_SO_DESC
1925 );
1926
dan9105fd52019-08-19 17:26:32 +00001927 pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00001928 assert( pItem->fg.bNulls==0 );
dan9105fd52019-08-19 17:26:32 +00001929 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1930 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001931 }
drhd88fd532022-05-02 20:49:30 +00001932 pItem->fg.sortFlags = (u8)iSortOrder;
dan9105fd52019-08-19 17:26:32 +00001933
1934 if( eNulls!=SQLITE_SO_UNDEFINED ){
drhd88fd532022-05-02 20:49:30 +00001935 pItem->fg.bNulls = 1;
dan9105fd52019-08-19 17:26:32 +00001936 if( iSortOrder!=eNulls ){
drhd88fd532022-05-02 20:49:30 +00001937 pItem->fg.sortFlags |= KEYINFO_ORDER_BIGNULL;
dan9105fd52019-08-19 17:26:32 +00001938 }
drhbc622bc2015-08-24 15:39:42 +00001939 }
drhbc622bc2015-08-24 15:39:42 +00001940}
1941
1942/*
drh41cee662019-12-12 20:22:34 +00001943** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001944** on the expression list.
1945**
1946** pList might be NULL following an OOM error. But pName should never be
1947** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1948** is set.
1949*/
1950void sqlite3ExprListSetName(
1951 Parse *pParse, /* Parsing context */
1952 ExprList *pList, /* List to which to add the span. */
drhb6dad522021-09-24 16:14:47 +00001953 const Token *pName, /* Name to be added */
drhb7916a72009-05-27 10:31:29 +00001954 int dequote /* True to cause the name to be dequoted */
1955){
1956 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001957 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001958 if( pList ){
1959 struct ExprList_item *pItem;
1960 assert( pList->nExpr>0 );
1961 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001962 assert( pItem->zEName==0 );
drhd88fd532022-05-02 20:49:30 +00001963 assert( pItem->fg.eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001964 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001965 if( dequote ){
1966 /* If dequote==0, then pName->z does not point to part of a DDL
1967 ** statement handled by the parser. And so no token need be added
1968 ** to the token-map. */
1969 sqlite3Dequote(pItem->zEName);
1970 if( IN_RENAME_OBJECT ){
drhb6dad522021-09-24 16:14:47 +00001971 sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
dan85f2c762020-04-06 16:37:05 +00001972 }
dan5be60c52018-08-15 20:28:39 +00001973 }
drhb7916a72009-05-27 10:31:29 +00001974 }
1975}
1976
1977/*
1978** Set the ExprList.a[].zSpan element of the most recently added item
1979** on the expression list.
1980**
1981** pList might be NULL following an OOM error. But pSpan should never be
1982** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1983** is set.
1984*/
1985void sqlite3ExprListSetSpan(
1986 Parse *pParse, /* Parsing context */
1987 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001988 const char *zStart, /* Start of the span */
1989 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001990){
1991 sqlite3 *db = pParse->db;
1992 assert( pList!=0 || db->mallocFailed!=0 );
1993 if( pList ){
1994 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1995 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001996 if( pItem->zEName==0 ){
1997 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
drhd88fd532022-05-02 20:49:30 +00001998 pItem->fg.eEName = ENAME_SPAN;
drhcbb9da32019-12-12 22:11:33 +00001999 }
drhb7916a72009-05-27 10:31:29 +00002000 }
2001}
2002
2003/*
danielk19777a15a4b2007-05-08 17:54:43 +00002004** If the expression list pEList contains more than iLimit elements,
2005** leave an error message in pParse.
2006*/
2007void sqlite3ExprListCheckLength(
2008 Parse *pParse,
2009 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00002010 const char *zObject
2011){
drhb1a6c3c2008-03-20 16:30:17 +00002012 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00002013 testcase( pEList && pEList->nExpr==mx );
2014 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00002015 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00002016 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
2017 }
2018}
2019
2020/*
drha76b5df2002-02-23 02:32:10 +00002021** Delete an entire expression list.
2022*/
drhaffa8552016-04-11 18:25:05 +00002023static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00002024 int i = pList->nExpr;
2025 struct ExprList_item *pItem = pList->a;
2026 assert( pList->nExpr>0 );
2027 do{
drh633e6d52008-07-28 19:34:53 +00002028 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00002029 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00002030 pItem++;
2031 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00002032 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00002033}
drhaffa8552016-04-11 18:25:05 +00002034void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2035 if( pList ) exprListDeleteNN(db, pList);
2036}
drha76b5df2002-02-23 02:32:10 +00002037
2038/*
drh2308ed32015-02-09 16:09:34 +00002039** Return the bitwise-OR of all Expr.flags fields in the given
2040** ExprList.
drh885a5b02015-02-09 15:21:36 +00002041*/
drh2308ed32015-02-09 16:09:34 +00002042u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00002043 int i;
drh2308ed32015-02-09 16:09:34 +00002044 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00002045 assert( pList!=0 );
2046 for(i=0; i<pList->nExpr; i++){
2047 Expr *pExpr = pList->a[i].pExpr;
2048 assert( pExpr!=0 );
2049 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00002050 }
drh2308ed32015-02-09 16:09:34 +00002051 return m;
drh885a5b02015-02-09 15:21:36 +00002052}
2053
2054/*
drh7e6f9802017-09-04 00:33:04 +00002055** This is a SELECT-node callback for the expression walker that
2056** always "fails". By "fail" in this case, we mean set
2057** pWalker->eCode to zero and abort.
2058**
2059** This callback is used by multiple expression walkers.
2060*/
2061int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
2062 UNUSED_PARAMETER(NotUsed);
2063 pWalker->eCode = 0;
2064 return WRC_Abort;
2065}
2066
2067/*
drh0cbec592020-01-03 02:20:37 +00002068** Check the input string to see if it is "true" or "false" (in any case).
2069**
2070** If the string is.... Return
2071** "true" EP_IsTrue
2072** "false" EP_IsFalse
2073** anything else 0
2074*/
2075u32 sqlite3IsTrueOrFalse(const char *zIn){
2076 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
2077 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
2078 return 0;
2079}
2080
2081
2082/*
drh171d16b2018-02-26 20:15:54 +00002083** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00002084** then convert it into an TK_TRUEFALSE term. Return non-zero if
2085** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00002086*/
2087int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00002088 u32 v;
drh171d16b2018-02-26 20:15:54 +00002089 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drhf9751072021-10-07 13:40:29 +00002090 if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
drh0cbec592020-01-03 02:20:37 +00002091 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00002092 ){
2093 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00002094 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00002095 return 1;
2096 }
2097 return 0;
2098}
2099
drh43c4ac82018-02-26 21:26:27 +00002100/*
drh96acafb2018-02-27 14:49:25 +00002101** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002102** and 0 if it is FALSE.
2103*/
drh96acafb2018-02-27 14:49:25 +00002104int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002105 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002106 assert( pExpr->op==TK_TRUEFALSE );
drhf9751072021-10-07 13:40:29 +00002107 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh43c4ac82018-02-26 21:26:27 +00002108 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2109 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2110 return pExpr->u.zToken[4]==0;
2111}
2112
drh17180fc2019-04-19 17:26:19 +00002113/*
2114** If pExpr is an AND or OR expression, try to simplify it by eliminating
2115** terms that are always true or false. Return the simplified expression.
2116** Or return the original expression if no simplification is possible.
2117**
2118** Examples:
2119**
2120** (x<10) AND true => (x<10)
2121** (x<10) AND false => false
2122** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2123** (x<10) AND (y=22 OR true) => (x<10)
2124** (y=22) OR true => true
2125*/
2126Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2127 assert( pExpr!=0 );
2128 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2129 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2130 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2131 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2132 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2133 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2134 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2135 }
2136 }
2137 return pExpr;
2138}
2139
drh171d16b2018-02-26 20:15:54 +00002140
2141/*
drh059b2d52014-10-24 19:28:09 +00002142** These routines are Walker callbacks used to check expressions to
2143** see if they are "constant" for some definition of constant. The
2144** Walker.eCode value determines the type of "constant" we are looking
2145** for.
drh73b211a2005-01-18 04:00:42 +00002146**
drh7d10d5a2008-08-20 16:35:10 +00002147** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002148**
drh059b2d52014-10-24 19:28:09 +00002149** sqlite3ExprIsConstant() pWalker->eCode==1
2150** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002151** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002152** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002153**
drh059b2d52014-10-24 19:28:09 +00002154** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2155** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002156**
drh014fff22020-01-08 22:22:36 +00002157** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2158** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002159** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002160** when processing a new CREATE TABLE statement. A bound parameter raises
2161** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002162** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002163** contain a bound parameter because they were generated by older versions
2164** of SQLite to be parsed by newer versions of SQLite without raising a
2165** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002166*/
drh7d10d5a2008-08-20 16:35:10 +00002167static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002168
drh059b2d52014-10-24 19:28:09 +00002169 /* If pWalker->eCode is 2 then any term of the expression that comes from
drhb77c07a2022-04-11 11:59:25 +00002170 ** the ON or USING clauses of an outer join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002171 ** from being considered constant. */
drh67a99db2022-05-13 14:52:04 +00002172 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_OuterON) ){
drh059b2d52014-10-24 19:28:09 +00002173 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002174 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002175 }
2176
drh626a8792005-01-17 22:08:19 +00002177 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002178 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002179 ** and either pWalker->eCode==4 or 5 or the function has the
2180 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002181 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002182 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2183 && !ExprHasProperty(pExpr, EP_WinFunc)
2184 ){
drh014fff22020-01-08 22:22:36 +00002185 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002186 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002187 }else{
2188 pWalker->eCode = 0;
2189 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002190 }
drh626a8792005-01-17 22:08:19 +00002191 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002192 /* Convert "true" or "false" in a DEFAULT clause into the
2193 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002194 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002195 return WRC_Prune;
2196 }
drh08b92082020-08-10 14:18:00 +00002197 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002198 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002199 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002200 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002201 testcase( pExpr->op==TK_ID );
2202 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002203 testcase( pExpr->op==TK_AGG_FUNCTION );
2204 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002205 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002206 return WRC_Continue;
2207 }
drh059b2d52014-10-24 19:28:09 +00002208 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2209 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002210 }
drh08b92082020-08-10 14:18:00 +00002211 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002212 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002213 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002214 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002215 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002216 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002217 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002218 pWalker->eCode = 0;
2219 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002220 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002221 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002222 /* Silently convert bound parameters that appear inside of CREATE
2223 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002224 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002225 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002226 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002227 /* A bound parameter in a CREATE statement that originates from
2228 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002229 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002230 return WRC_Abort;
2231 }
drh08b92082020-08-10 14:18:00 +00002232 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002233 default:
drh6e341b92018-04-17 18:50:40 +00002234 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2235 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002236 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002237 }
2238}
drh059b2d52014-10-24 19:28:09 +00002239static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002240 Walker w;
drh059b2d52014-10-24 19:28:09 +00002241 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002242 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002243 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002244#ifdef SQLITE_DEBUG
2245 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2246#endif
drh059b2d52014-10-24 19:28:09 +00002247 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002248 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002249 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002250}
drh626a8792005-01-17 22:08:19 +00002251
2252/*
drh059b2d52014-10-24 19:28:09 +00002253** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002254** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002255**
2256** For the purposes of this function, a double-quoted string (ex: "abc")
2257** is considered a variable but a single-quoted string (ex: 'abc') is
2258** a constant.
drhfef52082000-06-06 01:50:43 +00002259*/
danielk19774adee202004-05-08 08:23:19 +00002260int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002261 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002262}
2263
2264/*
drh07aded62018-07-28 16:24:08 +00002265** Walk an expression tree. Return non-zero if
2266**
2267** (1) the expression is constant, and
2268** (2) the expression does originate in the ON or USING clause
2269** of a LEFT JOIN, and
2270** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2271** operands created by the constant propagation optimization.
2272**
2273** When this routine returns true, it indicates that the expression
2274** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002275** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002276*/
2277int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002278 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002279}
2280
2281/*
drhfcb9f4f2015-06-01 18:13:16 +00002282** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002283** for any single row of the table with cursor iCur. In other words, the
2284** expression must not refer to any non-deterministic function nor any
2285** table other than iCur.
2286*/
2287int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2288 return exprIsConst(p, 3, iCur);
2289}
2290
drha9cdb902022-04-25 19:40:33 +00002291/*
2292** Check pExpr to see if it is an invariant constraint on data source pSrc.
2293** This is an optimization. False negatives will perhaps cause slower
2294** queries, but false positives will yield incorrect answers. So when in
drh22b541b2022-04-27 18:38:46 +00002295** doubt, return 0.
drha9cdb902022-04-25 19:40:33 +00002296**
2297** To be an invariant constraint, the following must be true:
2298**
2299** (1) pExpr cannot refer to any table other than pSrc->iCursor.
2300**
2301** (2) pExpr cannot use subqueries or non-deterministic functions.
2302**
2303** (3) pSrc cannot be part of the left operand for a RIGHT JOIN.
2304** (Is there some way to relax this constraint?)
2305**
2306** (4) If pSrc is the right operand of a LEFT JOIN, then...
2307** (4a) pExpr must come from an ON clause..
2308 (4b) and specifically the ON clause associated with the LEFT JOIN.
2309**
2310** (5) If pSrc is not the right operand of a LEFT JOIN or the left
2311** operand of a RIGHT JOIN, then pExpr must be from the WHERE
2312** clause, not an ON clause.
2313*/
2314int sqlite3ExprIsTableConstraint(Expr *pExpr, const SrcItem *pSrc){
2315 if( pSrc->fg.jointype & JT_LTORJ ){
2316 return 0; /* rule (3) */
2317 }
2318 if( pSrc->fg.jointype & JT_LEFT ){
drh67a99db2022-05-13 14:52:04 +00002319 if( !ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (4a) */
drha9cdb902022-04-25 19:40:33 +00002320 if( pExpr->w.iJoin!=pSrc->iCursor ) return 0; /* rule (4b) */
2321 }else{
drh67a99db2022-05-13 14:52:04 +00002322 if( ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (5) */
drha9cdb902022-04-25 19:40:33 +00002323 }
2324 return sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor); /* rules (1), (2) */
2325}
2326
danab31a842017-04-29 20:53:09 +00002327
2328/*
2329** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2330*/
2331static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2332 ExprList *pGroupBy = pWalker->u.pGroupBy;
2333 int i;
2334
2335 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2336 ** it constant. */
2337 for(i=0; i<pGroupBy->nExpr; i++){
2338 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002339 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002340 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002341 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002342 return WRC_Prune;
2343 }
2344 }
2345 }
2346
2347 /* Check if pExpr is a sub-select. If so, consider it variable. */
drha4eeccd2021-10-07 17:43:30 +00002348 if( ExprUseXSelect(pExpr) ){
danab31a842017-04-29 20:53:09 +00002349 pWalker->eCode = 0;
2350 return WRC_Abort;
2351 }
2352
2353 return exprNodeIsConstant(pWalker, pExpr);
2354}
2355
2356/*
2357** Walk the expression tree passed as the first argument. Return non-zero
2358** if the expression consists entirely of constants or copies of terms
2359** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002360**
2361** This routine is used to determine if a term of the HAVING clause can
2362** be promoted into the WHERE clause. In order for such a promotion to work,
2363** the value of the HAVING clause term must be the same for all members of
2364** a "group". The requirement that the GROUP BY term must be BINARY
2365** assumes that no other collating sequence will have a finer-grained
2366** grouping than binary. In other words (A=B COLLATE binary) implies
2367** A=B in every other collating sequence. The requirement that the
2368** GROUP BY be BINARY is stricter than necessary. It would also work
2369** to promote HAVING clauses that use the same alternative collating
2370** sequence as the GROUP BY term, but that is much harder to check,
2371** alternative collating sequences are uncommon, and this is only an
2372** optimization, so we take the easy way out and simply require the
2373** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002374*/
2375int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2376 Walker w;
danab31a842017-04-29 20:53:09 +00002377 w.eCode = 1;
2378 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002379 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002380 w.u.pGroupBy = pGroupBy;
2381 w.pParse = pParse;
2382 sqlite3WalkExpr(&w, p);
2383 return w.eCode;
2384}
2385
drh059b2d52014-10-24 19:28:09 +00002386/*
drh014fff22020-01-08 22:22:36 +00002387** Walk an expression tree for the DEFAULT field of a column definition
2388** in a CREATE TABLE statement. Return non-zero if the expression is
2389** acceptable for use as a DEFAULT. That is to say, return non-zero if
2390** the expression is constant or a function call with constant arguments.
2391** Return and 0 if there are any variables.
2392**
drh1e32bed2020-06-19 13:33:53 +00002393** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002394** processing a new CREATE TABLE statement. When isInit is true, parameters
2395** (such as ? or $abc) in the expression are converted into NULL. When
2396** isInit is false, parameters raise an error. Parameters should not be
2397** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002398** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002399** backwards compatibility.
2400**
2401** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002402**
2403** For the purposes of this function, a double-quoted string (ex: "abc")
2404** is considered a variable but a single-quoted string (ex: 'abc') is
2405** a constant.
2406*/
drhfeada2d2014-09-24 13:20:22 +00002407int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2408 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002409 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002410}
2411
drh5b88bc42013-12-07 23:35:21 +00002412#ifdef SQLITE_ENABLE_CURSOR_HINTS
2413/*
2414** Walk an expression tree. Return 1 if the expression contains a
2415** subquery of some kind. Return 0 if there are no subqueries.
2416*/
2417int sqlite3ExprContainsSubquery(Expr *p){
2418 Walker w;
drhbec24762015-08-13 20:07:13 +00002419 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002420 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002421 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002422#ifdef SQLITE_DEBUG
2423 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2424#endif
drh5b88bc42013-12-07 23:35:21 +00002425 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002426 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002427}
2428#endif
2429
drheb55bd22005-06-30 17:04:21 +00002430/*
drh73b211a2005-01-18 04:00:42 +00002431** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002432** to fit in a 32-bit integer, return 1 and put the value of the integer
2433** in *pValue. If the expression is not an integer or if it is too big
2434** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002435*/
drhb6dad522021-09-24 16:14:47 +00002436int sqlite3ExprIsInteger(const Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002437 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002438 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002439
2440 /* If an expression is an integer literal that fits in a signed 32-bit
2441 ** integer, then the EP_IntValue flag will have already been set */
2442 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2443 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2444
drh92b01d52008-06-24 00:32:35 +00002445 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002446 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002447 return 1;
2448 }
drhe4de1fe2002-06-02 16:09:01 +00002449 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002450 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002451 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002452 break;
drh4b59ab52002-08-24 18:24:51 +00002453 }
drhe4de1fe2002-06-02 16:09:01 +00002454 case TK_UMINUS: {
drhc59ffa82021-10-04 15:08:49 +00002455 int v = 0;
danielk19774adee202004-05-08 08:23:19 +00002456 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
drhc59ffa82021-10-04 15:08:49 +00002457 assert( ((unsigned int)v)!=0x80000000 );
drhe4de1fe2002-06-02 16:09:01 +00002458 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002459 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002460 }
2461 break;
2462 }
2463 default: break;
2464 }
drh92b01d52008-06-24 00:32:35 +00002465 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002466}
2467
2468/*
drh039fc322009-11-17 18:31:47 +00002469** Return FALSE if there is no chance that the expression can be NULL.
2470**
2471** If the expression might be NULL or if the expression is too complex
2472** to tell return TRUE.
2473**
2474** This routine is used as an optimization, to skip OP_IsNull opcodes
2475** when we know that a value cannot be NULL. Hence, a false positive
2476** (returning TRUE when in fact the expression can never be NULL) might
2477** be a small performance hit but is otherwise harmless. On the other
2478** hand, a false negative (returning FALSE when the result could be NULL)
2479** will likely result in an incorrect answer. So when in doubt, return
2480** TRUE.
2481*/
2482int sqlite3ExprCanBeNull(const Expr *p){
2483 u8 op;
drh3c6edc82021-04-26 15:28:06 +00002484 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002485 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2486 p = p->pLeft;
drh3c6edc82021-04-26 15:28:06 +00002487 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002488 }
drh039fc322009-11-17 18:31:47 +00002489 op = p->op;
2490 if( op==TK_REGISTER ) op = p->op2;
2491 switch( op ){
2492 case TK_INTEGER:
2493 case TK_STRING:
2494 case TK_FLOAT:
2495 case TK_BLOB:
2496 return 0;
drh7248a8b2014-08-04 18:50:54 +00002497 case TK_COLUMN:
drh477572b2021-10-07 20:46:29 +00002498 assert( ExprUseYTab(p) );
drh72673a22014-12-04 16:27:17 +00002499 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002500 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002501 (p->iColumn>=0
drh6df8c0c2021-11-28 19:54:38 +00002502 && p->y.pTab->aCol!=0 /* Possible due to prior error */
drh4eac5f02019-12-24 15:01:17 +00002503 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002504 default:
2505 return 1;
2506 }
2507}
2508
2509/*
2510** Return TRUE if the given expression is a constant which would be
2511** unchanged by OP_Affinity with the affinity given in the second
2512** argument.
2513**
2514** This routine is used to determine if the OP_Affinity operation
2515** can be omitted. When in doubt return FALSE. A false negative
2516** is harmless. A false positive, however, can result in the wrong
2517** answer.
2518*/
2519int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2520 u8 op;
drhaf866402019-08-22 11:11:28 +00002521 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002522 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002523 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2524 if( p->op==TK_UMINUS ) unaryMinus = 1;
2525 p = p->pLeft;
2526 }
drh039fc322009-11-17 18:31:47 +00002527 op = p->op;
2528 if( op==TK_REGISTER ) op = p->op2;
2529 switch( op ){
2530 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002531 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002532 }
2533 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002534 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002535 }
2536 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002537 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002538 }
2539 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002540 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002541 }
drh2f2855b2009-11-18 01:25:26 +00002542 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002543 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002544 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002545 }
drh039fc322009-11-17 18:31:47 +00002546 default: {
2547 return 0;
2548 }
2549 }
2550}
2551
2552/*
drhc4a3c772001-04-04 11:48:57 +00002553** Return TRUE if the given string is a row-id column name.
2554*/
danielk19774adee202004-05-08 08:23:19 +00002555int sqlite3IsRowid(const char *z){
2556 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2557 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2558 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002559 return 0;
2560}
2561
danielk19779a96b662007-11-29 17:05:18 +00002562/*
drh69c355b2016-03-09 15:34:51 +00002563** pX is the RHS of an IN operator. If pX is a SELECT statement
2564** that can be simplified to a direct table access, then return
2565** a pointer to the SELECT statement. If pX is not a SELECT statement,
2566** or if the SELECT statement needs to be manifested into a transient
2567** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002568*/
2569#ifndef SQLITE_OMIT_SUBQUERY
drhb6dad522021-09-24 16:14:47 +00002570static Select *isCandidateForInOpt(const Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002571 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002572 SrcList *pSrc;
2573 ExprList *pEList;
2574 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002575 int i;
drha4eeccd2021-10-07 17:43:30 +00002576 if( !ExprUseXSelect(pX) ) return 0; /* Not a subquery */
drh69c355b2016-03-09 15:34:51 +00002577 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2578 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002579 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002580 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002581 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2582 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2583 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002584 }
drh2e26a602020-01-06 18:59:46 +00002585 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002586 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002587 if( p->pWhere ) return 0; /* Has no WHERE clause */
2588 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002589 assert( pSrc!=0 );
2590 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002591 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002592 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002593 assert( pTab!=0 );
drhf38524d2021-08-02 16:41:57 +00002594 assert( !IsView(pTab) ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002595 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2596 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002597 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002598 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002599 for(i=0; i<pEList->nExpr; i++){
2600 Expr *pRes = pEList->a[i].pExpr;
2601 if( pRes->op!=TK_COLUMN ) return 0;
2602 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002603 }
drh69c355b2016-03-09 15:34:51 +00002604 return p;
drhb287f4b2008-04-25 00:08:38 +00002605}
2606#endif /* SQLITE_OMIT_SUBQUERY */
2607
danf9b2e052016-08-02 17:45:00 +00002608#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002609/*
drh4c259e92014-08-01 21:12:35 +00002610** Generate code that checks the left-most column of index table iCur to see if
2611** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002612** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2613** to be set to NULL if iCur contains one or more NULL values.
2614*/
2615static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002616 int addr1;
drh6be515e2014-08-01 21:00:53 +00002617 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002618 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002619 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2620 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002621 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002622 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002623}
danf9b2e052016-08-02 17:45:00 +00002624#endif
drh6be515e2014-08-01 21:00:53 +00002625
drhbb53ecb2014-08-02 21:03:33 +00002626
2627#ifndef SQLITE_OMIT_SUBQUERY
2628/*
2629** The argument is an IN operator with a list (not a subquery) on the
2630** right-hand side. Return TRUE if that list is constant.
2631*/
2632static int sqlite3InRhsIsConstant(Expr *pIn){
2633 Expr *pLHS;
2634 int res;
2635 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2636 pLHS = pIn->pLeft;
2637 pIn->pLeft = 0;
2638 res = sqlite3ExprIsConstant(pIn);
2639 pIn->pLeft = pLHS;
2640 return res;
2641}
2642#endif
2643
drh6be515e2014-08-01 21:00:53 +00002644/*
danielk19779a96b662007-11-29 17:05:18 +00002645** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002646** The pX parameter is the expression on the RHS of the IN operator, which
2647** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002648**
drhd4305ca2012-09-18 17:08:33 +00002649** The job of this routine is to find or create a b-tree object that can
2650** be used either to test for membership in the RHS set or to iterate through
2651** all members of the RHS set, skipping duplicates.
2652**
drh3a856252014-08-01 14:46:57 +00002653** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhb94182b2022-05-02 11:24:21 +00002654** and the *piTab parameter is set to the index of that cursor.
drhd4305ca2012-09-18 17:08:33 +00002655**
drhb74b1012009-05-28 21:04:37 +00002656** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002657**
drh1ccce442013-03-12 20:38:51 +00002658** IN_INDEX_ROWID - The cursor was opened on a database table.
2659** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2660** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2661** IN_INDEX_EPH - The cursor was opened on a specially created and
2662** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002663** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2664** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002665**
drhd4305ca2012-09-18 17:08:33 +00002666** An existing b-tree might be used if the RHS expression pX is a simple
2667** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002668**
dan553168c2016-08-01 20:14:31 +00002669** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002670**
drhd4305ca2012-09-18 17:08:33 +00002671** If the RHS of the IN operator is a list or a more complex subquery, then
2672** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002673** pX->iTable made to point to the ephemeral table instead of an
drhb94182b2022-05-02 11:24:21 +00002674** existing table. In this case, the creation and initialization of the
2675** ephmeral table might be put inside of a subroutine, the EP_Subrtn flag
2676** will be set on pX and the pX->y.sub fields will be set to show where
2677** the subroutine is coded.
drhd4305ca2012-09-18 17:08:33 +00002678**
drh7fc0ba02017-11-17 15:02:00 +00002679** The inFlags parameter must contain, at a minimum, one of the bits
2680** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2681** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2682** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2683** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002684**
2685** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2686** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002687** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002688** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2689** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002690**
drh3a856252014-08-01 14:46:57 +00002691** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2692** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002693** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2694** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002695**
drhbb53ecb2014-08-02 21:03:33 +00002696** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2697** if the RHS of the IN operator is a list (not a subquery) then this
2698** routine might decide that creating an ephemeral b-tree for membership
2699** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2700** calling routine should implement the IN operator using a sequence
2701** of Eq or Ne comparison operations.
2702**
drhb74b1012009-05-28 21:04:37 +00002703** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002704** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002705** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002706** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002707** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002708** to *prRhsHasNull. If there is no chance that the (...) contains a
2709** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002710**
drhe21a6e12014-08-01 18:00:24 +00002711** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002712** the value in that register will be NULL if the b-tree contains one or more
2713** NULL values, and it will be some non-NULL value if the b-tree contains no
2714** NULL values.
dan553168c2016-08-01 20:14:31 +00002715**
2716** If the aiMap parameter is not NULL, it must point to an array containing
2717** one element for each column returned by the SELECT statement on the RHS
2718** of the IN(...) operator. The i'th entry of the array is populated with the
2719** offset of the index column that matches the i'th column returned by the
2720** SELECT. For example, if the expression and selected index are:
2721**
2722** (?,?,?) IN (SELECT a, b, c FROM t1)
2723** CREATE INDEX i1 ON t1(b, c, a);
2724**
2725** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002726*/
danielk1977284f4ac2007-12-10 05:03:46 +00002727#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002728int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002729 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002730 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002731 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2732 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002733 int *aiMap, /* Mapping from Index fields to RHS fields */
2734 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002735){
drhb74b1012009-05-28 21:04:37 +00002736 Select *p; /* SELECT to the right of IN operator */
2737 int eType = 0; /* Type of RHS table. IN_INDEX_* */
drh3a45d302022-05-02 14:32:56 +00002738 int iTab; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002739 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002740 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002741
drh1450bc62009-10-30 13:25:56 +00002742 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002743 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drhf69dad82022-05-13 19:50:29 +00002744 iTab = pParse->nTab++;
drh1450bc62009-10-30 13:25:56 +00002745
dan7b35a772016-07-28 19:47:15 +00002746 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2747 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002748 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002749 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002750 ** set prRhsHasNull to 0 before continuing. */
drha4eeccd2021-10-07 17:43:30 +00002751 if( prRhsHasNull && ExprUseXSelect(pX) ){
dan7b35a772016-07-28 19:47:15 +00002752 int i;
2753 ExprList *pEList = pX->x.pSelect->pEList;
2754 for(i=0; i<pEList->nExpr; i++){
2755 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2756 }
2757 if( i==pEList->nExpr ){
2758 prRhsHasNull = 0;
2759 }
2760 }
2761
drhb74b1012009-05-28 21:04:37 +00002762 /* Check to see if an existing table or index can be used to
2763 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002764 ** ephemeral table. */
2765 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002766 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002767 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002768 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002769 ExprList *pEList = p->pEList;
2770 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002771
drhb07028f2011-10-14 21:49:18 +00002772 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2773 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2774 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2775 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002776
drhb22f7c82014-02-06 23:56:27 +00002777 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002778 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002779 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002780 sqlite3CodeVerifySchema(pParse, iDb);
2781 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002782
drha84a2832016-08-26 21:15:35 +00002783 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002784 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002785 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002786 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002787 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002788
2789 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2790 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002791 ExplainQueryPlan((pParse, 0,
2792 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002793 sqlite3VdbeJumpHere(v, iAddr);
2794 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002795 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002796 int affinity_ok = 1;
2797 int i;
2798
2799 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002800 ** comparison is the same as the affinity of each column in table
2801 ** on the RHS of the IN operator. If it not, it is not possible to
2802 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002803 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002804 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002805 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002806 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002807 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002808 testcase( cmpaff==SQLITE_AFF_BLOB );
2809 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002810 switch( cmpaff ){
2811 case SQLITE_AFF_BLOB:
2812 break;
2813 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002814 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2815 ** other has no affinity and the other side is TEXT. Hence,
2816 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2817 ** and for the term on the LHS of the IN to have no affinity. */
2818 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002819 break;
2820 default:
2821 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2822 }
2823 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002824
drha84a2832016-08-26 21:15:35 +00002825 if( affinity_ok ){
2826 /* Search for an existing index that will work for this IN operator */
2827 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2828 Bitmask colUsed; /* Columns of the index used */
2829 Bitmask mCol; /* Mask for the current column */
2830 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002831 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002832 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2833 ** BITMASK(nExpr) without overflowing */
2834 testcase( pIdx->nColumn==BMS-2 );
2835 testcase( pIdx->nColumn==BMS-1 );
2836 if( pIdx->nColumn>=BMS-1 ) continue;
2837 if( mustBeUnique ){
2838 if( pIdx->nKeyCol>nExpr
2839 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2840 ){
2841 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002842 }
danielk19770cdc0222008-06-26 18:04:03 +00002843 }
drha84a2832016-08-26 21:15:35 +00002844
2845 colUsed = 0; /* Columns of index used so far */
2846 for(i=0; i<nExpr; i++){
2847 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2848 Expr *pRhs = pEList->a[i].pExpr;
2849 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2850 int j;
2851
drh0c7d3d32022-01-24 16:47:12 +00002852 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
drha84a2832016-08-26 21:15:35 +00002853 for(j=0; j<nExpr; j++){
2854 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2855 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002856 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2857 continue;
2858 }
drha84a2832016-08-26 21:15:35 +00002859 break;
2860 }
2861 if( j==nExpr ) break;
2862 mCol = MASKBIT(j);
2863 if( mCol & colUsed ) break; /* Each column used only once */
2864 colUsed |= mCol;
2865 if( aiMap ) aiMap[i] = j;
2866 }
2867
2868 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2869 if( colUsed==(MASKBIT(nExpr)-1) ){
2870 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002871 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002872 ExplainQueryPlan((pParse, 0,
2873 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002874 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2875 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2876 VdbeComment((v, "%s", pIdx->zName));
2877 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2878 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2879
2880 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002881#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002882 i64 mask = (1<<nExpr)-1;
2883 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2884 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002885#endif
2886 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002887 if( nExpr==1 ){
2888 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2889 }
2890 }
2891 sqlite3VdbeJumpHere(v, iAddr);
2892 }
2893 } /* End loop over indexes */
2894 } /* End if( affinity_ok ) */
2895 } /* End if not an rowid index */
2896 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002897
drhbb53ecb2014-08-02 21:03:33 +00002898 /* If no preexisting index is available for the IN clause
2899 ** and IN_INDEX_NOOP is an allowed reply
2900 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002901 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002902 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002903 ** the IN operator so return IN_INDEX_NOOP.
2904 */
2905 if( eType==0
2906 && (inFlags & IN_INDEX_NOOP_OK)
drha4eeccd2021-10-07 17:43:30 +00002907 && ExprUseXList(pX)
drhbb53ecb2014-08-02 21:03:33 +00002908 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2909 ){
drhb94182b2022-05-02 11:24:21 +00002910 pParse->nTab--; /* Back out the allocation of the unused cursor */
2911 iTab = -1; /* Cursor is not allocated */
drhbb53ecb2014-08-02 21:03:33 +00002912 eType = IN_INDEX_NOOP;
2913 }
drhbb53ecb2014-08-02 21:03:33 +00002914
danielk19779a96b662007-11-29 17:05:18 +00002915 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002916 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002917 ** We will have to generate an ephemeral table to do the job.
2918 */
drh8e23daf2013-06-11 13:30:04 +00002919 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002920 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002921 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002922 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002923 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002924 }else if( prRhsHasNull ){
2925 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002926 }
drh85bcdce2018-12-23 21:27:29 +00002927 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002928 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002929 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002930 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002931 }
drhcf4d38a2010-07-28 02:53:36 +00002932 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002933 }
danba00e302016-07-23 20:24:06 +00002934
2935 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2936 int i, n;
2937 n = sqlite3ExprVectorSize(pX->pLeft);
2938 for(i=0; i<n; i++) aiMap[i] = i;
2939 }
drh2c041312018-12-24 02:34:49 +00002940 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002941 return eType;
2942}
danielk1977284f4ac2007-12-10 05:03:46 +00002943#endif
drh626a8792005-01-17 22:08:19 +00002944
danf9b2e052016-08-02 17:45:00 +00002945#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002946/*
2947** Argument pExpr is an (?, ?...) IN(...) expression. This
2948** function allocates and returns a nul-terminated string containing
2949** the affinities to be used for each column of the comparison.
2950**
2951** It is the responsibility of the caller to ensure that the returned
2952** string is eventually freed using sqlite3DbFree().
2953*/
drhb6dad522021-09-24 16:14:47 +00002954static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
dan71c57db2016-07-09 20:23:55 +00002955 Expr *pLeft = pExpr->pLeft;
2956 int nVal = sqlite3ExprVectorSize(pLeft);
drha4eeccd2021-10-07 17:43:30 +00002957 Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002958 char *zRet;
2959
dan553168c2016-08-01 20:14:31 +00002960 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002961 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002962 if( zRet ){
2963 int i;
2964 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002965 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002966 char a = sqlite3ExprAffinity(pA);
2967 if( pSelect ){
2968 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2969 }else{
2970 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002971 }
dan71c57db2016-07-09 20:23:55 +00002972 }
2973 zRet[nVal] = '\0';
2974 }
2975 return zRet;
2976}
danf9b2e052016-08-02 17:45:00 +00002977#endif
dan71c57db2016-07-09 20:23:55 +00002978
dan8da209b2016-07-26 18:06:08 +00002979#ifndef SQLITE_OMIT_SUBQUERY
2980/*
2981** Load the Parse object passed as the first argument with an error
2982** message of the form:
2983**
2984** "sub-select returns N columns - expected M"
2985*/
2986void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002987 if( pParse->nErr==0 ){
2988 const char *zFmt = "sub-select returns %d columns - expected %d";
2989 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2990 }
dan8da209b2016-07-26 18:06:08 +00002991}
2992#endif
2993
drh626a8792005-01-17 22:08:19 +00002994/*
dan44c56042016-12-07 15:38:37 +00002995** Expression pExpr is a vector that has been used in a context where
2996** it is not permitted. If pExpr is a sub-select vector, this routine
2997** loads the Parse object with a message of the form:
2998**
2999** "sub-select returns N columns - expected 1"
3000**
3001** Or, if it is a regular scalar vector:
3002**
3003** "row value misused"
3004*/
3005void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
3006#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00003007 if( ExprUseXSelect(pExpr) ){
dan44c56042016-12-07 15:38:37 +00003008 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
3009 }else
3010#endif
3011 {
3012 sqlite3ErrorMsg(pParse, "row value misused");
3013 }
3014}
3015
drh85bcdce2018-12-23 21:27:29 +00003016#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00003017/*
drh85bcdce2018-12-23 21:27:29 +00003018** Generate code that will construct an ephemeral table containing all terms
3019** in the RHS of an IN operator. The IN operator can be in either of two
3020** forms:
drh626a8792005-01-17 22:08:19 +00003021**
drh9cbe6352005-11-29 03:13:21 +00003022** x IN (4,5,11) -- IN operator with list on right-hand side
3023** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00003024**
drh2c041312018-12-24 02:34:49 +00003025** The pExpr parameter is the IN operator. The cursor number for the
3026** constructed ephermeral table is returned. The first time the ephemeral
3027** table is computed, the cursor number is also stored in pExpr->iTable,
3028** however the cursor number returned might not be the same, as it might
3029** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00003030**
drh85bcdce2018-12-23 21:27:29 +00003031** If the LHS expression ("x" in the examples) is a column value, or
3032** the SELECT statement returns a column value, then the affinity of that
3033** column is used to build the index keys. If both 'x' and the
3034** SELECT... statement are columns, then numeric affinity is used
3035** if either column has NUMERIC or INTEGER affinity. If neither
3036** 'x' nor the SELECT... statement are columns, then numeric affinity
3037** is used.
drhcce7d172000-05-31 15:34:51 +00003038*/
drh85bcdce2018-12-23 21:27:29 +00003039void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00003040 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00003041 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00003042 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00003043){
drh2c041312018-12-24 02:34:49 +00003044 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00003045 int addr; /* Address of OP_OpenEphemeral instruction */
3046 Expr *pLeft; /* the LHS of the IN operator */
3047 KeyInfo *pKeyInfo = 0; /* Key information */
3048 int nVal; /* Size of vector pLeft */
3049 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00003050
drh2c041312018-12-24 02:34:49 +00003051 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003052 assert( v!=0 );
3053
drh2c041312018-12-24 02:34:49 +00003054 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00003055 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00003056 **
3057 ** * The right-hand side is a correlated subquery
3058 ** * The right-hand side is an expression list containing variables
3059 ** * We are inside a trigger
3060 **
drh2c041312018-12-24 02:34:49 +00003061 ** If all of the above are false, then we can compute the RHS just once
3062 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00003063 */
drhefb699f2018-12-24 11:55:44 +00003064 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00003065 /* Reuse of the RHS is allowed */
3066 /* If this routine has already been coded, but the previous code
3067 ** might not have been invoked yet, so invoke it now as a subroutine.
3068 */
3069 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00003070 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha4eeccd2021-10-07 17:43:30 +00003071 if( ExprUseXSelect(pExpr) ){
drhbd462bc2018-12-24 20:21:06 +00003072 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3073 pExpr->x.pSelect->selId));
3074 }
drh477572b2021-10-07 20:46:29 +00003075 assert( ExprUseYSub(pExpr) );
drh2c041312018-12-24 02:34:49 +00003076 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3077 pExpr->y.sub.iAddr);
drh086b8002022-05-13 23:01:28 +00003078 assert( iTab!=pExpr->iTable );
3079 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00003080 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00003081 return;
3082 }
3083
3084 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003085 assert( !ExprUseYWin(pExpr) );
drh2c041312018-12-24 02:34:49 +00003086 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00003087 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00003088 pExpr->y.sub.regReturn = ++pParse->nMem;
3089 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003090 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh2c041312018-12-24 02:34:49 +00003091
3092 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003093 }
3094
drh85bcdce2018-12-23 21:27:29 +00003095 /* Check to see if this is a vector IN operator */
3096 pLeft = pExpr->pLeft;
3097 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00003098
drh85bcdce2018-12-23 21:27:29 +00003099 /* Construct the ephemeral table that will contain the content of
3100 ** RHS of the IN operator.
3101 */
drh2c041312018-12-24 02:34:49 +00003102 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00003103 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00003104#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drha4eeccd2021-10-07 17:43:30 +00003105 if( ExprUseXSelect(pExpr) ){
drh2c041312018-12-24 02:34:49 +00003106 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
3107 }else{
3108 VdbeComment((v, "RHS of IN operator"));
3109 }
3110#endif
drh50ef6712019-02-22 23:29:56 +00003111 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00003112
drha4eeccd2021-10-07 17:43:30 +00003113 if( ExprUseXSelect(pExpr) ){
drh85bcdce2018-12-23 21:27:29 +00003114 /* Case 1: expr IN (SELECT ...)
3115 **
3116 ** Generate code to write the results of the select into the temporary
3117 ** table allocated and opened above.
3118 */
3119 Select *pSelect = pExpr->x.pSelect;
3120 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00003121
drh2c041312018-12-24 02:34:49 +00003122 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
3123 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00003124 ));
drh85bcdce2018-12-23 21:27:29 +00003125 /* If the LHS and RHS of the IN operator do not match, that
3126 ** error will have been caught long before we reach this point. */
3127 if( ALWAYS(pEList->nExpr==nVal) ){
drh14c4d422021-05-26 18:46:51 +00003128 Select *pCopy;
drh85bcdce2018-12-23 21:27:29 +00003129 SelectDest dest;
3130 int i;
drh14c4d422021-05-26 18:46:51 +00003131 int rc;
drhbd462bc2018-12-24 20:21:06 +00003132 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00003133 dest.zAffSdst = exprINAffinity(pParse, pExpr);
3134 pSelect->iLimit = 0;
3135 testcase( pSelect->selFlags & SF_Distinct );
3136 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh14c4d422021-05-26 18:46:51 +00003137 pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
3138 rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
3139 sqlite3SelectDelete(pParse->db, pCopy);
3140 sqlite3DbFree(pParse->db, dest.zAffSdst);
3141 if( rc ){
drh85bcdce2018-12-23 21:27:29 +00003142 sqlite3KeyInfoUnref(pKeyInfo);
3143 return;
drh14c4d422021-05-26 18:46:51 +00003144 }
drh85bcdce2018-12-23 21:27:29 +00003145 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
3146 assert( pEList!=0 );
3147 assert( pEList->nExpr>0 );
3148 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3149 for(i=0; i<nVal; i++){
3150 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3151 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3152 pParse, p, pEList->a[i].pExpr
3153 );
danielk197741a05b72008-10-02 13:50:55 +00003154 }
drh85bcdce2018-12-23 21:27:29 +00003155 }
3156 }else if( ALWAYS(pExpr->x.pList!=0) ){
3157 /* Case 2: expr IN (exprlist)
3158 **
3159 ** For each expression, build an index key from the evaluation and
3160 ** store it in the temporary table. If <expr> is a column, then use
3161 ** that columns affinity when building index keys. If <expr> is not
3162 ** a column, use numeric affinity.
3163 */
3164 char affinity; /* Affinity of the LHS of the IN */
3165 int i;
3166 ExprList *pList = pExpr->x.pList;
3167 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003168 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003169 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003170 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003171 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003172 }else if( affinity==SQLITE_AFF_REAL ){
3173 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003174 }
3175 if( pKeyInfo ){
3176 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3177 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003178 }
3179
drh85bcdce2018-12-23 21:27:29 +00003180 /* Loop through each expression in <exprlist>. */
3181 r1 = sqlite3GetTempReg(pParse);
3182 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003183 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3184 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003185
3186 /* If the expression is not constant then we will need to
3187 ** disable the test that was generated above that makes sure
3188 ** this code only executes once. Because for a non-constant
3189 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003190 */
drh2c041312018-12-24 02:34:49 +00003191 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
drh19025162022-03-03 15:00:44 +00003192 sqlite3VdbeChangeToNoop(v, addrOnce-1);
drh2c041312018-12-24 02:34:49 +00003193 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003194 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003195 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003196 }
drh1398ad32005-01-19 23:24:50 +00003197
drh85bcdce2018-12-23 21:27:29 +00003198 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003199 sqlite3ExprCode(pParse, pE2, r1);
3200 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3201 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003202 }
drh85bcdce2018-12-23 21:27:29 +00003203 sqlite3ReleaseTempReg(pParse, r1);
3204 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003205 }
drh85bcdce2018-12-23 21:27:29 +00003206 if( pKeyInfo ){
3207 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3208 }
drh2c041312018-12-24 02:34:49 +00003209 if( addrOnce ){
3210 sqlite3VdbeJumpHere(v, addrOnce);
3211 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003212 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003213 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3214 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003215 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3216 pExpr->y.sub.iAddr, 1);
3217 VdbeCoverage(v);
drh6d2566d2019-09-18 20:34:54 +00003218 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003219 }
3220}
3221#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003222
drh85bcdce2018-12-23 21:27:29 +00003223/*
3224** Generate code for scalar subqueries used as a subquery expression
3225** or EXISTS operator:
3226**
3227** (SELECT a FROM b) -- subquery
3228** EXISTS (SELECT a FROM b) -- EXISTS subquery
3229**
3230** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3231**
drhd86fe442019-08-26 13:45:49 +00003232** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003233** the result is stored in a contiguous array of registers and the
3234** return value is the register of the left-most result column.
3235** Return 0 if an error occurs.
3236*/
3237#ifndef SQLITE_OMIT_SUBQUERY
3238int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003239 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003240 int rReg = 0; /* Register storing resulting */
3241 Select *pSel; /* SELECT statement to encode */
3242 SelectDest dest; /* How to deal with SELECT result */
3243 int nReg; /* Registers to allocate */
3244 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003245
3246 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003247 assert( v!=0 );
drh05428122021-05-24 00:17:04 +00003248 if( pParse->nErr ) return 0;
drhbd462bc2018-12-24 20:21:06 +00003249 testcase( pExpr->op==TK_EXISTS );
3250 testcase( pExpr->op==TK_SELECT );
3251 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
drha4eeccd2021-10-07 17:43:30 +00003252 assert( ExprUseXSelect(pExpr) );
drhbd462bc2018-12-24 20:21:06 +00003253 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003254
drh14c4d422021-05-26 18:46:51 +00003255 /* If this routine has already been coded, then invoke it as a
3256 ** subroutine. */
3257 if( ExprHasProperty(pExpr, EP_Subrtn) ){
3258 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh477572b2021-10-07 20:46:29 +00003259 assert( ExprUseYSub(pExpr) );
drh14c4d422021-05-26 18:46:51 +00003260 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3261 pExpr->y.sub.iAddr);
3262 return pExpr->iTable;
3263 }
3264
3265 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003266 assert( !ExprUseYWin(pExpr) );
3267 assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
drh14c4d422021-05-26 18:46:51 +00003268 ExprSetProperty(pExpr, EP_Subrtn);
3269 pExpr->y.sub.regReturn = ++pParse->nMem;
3270 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003271 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh14c4d422021-05-26 18:46:51 +00003272
drh5198ff52018-12-24 12:09:47 +00003273 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003274 ** is encountered if any of the following is true:
3275 **
3276 ** * The right-hand side is a correlated subquery
3277 ** * The right-hand side is an expression list containing variables
3278 ** * We are inside a trigger
3279 **
3280 ** If all of the above are false, then we can run this code just once
3281 ** save the results, and reuse the same result on subsequent invocations.
3282 */
3283 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh2c041312018-12-24 02:34:49 +00003284 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003285 }
drh85bcdce2018-12-23 21:27:29 +00003286
3287 /* For a SELECT, generate code to put the values for all columns of
3288 ** the first row into an array of registers and return the index of
3289 ** the first register.
3290 **
3291 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3292 ** into a register and return that register number.
3293 **
3294 ** In both cases, the query is augmented with "LIMIT 1". Any
3295 ** preexisting limit is discarded in place of the new LIMIT 1.
3296 */
drhbd462bc2018-12-24 20:21:06 +00003297 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3298 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003299 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3300 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3301 pParse->nMem += nReg;
3302 if( pExpr->op==TK_SELECT ){
3303 dest.eDest = SRT_Mem;
3304 dest.iSdst = dest.iSDParm;
3305 dest.nSdst = nReg;
3306 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3307 VdbeComment((v, "Init subquery result"));
3308 }else{
3309 dest.eDest = SRT_Exists;
3310 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3311 VdbeComment((v, "Init EXISTS result"));
3312 }
drh85bcdce2018-12-23 21:27:29 +00003313 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003314 /* The subquery already has a limit. If the pre-existing limit is X
3315 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3316 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003317 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003318 if( pLimit ){
3319 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3320 pLimit = sqlite3PExpr(pParse, TK_NE,
3321 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3322 }
drh95530162022-07-20 20:36:26 +00003323 sqlite3ExprDeferredDelete(pParse, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003324 pSel->pLimit->pLeft = pLimit;
3325 }else{
drh7ca13472019-09-23 11:55:22 +00003326 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003327 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003328 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3329 }
3330 pSel->iLimit = 0;
3331 if( sqlite3Select(pParse, pSel, &dest) ){
drh1da88b52022-01-24 19:38:56 +00003332 pExpr->op2 = pExpr->op;
3333 pExpr->op = TK_ERROR;
drh85bcdce2018-12-23 21:27:29 +00003334 return 0;
3335 }
drh2c041312018-12-24 02:34:49 +00003336 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003337 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003338 if( addrOnce ){
3339 sqlite3VdbeJumpHere(v, addrOnce);
drh5198ff52018-12-24 12:09:47 +00003340 }
drh2c041312018-12-24 02:34:49 +00003341
drh14c4d422021-05-26 18:46:51 +00003342 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003343 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003344 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3345 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003346 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3347 pExpr->y.sub.iAddr, 1);
3348 VdbeCoverage(v);
drh14c4d422021-05-26 18:46:51 +00003349 sqlite3ClearTempRegCache(pParse);
drh1450bc62009-10-30 13:25:56 +00003350 return rReg;
drhcce7d172000-05-31 15:34:51 +00003351}
drh51522cd2005-01-20 13:36:19 +00003352#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003353
drhe3365e62009-11-12 17:52:24 +00003354#ifndef SQLITE_OMIT_SUBQUERY
3355/*
dan7b35a772016-07-28 19:47:15 +00003356** Expr pIn is an IN(...) expression. This function checks that the
3357** sub-select on the RHS of the IN() operator has the same number of
3358** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3359** a sub-query, that the LHS is a vector of size 1.
3360*/
3361int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3362 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
drha4eeccd2021-10-07 17:43:30 +00003363 if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
dan7b35a772016-07-28 19:47:15 +00003364 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3365 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3366 return 1;
3367 }
3368 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003369 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003370 return 1;
3371 }
3372 return 0;
3373}
3374#endif
3375
3376#ifndef SQLITE_OMIT_SUBQUERY
3377/*
drhe3365e62009-11-12 17:52:24 +00003378** Generate code for an IN expression.
3379**
3380** x IN (SELECT ...)
3381** x IN (value, value, ...)
3382**
drhecb87ac2016-08-25 15:46:25 +00003383** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003384** right-hand side (RHS) is an array of zero or more scalar values, or a
3385** subquery. If the RHS is a subquery, the number of result columns must
3386** match the number of columns in the vector on the LHS. If the RHS is
3387** a list of values, the LHS must be a scalar.
3388**
3389** The IN operator is true if the LHS value is contained within the RHS.
3390** The result is false if the LHS is definitely not in the RHS. The
3391** result is NULL if the presence of the LHS in the RHS cannot be
3392** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003393**
drh6be515e2014-08-01 21:00:53 +00003394** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003395** contained within the RHS. If due to NULLs we cannot determine if the LHS
3396** is contained in the RHS then jump to destIfNull. If the LHS is contained
3397** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003398**
3399** See the separate in-operator.md documentation file in the canonical
3400** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003401*/
3402static void sqlite3ExprCodeIN(
3403 Parse *pParse, /* Parsing and code generating context */
3404 Expr *pExpr, /* The IN expression */
3405 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3406 int destIfNull /* Jump here if the results are unknown due to NULLs */
3407){
3408 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003409 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003410 int rLhs; /* Register(s) holding the LHS values */
3411 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003412 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003413 int *aiMap = 0; /* Map from vector field to index column */
3414 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003415 int nVector; /* Size of vectors for this IN operator */
3416 int iDummy; /* Dummy parameter to exprCodeVector() */
3417 Expr *pLeft; /* The LHS of the IN operator */
3418 int i; /* loop counter */
3419 int destStep2; /* Where to jump when NULLs seen in step 2 */
3420 int destStep6 = 0; /* Start of code for Step 6 */
3421 int addrTruthOp; /* Address of opcode that determines the IN is true */
3422 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3423 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003424 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003425 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003426
drhe7375bf2020-03-10 19:24:38 +00003427 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003428 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003429 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003430 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003431 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3432 aiMap = (int*)sqlite3DbMallocZero(
3433 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3434 );
drhe347d3e2016-08-25 21:14:34 +00003435 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003436
danba00e302016-07-23 20:24:06 +00003437 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003438 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003439 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3440 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003441 v = pParse->pVdbe;
3442 assert( v!=0 ); /* OOM detected prior to this routine */
3443 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003444 eType = sqlite3FindInIndex(pParse, pExpr,
3445 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003446 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3447 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003448
danba00e302016-07-23 20:24:06 +00003449 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3450 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3451 );
drhecb87ac2016-08-25 15:46:25 +00003452#ifdef SQLITE_DEBUG
3453 /* Confirm that aiMap[] contains nVector integer values between 0 and
3454 ** nVector-1. */
3455 for(i=0; i<nVector; i++){
3456 int j, cnt;
3457 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3458 assert( cnt==1 );
3459 }
3460#endif
drhe3365e62009-11-12 17:52:24 +00003461
danba00e302016-07-23 20:24:06 +00003462 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3463 ** vector, then it is stored in an array of nVector registers starting
3464 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003465 **
3466 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3467 ** so that the fields are in the same order as an existing index. The
3468 ** aiMap[] array contains a mapping from the original LHS field order to
3469 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003470 **
3471 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3472 ** even if it is constant, as OP_Affinity may be used on the register
3473 ** by code generated below. */
3474 assert( pParse->okConstFactor==okConstFactor );
3475 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003476 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003477 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003478 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003479 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003480 /* LHS fields are not reordered */
3481 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003482 }else{
3483 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003484 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003485 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003486 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003487 }
danba00e302016-07-23 20:24:06 +00003488 }
drhe3365e62009-11-12 17:52:24 +00003489
drhbb53ecb2014-08-02 21:03:33 +00003490 /* If sqlite3FindInIndex() did not find or create an index that is
3491 ** suitable for evaluating the IN operator, then evaluate using a
3492 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003493 **
3494 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003495 */
drhbb53ecb2014-08-02 21:03:33 +00003496 if( eType==IN_INDEX_NOOP ){
drha4eeccd2021-10-07 17:43:30 +00003497 ExprList *pList;
3498 CollSeq *pColl;
drhec4ccdb2018-12-29 02:26:59 +00003499 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003500 int r2, regToFree;
3501 int regCkNull = 0;
3502 int ii;
drha4eeccd2021-10-07 17:43:30 +00003503 assert( ExprUseXList(pExpr) );
3504 pList = pExpr->x.pList;
3505 pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhbb53ecb2014-08-02 21:03:33 +00003506 if( destIfNull!=destIfFalse ){
3507 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003508 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003509 }
3510 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003511 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003512 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003513 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3514 }
drhf6ea97e2020-01-04 15:21:47 +00003515 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003516 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003517 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3518 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003519 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003520 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3521 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3522 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3523 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003524 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003525 }else{
drh47994882019-12-22 23:48:36 +00003526 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003527 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003528 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3529 (void*)pColl, P4_COLLSEQ);
3530 VdbeCoverageIf(v, op==OP_Ne);
3531 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003532 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003533 }
drhbb53ecb2014-08-02 21:03:33 +00003534 }
3535 if( regCkNull ){
3536 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003537 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003538 }
3539 sqlite3VdbeResolveLabel(v, labelOk);
3540 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003541 goto sqlite3ExprCodeIN_finished;
3542 }
3543
3544 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3545 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3546 ** We will then skip the binary search of the RHS.
3547 */
3548 if( destIfNull==destIfFalse ){
3549 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003550 }else{
drhec4ccdb2018-12-29 02:26:59 +00003551 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003552 }
3553 for(i=0; i<nVector; i++){
3554 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
drh1da88b52022-01-24 19:38:56 +00003555 if( pParse->nErr ) goto sqlite3ExprCodeIN_oom_error;
drhe347d3e2016-08-25 21:14:34 +00003556 if( sqlite3ExprCanBeNull(p) ){
3557 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003558 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003559 }
drhe3365e62009-11-12 17:52:24 +00003560 }
drhe347d3e2016-08-25 21:14:34 +00003561
3562 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3563 ** of the RHS using the LHS as a probe. If found, the result is
3564 ** true.
3565 */
3566 if( eType==IN_INDEX_ROWID ){
3567 /* In this case, the RHS is the ROWID of table b-tree and so we also
3568 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3569 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003570 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003571 VdbeCoverage(v);
3572 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3573 }else{
3574 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3575 if( destIfFalse==destIfNull ){
3576 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003577 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003578 rLhs, nVector); VdbeCoverage(v);
3579 goto sqlite3ExprCodeIN_finished;
3580 }
3581 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003582 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003583 rLhs, nVector); VdbeCoverage(v);
3584 }
3585
3586 /* Step 4. If the RHS is known to be non-NULL and we did not find
3587 ** an match on the search above, then the result must be FALSE.
3588 */
3589 if( rRhsHasNull && nVector==1 ){
3590 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3591 VdbeCoverage(v);
3592 }
3593
3594 /* Step 5. If we do not care about the difference between NULL and
3595 ** FALSE, then just return false.
3596 */
3597 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3598
3599 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3600 ** If any comparison is NULL, then the result is NULL. If all
3601 ** comparisons are FALSE then the final result is FALSE.
3602 **
3603 ** For a scalar LHS, it is sufficient to check just the first row
3604 ** of the RHS.
3605 */
3606 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003607 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003608 VdbeCoverage(v);
3609 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003610 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003611 }else{
3612 /* For nVector==1, combine steps 6 and 7 by immediately returning
3613 ** FALSE if the first comparison is not NULL */
3614 destNotNull = destIfFalse;
3615 }
3616 for(i=0; i<nVector; i++){
3617 Expr *p;
3618 CollSeq *pColl;
3619 int r3 = sqlite3GetTempReg(pParse);
3620 p = sqlite3VectorFieldSubexpr(pLeft, i);
3621 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003622 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003623 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3624 (void*)pColl, P4_COLLSEQ);
3625 VdbeCoverage(v);
3626 sqlite3ReleaseTempReg(pParse, r3);
3627 }
3628 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3629 if( nVector>1 ){
3630 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003631 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003632 VdbeCoverage(v);
3633
3634 /* Step 7: If we reach this point, we know that the result must
3635 ** be false. */
3636 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3637 }
3638
3639 /* Jumps here in order to return true. */
3640 sqlite3VdbeJumpHere(v, addrTruthOp);
3641
3642sqlite3ExprCodeIN_finished:
3643 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003644 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003645sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003646 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003647 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003648}
3649#endif /* SQLITE_OMIT_SUBQUERY */
3650
drh13573c72010-01-12 17:04:07 +00003651#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003652/*
3653** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003654** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003655**
3656** The z[] string will probably not be zero-terminated. But the
3657** z[n] character is guaranteed to be something that does not look
3658** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003659*/
drhb7916a72009-05-27 10:31:29 +00003660static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003661 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003662 double value;
drh9339da12010-09-30 00:50:49 +00003663 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003664 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3665 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003666 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003667 }
3668}
drh13573c72010-01-12 17:04:07 +00003669#endif
drh598f1342007-10-23 15:39:45 +00003670
3671
3672/*
drhfec19aa2004-05-19 20:41:03 +00003673** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003674** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003675**
shaneh5f1d6b62010-09-30 16:51:25 +00003676** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003677*/
drh13573c72010-01-12 17:04:07 +00003678static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3679 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003680 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003681 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003682 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003683 if( negFlag ) i = -i;
3684 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003685 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003686 int c;
3687 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003688 const char *z = pExpr->u.zToken;
3689 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003690 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003691 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003692#ifdef SQLITE_OMIT_FLOATING_POINT
drh62fc0692022-02-06 00:30:04 +00003693 sqlite3ErrorMsg(pParse, "oversized integer: %s%#T", negFlag?"-":"",pExpr);
drh13573c72010-01-12 17:04:07 +00003694#else
drh1b7ddc52014-07-23 14:52:05 +00003695#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003696 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh62fc0692022-02-06 00:30:04 +00003697 sqlite3ErrorMsg(pParse, "hex literal too big: %s%#T",
3698 negFlag?"-":"",pExpr);
drh1b7ddc52014-07-23 14:52:05 +00003699 }else
3700#endif
3701 {
drh9296c182014-07-23 13:40:49 +00003702 codeReal(v, z, negFlag, iMem);
3703 }
drh13573c72010-01-12 17:04:07 +00003704#endif
drh77320ea2016-11-30 14:47:37 +00003705 }else{
drh84d4f1a2017-09-20 10:47:10 +00003706 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003707 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003708 }
drhfec19aa2004-05-19 20:41:03 +00003709 }
3710}
3711
drh5cd79232009-05-25 11:46:29 +00003712
drh1f9ca2c2015-08-25 16:57:52 +00003713/* Generate code that will load into register regOut a value that is
3714** appropriate for the iIdxCol-th column of index pIdx.
3715*/
3716void sqlite3ExprCodeLoadIndexColumn(
3717 Parse *pParse, /* The parsing context */
3718 Index *pIdx, /* The index whose column is to be loaded */
3719 int iTabCur, /* Cursor pointing to a table row */
3720 int iIdxCol, /* The column of the index to be loaded */
3721 int regOut /* Store the index column value in this register */
3722){
3723 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003724 if( iTabCol==XN_EXPR ){
3725 assert( pIdx->aColExpr );
3726 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003727 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003728 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003729 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003730 }else{
drh6df9c4b2019-10-18 12:52:08 +00003731 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003732 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003733 }
drh1f9ca2c2015-08-25 16:57:52 +00003734}
3735
drhe70fa7f2019-10-22 21:01:34 +00003736#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3737/*
3738** Generate code that will compute the value of generated column pCol
3739** and store the result in register regOut
3740*/
3741void sqlite3ExprCodeGeneratedColumn(
drh79cf2b72021-07-31 20:30:41 +00003742 Parse *pParse, /* Parsing context */
3743 Table *pTab, /* Table containing the generated column */
3744 Column *pCol, /* The generated column */
3745 int regOut /* Put the result in this register */
drhe70fa7f2019-10-22 21:01:34 +00003746){
drh4dad7ed2019-12-16 16:52:22 +00003747 int iAddr;
3748 Vdbe *v = pParse->pVdbe;
3749 assert( v!=0 );
3750 assert( pParse->iSelfTab!=0 );
3751 if( pParse->iSelfTab>0 ){
3752 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3753 }else{
3754 iAddr = 0;
3755 }
drh79cf2b72021-07-31 20:30:41 +00003756 sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
drhe70fa7f2019-10-22 21:01:34 +00003757 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003758 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003759 }
drh4dad7ed2019-12-16 16:52:22 +00003760 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003761}
3762#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3763
drh5cd79232009-05-25 11:46:29 +00003764/*
drh5c092e82010-05-14 19:24:02 +00003765** Generate code to extract the value of the iCol-th column of a table.
3766*/
3767void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003768 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003769 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003770 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003771 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003772 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003773){
drhab45fc02019-10-16 22:01:56 +00003774 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003775 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003776 if( pTab==0 ){
3777 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3778 return;
3779 }
drh5c092e82010-05-14 19:24:02 +00003780 if( iCol<0 || iCol==pTab->iPKey ){
3781 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
drh088b6152022-04-18 13:57:57 +00003782 VdbeComment((v, "%s.rowid", pTab->zName));
drh5c092e82010-05-14 19:24:02 +00003783 }else{
drh81f7b372019-10-16 12:18:59 +00003784 int op;
3785 int x;
3786 if( IsVirtual(pTab) ){
3787 op = OP_VColumn;
3788 x = iCol;
3789#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003790 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003791 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003792 if( pCol->colFlags & COLFLAG_BUSY ){
drhcf9d36d2021-08-02 18:03:43 +00003793 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3794 pCol->zCnName);
drhab45fc02019-10-16 22:01:56 +00003795 }else{
3796 int savedSelfTab = pParse->iSelfTab;
3797 pCol->colFlags |= COLFLAG_BUSY;
3798 pParse->iSelfTab = iTabCur+1;
drh79cf2b72021-07-31 20:30:41 +00003799 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003800 pParse->iSelfTab = savedSelfTab;
3801 pCol->colFlags &= ~COLFLAG_BUSY;
3802 }
drh81f7b372019-10-16 12:18:59 +00003803 return;
3804#endif
3805 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003806 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003807 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003808 op = OP_Column;
3809 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003810 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003811 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003812 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003813 }
3814 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003815 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3816 }
3817}
3818
3819/*
drh945498f2007-02-24 11:52:52 +00003820** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003821** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003822**
3823** There must be an open cursor to pTab in iTable when this routine
3824** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003825*/
drhe55cbd72008-03-31 23:48:03 +00003826int sqlite3ExprCodeGetColumn(
3827 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003828 Table *pTab, /* Description of the table we are reading from */
3829 int iColumn, /* Index of the table column */
3830 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003831 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003832 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003833){
drh81f7b372019-10-16 12:18:59 +00003834 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003835 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003836 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003837 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3838 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003839 }
drhe55cbd72008-03-31 23:48:03 +00003840 return iReg;
3841}
drhe55cbd72008-03-31 23:48:03 +00003842
3843/*
drhb21e7c72008-06-22 12:37:57 +00003844** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003845** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003846*/
drhb21e7c72008-06-22 12:37:57 +00003847void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003848 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003849}
3850
drh652fbf52008-04-01 01:42:41 +00003851/*
drh12abf402016-08-22 14:30:05 +00003852** Convert a scalar expression node to a TK_REGISTER referencing
3853** register iReg. The caller must ensure that iReg already contains
3854** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003855*/
dan069d1b12019-06-16 08:58:14 +00003856static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003857 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003858 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003859 p->op2 = p->op;
3860 p->op = TK_REGISTER;
3861 p->iTable = iReg;
3862 ExprClearProperty(p, EP_Skip);
3863}
3864
drh12abf402016-08-22 14:30:05 +00003865/*
3866** Evaluate an expression (either a vector or a scalar expression) and store
3867** the result in continguous temporary registers. Return the index of
3868** the first register used to store the result.
3869**
3870** If the returned result register is a temporary scalar, then also write
3871** that register number into *piFreeable. If the returned result register
3872** is not a temporary or if the expression is a vector set *piFreeable
3873** to 0.
3874*/
3875static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3876 int iResult;
3877 int nResult = sqlite3ExprVectorSize(p);
3878 if( nResult==1 ){
3879 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3880 }else{
3881 *piFreeable = 0;
3882 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003883#if SQLITE_OMIT_SUBQUERY
3884 iResult = 0;
3885#else
drh85bcdce2018-12-23 21:27:29 +00003886 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003887#endif
drh12abf402016-08-22 14:30:05 +00003888 }else{
3889 int i;
3890 iResult = pParse->nMem+1;
3891 pParse->nMem += nResult;
drha4eeccd2021-10-07 17:43:30 +00003892 assert( ExprUseXList(p) );
drh12abf402016-08-22 14:30:05 +00003893 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003894 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003895 }
3896 }
3897 }
3898 return iResult;
3899}
3900
drh25c42962020-01-01 13:55:08 +00003901/*
drh92a27f72020-02-04 01:41:44 +00003902** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3903** so that a subsequent copy will not be merged into this one.
3904*/
3905static void setDoNotMergeFlagOnCopy(Vdbe *v){
3906 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3907 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3908 }
3909}
3910
3911/*
drh25c42962020-01-01 13:55:08 +00003912** Generate code to implement special SQL functions that are implemented
3913** in-line rather than by using the usual callbacks.
3914*/
3915static int exprCodeInlineFunction(
3916 Parse *pParse, /* Parsing context */
3917 ExprList *pFarg, /* List of function arguments */
3918 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3919 int target /* Store function result in this register */
3920){
3921 int nFarg;
3922 Vdbe *v = pParse->pVdbe;
3923 assert( v!=0 );
3924 assert( pFarg!=0 );
3925 nFarg = pFarg->nExpr;
3926 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3927 switch( iFuncId ){
3928 case INLINEFUNC_coalesce: {
3929 /* Attempt a direct implementation of the built-in COALESCE() and
3930 ** IFNULL() functions. This avoids unnecessary evaluation of
3931 ** arguments past the first non-NULL argument.
3932 */
3933 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3934 int i;
3935 assert( nFarg>=2 );
3936 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3937 for(i=1; i<nFarg; i++){
3938 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3939 VdbeCoverage(v);
3940 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3941 }
drh92a27f72020-02-04 01:41:44 +00003942 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003943 sqlite3VdbeResolveLabel(v, endCoalesce);
3944 break;
3945 }
drh3c0e6062020-05-13 18:03:34 +00003946 case INLINEFUNC_iif: {
3947 Expr caseExpr;
3948 memset(&caseExpr, 0, sizeof(caseExpr));
3949 caseExpr.op = TK_CASE;
3950 caseExpr.x.pList = pFarg;
3951 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3952 }
drh6d013d82022-06-01 13:32:05 +00003953#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh645682a2022-06-01 11:05:59 +00003954 case INLINEFUNC_sqlite_offset: {
3955 Expr *pArg = pFarg->a[0].pExpr;
3956 if( pArg->op==TK_COLUMN && pArg->iTable>=0 ){
3957 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
3958 }else{
3959 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3960 }
3961 break;
3962 }
drh6d013d82022-06-01 13:32:05 +00003963#endif
drh171c50e2020-01-01 15:43:30 +00003964 default: {
drh25c42962020-01-01 13:55:08 +00003965 /* The UNLIKELY() function is a no-op. The result is the value
3966 ** of the first argument.
3967 */
drh171c50e2020-01-01 15:43:30 +00003968 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003969 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3970 break;
3971 }
3972
drh171c50e2020-01-01 15:43:30 +00003973 /***********************************************************************
3974 ** Test-only SQL functions that are only usable if enabled
3975 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3976 */
drh3780f9a2021-09-17 13:07:15 +00003977#if !defined(SQLITE_UNTESTABLE)
drh171c50e2020-01-01 15:43:30 +00003978 case INLINEFUNC_expr_compare: {
3979 /* Compare two expressions using sqlite3ExprCompare() */
3980 assert( nFarg==2 );
3981 sqlite3VdbeAddOp2(v, OP_Integer,
3982 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3983 target);
3984 break;
3985 }
3986
3987 case INLINEFUNC_expr_implies_expr: {
3988 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3989 assert( nFarg==2 );
3990 sqlite3VdbeAddOp2(v, OP_Integer,
3991 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3992 target);
3993 break;
3994 }
3995
3996 case INLINEFUNC_implies_nonnull_row: {
3997 /* REsult of sqlite3ExprImpliesNonNullRow() */
3998 Expr *pA1;
3999 assert( nFarg==2 );
4000 pA1 = pFarg->a[1].pExpr;
4001 if( pA1->op==TK_COLUMN ){
4002 sqlite3VdbeAddOp2(v, OP_Integer,
4003 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
4004 target);
4005 }else{
4006 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4007 }
4008 break;
4009 }
4010
drh25c42962020-01-01 13:55:08 +00004011 case INLINEFUNC_affinity: {
4012 /* The AFFINITY() function evaluates to a string that describes
4013 ** the type affinity of the argument. This is used for testing of
4014 ** the SQLite type logic.
4015 */
4016 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
4017 char aff;
4018 assert( nFarg==1 );
4019 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
4020 sqlite3VdbeLoadString(v, target,
4021 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
4022 break;
4023 }
drh3780f9a2021-09-17 13:07:15 +00004024#endif /* !defined(SQLITE_UNTESTABLE) */
drh25c42962020-01-01 13:55:08 +00004025 }
4026 return target;
4027}
4028
dan71c57db2016-07-09 20:23:55 +00004029
drha4c3c872013-09-12 17:29:25 +00004030/*
drhcce7d172000-05-31 15:34:51 +00004031** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00004032** expression. Attempt to store the results in register "target".
4033** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00004034**
drh8b213892008-08-29 02:14:02 +00004035** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00004036** be stored in target. The result might be stored in some other
4037** register if it is convenient to do so. The calling function
4038** must check the return code and move the results to the desired
4039** register.
drhcce7d172000-05-31 15:34:51 +00004040*/
drh678ccce2008-03-31 18:19:54 +00004041int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00004042 Vdbe *v = pParse->pVdbe; /* The VM under construction */
4043 int op; /* The opcode being coded */
4044 int inReg = target; /* Results stored in register inReg */
4045 int regFree1 = 0; /* If non-zero free this temporary register */
4046 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00004047 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00004048 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00004049 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00004050
drh9cbf3422008-01-17 16:22:13 +00004051 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00004052 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00004053
drh1efa8022018-04-28 04:16:43 +00004054expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00004055 if( pExpr==0 ){
4056 op = TK_NULL;
4057 }else{
drhe7375bf2020-03-10 19:24:38 +00004058 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00004059 op = pExpr->op;
4060 }
drhf2bc0132004-10-04 13:19:23 +00004061 switch( op ){
drh13449892005-09-07 21:22:45 +00004062 case TK_AGG_COLUMN: {
4063 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004064 struct AggInfo_col *pCol;
4065 assert( pAggInfo!=0 );
4066 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4067 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00004068 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00004069 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00004070 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00004071 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00004072 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00004073 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00004074 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00004075 if( pCol->iColumn<0 ){
4076 VdbeComment((v,"%s.rowid",pTab->zName));
4077 }else{
drhcf9d36d2021-08-02 18:03:43 +00004078 VdbeComment((v,"%s.%s",
4079 pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
drh8d5cea62020-03-11 02:04:15 +00004080 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
4081 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4082 }
drh0c76e892020-03-10 11:50:43 +00004083 }
drhc332cc32016-09-19 10:24:19 +00004084 return target;
drh13449892005-09-07 21:22:45 +00004085 }
4086 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00004087 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00004088 }
drh967e8b72000-06-21 13:59:10 +00004089 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00004090 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00004091 int iReg;
drhefad2e22018-07-27 16:57:11 +00004092 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00004093 /* This COLUMN expression is really a constant due to WHERE clause
4094 ** constraints, and that constant is coded by the pExpr->pLeft
4095 ** expresssion. However, make sure the constant has the correct
4096 ** datatype by applying the Affinity of the table column to the
4097 ** constant.
4098 */
drh57f7ece2019-11-21 18:28:44 +00004099 int aff;
drh67b9ba12019-12-20 20:45:02 +00004100 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh477572b2021-10-07 20:46:29 +00004101 assert( ExprUseYTab(pExpr) );
drh57f7ece2019-11-21 18:28:44 +00004102 if( pExpr->y.pTab ){
4103 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
4104 }else{
4105 aff = pExpr->affExpr;
4106 }
drh96fb16e2019-08-06 14:37:24 +00004107 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00004108 static const char zAff[] = "B\000C\000D\000E";
4109 assert( SQLITE_AFF_BLOB=='A' );
4110 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00004111 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4112 &zAff[(aff-'B')*2], P4_STATIC);
4113 }
4114 return iReg;
drhefad2e22018-07-27 16:57:11 +00004115 }
drhb2b9d3d2013-08-01 01:14:43 +00004116 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00004117 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00004118 /* Other columns in the same row for CHECK constraints or
4119 ** generated columns or for inserting into partial index.
4120 ** The row is unpacked into registers beginning at
4121 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
4122 ** immediately prior to the first column.
4123 */
4124 Column *pCol;
drh477572b2021-10-07 20:46:29 +00004125 Table *pTab;
drh9942ef02019-10-18 02:19:18 +00004126 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00004127 int iCol = pExpr->iColumn;
drh477572b2021-10-07 20:46:29 +00004128 assert( ExprUseYTab(pExpr) );
4129 pTab = pExpr->y.pTab;
drh9942ef02019-10-18 02:19:18 +00004130 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00004131 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00004132 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00004133 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00004134 return -1-pParse->iSelfTab;
4135 }
drhc5f808d2019-10-19 15:01:52 +00004136 pCol = pTab->aCol + iCol;
4137 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4138 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00004139#ifndef SQLITE_OMIT_GENERATED_COLUMNS
4140 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00004141 if( pCol->colFlags & COLFLAG_BUSY ){
4142 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
drhcf9d36d2021-08-02 18:03:43 +00004143 pCol->zCnName);
drh4e8e5332019-11-07 02:32:54 +00004144 return 0;
4145 }
4146 pCol->colFlags |= COLFLAG_BUSY;
4147 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
drh79cf2b72021-07-31 20:30:41 +00004148 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
drh4e8e5332019-11-07 02:32:54 +00004149 }
4150 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00004151 return iSrc;
drh9942ef02019-10-18 02:19:18 +00004152 }else
4153#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
4154 if( pCol->affinity==SQLITE_AFF_REAL ){
4155 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00004156 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4157 return target;
4158 }else{
drh9942ef02019-10-18 02:19:18 +00004159 return iSrc;
drhbffdd632019-09-02 00:58:44 +00004160 }
drhb2b9d3d2013-08-01 01:14:43 +00004161 }else{
drh1f9ca2c2015-08-25 16:57:52 +00004162 /* Coding an expression that is part of an index where column names
4163 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00004164 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00004165 }
drh22827922000-06-06 17:27:05 +00004166 }
drh477572b2021-10-07 20:46:29 +00004167 assert( ExprUseYTab(pExpr) );
drh67b9ba12019-12-20 20:45:02 +00004168 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00004169 pExpr->iColumn, iTab, target,
4170 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00004171 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
4172 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
4173 }
4174 return iReg;
drhcce7d172000-05-31 15:34:51 +00004175 }
4176 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00004177 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00004178 return target;
drhfec19aa2004-05-19 20:41:03 +00004179 }
drh8abed7b2018-02-26 18:49:05 +00004180 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00004181 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00004182 return target;
4183 }
drh13573c72010-01-12 17:04:07 +00004184#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004185 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004186 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4187 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004188 return target;
drh598f1342007-10-23 15:39:45 +00004189 }
drh13573c72010-01-12 17:04:07 +00004190#endif
drhfec19aa2004-05-19 20:41:03 +00004191 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004192 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004193 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004194 return target;
drhcce7d172000-05-31 15:34:51 +00004195 }
drhaac30f92019-12-14 15:01:55 +00004196 default: {
drhc29af652019-12-18 21:22:40 +00004197 /* Make NULL the default case so that if a bug causes an illegal
4198 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004199 ** sanely and not crash. But keep the assert() to bring the problem
4200 ** to the attention of the developers. */
drh05428122021-05-24 00:17:04 +00004201 assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
drh9de221d2008-01-05 06:51:30 +00004202 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004203 return target;
drhf0863fe2005-06-12 21:35:51 +00004204 }
danielk19775338a5f2005-01-20 13:03:10 +00004205#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004206 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004207 int n;
4208 const char *z;
drhca48c902008-01-18 14:08:24 +00004209 char *zBlob;
drh034d1112022-07-22 18:25:04 +00004210 if( pParse->nErr ) return target;
drh33e619f2009-05-28 01:00:55 +00004211 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4212 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4213 assert( pExpr->u.zToken[1]=='\'' );
4214 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004215 n = sqlite3Strlen30(z) - 1;
4216 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004217 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4218 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004219 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004220 }
danielk19775338a5f2005-01-20 13:03:10 +00004221#endif
drh50457892003-09-06 01:10:47 +00004222 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004223 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4224 assert( pExpr->u.zToken!=0 );
4225 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004226 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4227 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004228 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004229 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004230 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004231 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004232 }
drhc332cc32016-09-19 10:24:19 +00004233 return target;
drh50457892003-09-06 01:10:47 +00004234 }
drh4e0cff62004-11-05 05:10:28 +00004235 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004236 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004237 }
drh487e2622005-06-25 18:42:14 +00004238#ifndef SQLITE_OMIT_CAST
4239 case TK_CAST: {
4240 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004241 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004242 if( inReg!=target ){
4243 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4244 inReg = target;
4245 }
drhf9751072021-10-07 13:40:29 +00004246 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh4169e432014-08-25 20:11:52 +00004247 sqlite3VdbeAddOp2(v, OP_Cast, target,
4248 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004249 return inReg;
drh487e2622005-06-25 18:42:14 +00004250 }
4251#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004252 case TK_IS:
4253 case TK_ISNOT:
4254 op = (op==TK_IS) ? TK_EQ : TK_NE;
4255 p5 = SQLITE_NULLEQ;
4256 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004257 case TK_LT:
4258 case TK_LE:
4259 case TK_GT:
4260 case TK_GE:
4261 case TK_NE:
4262 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004263 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004264 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004265 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004266 }else{
4267 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4268 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004269 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4270 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4271 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004272 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004273 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4274 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4275 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4276 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4277 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4278 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004279 if( p5==SQLITE_NULLEQ ){
4280 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4281 }else{
4282 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4283 }
dan71c57db2016-07-09 20:23:55 +00004284 testcase( regFree1==0 );
4285 testcase( regFree2==0 );
4286 }
drh6a2fe092009-09-23 02:29:36 +00004287 break;
4288 }
drhcce7d172000-05-31 15:34:51 +00004289 case TK_AND:
4290 case TK_OR:
4291 case TK_PLUS:
4292 case TK_STAR:
4293 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004294 case TK_REM:
4295 case TK_BITAND:
4296 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004297 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004298 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004299 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004300 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004301 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4302 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4303 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4304 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4305 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4306 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4307 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4308 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4309 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4310 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4311 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004312 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4313 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004314 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004315 testcase( regFree1==0 );
4316 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004317 break;
4318 }
drhcce7d172000-05-31 15:34:51 +00004319 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004320 Expr *pLeft = pExpr->pLeft;
4321 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004322 if( pLeft->op==TK_INTEGER ){
4323 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004324 return target;
drh13573c72010-01-12 17:04:07 +00004325#ifndef SQLITE_OMIT_FLOATING_POINT
4326 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004327 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4328 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004329 return target;
drh13573c72010-01-12 17:04:07 +00004330#endif
drh3c84ddf2008-01-09 02:15:38 +00004331 }else{
drh10d1edf2013-11-15 15:52:39 +00004332 tempX.op = TK_INTEGER;
4333 tempX.flags = EP_IntValue|EP_TokenOnly;
4334 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004335 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004336 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004337 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004338 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004339 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004340 }
drh3c84ddf2008-01-09 02:15:38 +00004341 break;
drh6e142f52000-06-08 13:36:40 +00004342 }
drhbf4133c2001-10-13 02:59:08 +00004343 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004344 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004345 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4346 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004347 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4348 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004349 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004350 break;
4351 }
drh8abed7b2018-02-26 18:49:05 +00004352 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004353 int isTrue; /* IS TRUE or IS NOT TRUE */
4354 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004355 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4356 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004357 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4358 bNormal = pExpr->op2==TK_IS;
4359 testcase( isTrue && bNormal);
4360 testcase( !isTrue && bNormal);
4361 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004362 break;
4363 }
drhcce7d172000-05-31 15:34:51 +00004364 case TK_ISNULL:
4365 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004366 int addr;
drh7d176102014-02-18 03:07:12 +00004367 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4368 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004369 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004370 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004371 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004372 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004373 VdbeCoverageIf(v, op==TK_ISNULL);
4374 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004375 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004376 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004377 break;
drhcce7d172000-05-31 15:34:51 +00004378 }
drh22827922000-06-06 17:27:05 +00004379 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004380 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004381 if( pInfo==0
4382 || NEVER(pExpr->iAgg<0)
4383 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4384 ){
drh33e619f2009-05-28 01:00:55 +00004385 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh62fc0692022-02-06 00:30:04 +00004386 sqlite3ErrorMsg(pParse, "misuse of aggregate: %#T()", pExpr);
drh7e56e712005-11-16 12:53:15 +00004387 }else{
drhc332cc32016-09-19 10:24:19 +00004388 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004389 }
drh22827922000-06-06 17:27:05 +00004390 break;
4391 }
drhcce7d172000-05-31 15:34:51 +00004392 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004393 ExprList *pFarg; /* List of function arguments */
4394 int nFarg; /* Number of function arguments */
4395 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004396 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004397 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004398 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004399 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004400 u8 enc = ENC(db); /* The text encoding used by this database */
4401 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004402
dan67a9b8e2018-06-22 20:51:35 +00004403#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004404 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4405 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004406 }
dan67a9b8e2018-06-22 20:51:35 +00004407#endif
dan86fb6e12018-05-16 20:58:07 +00004408
drh1e9b53f2017-01-04 01:07:24 +00004409 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004410 /* SQL functions can be expensive. So try to avoid running them
4411 ** multiple times if we know they always give the same result */
4412 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004413 }
drhe7375bf2020-03-10 19:24:38 +00004414 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
drha4eeccd2021-10-07 17:43:30 +00004415 assert( ExprUseXList(pExpr) );
drhe7375bf2020-03-10 19:24:38 +00004416 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004417 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004418 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4419 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004420 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004421#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4422 if( pDef==0 && pParse->explain ){
4423 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4424 }
4425#endif
danb6e9f7a2018-05-19 14:15:29 +00004426 if( pDef==0 || pDef->xFinalize!=0 ){
drh62fc0692022-02-06 00:30:04 +00004427 sqlite3ErrorMsg(pParse, "unknown function: %#T()", pExpr);
drhfeb306f2009-08-18 16:05:46 +00004428 break;
4429 }
drh25c42962020-01-01 13:55:08 +00004430 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004431 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4432 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004433 return exprCodeInlineFunction(pParse, pFarg,
4434 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004435 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4436 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004437 }
4438
drhd1a01ed2013-11-21 16:08:52 +00004439 for(i=0; i<nFarg; i++){
4440 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004441 testcase( i==31 );
4442 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004443 }
4444 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4445 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4446 }
4447 }
drh12ffee82009-04-08 13:51:51 +00004448 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004449 if( constMask ){
4450 r1 = pParse->nMem+1;
4451 pParse->nMem += nFarg;
4452 }else{
4453 r1 = sqlite3GetTempRange(pParse, nFarg);
4454 }
drha748fdc2012-03-28 01:34:47 +00004455
4456 /* For length() and typeof() functions with a column argument,
4457 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4458 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4459 ** loading.
4460 */
drhd36e1042013-09-06 13:10:12 +00004461 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004462 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004463 assert( nFarg==1 );
4464 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004465 exprOp = pFarg->a[0].pExpr->op;
4466 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004467 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4468 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004469 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4470 pFarg->a[0].pExpr->op2 =
4471 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004472 }
4473 }
4474
drh5579d592015-08-26 14:01:41 +00004475 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004476 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004477 }else{
drh12ffee82009-04-08 13:51:51 +00004478 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004479 }
drhb7f6f682006-07-08 17:06:43 +00004480#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004481 /* Possibly overload the function if the first argument is
4482 ** a virtual table column.
4483 **
4484 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4485 ** second argument, not the first, as the argument to test to
4486 ** see if it is a column in a virtual table. This is done because
4487 ** the left operand of infix functions (the operand we want to
4488 ** control overloading) ends up as the second argument to the
4489 ** function. The expression "A glob B" is equivalent to
4490 ** "glob(B,A). We want to use the A in "A glob B" to test
4491 ** for function overloading. But we use the B term in "glob(B,A)".
4492 */
drh59155062018-05-26 18:03:48 +00004493 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004494 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4495 }else if( nFarg>0 ){
4496 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004497 }
4498#endif
drhd36e1042013-09-06 13:10:12 +00004499 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004500 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004501 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004502 }
drh645682a2022-06-01 11:05:59 +00004503 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
4504 pDef, pExpr->op2);
drh13d79502019-12-23 02:18:49 +00004505 if( nFarg ){
4506 if( constMask==0 ){
4507 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4508 }else{
drh3aef2fb2020-01-02 17:46:02 +00004509 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004510 }
drh2dcef112008-01-12 19:03:48 +00004511 }
drhc332cc32016-09-19 10:24:19 +00004512 return target;
drhcce7d172000-05-31 15:34:51 +00004513 }
drhfe2093d2005-01-20 22:48:47 +00004514#ifndef SQLITE_OMIT_SUBQUERY
4515 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004516 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004517 int nCol;
drhc5499be2008-04-01 15:06:33 +00004518 testcase( op==TK_EXISTS );
4519 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004520 if( pParse->db->mallocFailed ){
4521 return 0;
drha4eeccd2021-10-07 17:43:30 +00004522 }else if( op==TK_SELECT
4523 && ALWAYS( ExprUseXSelect(pExpr) )
4524 && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4525 ){
dan8da209b2016-07-26 18:06:08 +00004526 sqlite3SubselectError(pParse, nCol, 1);
4527 }else{
drh85bcdce2018-12-23 21:27:29 +00004528 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004529 }
drh19a775c2000-06-05 18:54:46 +00004530 break;
4531 }
drhfc7f27b2016-08-20 00:07:01 +00004532 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004533 int n;
drh2c31c002022-04-14 16:34:07 +00004534 Expr *pLeft = pExpr->pLeft;
4535 if( pLeft->iTable==0 || pParse->withinRJSubrtn > pLeft->op2 ){
4536 pLeft->iTable = sqlite3CodeSubselect(pParse, pLeft);
4537 pLeft->op2 = pParse->withinRJSubrtn;
drhfc7f27b2016-08-20 00:07:01 +00004538 }
drh2c31c002022-04-14 16:34:07 +00004539 assert( pLeft->op==TK_SELECT || pLeft->op==TK_ERROR );
4540 n = sqlite3ExprVectorSize(pLeft);
drh10f08272021-07-05 01:11:26 +00004541 if( pExpr->iTable!=n ){
drh966e2912017-01-03 02:58:01 +00004542 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4543 pExpr->iTable, n);
4544 }
drh2c31c002022-04-14 16:34:07 +00004545 return pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004546 }
drhfef52082000-06-06 01:50:43 +00004547 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004548 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4549 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004550 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4551 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4552 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4553 sqlite3VdbeResolveLabel(v, destIfFalse);
4554 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4555 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004556 return target;
drhfef52082000-06-06 01:50:43 +00004557 }
drhe3365e62009-11-12 17:52:24 +00004558#endif /* SQLITE_OMIT_SUBQUERY */
4559
4560
drh2dcef112008-01-12 19:03:48 +00004561 /*
4562 ** x BETWEEN y AND z
4563 **
4564 ** This is equivalent to
4565 **
4566 ** x>=y AND x<=z
4567 **
4568 ** X is stored in pExpr->pLeft.
4569 ** Y is stored in pExpr->pList->a[0].pExpr.
4570 ** Z is stored in pExpr->pList->a[1].pExpr.
4571 */
drhfef52082000-06-06 01:50:43 +00004572 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004573 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004574 return target;
drhfef52082000-06-06 01:50:43 +00004575 }
drh8878f8a2022-06-09 16:19:01 +00004576 case TK_COLLATE: {
4577 if( !ExprHasProperty(pExpr, EP_Collate)
4578 && ALWAYS(pExpr->pLeft)
4579 && pExpr->pLeft->op==TK_FUNCTION
4580 ){
4581 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
4582 if( inReg!=target ){
4583 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4584 inReg = target;
4585 }
4586 sqlite3VdbeAddOp1(v, OP_ClrSubtype, inReg);
4587 return inReg;
4588 }else{
4589 pExpr = pExpr->pLeft;
4590 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. */
4591 }
4592 }
drh94fa9c42016-02-27 21:16:04 +00004593 case TK_SPAN:
drh4f07e5f2007-05-14 11:34:46 +00004594 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004595 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004596 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004597 }
drh2dcef112008-01-12 19:03:48 +00004598
dan165921a2009-08-28 18:53:45 +00004599 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004600 /* If the opcode is TK_TRIGGER, then the expression is a reference
4601 ** to a column in the new.* or old.* pseudo-tables available to
4602 ** trigger programs. In this case Expr.iTable is set to 1 for the
4603 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4604 ** is set to the column of the pseudo-table to read, or to -1 to
4605 ** read the rowid field.
4606 **
4607 ** The expression is implemented using an OP_Param opcode. The p1
4608 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4609 ** to reference another column of the old.* pseudo-table, where
4610 ** i is the index of the column. For a new.rowid reference, p1 is
4611 ** set to (n+1), where n is the number of columns in each pseudo-table.
4612 ** For a reference to any other column in the new.* pseudo-table, p1
4613 ** is set to (n+2+i), where n and i are as defined previously. For
4614 ** example, if the table on which triggers are being fired is
4615 ** declared as:
4616 **
4617 ** CREATE TABLE t1(a, b);
4618 **
4619 ** Then p1 is interpreted as follows:
4620 **
4621 ** p1==0 -> old.rowid p1==3 -> new.rowid
4622 ** p1==1 -> old.a p1==4 -> new.a
4623 ** p1==2 -> old.b p1==5 -> new.b
4624 */
drh477572b2021-10-07 20:46:29 +00004625 Table *pTab;
4626 int iCol;
4627 int p1;
4628
4629 assert( ExprUseYTab(pExpr) );
4630 pTab = pExpr->y.pTab;
4631 iCol = pExpr->iColumn;
4632 p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004633 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004634
4635 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004636 assert( iCol>=-1 && iCol<pTab->nCol );
4637 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004638 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4639
4640 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004641 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004642 (pExpr->iTable ? "new" : "old"),
drhcf9d36d2021-08-02 18:03:43 +00004643 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
dan165921a2009-08-28 18:53:45 +00004644 ));
dan65a7cd12009-09-01 12:16:01 +00004645
drh44dbca82010-01-13 04:22:20 +00004646#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004647 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004648 ** integer. Use OP_RealAffinity to make sure it is really real.
4649 **
4650 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4651 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004652 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004653 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4654 }
drh44dbca82010-01-13 04:22:20 +00004655#endif
dan165921a2009-08-28 18:53:45 +00004656 break;
4657 }
4658
dan71c57db2016-07-09 20:23:55 +00004659 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004660 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004661 break;
4662 }
4663
drh9e9a67a2019-08-17 17:07:15 +00004664 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4665 ** that derive from the right-hand table of a LEFT JOIN. The
4666 ** Expr.iTable value is the table number for the right-hand table.
4667 ** The expression is only evaluated if that table is not currently
4668 ** on a LEFT JOIN NULL row.
4669 */
drh31d6fd52017-04-14 19:03:10 +00004670 case TK_IF_NULL_ROW: {
4671 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004672 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004673 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004674 /* Temporarily disable factoring of constant expressions, since
4675 ** even though expressions may appear to be constant, they are not
4676 ** really constant because they originate from the right-hand side
4677 ** of a LEFT JOIN. */
4678 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004679 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004680 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004681 sqlite3VdbeJumpHere(v, addrINR);
4682 sqlite3VdbeChangeP3(v, addrINR, inReg);
4683 break;
4684 }
4685
drh2dcef112008-01-12 19:03:48 +00004686 /*
4687 ** Form A:
4688 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4689 **
4690 ** Form B:
4691 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4692 **
4693 ** Form A is can be transformed into the equivalent form B as follows:
4694 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4695 ** WHEN x=eN THEN rN ELSE y END
4696 **
4697 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004698 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4699 ** odd. The Y is also optional. If the number of elements in x.pList
4700 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004701 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4702 **
4703 ** The result of the expression is the Ri for the first matching Ei,
4704 ** or if there is no matching Ei, the ELSE term Y, or if there is
4705 ** no ELSE term, NULL.
4706 */
drhaac30f92019-12-14 15:01:55 +00004707 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004708 int endLabel; /* GOTO label for end of CASE stmt */
4709 int nextCase; /* GOTO label for next WHEN clause */
4710 int nExpr; /* 2x number of WHEN terms */
4711 int i; /* Loop counter */
4712 ExprList *pEList; /* List of WHEN terms */
4713 struct ExprList_item *aListelem; /* Array of WHEN terms */
4714 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004715 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004716 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004717 Expr *pDel = 0;
4718 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004719
drha4eeccd2021-10-07 17:43:30 +00004720 assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00004721 assert(pExpr->x.pList->nExpr > 0);
4722 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004723 aListelem = pEList->a;
4724 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004725 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004726 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004727 pDel = sqlite3ExprDup(db, pX, 0);
4728 if( db->mallocFailed ){
4729 sqlite3ExprDelete(db, pDel);
4730 break;
4731 }
drh33cd4902009-05-30 20:49:20 +00004732 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004733 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004734 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004735 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004736 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004737 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004738 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004739 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4740 ** The value in regFree1 might get SCopy-ed into the file result.
4741 ** So make sure that the regFree1 register is not reused for other
4742 ** purposes and possibly overwritten. */
4743 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004744 }
drhc5cd1242013-09-12 16:50:49 +00004745 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004746 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004747 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004748 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004749 }else{
drh2dcef112008-01-12 19:03:48 +00004750 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004751 }
drhec4ccdb2018-12-29 02:26:59 +00004752 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004753 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004754 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004755 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004756 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004757 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004758 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004759 }
drhc5cd1242013-09-12 16:50:49 +00004760 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004761 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004762 }else{
drh9de221d2008-01-05 06:51:30 +00004763 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004764 }
dan8b65e592019-07-17 14:34:17 +00004765 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004766 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004767 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004768 break;
4769 }
danielk19775338a5f2005-01-20 13:03:10 +00004770#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004771 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004772 assert( pExpr->affExpr==OE_Rollback
4773 || pExpr->affExpr==OE_Abort
4774 || pExpr->affExpr==OE_Fail
4775 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004776 );
drh9e5fdc42020-05-08 19:02:21 +00004777 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004778 sqlite3ErrorMsg(pParse,
4779 "RAISE() may only be used within a trigger-program");
4780 return 0;
4781 }
drh11949042019-08-05 18:01:42 +00004782 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004783 sqlite3MayAbort(pParse);
4784 }
dan165921a2009-08-28 18:53:45 +00004785 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004786 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004787 sqlite3VdbeAddOp4(
4788 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004789 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004790 }else{
drh9e5fdc42020-05-08 19:02:21 +00004791 sqlite3HaltConstraint(pParse,
4792 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4793 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004794 }
4795
drhffe07b22005-11-03 00:41:17 +00004796 break;
drh17a7f8d2002-03-24 13:13:27 +00004797 }
danielk19775338a5f2005-01-20 13:03:10 +00004798#endif
drhffe07b22005-11-03 00:41:17 +00004799 }
drh2dcef112008-01-12 19:03:48 +00004800 sqlite3ReleaseTempReg(pParse, regFree1);
4801 sqlite3ReleaseTempReg(pParse, regFree2);
4802 return inReg;
4803}
4804
4805/*
drh9b258c52020-03-11 19:41:49 +00004806** Generate code that will evaluate expression pExpr just one time
4807** per prepared statement execution.
4808**
4809** If the expression uses functions (that might throw an exception) then
4810** guard them with an OP_Once opcode to ensure that the code is only executed
4811** once. If no functions are involved, then factor the code out and put it at
4812** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004813**
drhad879ff2017-01-04 04:10:02 +00004814** If regDest>=0 then the result is always stored in that register and the
4815** result is not reusable. If regDest<0 then this routine is free to
4816** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004817** is stored is returned. When regDest<0, two identical expressions might
4818** code to the same register, if they do not contain function calls and hence
4819** are factored out into the initialization section at the end of the
4820** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004821*/
drh9b258c52020-03-11 19:41:49 +00004822int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004823 Parse *pParse, /* Parsing context */
4824 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004825 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004826){
drhd1a01ed2013-11-21 16:08:52 +00004827 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004828 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004829 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004830 if( regDest<0 && p ){
4831 struct ExprList_item *pItem;
4832 int i;
4833 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
drhd88fd532022-05-02 20:49:30 +00004834 if( pItem->fg.reusable
4835 && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0
4836 ){
drhad879ff2017-01-04 04:10:02 +00004837 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004838 }
4839 }
drh1e9b53f2017-01-04 01:07:24 +00004840 }
drhd1a01ed2013-11-21 16:08:52 +00004841 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004842 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4843 Vdbe *v = pParse->pVdbe;
4844 int addr;
4845 assert( v );
4846 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4847 pParse->okConstFactor = 0;
4848 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004849 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004850 sqlite3ExprCode(pParse, pExpr, regDest);
4851 }
4852 pParse->okConstFactor = 1;
4853 sqlite3ExprDelete(pParse->db, pExpr);
4854 sqlite3VdbeJumpHere(v, addr);
4855 }else{
4856 p = sqlite3ExprListAppend(pParse, p, pExpr);
4857 if( p ){
4858 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00004859 pItem->fg.reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004860 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004861 pItem->u.iConstExprReg = regDest;
4862 }
4863 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004864 }
drh1e9b53f2017-01-04 01:07:24 +00004865 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004866}
4867
4868/*
drh2dcef112008-01-12 19:03:48 +00004869** Generate code to evaluate an expression and store the results
4870** into a register. Return the register number where the results
4871** are stored.
4872**
4873** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004874** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004875** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004876**
4877** If pExpr is a constant, then this routine might generate this
4878** code to fill the register in the initialization section of the
4879** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004880*/
4881int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004882 int r2;
drh0d950af2019-08-22 16:38:42 +00004883 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004884 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004885 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004886 && pExpr->op!=TK_REGISTER
4887 && sqlite3ExprIsConstantNotJoin(pExpr)
4888 ){
drhf30a9692013-11-15 01:10:18 +00004889 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004890 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004891 }else{
drhf30a9692013-11-15 01:10:18 +00004892 int r1 = sqlite3GetTempReg(pParse);
4893 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4894 if( r2==r1 ){
4895 *pReg = r1;
4896 }else{
4897 sqlite3ReleaseTempReg(pParse, r1);
4898 *pReg = 0;
4899 }
drh2dcef112008-01-12 19:03:48 +00004900 }
4901 return r2;
4902}
4903
4904/*
4905** Generate code that will evaluate expression pExpr and store the
4906** results in register target. The results are guaranteed to appear
4907** in register target.
4908*/
drh05a86c52014-02-16 01:55:49 +00004909void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004910 int inReg;
4911
drhe7375bf2020-03-10 19:24:38 +00004912 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004913 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004914 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004915 if( pParse->pVdbe==0 ) return;
4916 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4917 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004918 u8 op;
drh952f35b2021-10-02 17:46:24 +00004919 if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
drh629b88c2020-01-02 02:50:45 +00004920 op = OP_Copy;
4921 }else{
4922 op = OP_SCopy;
4923 }
4924 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004925 }
drhcce7d172000-05-31 15:34:51 +00004926}
4927
4928/*
drh1c75c9d2015-12-21 15:22:13 +00004929** Make a transient copy of expression pExpr and then code it using
4930** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4931** except that the input expression is guaranteed to be unchanged.
4932*/
4933void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4934 sqlite3 *db = pParse->db;
4935 pExpr = sqlite3ExprDup(db, pExpr, 0);
4936 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4937 sqlite3ExprDelete(db, pExpr);
4938}
4939
4940/*
drh05a86c52014-02-16 01:55:49 +00004941** Generate code that will evaluate expression pExpr and store the
4942** results in register target. The results are guaranteed to appear
4943** in register target. If the expression is constant, then this routine
4944** might choose to code the expression at initialization time.
4945*/
4946void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004947 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004948 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004949 }else{
drh088489e2020-03-10 02:57:37 +00004950 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004951 }
drhcce7d172000-05-31 15:34:51 +00004952}
4953
4954/*
drh268380c2004-02-25 13:47:31 +00004955** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004956** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004957**
drh3df6c3b2017-09-15 15:38:01 +00004958** Return the number of elements evaluated. The number returned will
4959** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4960** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004961**
4962** The SQLITE_ECEL_DUP flag prevents the arguments from being
4963** filled using OP_SCopy. OP_Copy must be used instead.
4964**
4965** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4966** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004967**
4968** The SQLITE_ECEL_REF flag means that expressions in the list with
4969** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4970** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004971** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4972** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004973*/
danielk19774adee202004-05-08 08:23:19 +00004974int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004975 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004976 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004977 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004978 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004979 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004980){
4981 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004982 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004983 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004984 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004985 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004986 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004987 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004988 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004989 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004990 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004991 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004992#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00004993 if( pItem->fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00004994 i--;
4995 n--;
4996 }else
4997#endif
dan257c13f2016-11-10 20:14:06 +00004998 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4999 if( flags & SQLITE_ECEL_OMITREF ){
5000 i--;
5001 n--;
5002 }else{
5003 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
5004 }
drhb8b06692018-08-04 15:16:20 +00005005 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
5006 && sqlite3ExprIsConstantNotJoin(pExpr)
5007 ){
drh9b258c52020-03-11 19:41:49 +00005008 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00005009 }else{
5010 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
5011 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00005012 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00005013 if( copyOp==OP_Copy
5014 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
5015 && pOp->p1+pOp->p3+1==inReg
5016 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00005017 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00005018 ){
5019 pOp->p3++;
5020 }else{
5021 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
5022 }
drhd1a01ed2013-11-21 16:08:52 +00005023 }
drhd1766112008-09-17 00:13:12 +00005024 }
drh268380c2004-02-25 13:47:31 +00005025 }
drhf9b596e2004-05-26 16:54:42 +00005026 return n;
drh268380c2004-02-25 13:47:31 +00005027}
5028
5029/*
drh36c563a2009-11-12 13:32:22 +00005030** Generate code for a BETWEEN operator.
5031**
5032** x BETWEEN y AND z
5033**
5034** The above is equivalent to
5035**
5036** x>=y AND x<=z
5037**
5038** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00005039** elimination of x.
drh84b19a32016-08-20 22:49:28 +00005040**
5041** The xJumpIf parameter determines details:
5042**
5043** NULL: Store the boolean result in reg[dest]
5044** sqlite3ExprIfTrue: Jump to dest if true
5045** sqlite3ExprIfFalse: Jump to dest if false
5046**
5047** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00005048*/
5049static void exprCodeBetween(
5050 Parse *pParse, /* Parsing and code generating context */
5051 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00005052 int dest, /* Jump destination or storage location */
5053 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00005054 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
5055){
dan8b65e592019-07-17 14:34:17 +00005056 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00005057 Expr compLeft; /* The x>=y term */
5058 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00005059 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00005060 Expr *pDel = 0;
5061 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00005062
dan71c57db2016-07-09 20:23:55 +00005063 memset(&compLeft, 0, sizeof(Expr));
5064 memset(&compRight, 0, sizeof(Expr));
5065 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00005066
drha4eeccd2021-10-07 17:43:30 +00005067 assert( ExprUseXList(pExpr) );
dan8b65e592019-07-17 14:34:17 +00005068 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
5069 if( db->mallocFailed==0 ){
5070 exprAnd.op = TK_AND;
5071 exprAnd.pLeft = &compLeft;
5072 exprAnd.pRight = &compRight;
5073 compLeft.op = TK_GE;
5074 compLeft.pLeft = pDel;
5075 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
5076 compRight.op = TK_LE;
5077 compRight.pLeft = pDel;
5078 compRight.pRight = pExpr->x.pList->a[1].pExpr;
5079 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
5080 if( xJump ){
5081 xJump(pParse, &exprAnd, dest, jumpIfNull);
5082 }else{
5083 /* Mark the expression is being from the ON or USING clause of a join
5084 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
5085 ** it into the Parse.pConstExpr list. We should use a new bit for this,
5086 ** for clarity, but we are out of bits in the Expr.flags field so we
drh67a99db2022-05-13 14:52:04 +00005087 ** have to reuse the EP_OuterON bit. Bummer. */
5088 pDel->flags |= EP_OuterON;
dan8b65e592019-07-17 14:34:17 +00005089 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
5090 }
5091 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00005092 }
dan8b65e592019-07-17 14:34:17 +00005093 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00005094
5095 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00005096 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
5097 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
5098 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
5099 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
5100 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5101 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5102 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5103 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00005104 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00005105}
5106
5107/*
drhcce7d172000-05-31 15:34:51 +00005108** Generate code for a boolean expression such that a jump is made
5109** to the label "dest" if the expression is true but execution
5110** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00005111**
5112** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00005113** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00005114**
5115** This code depends on the fact that certain token values (ex: TK_EQ)
5116** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5117** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
5118** the make process cause these values to align. Assert()s in the code
5119** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00005120*/
danielk19774adee202004-05-08 08:23:19 +00005121void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005122 Vdbe *v = pParse->pVdbe;
5123 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005124 int regFree1 = 0;
5125 int regFree2 = 0;
5126 int r1, r2;
5127
drh35573352008-01-08 23:54:25 +00005128 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005129 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005130 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00005131 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005132 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00005133 switch( op ){
drh17180fc2019-04-19 17:26:19 +00005134 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005135 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005136 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5137 if( pAlt!=pExpr ){
5138 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
5139 }else if( op==TK_AND ){
5140 int d2 = sqlite3VdbeMakeLabel(pParse);
5141 testcase( jumpIfNull==0 );
5142 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
5143 jumpIfNull^SQLITE_JUMPIFNULL);
5144 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5145 sqlite3VdbeResolveLabel(v, d2);
5146 }else{
5147 testcase( jumpIfNull==0 );
5148 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5149 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5150 }
drhcce7d172000-05-31 15:34:51 +00005151 break;
5152 }
5153 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00005154 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005155 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005156 break;
5157 }
drh8abed7b2018-02-26 18:49:05 +00005158 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005159 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5160 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00005161 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005162 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005163 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005164 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005165 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005166 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005167 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
5168 isNot ? SQLITE_JUMPIFNULL : 0);
5169 }else{
5170 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5171 isNot ? SQLITE_JUMPIFNULL : 0);
5172 }
drh007c8432018-02-26 03:20:18 +00005173 break;
5174 }
drhde845c22016-03-17 19:07:52 +00005175 case TK_IS:
5176 case TK_ISNOT:
5177 testcase( op==TK_IS );
5178 testcase( op==TK_ISNOT );
5179 op = (op==TK_IS) ? TK_EQ : TK_NE;
5180 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005181 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005182 case TK_LT:
5183 case TK_LE:
5184 case TK_GT:
5185 case TK_GE:
5186 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00005187 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005188 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005189 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005190 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5191 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005192 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005193 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005194 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5195 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5196 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5197 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005198 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5199 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5200 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5201 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5202 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5203 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005204 testcase( regFree1==0 );
5205 testcase( regFree2==0 );
5206 break;
5207 }
drhcce7d172000-05-31 15:34:51 +00005208 case TK_ISNULL:
5209 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005210 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5211 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005212 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5213 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005214 VdbeCoverageIf(v, op==TK_ISNULL);
5215 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005216 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005217 break;
5218 }
drhfef52082000-06-06 01:50:43 +00005219 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005220 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005221 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005222 break;
5223 }
drh84e30ca2011-02-10 17:46:14 +00005224#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005225 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005226 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005227 int destIfNull = jumpIfNull ? dest : destIfFalse;
5228 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005229 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005230 sqlite3VdbeResolveLabel(v, destIfFalse);
5231 break;
5232 }
shanehbb201342011-02-09 19:55:20 +00005233#endif
drhcce7d172000-05-31 15:34:51 +00005234 default: {
dan7b35a772016-07-28 19:47:15 +00005235 default_expr:
drhad317272019-04-19 16:21:51 +00005236 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005237 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005238 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005239 /* No-op */
5240 }else{
5241 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5242 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005243 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005244 testcase( regFree1==0 );
5245 testcase( jumpIfNull==0 );
5246 }
drhcce7d172000-05-31 15:34:51 +00005247 break;
5248 }
5249 }
drh2dcef112008-01-12 19:03:48 +00005250 sqlite3ReleaseTempReg(pParse, regFree1);
5251 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005252}
5253
5254/*
drh66b89c82000-11-28 20:47:17 +00005255** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005256** to the label "dest" if the expression is false but execution
5257** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005258**
5259** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005260** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5261** is 0.
drhcce7d172000-05-31 15:34:51 +00005262*/
danielk19774adee202004-05-08 08:23:19 +00005263void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005264 Vdbe *v = pParse->pVdbe;
5265 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005266 int regFree1 = 0;
5267 int regFree2 = 0;
5268 int r1, r2;
5269
drh35573352008-01-08 23:54:25 +00005270 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005271 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005272 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005273 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005274
5275 /* The value of pExpr->op and op are related as follows:
5276 **
5277 ** pExpr->op op
5278 ** --------- ----------
5279 ** TK_ISNULL OP_NotNull
5280 ** TK_NOTNULL OP_IsNull
5281 ** TK_NE OP_Eq
5282 ** TK_EQ OP_Ne
5283 ** TK_GT OP_Le
5284 ** TK_LE OP_Gt
5285 ** TK_GE OP_Lt
5286 ** TK_LT OP_Ge
5287 **
5288 ** For other values of pExpr->op, op is undefined and unused.
5289 ** The value of TK_ and OP_ constants are arranged such that we
5290 ** can compute the mapping above using the following expression.
5291 ** Assert()s verify that the computation is correct.
5292 */
5293 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5294
5295 /* Verify correct alignment of TK_ and OP_ constants
5296 */
5297 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5298 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5299 assert( pExpr->op!=TK_NE || op==OP_Eq );
5300 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5301 assert( pExpr->op!=TK_LT || op==OP_Ge );
5302 assert( pExpr->op!=TK_LE || op==OP_Gt );
5303 assert( pExpr->op!=TK_GT || op==OP_Le );
5304 assert( pExpr->op!=TK_GE || op==OP_Lt );
5305
danba00e302016-07-23 20:24:06 +00005306 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005307 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005308 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005309 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5310 if( pAlt!=pExpr ){
5311 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5312 }else if( pExpr->op==TK_AND ){
5313 testcase( jumpIfNull==0 );
5314 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5315 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5316 }else{
5317 int d2 = sqlite3VdbeMakeLabel(pParse);
5318 testcase( jumpIfNull==0 );
5319 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5320 jumpIfNull^SQLITE_JUMPIFNULL);
5321 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5322 sqlite3VdbeResolveLabel(v, d2);
5323 }
drhcce7d172000-05-31 15:34:51 +00005324 break;
5325 }
5326 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005327 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005328 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005329 break;
5330 }
drh8abed7b2018-02-26 18:49:05 +00005331 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005332 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5333 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005334 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005335 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005336 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005337 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005338 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005339 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005340 /* IS TRUE and IS NOT FALSE */
5341 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5342 isNot ? 0 : SQLITE_JUMPIFNULL);
5343
5344 }else{
5345 /* IS FALSE and IS NOT TRUE */
5346 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005347 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005348 }
drh007c8432018-02-26 03:20:18 +00005349 break;
5350 }
drhde845c22016-03-17 19:07:52 +00005351 case TK_IS:
5352 case TK_ISNOT:
5353 testcase( pExpr->op==TK_IS );
5354 testcase( pExpr->op==TK_ISNOT );
5355 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5356 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005357 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005358 case TK_LT:
5359 case TK_LE:
5360 case TK_GT:
5361 case TK_GE:
5362 case TK_NE:
5363 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005364 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005365 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005366 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5367 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005368 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005369 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005370 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5371 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5372 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5373 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005374 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5375 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5376 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5377 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5378 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5379 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005380 testcase( regFree1==0 );
5381 testcase( regFree2==0 );
5382 break;
5383 }
drhcce7d172000-05-31 15:34:51 +00005384 case TK_ISNULL:
5385 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005386 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5387 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005388 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5389 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005390 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005391 break;
5392 }
drhfef52082000-06-06 01:50:43 +00005393 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005394 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005395 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005396 break;
5397 }
drh84e30ca2011-02-10 17:46:14 +00005398#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005399 case TK_IN: {
5400 if( jumpIfNull ){
5401 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5402 }else{
drhec4ccdb2018-12-29 02:26:59 +00005403 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005404 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5405 sqlite3VdbeResolveLabel(v, destIfNull);
5406 }
5407 break;
5408 }
shanehbb201342011-02-09 19:55:20 +00005409#endif
drhcce7d172000-05-31 15:34:51 +00005410 default: {
danba00e302016-07-23 20:24:06 +00005411 default_expr:
drhad317272019-04-19 16:21:51 +00005412 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005413 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005414 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005415 /* no-op */
5416 }else{
5417 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5418 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005419 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005420 testcase( regFree1==0 );
5421 testcase( jumpIfNull==0 );
5422 }
drhcce7d172000-05-31 15:34:51 +00005423 break;
5424 }
5425 }
drh2dcef112008-01-12 19:03:48 +00005426 sqlite3ReleaseTempReg(pParse, regFree1);
5427 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005428}
drh22827922000-06-06 17:27:05 +00005429
5430/*
drh72bc8202015-06-11 13:58:35 +00005431** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5432** code generation, and that copy is deleted after code generation. This
5433** ensures that the original pExpr is unchanged.
5434*/
5435void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5436 sqlite3 *db = pParse->db;
5437 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5438 if( db->mallocFailed==0 ){
5439 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5440 }
5441 sqlite3ExprDelete(db, pCopy);
5442}
5443
dan5aa550c2017-06-24 18:10:29 +00005444/*
5445** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5446** type of expression.
5447**
5448** If pExpr is a simple SQL value - an integer, real, string, blob
5449** or NULL value - then the VDBE currently being prepared is configured
5450** to re-prepare each time a new value is bound to variable pVar.
5451**
5452** Additionally, if pExpr is a simple SQL value and the value is the
5453** same as that currently bound to variable pVar, non-zero is returned.
5454** Otherwise, if the values are not the same or if pExpr is not a simple
5455** SQL value, zero is returned.
5456*/
drh1580d502021-09-25 17:07:57 +00005457static int exprCompareVariable(
5458 const Parse *pParse,
5459 const Expr *pVar,
5460 const Expr *pExpr
5461){
dan5aa550c2017-06-24 18:10:29 +00005462 int res = 0;
drhc0804222017-06-28 21:47:16 +00005463 int iVar;
5464 sqlite3_value *pL, *pR = 0;
5465
5466 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5467 if( pR ){
5468 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005469 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005470 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005471 if( pL ){
5472 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5473 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5474 }
5475 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005476 }
drhc0804222017-06-28 21:47:16 +00005477 sqlite3ValueFree(pR);
5478 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005479 }
5480
5481 return res;
5482}
drh72bc8202015-06-11 13:58:35 +00005483
5484/*
drh1d9da702010-01-07 15:17:02 +00005485** Do a deep comparison of two expression trees. Return 0 if the two
5486** expressions are completely identical. Return 1 if they differ only
5487** by a COLLATE operator at the top level. Return 2 if there are differences
5488** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005489**
drh619a1302013-08-01 13:04:46 +00005490** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5491** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5492**
drh66518ca2013-08-01 15:09:57 +00005493** The pA side might be using TK_REGISTER. If that is the case and pB is
5494** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5495**
drh1d9da702010-01-07 15:17:02 +00005496** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005497** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005498** identical, we return 2 just to be safe. So if this routine
5499** returns 2, then you do not really know for certain if the two
5500** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005501** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005502** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005503** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005504** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005505**
drhc0804222017-06-28 21:47:16 +00005506** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5507** pParse->pReprepare can be matched against literals in pB. The
5508** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5509** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5510** Argument pParse should normally be NULL. If it is not NULL and pA or
5511** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005512*/
drh1580d502021-09-25 17:07:57 +00005513int sqlite3ExprCompare(
5514 const Parse *pParse,
5515 const Expr *pA,
5516 const Expr *pB,
5517 int iTab
5518){
drh10d1edf2013-11-15 15:52:39 +00005519 u32 combinedFlags;
5520 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005521 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005522 }
dan5aa550c2017-06-24 18:10:29 +00005523 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5524 return 0;
5525 }
drh10d1edf2013-11-15 15:52:39 +00005526 combinedFlags = pA->flags | pB->flags;
5527 if( combinedFlags & EP_IntValue ){
5528 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5529 return 0;
5530 }
drh1d9da702010-01-07 15:17:02 +00005531 return 2;
drh22827922000-06-06 17:27:05 +00005532 }
dan16dd3982018-12-20 15:04:38 +00005533 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005534 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005535 return 1;
5536 }
dan5aa550c2017-06-24 18:10:29 +00005537 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005538 return 1;
5539 }
5540 return 2;
5541 }
drha51e6002021-11-19 19:11:58 +00005542 assert( !ExprHasProperty(pA, EP_IntValue) );
5543 assert( !ExprHasProperty(pB, EP_IntValue) );
5544 if( pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005545 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005546 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005547#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005548 assert( pA->op==pB->op );
5549 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5550 return 2;
5551 }
drheda079c2018-09-20 19:02:15 +00005552 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005553 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5554 return 2;
5555 }
drheda079c2018-09-20 19:02:15 +00005556 }
5557#endif
drhf20bbc52019-01-17 01:06:00 +00005558 }else if( pA->op==TK_NULL ){
5559 return 0;
drhd5af5422018-04-13 14:27:01 +00005560 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005561 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drha51e6002021-11-19 19:11:58 +00005562 }else
5563 if( pB->u.zToken!=0
5564 && pA->op!=TK_COLUMN
5565 && pA->op!=TK_AGG_COLUMN
5566 && strcmp(pA->u.zToken,pB->u.zToken)!=0
5567 ){
drhd5af5422018-04-13 14:27:01 +00005568 return 2;
drh2646da72005-12-09 20:02:05 +00005569 }
drh22827922000-06-06 17:27:05 +00005570 }
drh898c5272019-10-22 00:03:41 +00005571 if( (pA->flags & (EP_Distinct|EP_Commuted))
5572 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005573 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005574 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005575 if( (combinedFlags & EP_FixedCol)==0
5576 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005577 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005578 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005579 if( pA->op!=TK_STRING
5580 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005581 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005582 ){
drh10d1edf2013-11-15 15:52:39 +00005583 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005584 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005585 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5586 return 2;
5587 }
drh10d1edf2013-11-15 15:52:39 +00005588 }
5589 }
drh1d9da702010-01-07 15:17:02 +00005590 return 0;
drh22827922000-06-06 17:27:05 +00005591}
5592
drh8c6f6662010-04-26 19:17:26 +00005593/*
danfbb6e9f2020-01-09 20:11:29 +00005594** Compare two ExprList objects. Return 0 if they are identical, 1
5595** if they are certainly different, or 2 if it is not possible to
5596** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005597**
drh619a1302013-08-01 13:04:46 +00005598** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5599** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5600**
drh8c6f6662010-04-26 19:17:26 +00005601** This routine might return non-zero for equivalent ExprLists. The
5602** only consequence will be disabled optimizations. But this routine
5603** must never return 0 if the two ExprList objects are different, or
5604** a malfunction will result.
5605**
5606** Two NULL pointers are considered to be the same. But a NULL pointer
5607** always differs from a non-NULL pointer.
5608*/
drh1580d502021-09-25 17:07:57 +00005609int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005610 int i;
5611 if( pA==0 && pB==0 ) return 0;
5612 if( pA==0 || pB==0 ) return 1;
5613 if( pA->nExpr!=pB->nExpr ) return 1;
5614 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005615 int res;
drh8c6f6662010-04-26 19:17:26 +00005616 Expr *pExprA = pA->a[i].pExpr;
5617 Expr *pExprB = pB->a[i].pExpr;
drhd88fd532022-05-02 20:49:30 +00005618 if( pA->a[i].fg.sortFlags!=pB->a[i].fg.sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005619 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005620 }
5621 return 0;
5622}
drh13449892005-09-07 21:22:45 +00005623
drh22827922000-06-06 17:27:05 +00005624/*
drhf9463df2017-02-11 14:59:58 +00005625** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5626** are ignored.
5627*/
drh1580d502021-09-25 17:07:57 +00005628int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005629 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005630 sqlite3ExprSkipCollateAndLikely(pA),
5631 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005632 iTab);
5633}
5634
5635/*
drhc51cf862019-05-11 19:36:03 +00005636** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005637**
5638** Or if seenNot is true, return non-zero if Expr p can only be
5639** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005640*/
5641static int exprImpliesNotNull(
drh1580d502021-09-25 17:07:57 +00005642 const Parse *pParse,/* Parsing context */
5643 const Expr *p, /* The expression to be checked */
5644 const Expr *pNN, /* The expression that is NOT NULL */
drhc51cf862019-05-11 19:36:03 +00005645 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005646 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005647){
5648 assert( p );
5649 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005650 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5651 return pNN->op!=TK_NULL;
5652 }
drhc51cf862019-05-11 19:36:03 +00005653 switch( p->op ){
5654 case TK_IN: {
5655 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
drha4eeccd2021-10-07 17:43:30 +00005656 assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005657 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005658 }
5659 case TK_BETWEEN: {
drha4eeccd2021-10-07 17:43:30 +00005660 ExprList *pList;
5661 assert( ExprUseXList(p) );
5662 pList = p->x.pList;
drhc51cf862019-05-11 19:36:03 +00005663 assert( pList!=0 );
5664 assert( pList->nExpr==2 );
5665 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005666 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5667 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005668 ){
5669 return 1;
5670 }
drh7a231b42019-08-30 15:11:08 +00005671 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005672 }
5673 case TK_EQ:
5674 case TK_NE:
5675 case TK_LT:
5676 case TK_LE:
5677 case TK_GT:
5678 case TK_GE:
5679 case TK_PLUS:
5680 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005681 case TK_BITOR:
5682 case TK_LSHIFT:
5683 case TK_RSHIFT:
5684 case TK_CONCAT:
5685 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005686 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005687 case TK_STAR:
5688 case TK_REM:
5689 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005690 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005691 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005692 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005693 }
5694 case TK_SPAN:
5695 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005696 case TK_UPLUS:
5697 case TK_UMINUS: {
5698 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5699 }
5700 case TK_TRUTH: {
5701 if( seenNot ) return 0;
5702 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005703 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005704 }
dan1cd382e2019-08-29 15:06:35 +00005705 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005706 case TK_NOT: {
5707 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5708 }
5709 }
5710 return 0;
5711}
5712
5713/*
drh4bd5f732013-07-31 23:22:39 +00005714** Return true if we can prove the pE2 will always be true if pE1 is
5715** true. Return false if we cannot complete the proof or if pE2 might
5716** be false. Examples:
5717**
drh619a1302013-08-01 13:04:46 +00005718** pE1: x==5 pE2: x==5 Result: true
5719** pE1: x>0 pE2: x==5 Result: false
5720** pE1: x=21 pE2: x=21 OR y=43 Result: true
5721** pE1: x!=123 pE2: x IS NOT NULL Result: true
5722** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5723** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5724** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005725**
5726** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5727** Expr.iTable<0 then assume a table number given by iTab.
5728**
drhc0804222017-06-28 21:47:16 +00005729** If pParse is not NULL, then the values of bound variables in pE1 are
5730** compared against literal values in pE2 and pParse->pVdbe->expmask is
5731** modified to record which bound variables are referenced. If pParse
5732** is NULL, then false will be returned if pE1 contains any bound variables.
5733**
drh4bd5f732013-07-31 23:22:39 +00005734** When in doubt, return false. Returning true might give a performance
5735** improvement. Returning false might cause a performance reduction, but
5736** it will always give the correct answer and is hence always safe.
5737*/
drh1580d502021-09-25 17:07:57 +00005738int sqlite3ExprImpliesExpr(
5739 const Parse *pParse,
5740 const Expr *pE1,
5741 const Expr *pE2,
5742 int iTab
5743){
dan5aa550c2017-06-24 18:10:29 +00005744 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005745 return 1;
5746 }
5747 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005748 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5749 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005750 ){
5751 return 1;
5752 }
drh664d6d12019-05-04 17:32:07 +00005753 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005754 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005755 ){
drhc51cf862019-05-11 19:36:03 +00005756 return 1;
drh619a1302013-08-01 13:04:46 +00005757 }
5758 return 0;
drh4bd5f732013-07-31 23:22:39 +00005759}
5760
5761/*
drh6c68d752019-11-04 02:05:52 +00005762** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005763** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005764** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5765**
5766** This routine controls an optimization. False positives (setting
5767** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5768** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005769*/
5770static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005771 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005772 testcase( pExpr->op==TK_AGG_FUNCTION );
drh67a99db2022-05-13 14:52:04 +00005773 if( ExprHasProperty(pExpr, EP_OuterON) ) return WRC_Prune;
drh25897872018-03-20 21:16:15 +00005774 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005775 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005776 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005777 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005778 case TK_IS:
5779 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005780 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005781 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005782 case TK_IN:
drh25897872018-03-20 21:16:15 +00005783 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005784 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005785 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005786 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005787 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005788 testcase( pExpr->op==TK_IS );
5789 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005790 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005791 testcase( pExpr->op==TK_CASE );
5792 testcase( pExpr->op==TK_IN );
5793 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005794 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005795 return WRC_Prune;
5796 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005797 if( pWalker->u.iCur==pExpr->iTable ){
5798 pWalker->eCode = 1;
5799 return WRC_Abort;
5800 }
5801 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005802
dan9d23ea72019-08-29 19:34:29 +00005803 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005804 if( pWalker->eCode==0 ){
5805 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5806 if( pWalker->eCode ){
5807 pWalker->eCode = 0;
5808 sqlite3WalkExpr(pWalker, pExpr->pRight);
5809 }
dan9d23ea72019-08-29 19:34:29 +00005810 }
5811 return WRC_Prune;
5812
5813 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005814 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5815 assert( pWalker->eCode );
5816 return WRC_Abort;
5817 }
dan9d23ea72019-08-29 19:34:29 +00005818 return WRC_Prune;
5819
drh98811552018-04-03 14:04:48 +00005820 /* Virtual tables are allowed to use constraints like x=NULL. So
5821 ** a term of the form x=y does not prove that y is not null if x
5822 ** is the column of a virtual table */
5823 case TK_EQ:
5824 case TK_NE:
5825 case TK_LT:
5826 case TK_LE:
5827 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005828 case TK_GE: {
5829 Expr *pLeft = pExpr->pLeft;
5830 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005831 testcase( pExpr->op==TK_EQ );
5832 testcase( pExpr->op==TK_NE );
5833 testcase( pExpr->op==TK_LT );
5834 testcase( pExpr->op==TK_LE );
5835 testcase( pExpr->op==TK_GT );
5836 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005837 /* The y.pTab=0 assignment in wherecode.c always happens after the
5838 ** impliesNotNullRow() test */
drh477572b2021-10-07 20:46:29 +00005839 assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
5840 assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
5841 if( (pLeft->op==TK_COLUMN
5842 && pLeft->y.pTab!=0
5843 && IsVirtual(pLeft->y.pTab))
5844 || (pRight->op==TK_COLUMN
5845 && pRight->y.pTab!=0
5846 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005847 ){
drh78d1d222020-02-17 19:25:07 +00005848 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005849 }
drh08b92082020-08-10 14:18:00 +00005850 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005851 }
drh25897872018-03-20 21:16:15 +00005852 default:
5853 return WRC_Continue;
5854 }
5855}
5856
5857/*
5858** Return true (non-zero) if expression p can only be true if at least
5859** one column of table iTab is non-null. In other words, return true
5860** if expression p will always be NULL or false if every column of iTab
5861** is NULL.
5862**
drh821b6102018-03-24 18:01:51 +00005863** False negatives are acceptable. In other words, it is ok to return
5864** zero even if expression p will never be true of every column of iTab
5865** is NULL. A false negative is merely a missed optimization opportunity.
5866**
5867** False positives are not allowed, however. A false positive may result
5868** in an incorrect answer.
5869**
drh67a99db2022-05-13 14:52:04 +00005870** Terms of p that are marked with EP_OuterON (and hence that come from
drhb77c07a2022-04-11 11:59:25 +00005871** the ON or USING clauses of OUTER JOINS) are excluded from the analysis.
drh25897872018-03-20 21:16:15 +00005872**
5873** This routine is used to check if a LEFT JOIN can be converted into
5874** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5875** clause requires that some column of the right table of the LEFT JOIN
5876** be non-NULL, then the LEFT JOIN can be safely converted into an
5877** ordinary join.
5878*/
5879int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5880 Walker w;
drh0d950af2019-08-22 16:38:42 +00005881 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005882 if( p==0 ) return 0;
5883 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005884 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005885 }else{
5886 while( p->op==TK_AND ){
5887 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5888 p = p->pRight;
5889 }
drhd6db6592019-04-01 19:42:42 +00005890 }
drh25897872018-03-20 21:16:15 +00005891 w.xExprCallback = impliesNotNullRow;
5892 w.xSelectCallback = 0;
5893 w.xSelectCallback2 = 0;
5894 w.eCode = 0;
5895 w.u.iCur = iTab;
5896 sqlite3WalkExpr(&w, p);
5897 return w.eCode;
5898}
5899
5900/*
drh030796d2012-08-23 16:18:10 +00005901** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005902** to determine if an expression can be evaluated by reference to the
5903** index only, without having to do a search for the corresponding
5904** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5905** is the cursor for the table.
5906*/
5907struct IdxCover {
5908 Index *pIdx; /* The index to be tested for coverage */
5909 int iCur; /* Cursor number for the table corresponding to the index */
5910};
5911
5912/*
5913** Check to see if there are references to columns in table
5914** pWalker->u.pIdxCover->iCur can be satisfied using the index
5915** pWalker->u.pIdxCover->pIdx.
5916*/
5917static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5918 if( pExpr->op==TK_COLUMN
5919 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005920 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005921 ){
5922 pWalker->eCode = 1;
5923 return WRC_Abort;
5924 }
5925 return WRC_Continue;
5926}
5927
5928/*
drhe604ec02016-07-27 19:20:58 +00005929** Determine if an index pIdx on table with cursor iCur contains will
5930** the expression pExpr. Return true if the index does cover the
5931** expression and false if the pExpr expression references table columns
5932** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005933**
5934** An index covering an expression means that the expression can be
5935** evaluated using only the index and without having to lookup the
5936** corresponding table entry.
5937*/
5938int sqlite3ExprCoveredByIndex(
5939 Expr *pExpr, /* The index to be tested */
5940 int iCur, /* The cursor number for the corresponding table */
5941 Index *pIdx /* The index that might be used for coverage */
5942){
5943 Walker w;
5944 struct IdxCover xcov;
5945 memset(&w, 0, sizeof(w));
5946 xcov.iCur = iCur;
5947 xcov.pIdx = pIdx;
5948 w.xExprCallback = exprIdxCover;
5949 w.u.pIdxCover = &xcov;
5950 sqlite3WalkExpr(&w, pExpr);
5951 return !w.eCode;
5952}
5953
5954
drh90cf38b2021-11-08 23:24:00 +00005955/* Structure used to pass information throught the Walker in order to
5956** implement sqlite3ReferencesSrcList().
drh374fdce2012-04-17 16:38:53 +00005957*/
drh90cf38b2021-11-08 23:24:00 +00005958struct RefSrcList {
5959 sqlite3 *db; /* Database connection used for sqlite3DbRealloc() */
5960 SrcList *pRef; /* Looking for references to these tables */
drh913306a2021-11-26 17:10:18 +00005961 i64 nExclude; /* Number of tables to exclude from the search */
drh90cf38b2021-11-08 23:24:00 +00005962 int *aiExclude; /* Cursor IDs for tables to exclude from the search */
drh030796d2012-08-23 16:18:10 +00005963};
5964
5965/*
drh90cf38b2021-11-08 23:24:00 +00005966** Walker SELECT callbacks for sqlite3ReferencesSrcList().
5967**
5968** When entering a new subquery on the pExpr argument, add all FROM clause
5969** entries for that subquery to the exclude list.
5970**
5971** When leaving the subquery, remove those entries from the exclude list.
daned41a962020-06-09 17:45:48 +00005972*/
drh90cf38b2021-11-08 23:24:00 +00005973static int selectRefEnter(Walker *pWalker, Select *pSelect){
5974 struct RefSrcList *p = pWalker->u.pRefSrcList;
5975 SrcList *pSrc = pSelect->pSrc;
drh913306a2021-11-26 17:10:18 +00005976 i64 i, j;
5977 int *piNew;
drh90cf38b2021-11-08 23:24:00 +00005978 if( pSrc->nSrc==0 ) return WRC_Continue;
5979 j = p->nExclude;
5980 p->nExclude += pSrc->nSrc;
5981 piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
5982 if( piNew==0 ){
5983 p->nExclude = 0;
5984 return WRC_Abort;
5985 }else{
5986 p->aiExclude = piNew;
5987 }
5988 for(i=0; i<pSrc->nSrc; i++, j++){
5989 p->aiExclude[j] = pSrc->a[i].iCursor;
daned41a962020-06-09 17:45:48 +00005990 }
5991 return WRC_Continue;
5992}
drh90cf38b2021-11-08 23:24:00 +00005993static void selectRefLeave(Walker *pWalker, Select *pSelect){
5994 struct RefSrcList *p = pWalker->u.pRefSrcList;
5995 SrcList *pSrc = pSelect->pSrc;
5996 if( p->nExclude ){
5997 assert( p->nExclude>=pSrc->nSrc );
5998 p->nExclude -= pSrc->nSrc;
5999 }
6000}
daned41a962020-06-09 17:45:48 +00006001
drh90cf38b2021-11-08 23:24:00 +00006002/* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
6003**
6004** Set the 0x01 bit of pWalker->eCode if there is a reference to any
6005** of the tables shown in RefSrcList.pRef.
6006**
6007** Set the 0x02 bit of pWalker->eCode if there is a reference to a
6008** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
drh030796d2012-08-23 16:18:10 +00006009*/
drh90cf38b2021-11-08 23:24:00 +00006010static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
6011 if( pExpr->op==TK_COLUMN
6012 || pExpr->op==TK_AGG_COLUMN
6013 ){
drh374fdce2012-04-17 16:38:53 +00006014 int i;
drh90cf38b2021-11-08 23:24:00 +00006015 struct RefSrcList *p = pWalker->u.pRefSrcList;
6016 SrcList *pSrc = p->pRef;
drh655814d2015-01-09 01:27:29 +00006017 int nSrc = pSrc ? pSrc->nSrc : 0;
6018 for(i=0; i<nSrc; i++){
drh90cf38b2021-11-08 23:24:00 +00006019 if( pExpr->iTable==pSrc->a[i].iCursor ){
6020 pWalker->eCode |= 1;
6021 return WRC_Continue;
6022 }
drh374fdce2012-04-17 16:38:53 +00006023 }
drh90cf38b2021-11-08 23:24:00 +00006024 for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
6025 if( i>=p->nExclude ){
6026 pWalker->eCode |= 2;
drh030796d2012-08-23 16:18:10 +00006027 }
drh374fdce2012-04-17 16:38:53 +00006028 }
drh030796d2012-08-23 16:18:10 +00006029 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00006030}
6031
6032/*
drh90cf38b2021-11-08 23:24:00 +00006033** Check to see if pExpr references any tables in pSrcList.
6034** Possible return values:
6035**
6036** 1 pExpr does references a table in pSrcList.
6037**
6038** 0 pExpr references some table that is not defined in either
6039** pSrcList or in subqueries of pExpr itself.
6040**
6041** -1 pExpr only references no tables at all, or it only
6042** references tables defined in subqueries of pExpr itself.
6043**
6044** As currently used, pExpr is always an aggregate function call. That
6045** fact is exploited for efficiency.
drh374fdce2012-04-17 16:38:53 +00006046*/
drh90cf38b2021-11-08 23:24:00 +00006047int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00006048 Walker w;
drh90cf38b2021-11-08 23:24:00 +00006049 struct RefSrcList x;
drh80f6bfc2019-08-31 20:13:30 +00006050 memset(&w, 0, sizeof(w));
drh90cf38b2021-11-08 23:24:00 +00006051 memset(&x, 0, sizeof(x));
6052 w.xExprCallback = exprRefToSrcList;
6053 w.xSelectCallback = selectRefEnter;
6054 w.xSelectCallback2 = selectRefLeave;
6055 w.u.pRefSrcList = &x;
6056 x.db = pParse->db;
6057 x.pRef = pSrcList;
6058 assert( pExpr->op==TK_AGG_FUNCTION );
drha4eeccd2021-10-07 17:43:30 +00006059 assert( ExprUseXList(pExpr) );
drh030796d2012-08-23 16:18:10 +00006060 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00006061#ifndef SQLITE_OMIT_WINDOWFUNC
6062 if( ExprHasProperty(pExpr, EP_WinFunc) ){
6063 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
6064 }
6065#endif
drh90cf38b2021-11-08 23:24:00 +00006066 sqlite3DbFree(pParse->db, x.aiExclude);
6067 if( w.eCode & 0x01 ){
6068 return 1;
6069 }else if( w.eCode ){
6070 return 0;
6071 }else{
6072 return -1;
6073 }
drh374fdce2012-04-17 16:38:53 +00006074}
6075
6076/*
drh89636622020-06-07 17:33:18 +00006077** This is a Walker expression node callback.
6078**
6079** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
6080** object that is referenced does not refer directly to the Expr. If
6081** it does, make a copy. This is done because the pExpr argument is
6082** subject to change.
6083**
6084** The copy is stored on pParse->pConstExpr with a register number of 0.
6085** This will cause the expression to be deleted automatically when the
6086** Parse object is destroyed, but the zero register number means that it
6087** will not generate any code in the preamble.
6088*/
6089static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00006090 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00006091 && pExpr->pAggInfo!=0
6092 ){
6093 AggInfo *pAggInfo = pExpr->pAggInfo;
6094 int iAgg = pExpr->iAgg;
6095 Parse *pParse = pWalker->pParse;
6096 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00006097 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
6098 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00006099 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00006100 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006101 pExpr = sqlite3ExprDup(db, pExpr, 0);
6102 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006103 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006104 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006105 }
6106 }
6107 }else{
6108 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00006109 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006110 pExpr = sqlite3ExprDup(db, pExpr, 0);
6111 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006112 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006113 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006114 }
6115 }
6116 }
6117 }
6118 return WRC_Continue;
6119}
6120
6121/*
6122** Initialize a Walker object so that will persist AggInfo entries referenced
6123** by the tree that is walked.
6124*/
6125void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
6126 memset(pWalker, 0, sizeof(*pWalker));
6127 pWalker->pParse = pParse;
6128 pWalker->xExprCallback = agginfoPersistExprCb;
6129 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
6130}
6131
6132/*
drh13449892005-09-07 21:22:45 +00006133** Add a new element to the pAggInfo->aCol[] array. Return the index of
6134** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00006135*/
drh17435752007-08-16 04:30:38 +00006136static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006137 int i;
drhcf643722007-03-27 13:36:37 +00006138 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006139 db,
drhcf643722007-03-27 13:36:37 +00006140 pInfo->aCol,
6141 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00006142 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00006143 &i
6144 );
drh13449892005-09-07 21:22:45 +00006145 return i;
6146}
6147
6148/*
6149** Add a new element to the pAggInfo->aFunc[] array. Return the index of
6150** the new element. Return a negative number if malloc fails.
6151*/
drh17435752007-08-16 04:30:38 +00006152static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006153 int i;
drhcf643722007-03-27 13:36:37 +00006154 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006155 db,
drhcf643722007-03-27 13:36:37 +00006156 pInfo->aFunc,
6157 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00006158 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00006159 &i
6160 );
drh13449892005-09-07 21:22:45 +00006161 return i;
drh89636622020-06-07 17:33:18 +00006162}
drh22827922000-06-06 17:27:05 +00006163
6164/*
drh7d10d5a2008-08-20 16:35:10 +00006165** This is the xExprCallback for a tree walker. It is used to
6166** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00006167** for additional information.
drh22827922000-06-06 17:27:05 +00006168*/
drh7d10d5a2008-08-20 16:35:10 +00006169static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00006170 int i;
drh7d10d5a2008-08-20 16:35:10 +00006171 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00006172 Parse *pParse = pNC->pParse;
6173 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00006174 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00006175
drh25c3b8c2018-04-16 10:34:13 +00006176 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00006177 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00006178 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00006179 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00006180 testcase( pExpr->op==TK_AGG_COLUMN );
6181 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00006182 /* Check to see if the column is in one of the tables in the FROM
6183 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00006184 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00006185 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00006186 for(i=0; i<pSrcList->nSrc; i++, pItem++){
6187 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00006188 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00006189 if( pExpr->iTable==pItem->iCursor ){
6190 /* If we reach this point, it means that pExpr refers to a table
6191 ** that is in the FROM clause of the aggregate query.
6192 **
6193 ** Make an entry for the column in pAggInfo->aCol[] if there
6194 ** is not an entry there already.
6195 */
drh7f906d62007-03-12 23:48:52 +00006196 int k;
drh13449892005-09-07 21:22:45 +00006197 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00006198 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00006199 if( pCol->iTable==pExpr->iTable &&
6200 pCol->iColumn==pExpr->iColumn ){
6201 break;
6202 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006203 }
danielk19771e536952007-08-16 10:09:01 +00006204 if( (k>=pAggInfo->nColumn)
6205 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
6206 ){
drh7f906d62007-03-12 23:48:52 +00006207 pCol = &pAggInfo->aCol[k];
drh477572b2021-10-07 20:46:29 +00006208 assert( ExprUseYTab(pExpr) );
drheda079c2018-09-20 19:02:15 +00006209 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00006210 pCol->iTable = pExpr->iTable;
6211 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00006212 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00006213 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00006214 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00006215 if( pAggInfo->pGroupBy ){
6216 int j, n;
6217 ExprList *pGB = pAggInfo->pGroupBy;
6218 struct ExprList_item *pTerm = pGB->a;
6219 n = pGB->nExpr;
6220 for(j=0; j<n; j++, pTerm++){
6221 Expr *pE = pTerm->pExpr;
6222 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
6223 pE->iColumn==pExpr->iColumn ){
6224 pCol->iSorterColumn = j;
6225 break;
6226 }
6227 }
6228 }
6229 if( pCol->iSorterColumn<0 ){
6230 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
6231 }
6232 }
6233 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
6234 ** because it was there before or because we just created it).
6235 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
6236 ** pAggInfo->aCol[] entry.
6237 */
drhebb6a652013-09-12 23:42:22 +00006238 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00006239 pExpr->pAggInfo = pAggInfo;
6240 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00006241 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00006242 break;
6243 } /* endif pExpr->iTable==pItem->iCursor */
6244 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00006245 }
drh7d10d5a2008-08-20 16:35:10 +00006246 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00006247 }
6248 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00006249 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00006250 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00006251 ){
drh13449892005-09-07 21:22:45 +00006252 /* Check to see if pExpr is a duplicate of another aggregate
6253 ** function that is already in the pAggInfo structure
6254 */
6255 struct AggInfo_func *pItem = pAggInfo->aFunc;
6256 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan19e4eef2021-06-03 18:56:42 +00006257 if( pItem->pFExpr==pExpr ) break;
drh81185a52020-06-09 13:38:12 +00006258 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00006259 break;
6260 }
drh22827922000-06-06 17:27:05 +00006261 }
drh13449892005-09-07 21:22:45 +00006262 if( i>=pAggInfo->nFunc ){
6263 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
6264 */
danielk197714db2662006-01-09 16:12:04 +00006265 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006266 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006267 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006268 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006269 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006270 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00006271 pItem->iMem = ++pParse->nMem;
drha4eeccd2021-10-07 17:43:30 +00006272 assert( ExprUseUToken(pExpr) );
drh13449892005-09-07 21:22:45 +00006273 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006274 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006275 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006276 if( pExpr->flags & EP_Distinct ){
6277 pItem->iDistinct = pParse->nTab++;
6278 }else{
6279 pItem->iDistinct = -1;
6280 }
drh13449892005-09-07 21:22:45 +00006281 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006282 }
drh13449892005-09-07 21:22:45 +00006283 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6284 */
drhc5cd1242013-09-12 16:50:49 +00006285 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006286 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006287 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006288 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006289 return WRC_Prune;
6290 }else{
6291 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006292 }
drh22827922000-06-06 17:27:05 +00006293 }
6294 }
drh7d10d5a2008-08-20 16:35:10 +00006295 return WRC_Continue;
6296}
drh626a8792005-01-17 22:08:19 +00006297
6298/*
drhe8abb4c2012-11-02 18:24:57 +00006299** Analyze the pExpr expression looking for aggregate functions and
6300** for variables that need to be added to AggInfo object that pNC->pAggInfo
6301** points to. Additional entries are made on the AggInfo object as
6302** necessary.
drh626a8792005-01-17 22:08:19 +00006303**
6304** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006305** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006306*/
drhd2b3e232008-01-23 14:51:49 +00006307void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006308 Walker w;
6309 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006310 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6311 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006312 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006313 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006314 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006315 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006316 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006317}
drh5d9a4af2005-08-30 00:54:01 +00006318
6319/*
6320** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6321** expression list. Return the number of errors.
6322**
6323** If an error is found, the analysis is cut short.
6324*/
drhd2b3e232008-01-23 14:51:49 +00006325void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006326 struct ExprList_item *pItem;
6327 int i;
drh5d9a4af2005-08-30 00:54:01 +00006328 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006329 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6330 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006331 }
6332 }
drh5d9a4af2005-08-30 00:54:01 +00006333}
drh892d3172008-01-10 03:46:36 +00006334
6335/*
drhceea3322009-04-23 13:22:42 +00006336** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006337*/
6338int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006339 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006340 return ++pParse->nMem;
6341 }
danielk19772f425f62008-07-04 09:41:39 +00006342 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006343}
drhceea3322009-04-23 13:22:42 +00006344
6345/*
6346** Deallocate a register, making available for reuse for some other
6347** purpose.
drhceea3322009-04-23 13:22:42 +00006348*/
drh892d3172008-01-10 03:46:36 +00006349void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006350 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006351 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006352 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6353 pParse->aTempReg[pParse->nTempReg++] = iReg;
6354 }
drh892d3172008-01-10 03:46:36 +00006355 }
6356}
6357
6358/*
drhed24da42016-09-06 14:37:05 +00006359** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006360*/
6361int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006362 int i, n;
drhed24da42016-09-06 14:37:05 +00006363 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006364 i = pParse->iRangeReg;
6365 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006366 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006367 pParse->iRangeReg += nReg;
6368 pParse->nRangeReg -= nReg;
6369 }else{
6370 i = pParse->nMem+1;
6371 pParse->nMem += nReg;
6372 }
6373 return i;
6374}
6375void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006376 if( nReg==1 ){
6377 sqlite3ReleaseTempReg(pParse, iReg);
6378 return;
6379 }
drh3aef2fb2020-01-02 17:46:02 +00006380 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006381 if( nReg>pParse->nRangeReg ){
6382 pParse->nRangeReg = nReg;
6383 pParse->iRangeReg = iReg;
6384 }
6385}
drhcdc69552011-12-06 13:24:59 +00006386
6387/*
6388** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006389**
6390** Always invoke this procedure after coding a subroutine or co-routine
6391** that might be invoked from other parts of the code, to ensure that
6392** the sub/co-routine does not use registers in common with the code that
6393** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006394*/
6395void sqlite3ClearTempRegCache(Parse *pParse){
6396 pParse->nTempReg = 0;
6397 pParse->nRangeReg = 0;
6398}
drhbb9b5f22016-03-19 00:35:02 +00006399
6400/*
6401** Validate that no temporary register falls within the range of
6402** iFirst..iLast, inclusive. This routine is only call from within assert()
6403** statements.
6404*/
6405#ifdef SQLITE_DEBUG
6406int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6407 int i;
6408 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006409 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6410 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006411 ){
6412 return 0;
6413 }
6414 for(i=0; i<pParse->nTempReg; i++){
6415 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6416 return 0;
6417 }
6418 }
6419 return 1;
6420}
6421#endif /* SQLITE_DEBUG */