blob: a51d37a7b700c907f2b8ae2eeb22a6ecdff55c67 [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 );
drha4eeccd2021-10-07 17:43:30 +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){
772 int nHeight = 0;
773 heightOfExpr(p->pLeft, &nHeight);
774 heightOfExpr(p->pRight, &nHeight);
drha4eeccd2021-10-07 17:43:30 +0000775 if( ExprUseXSelect(p) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000776 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000777 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000778 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000779 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000780 }
danielk19774b5255a2008-06-05 16:47:39 +0000781 p->nHeight = nHeight + 1;
782}
783
784/*
785** Set the Expr.nHeight variable using the exprSetHeight() function. If
786** the height is greater than the maximum allowed expression depth,
787** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000788**
789** Also propagate all EP_Propagate flags from the Expr.x.pList into
790** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000791*/
drh2308ed32015-02-09 16:09:34 +0000792void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000793 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000794 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000795 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000796}
797
798/*
799** Return the maximum height of any expression tree referenced
800** by the select statement passed as an argument.
801*/
drhb6dad522021-09-24 16:14:47 +0000802int sqlite3SelectExprHeight(const Select *p){
danielk19774b5255a2008-06-05 16:47:39 +0000803 int nHeight = 0;
804 heightOfSelect(p, &nHeight);
805 return nHeight;
806}
drh2308ed32015-02-09 16:09:34 +0000807#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
808/*
809** Propagate all EP_Propagate flags from the Expr.x.pList into
810** Expr.flags.
811*/
812void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000813 if( pParse->nErr ) return;
drha4eeccd2021-10-07 17:43:30 +0000814 if( p && ExprUseXList(p) && p->x.pList ){
drh2308ed32015-02-09 16:09:34 +0000815 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
816 }
817}
818#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000819#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
820
drhbe5c89a2004-07-26 00:31:09 +0000821/*
drhb7916a72009-05-27 10:31:29 +0000822** This routine is the core allocator for Expr nodes.
823**
drha76b5df2002-02-23 02:32:10 +0000824** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000825** for this node and for the pToken argument is a single allocation
826** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000827** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000828**
829** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000830** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000831** parameter is ignored if pToken is NULL or if the token does not
832** appear to be quoted. If the quotes were of the form "..." (double-quotes)
833** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000834**
835** Special case: If op==TK_INTEGER and pToken points to a string that
836** can be translated into a 32-bit integer, then the token is not
837** stored in u.zToken. Instead, the integer values is written
838** into u.iValue and the EP_IntValue flag is set. No extra storage
839** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000840*/
drhb7916a72009-05-27 10:31:29 +0000841Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000842 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000843 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000844 const Token *pToken, /* Token argument. Might be NULL */
845 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000846){
drha76b5df2002-02-23 02:32:10 +0000847 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000848 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000849 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000850
drh575fad62016-02-05 13:38:36 +0000851 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000852 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000853 if( op!=TK_INTEGER || pToken->z==0
854 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
855 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000856 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000857 }
drhb7916a72009-05-27 10:31:29 +0000858 }
drh575fad62016-02-05 13:38:36 +0000859 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000860 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000861 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000862 pNew->op = (u8)op;
863 pNew->iAgg = -1;
864 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000865 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000866 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000867 pNew->u.iValue = iValue;
868 }else{
drh33e619f2009-05-28 01:00:55 +0000869 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000870 assert( pToken->z!=0 || pToken->n==0 );
871 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000872 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000873 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000874 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000875 }
drhb7916a72009-05-27 10:31:29 +0000876 }
877 }
878#if SQLITE_MAX_EXPR_DEPTH>0
879 pNew->nHeight = 1;
880#endif
881 }
drha76b5df2002-02-23 02:32:10 +0000882 return pNew;
883}
884
885/*
drhb7916a72009-05-27 10:31:29 +0000886** Allocate a new expression node from a zero-terminated token that has
887** already been dequoted.
888*/
889Expr *sqlite3Expr(
890 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
891 int op, /* Expression opcode */
892 const char *zToken /* Token argument. Might be NULL */
893){
894 Token x;
895 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000896 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000897 return sqlite3ExprAlloc(db, op, &x, 0);
898}
899
900/*
901** Attach subtrees pLeft and pRight to the Expr node pRoot.
902**
903** If pRoot==NULL that means that a memory allocation error has occurred.
904** In that case, delete the subtrees pLeft and pRight.
905*/
906void sqlite3ExprAttachSubtrees(
907 sqlite3 *db,
908 Expr *pRoot,
909 Expr *pLeft,
910 Expr *pRight
911){
912 if( pRoot==0 ){
913 assert( db->mallocFailed );
914 sqlite3ExprDelete(db, pLeft);
915 sqlite3ExprDelete(db, pRight);
916 }else{
917 if( pRight ){
918 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000919 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000920 }
921 if( pLeft ){
922 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000923 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000924 }
925 exprSetHeight(pRoot);
926 }
927}
928
929/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000930** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000931**
drhbf664462009-06-19 18:32:54 +0000932** One or both of the subtrees can be NULL. Return a pointer to the new
933** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
934** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000935*/
drh17435752007-08-16 04:30:38 +0000936Expr *sqlite3PExpr(
937 Parse *pParse, /* Parsing context */
938 int op, /* Expression opcode */
939 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000940 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000941){
drh5fb52ca2012-03-31 02:34:35 +0000942 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000943 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
944 if( p ){
945 memset(p, 0, sizeof(Expr));
946 p->op = op & 0xff;
947 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000948 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000949 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000950 }else{
951 sqlite3ExprDelete(pParse->db, pLeft);
952 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000953 }
drh4e0cff62004-11-05 05:10:28 +0000954 return p;
955}
956
957/*
drh08de4f72016-04-11 01:06:47 +0000958** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
959** do a memory allocation failure) then delete the pSelect object.
960*/
961void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
962 if( pExpr ){
963 pExpr->x.pSelect = pSelect;
964 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
965 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
966 }else{
967 assert( pParse->db->mallocFailed );
968 sqlite3SelectDelete(pParse->db, pSelect);
969 }
970}
971
dan9289f512021-07-06 20:44:32 +0000972/*
973** Expression list pEList is a list of vector values. This function
974** converts the contents of pEList to a VALUES(...) Select statement
dan74777f92021-07-07 13:53:55 +0000975** returning 1 row for each element of the list. For example, the
976** expression list:
dan9289f512021-07-06 20:44:32 +0000977**
dan74777f92021-07-07 13:53:55 +0000978** ( (1,2), (3,4) (5,6) )
dan9289f512021-07-06 20:44:32 +0000979**
dan74777f92021-07-07 13:53:55 +0000980** is translated to the equivalent of:
dan9289f512021-07-06 20:44:32 +0000981**
dan74777f92021-07-07 13:53:55 +0000982** VALUES(1,2), (3,4), (5,6)
dan9289f512021-07-06 20:44:32 +0000983**
dan74777f92021-07-07 13:53:55 +0000984** Each of the vector values in pEList must contain exactly nElem terms.
985** If a list element that is not a vector or does not contain nElem terms,
986** an error message is left in pParse.
dan9289f512021-07-06 20:44:32 +0000987**
988** This is used as part of processing IN(...) expressions with a list
989** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
990*/
dan74777f92021-07-07 13:53:55 +0000991Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
dan9289f512021-07-06 20:44:32 +0000992 int ii;
993 Select *pRet = 0;
dan2931a662021-07-07 15:52:44 +0000994 assert( nElem>1 );
dan9289f512021-07-06 20:44:32 +0000995 for(ii=0; ii<pEList->nExpr; ii++){
996 Select *pSel;
dan9289f512021-07-06 20:44:32 +0000997 Expr *pExpr = pEList->a[ii].pExpr;
drha4eeccd2021-10-07 17:43:30 +0000998 int nExprElem;
999 if( pExpr->op==TK_VECTOR ){
1000 assert( ExprUseXList(pExpr) );
1001 nExprElem = pExpr->x.pList->nExpr;
1002 }else{
1003 nExprElem = 1;
1004 }
dan74777f92021-07-07 13:53:55 +00001005 if( nExprElem!=nElem ){
1006 sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
1007 nExprElem, nExprElem>1?"s":"", nElem
1008 );
1009 break;
dan9289f512021-07-06 20:44:32 +00001010 }
drha4eeccd2021-10-07 17:43:30 +00001011 assert( ExprUseXList(pExpr) );
dan74777f92021-07-07 13:53:55 +00001012 pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
1013 pExpr->x.pList = 0;
dan9289f512021-07-06 20:44:32 +00001014 if( pSel ){
1015 if( pRet ){
1016 pSel->op = TK_ALL;
1017 pSel->pPrior = pRet;
1018 }
1019 pRet = pSel;
1020 }
1021 }
1022
1023 if( pRet && pRet->pPrior ){
1024 pRet->selFlags |= SF_MultiValue;
1025 }
1026 sqlite3ExprListDelete(pParse->db, pEList);
1027 return pRet;
1028}
drh08de4f72016-04-11 01:06:47 +00001029
1030/*
drh91bb0ee2004-09-01 03:06:34 +00001031** Join two expressions using an AND operator. If either expression is
1032** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +00001033**
1034** If one side or the other of the AND is known to be false, then instead
1035** of returning an AND expression, just return a constant expression with
1036** a value of false.
drh91bb0ee2004-09-01 03:06:34 +00001037*/
drhd5c851c2019-04-19 13:38:34 +00001038Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1039 sqlite3 *db = pParse->db;
1040 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +00001041 return pRight;
1042 }else if( pRight==0 ){
1043 return pLeft;
dan2b6e6702019-12-30 06:55:31 +00001044 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
1045 && !IN_RENAME_OBJECT
1046 ){
drhb3ad4e62021-03-31 13:31:33 +00001047 sqlite3ExprDeferredDelete(pParse, pLeft);
1048 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +00001049 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +00001050 }else{
drhd5c851c2019-04-19 13:38:34 +00001051 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +00001052 }
1053}
1054
1055/*
1056** Construct a new expression node for a function with multiple
1057** arguments.
1058*/
drh954733b2018-07-27 23:33:16 +00001059Expr *sqlite3ExprFunction(
1060 Parse *pParse, /* Parsing context */
1061 ExprList *pList, /* Argument list */
drhb6dad522021-09-24 16:14:47 +00001062 const Token *pToken, /* Name of the function */
drh954733b2018-07-27 23:33:16 +00001063 int eDistinct /* SF_Distinct or SF_ALL or 0 */
1064){
drha76b5df2002-02-23 02:32:10 +00001065 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +00001066 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +00001067 assert( pToken );
drhb7916a72009-05-27 10:31:29 +00001068 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +00001069 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +00001070 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +00001071 return 0;
1072 }
drh14a1b1c2021-06-30 11:53:21 +00001073 if( pList
1074 && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
1075 && !pParse->nested
1076 ){
drh954733b2018-07-27 23:33:16 +00001077 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1078 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001079 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +00001080 ExprSetProperty(pNew, EP_HasFunc);
drha4eeccd2021-10-07 17:43:30 +00001081 assert( ExprUseXList(pNew) );
drh2308ed32015-02-09 16:09:34 +00001082 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +00001083 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +00001084 return pNew;
1085}
1086
1087/*
drh0dfa5252020-01-08 17:28:19 +00001088** Check to see if a function is usable according to current access
1089** rules:
1090**
1091** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1092**
1093** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1094** top-level SQL
1095**
1096** If the function is not usable, create an error.
1097*/
1098void sqlite3ExprFunctionUsable(
1099 Parse *pParse, /* Parsing and code generating context */
drhb6dad522021-09-24 16:14:47 +00001100 const Expr *pExpr, /* The function invocation */
1101 const FuncDef *pDef /* The function being invoked */
drh0dfa5252020-01-08 17:28:19 +00001102){
1103 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001104 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1105 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001106 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1107 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1108 ){
1109 /* Functions prohibited in triggers and views if:
1110 ** (1) tagged with SQLITE_DIRECTONLY
1111 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1112 ** is tagged with SQLITE_FUNC_UNSAFE) and
1113 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1114 ** that the schema is possibly tainted).
1115 */
1116 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1117 }
1118 }
1119}
1120
1121/*
drhfa6bc002004-09-07 16:19:52 +00001122** Assign a variable number to an expression that encodes a wildcard
1123** in the original SQL statement.
1124**
1125** Wildcards consisting of a single "?" are assigned the next sequential
1126** variable number.
1127**
1128** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001129** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001130** the SQL statement comes from an external source.
1131**
drh51f49f12009-05-21 20:41:32 +00001132** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001133** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001134** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001135** assigned.
1136*/
drhde25a882016-10-03 15:28:24 +00001137void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001138 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001139 const char *z;
drhf326d662016-12-23 13:30:53 +00001140 ynVar x;
drh17435752007-08-16 04:30:38 +00001141
drhfa6bc002004-09-07 16:19:52 +00001142 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001143 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001144 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001145 assert( z!=0 );
1146 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001147 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001148 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001149 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001150 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001151 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001152 }else{
drhf326d662016-12-23 13:30:53 +00001153 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001154 if( z[0]=='?' ){
1155 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1156 ** use it as the variable number */
1157 i64 i;
drh18814df2017-01-31 03:52:34 +00001158 int bOk;
1159 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1160 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1161 bOk = 1;
1162 }else{
1163 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1164 }
drh124c0b42011-06-01 18:15:55 +00001165 testcase( i==0 );
1166 testcase( i==1 );
1167 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1168 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1169 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1170 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1171 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001172 return;
drhfa6bc002004-09-07 16:19:52 +00001173 }
drh8e74e7b2017-01-31 12:41:48 +00001174 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001175 if( x>pParse->nVar ){
1176 pParse->nVar = (int)x;
1177 doAdd = 1;
1178 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1179 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001180 }
1181 }else{
1182 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1183 ** number as the prior appearance of the same name, or if the name
1184 ** has never appeared before, reuse the same variable number
1185 */
drh9bf755c2016-12-23 03:59:31 +00001186 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1187 if( x==0 ){
1188 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001189 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001190 }
drhfa6bc002004-09-07 16:19:52 +00001191 }
drhf326d662016-12-23 13:30:53 +00001192 if( doAdd ){
1193 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1194 }
1195 }
1196 pExpr->iColumn = x;
1197 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001198 sqlite3ErrorMsg(pParse, "too many SQL variables");
1199 }
drhfa6bc002004-09-07 16:19:52 +00001200}
1201
1202/*
danf6963f92009-11-23 14:39:14 +00001203** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001204*/
drh4f0010b2016-04-11 14:49:39 +00001205static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1206 assert( p!=0 );
drh477572b2021-10-07 20:46:29 +00001207 assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1208 assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1209 assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1210 assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
drh209bc522016-09-23 21:36:24 +00001211#ifdef SQLITE_DEBUG
1212 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1213 assert( p->pLeft==0 );
1214 assert( p->pRight==0 );
drha4eeccd2021-10-07 17:43:30 +00001215 assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1216 assert( !ExprUseXList(p) || p->x.pList==0 );
drh209bc522016-09-23 21:36:24 +00001217 }
1218#endif
1219 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001220 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +00001221 assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001222 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001223 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001224 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001225 sqlite3ExprDeleteNN(db, p->pRight);
drha4eeccd2021-10-07 17:43:30 +00001226 }else if( ExprUseXSelect(p) ){
dan4f9adee2019-07-13 16:22:50 +00001227 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001228 sqlite3SelectDelete(db, p->x.pSelect);
1229 }else{
1230 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001231#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001232 if( ExprHasProperty(p, EP_WinFunc) ){
1233 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001234 }
dan6ba7ab02019-07-02 11:56:47 +00001235#endif
dan8117f112019-07-10 20:16:53 +00001236 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001237 }
drhf9751072021-10-07 13:40:29 +00001238 if( ExprHasProperty(p, EP_MemToken) ){
1239 assert( !ExprHasProperty(p, EP_IntValue) );
1240 sqlite3DbFree(db, p->u.zToken);
1241 }
drh33e619f2009-05-28 01:00:55 +00001242 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001243 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001244 }
drha2e00042002-01-22 03:13:42 +00001245}
drh4f0010b2016-04-11 14:49:39 +00001246void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1247 if( p ) sqlite3ExprDeleteNN(db, p);
1248}
drha2e00042002-01-22 03:13:42 +00001249
drhb3ad4e62021-03-31 13:31:33 +00001250
1251/*
1252** Arrange to cause pExpr to be deleted when the pParse is deleted.
1253** This is similar to sqlite3ExprDelete() except that the delete is
1254** deferred untilthe pParse is deleted.
1255**
1256** The pExpr might be deleted immediately on an OOM error.
1257**
1258** The deferred delete is (currently) implemented by adding the
1259** pExpr to the pParse->pConstExpr list with a register number of 0.
1260*/
1261void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1262 pParse->pConstExpr =
1263 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1264}
1265
drh8e34e402019-06-11 10:43:56 +00001266/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1267** expression.
1268*/
1269void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1270 if( p ){
1271 if( IN_RENAME_OBJECT ){
1272 sqlite3RenameExprUnmap(pParse, p);
1273 }
1274 sqlite3ExprDeleteNN(pParse->db, p);
1275 }
1276}
1277
drhd2687b72005-08-12 22:56:09 +00001278/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001279** Return the number of bytes allocated for the expression structure
1280** passed as the first argument. This is always one of EXPR_FULLSIZE,
1281** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1282*/
drhb6dad522021-09-24 16:14:47 +00001283static int exprStructSize(const Expr *p){
danielk19776ab3a2e2009-02-19 14:39:25 +00001284 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001285 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1286 return EXPR_FULLSIZE;
1287}
1288
1289/*
drh33e619f2009-05-28 01:00:55 +00001290** The dupedExpr*Size() routines each return the number of bytes required
1291** to store a copy of an expression or expression tree. They differ in
1292** how much of the tree is measured.
1293**
1294** dupedExprStructSize() Size of only the Expr structure
1295** dupedExprNodeSize() Size of Expr + space for token
1296** dupedExprSize() Expr + token + subtree components
1297**
1298***************************************************************************
1299**
1300** The dupedExprStructSize() function returns two values OR-ed together:
1301** (1) the space required for a copy of the Expr structure only and
1302** (2) the EP_xxx flags that indicate what the structure size should be.
1303** The return values is always one of:
1304**
1305** EXPR_FULLSIZE
1306** EXPR_REDUCEDSIZE | EP_Reduced
1307** EXPR_TOKENONLYSIZE | EP_TokenOnly
1308**
1309** The size of the structure can be found by masking the return value
1310** of this routine with 0xfff. The flags can be found by masking the
1311** return value with EP_Reduced|EP_TokenOnly.
1312**
1313** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1314** (unreduced) Expr objects as they or originally constructed by the parser.
1315** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001316** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001317** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001318** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001319** to reduce a pristine expression tree from the parser. The implementation
1320** of dupedExprStructSize() contain multiple assert() statements that attempt
1321** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001322*/
drhb6dad522021-09-24 16:14:47 +00001323static int dupedExprStructSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001324 int nSize;
drh33e619f2009-05-28 01:00:55 +00001325 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001326 assert( EXPR_FULLSIZE<=0xfff );
1327 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001328 if( 0==flags || p->op==TK_SELECT_COLUMN
1329#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001330 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001331#endif
1332 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001333 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001334 }else{
drhc5cd1242013-09-12 16:50:49 +00001335 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001336 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001337 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001338 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001339 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001340 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1341 }else{
drhaecd8022013-09-13 18:15:15 +00001342 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001343 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1344 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001345 }
1346 return nSize;
1347}
1348
1349/*
drh33e619f2009-05-28 01:00:55 +00001350** This function returns the space in bytes required to store the copy
1351** of the Expr structure and a copy of the Expr.u.zToken string (if that
1352** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001353*/
drhb6dad522021-09-24 16:14:47 +00001354static int dupedExprNodeSize(const Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001355 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1356 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001357 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001358 }
danielk1977bc739712009-03-23 04:33:32 +00001359 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001360}
1361
1362/*
1363** Return the number of bytes required to create a duplicate of the
1364** expression passed as the first argument. The second argument is a
1365** mask containing EXPRDUP_XXX flags.
1366**
1367** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001368** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001369**
1370** If the EXPRDUP_REDUCE flag is set, then the return value includes
1371** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1372** and Expr.pRight variables (but not for any structures pointed to or
1373** descended from the Expr.x.pList or Expr.x.pSelect variables).
1374*/
drhb6dad522021-09-24 16:14:47 +00001375static int dupedExprSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001376 int nByte = 0;
1377 if( p ){
1378 nByte = dupedExprNodeSize(p, flags);
1379 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001380 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001381 }
1382 }
1383 return nByte;
1384}
1385
1386/*
1387** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1388** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001389** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001390** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001391** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001392** portion of the buffer copied into by this function.
1393*/
drhb6dad522021-09-24 16:14:47 +00001394static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
drh3c194692016-04-11 16:43:43 +00001395 Expr *pNew; /* Value to return */
1396 u8 *zAlloc; /* Memory space from which to build Expr object */
1397 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1398
drh575fad62016-02-05 13:38:36 +00001399 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001400 assert( p );
1401 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1402 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001403
drh3c194692016-04-11 16:43:43 +00001404 /* Figure out where to write the new Expr structure. */
1405 if( pzBuffer ){
1406 zAlloc = *pzBuffer;
1407 staticFlag = EP_Static;
drh3c6edc82021-04-26 15:28:06 +00001408 assert( zAlloc!=0 );
drh3c194692016-04-11 16:43:43 +00001409 }else{
1410 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1411 staticFlag = 0;
1412 }
1413 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001414
drh3c194692016-04-11 16:43:43 +00001415 if( pNew ){
1416 /* Set nNewSize to the size allocated for the structure pointed to
1417 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1418 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1419 ** by the copy of the p->u.zToken string (if any).
1420 */
1421 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1422 const int nNewSize = nStructSize & 0xfff;
1423 int nToken;
1424 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1425 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001426 }else{
drh3c194692016-04-11 16:43:43 +00001427 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001428 }
drh3c194692016-04-11 16:43:43 +00001429 if( dupFlags ){
1430 assert( ExprHasProperty(p, EP_Reduced)==0 );
1431 memcpy(zAlloc, p, nNewSize);
1432 }else{
1433 u32 nSize = (u32)exprStructSize(p);
1434 memcpy(zAlloc, p, nSize);
1435 if( nSize<EXPR_FULLSIZE ){
1436 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1437 }
1438 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001439
drh3c194692016-04-11 16:43:43 +00001440 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1441 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1442 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1443 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001444 ExprClearVVAProperties(pNew);
1445 if( dupFlags ){
1446 ExprSetVVAProperty(pNew, EP_Immutable);
1447 }
drh3c194692016-04-11 16:43:43 +00001448
1449 /* Copy the p->u.zToken string, if any. */
1450 if( nToken ){
1451 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1452 memcpy(zToken, p->u.zToken, nToken);
1453 }
1454
drh209bc522016-09-23 21:36:24 +00001455 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001456 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
drha4eeccd2021-10-07 17:43:30 +00001457 if( ExprUseXSelect(p) ){
drh3c194692016-04-11 16:43:43 +00001458 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001459 }else{
drh3c194692016-04-11 16:43:43 +00001460 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001461 }
drh3c194692016-04-11 16:43:43 +00001462 }
1463
1464 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001465 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001466 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001467 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001468 pNew->pLeft = p->pLeft ?
1469 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1470 pNew->pRight = p->pRight ?
1471 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001472 }
dan67a9b8e2018-06-22 20:51:35 +00001473#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001474 if( ExprHasProperty(p, EP_WinFunc) ){
1475 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1476 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001477 }
dan67a9b8e2018-06-22 20:51:35 +00001478#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001479 if( pzBuffer ){
1480 *pzBuffer = zAlloc;
1481 }
1482 }else{
drh209bc522016-09-23 21:36:24 +00001483 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001484 if( pNew->op==TK_SELECT_COLUMN ){
1485 pNew->pLeft = p->pLeft;
drh5cc9daf2021-04-12 23:18:18 +00001486 assert( p->pRight==0 || p->pRight==p->pLeft
1487 || ExprHasProperty(p->pLeft, EP_Subquery) );
drh98542602016-08-20 17:00:16 +00001488 }else{
1489 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1490 }
drh3c194692016-04-11 16:43:43 +00001491 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001492 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001493 }
1494 }
1495 return pNew;
1496}
1497
1498/*
danbfe31e72014-01-15 14:17:31 +00001499** Create and return a deep copy of the object passed as the second
1500** argument. If an OOM condition is encountered, NULL is returned
1501** and the db->mallocFailed flag set.
1502*/
daneede6a52014-01-15 19:42:23 +00001503#ifndef SQLITE_OMIT_CTE
dan26d61e52021-06-11 11:14:24 +00001504With *sqlite3WithDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001505 With *pRet = 0;
1506 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001507 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001508 pRet = sqlite3DbMallocZero(db, nByte);
1509 if( pRet ){
1510 int i;
1511 pRet->nCte = p->nCte;
1512 for(i=0; i<p->nCte; i++){
1513 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1514 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1515 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1516 }
1517 }
1518 }
1519 return pRet;
1520}
daneede6a52014-01-15 19:42:23 +00001521#else
dan26d61e52021-06-11 11:14:24 +00001522# define sqlite3WithDup(x,y) 0
daneede6a52014-01-15 19:42:23 +00001523#endif
dan4e9119d2014-01-13 15:12:23 +00001524
drha8389972018-12-06 22:04:19 +00001525#ifndef SQLITE_OMIT_WINDOWFUNC
1526/*
1527** The gatherSelectWindows() procedure and its helper routine
1528** gatherSelectWindowsCallback() are used to scan all the expressions
1529** an a newly duplicated SELECT statement and gather all of the Window
1530** objects found there, assembling them onto the linked list at Select->pWin.
1531*/
1532static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001533 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001534 Select *pSelect = pWalker->u.pSelect;
1535 Window *pWin = pExpr->y.pWin;
1536 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001537 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001538 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001539 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001540 }
1541 return WRC_Continue;
1542}
drha37b6a52018-12-06 22:12:18 +00001543static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1544 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1545}
drha8389972018-12-06 22:04:19 +00001546static void gatherSelectWindows(Select *p){
1547 Walker w;
1548 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001549 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1550 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001551 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001552 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001553 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001554}
1555#endif
1556
1557
drha76b5df2002-02-23 02:32:10 +00001558/*
drhff78bd22002-02-27 01:47:11 +00001559** The following group of routines make deep copies of expressions,
1560** expression lists, ID lists, and select statements. The copies can
1561** be deleted (by being passed to their respective ...Delete() routines)
1562** without effecting the originals.
1563**
danielk19774adee202004-05-08 08:23:19 +00001564** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1565** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001566** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001567**
drhad3cab52002-05-24 02:04:32 +00001568** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001569**
drhb7916a72009-05-27 10:31:29 +00001570** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001571** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1572** truncated version of the usual Expr structure that will be stored as
1573** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001574*/
drhb6dad522021-09-24 16:14:47 +00001575Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001576 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001577 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001578}
drhb6dad522021-09-24 16:14:47 +00001579ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001580 ExprList *pNew;
drhb6dad522021-09-24 16:14:47 +00001581 struct ExprList_item *pItem;
1582 const struct ExprList_item *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001583 int i;
drhe46292a2021-07-05 02:40:29 +00001584 Expr *pPriorSelectColOld = 0;
1585 Expr *pPriorSelectColNew = 0;
drh575fad62016-02-05 13:38:36 +00001586 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001587 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001588 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001589 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001590 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001591 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001592 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001593 pOldItem = p->a;
1594 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001595 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001596 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001597 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001598 if( pOldExpr
1599 && pOldExpr->op==TK_SELECT_COLUMN
1600 && (pNewExpr = pItem->pExpr)!=0
1601 ){
drhe46292a2021-07-05 02:40:29 +00001602 if( pNewExpr->pRight ){
1603 pPriorSelectColOld = pOldExpr->pRight;
1604 pPriorSelectColNew = pNewExpr->pRight;
1605 pNewExpr->pLeft = pNewExpr->pRight;
drhb1637482017-01-03 00:27:16 +00001606 }else{
drhe46292a2021-07-05 02:40:29 +00001607 if( pOldExpr->pLeft!=pPriorSelectColOld ){
1608 pPriorSelectColOld = pOldExpr->pLeft;
1609 pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1610 pNewExpr->pRight = pPriorSelectColNew;
1611 }
1612 pNewExpr->pLeft = pPriorSelectColNew;
drh47073f62017-01-02 22:36:32 +00001613 }
1614 }
drh41cee662019-12-12 20:22:34 +00001615 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001616 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001617 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001618 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001619 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001620 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001621 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001622 }
1623 return pNew;
1624}
danielk197793758c82005-01-21 08:13:14 +00001625
1626/*
1627** If cursors, triggers, views and subqueries are all omitted from
1628** the build, then none of the following routines, except for
1629** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1630** called with a NULL argument.
1631*/
danielk19776a67fe82005-02-04 04:07:16 +00001632#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1633 || !defined(SQLITE_OMIT_SUBQUERY)
drhb6dad522021-09-24 16:14:47 +00001634SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001635 SrcList *pNew;
1636 int i;
drh113088e2003-03-20 01:16:58 +00001637 int nByte;
drh575fad62016-02-05 13:38:36 +00001638 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001639 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001640 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001641 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001642 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001643 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001644 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001645 SrcItem *pNewItem = &pNew->a[i];
drhb6dad522021-09-24 16:14:47 +00001646 const SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001647 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001648 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001649 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1650 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1651 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001652 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001653 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001654 pNewItem->addrFillSub = pOldItem->addrFillSub;
1655 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001656 if( pNewItem->fg.isIndexedBy ){
1657 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1658 }
drha79e2a22021-02-21 23:44:14 +00001659 pNewItem->u2 = pOldItem->u2;
1660 if( pNewItem->fg.isCte ){
1661 pNewItem->u2.pCteUse->nUse++;
1662 }
drh8a48b9c2015-08-19 15:20:00 +00001663 if( pNewItem->fg.isTabFunc ){
1664 pNewItem->u1.pFuncArg =
1665 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1666 }
drhed8a3bb2005-06-06 21:19:56 +00001667 pTab = pNewItem->pTab = pOldItem->pTab;
1668 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001669 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001670 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001671 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1672 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001673 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001674 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001675 }
1676 return pNew;
1677}
drhb6dad522021-09-24 16:14:47 +00001678IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
drhff78bd22002-02-27 01:47:11 +00001679 IdList *pNew;
1680 int i;
drh575fad62016-02-05 13:38:36 +00001681 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001682 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001683 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001684 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001685 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001686 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001687 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001688 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001689 return 0;
1690 }
drh6c535152012-02-02 03:38:30 +00001691 /* Note that because the size of the allocation for p->a[] is not
1692 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1693 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001694 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001695 struct IdList_item *pNewItem = &pNew->a[i];
1696 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001697 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001698 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001699 }
1700 return pNew;
1701}
drhb6dad522021-09-24 16:14:47 +00001702Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
dana7466202017-02-03 14:44:52 +00001703 Select *pRet = 0;
1704 Select *pNext = 0;
1705 Select **pp = &pRet;
drhb6dad522021-09-24 16:14:47 +00001706 const Select *p;
dana7466202017-02-03 14:44:52 +00001707
drh575fad62016-02-05 13:38:36 +00001708 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001709 for(p=pDup; p; p=p->pPrior){
1710 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1711 if( pNew==0 ) break;
1712 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1713 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1714 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1715 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1716 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1717 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1718 pNew->op = p->op;
1719 pNew->pNext = pNext;
1720 pNew->pPrior = 0;
1721 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001722 pNew->iLimit = 0;
1723 pNew->iOffset = 0;
1724 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1725 pNew->addrOpenEphm[0] = -1;
1726 pNew->addrOpenEphm[1] = -1;
1727 pNew->nSelectRow = p->nSelectRow;
dan26d61e52021-06-11 11:14:24 +00001728 pNew->pWith = sqlite3WithDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001729#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001730 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001731 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001732 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001733#endif
drhfef37762018-07-10 19:48:35 +00001734 pNew->selId = p->selId;
drh9da977f2021-04-20 12:14:12 +00001735 if( db->mallocFailed ){
1736 /* Any prior OOM might have left the Select object incomplete.
1737 ** Delete the whole thing rather than allow an incomplete Select
1738 ** to be used by the code generator. */
1739 pNew->pNext = 0;
1740 sqlite3SelectDelete(db, pNew);
1741 break;
1742 }
dana7466202017-02-03 14:44:52 +00001743 *pp = pNew;
1744 pp = &pNew->pPrior;
1745 pNext = pNew;
1746 }
1747
1748 return pRet;
drhff78bd22002-02-27 01:47:11 +00001749}
danielk197793758c82005-01-21 08:13:14 +00001750#else
drhf76d2872021-10-27 17:15:08 +00001751Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001752 assert( p==0 );
1753 return 0;
1754}
1755#endif
drhff78bd22002-02-27 01:47:11 +00001756
1757
1758/*
drha76b5df2002-02-23 02:32:10 +00001759** Add a new element to the end of an expression list. If pList is
1760** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001761**
drha19543f2017-09-15 15:17:48 +00001762** The pList argument must be either NULL or a pointer to an ExprList
1763** obtained from a prior call to sqlite3ExprListAppend(). This routine
1764** may not be used with an ExprList obtained from sqlite3ExprListDup().
1765** Reason: This routine assumes that the number of slots in pList->a[]
1766** is a power of two. That is true for sqlite3ExprListAppend() returns
1767** but is not necessarily true from the return value of sqlite3ExprListDup().
1768**
drhb7916a72009-05-27 10:31:29 +00001769** If a memory allocation error occurs, the entire list is freed and
1770** NULL is returned. If non-NULL is returned, then it is guaranteed
1771** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001772*/
larrybrdabada62021-04-04 12:52:58 +00001773static const struct ExprList_item zeroItem = {0};
drh50e43c52021-03-23 14:27:35 +00001774SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1775 sqlite3 *db, /* Database handle. Used for memory allocation */
1776 Expr *pExpr /* Expression to be appended. Might be NULL */
1777){
1778 struct ExprList_item *pItem;
1779 ExprList *pList;
1780
1781 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1782 if( pList==0 ){
1783 sqlite3ExprDelete(db, pExpr);
1784 return 0;
1785 }
1786 pList->nAlloc = 4;
1787 pList->nExpr = 1;
1788 pItem = &pList->a[0];
1789 *pItem = zeroItem;
1790 pItem->pExpr = pExpr;
1791 return pList;
1792}
1793SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1794 sqlite3 *db, /* Database handle. Used for memory allocation */
1795 ExprList *pList, /* List to which to append. Might be NULL */
1796 Expr *pExpr /* Expression to be appended. Might be NULL */
1797){
1798 struct ExprList_item *pItem;
1799 ExprList *pNew;
1800 pList->nAlloc *= 2;
1801 pNew = sqlite3DbRealloc(db, pList,
1802 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1803 if( pNew==0 ){
1804 sqlite3ExprListDelete(db, pList);
1805 sqlite3ExprDelete(db, pExpr);
1806 return 0;
1807 }else{
1808 pList = pNew;
1809 }
1810 pItem = &pList->a[pList->nExpr++];
1811 *pItem = zeroItem;
1812 pItem->pExpr = pExpr;
1813 return pList;
1814}
drh17435752007-08-16 04:30:38 +00001815ExprList *sqlite3ExprListAppend(
1816 Parse *pParse, /* Parsing context */
1817 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001818 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001819){
drh43606172017-04-05 11:32:13 +00001820 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001821 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001822 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1823 }
1824 if( pList->nAlloc<pList->nExpr+1 ){
1825 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001826 }
drh43606172017-04-05 11:32:13 +00001827 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001828 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001829 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001830 return pList;
1831}
1832
1833/*
drh8762ec12016-08-20 01:06:22 +00001834** pColumns and pExpr form a vector assignment which is part of the SET
1835** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001836**
1837** (a,b,c) = (expr1,expr2,expr3)
1838** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1839**
1840** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001841** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001842** TK_SELECT_COLUMN expressions.
1843*/
1844ExprList *sqlite3ExprListAppendVector(
1845 Parse *pParse, /* Parsing context */
1846 ExprList *pList, /* List to which to append. Might be NULL */
1847 IdList *pColumns, /* List of names of LHS of the assignment */
1848 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1849){
1850 sqlite3 *db = pParse->db;
1851 int n;
1852 int i;
drh66860af2016-08-23 18:30:10 +00001853 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001854 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1855 ** exit prior to this routine being invoked */
1856 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001857 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001858
1859 /* If the RHS is a vector, then we can immediately check to see that
1860 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1861 ** wildcards ("*") in the result set of the SELECT must be expanded before
1862 ** we can do the size check, so defer the size check until code generation.
1863 */
1864 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001865 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1866 pColumns->nId, n);
1867 goto vector_append_error;
1868 }
drh966e2912017-01-03 02:58:01 +00001869
1870 for(i=0; i<pColumns->nId; i++){
drh10f08272021-07-05 01:11:26 +00001871 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
drh554a9dc2019-08-26 14:18:28 +00001872 assert( pSubExpr!=0 || db->mallocFailed );
drh554a9dc2019-08-26 14:18:28 +00001873 if( pSubExpr==0 ) continue;
drha1251bc2016-08-20 00:51:37 +00001874 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1875 if( pList ){
drh66860af2016-08-23 18:30:10 +00001876 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001877 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001878 pColumns->a[i].zName = 0;
1879 }
1880 }
drh966e2912017-01-03 02:58:01 +00001881
drhffe28052017-05-06 18:09:36 +00001882 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001883 Expr *pFirst = pList->a[iFirst].pExpr;
1884 assert( pFirst!=0 );
1885 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001886
drhf4dd26c2017-04-05 11:49:06 +00001887 /* Store the SELECT statement in pRight so it will be deleted when
1888 ** sqlite3ExprListDelete() is called */
1889 pFirst->pRight = pExpr;
1890 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001891
drhf4dd26c2017-04-05 11:49:06 +00001892 /* Remember the size of the LHS in iTable so that we can check that
1893 ** the RHS and LHS sizes match during code generation. */
1894 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001895 }
1896
1897vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001898 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001899 sqlite3IdListDelete(db, pColumns);
1900 return pList;
1901}
1902
1903/*
drhbc622bc2015-08-24 15:39:42 +00001904** Set the sort order for the last element on the given ExprList.
1905*/
dan6e118922019-08-12 16:36:38 +00001906void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001907 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001908 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001909 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001910
1911 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1912 assert( iSortOrder==SQLITE_SO_UNDEFINED
1913 || iSortOrder==SQLITE_SO_ASC
1914 || iSortOrder==SQLITE_SO_DESC
1915 );
1916 assert( eNulls==SQLITE_SO_UNDEFINED
1917 || eNulls==SQLITE_SO_ASC
1918 || eNulls==SQLITE_SO_DESC
1919 );
1920
dan9105fd52019-08-19 17:26:32 +00001921 pItem = &p->a[p->nExpr-1];
1922 assert( pItem->bNulls==0 );
1923 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1924 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001925 }
dan9105fd52019-08-19 17:26:32 +00001926 pItem->sortFlags = (u8)iSortOrder;
1927
1928 if( eNulls!=SQLITE_SO_UNDEFINED ){
1929 pItem->bNulls = 1;
1930 if( iSortOrder!=eNulls ){
1931 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1932 }
drhbc622bc2015-08-24 15:39:42 +00001933 }
drhbc622bc2015-08-24 15:39:42 +00001934}
1935
1936/*
drh41cee662019-12-12 20:22:34 +00001937** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001938** on the expression list.
1939**
1940** pList might be NULL following an OOM error. But pName should never be
1941** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1942** is set.
1943*/
1944void sqlite3ExprListSetName(
1945 Parse *pParse, /* Parsing context */
1946 ExprList *pList, /* List to which to add the span. */
drhb6dad522021-09-24 16:14:47 +00001947 const Token *pName, /* Name to be added */
drhb7916a72009-05-27 10:31:29 +00001948 int dequote /* True to cause the name to be dequoted */
1949){
1950 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001951 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001952 if( pList ){
1953 struct ExprList_item *pItem;
1954 assert( pList->nExpr>0 );
1955 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001956 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001957 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001958 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001959 if( dequote ){
1960 /* If dequote==0, then pName->z does not point to part of a DDL
1961 ** statement handled by the parser. And so no token need be added
1962 ** to the token-map. */
1963 sqlite3Dequote(pItem->zEName);
1964 if( IN_RENAME_OBJECT ){
drhb6dad522021-09-24 16:14:47 +00001965 sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
dan85f2c762020-04-06 16:37:05 +00001966 }
dan5be60c52018-08-15 20:28:39 +00001967 }
drhb7916a72009-05-27 10:31:29 +00001968 }
1969}
1970
1971/*
1972** Set the ExprList.a[].zSpan element of the most recently added item
1973** on the expression list.
1974**
1975** pList might be NULL following an OOM error. But pSpan should never be
1976** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1977** is set.
1978*/
1979void sqlite3ExprListSetSpan(
1980 Parse *pParse, /* Parsing context */
1981 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001982 const char *zStart, /* Start of the span */
1983 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001984){
1985 sqlite3 *db = pParse->db;
1986 assert( pList!=0 || db->mallocFailed!=0 );
1987 if( pList ){
1988 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1989 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001990 if( pItem->zEName==0 ){
1991 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1992 pItem->eEName = ENAME_SPAN;
1993 }
drhb7916a72009-05-27 10:31:29 +00001994 }
1995}
1996
1997/*
danielk19777a15a4b2007-05-08 17:54:43 +00001998** If the expression list pEList contains more than iLimit elements,
1999** leave an error message in pParse.
2000*/
2001void sqlite3ExprListCheckLength(
2002 Parse *pParse,
2003 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00002004 const char *zObject
2005){
drhb1a6c3c2008-03-20 16:30:17 +00002006 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00002007 testcase( pEList && pEList->nExpr==mx );
2008 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00002009 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00002010 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
2011 }
2012}
2013
2014/*
drha76b5df2002-02-23 02:32:10 +00002015** Delete an entire expression list.
2016*/
drhaffa8552016-04-11 18:25:05 +00002017static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00002018 int i = pList->nExpr;
2019 struct ExprList_item *pItem = pList->a;
2020 assert( pList->nExpr>0 );
2021 do{
drh633e6d52008-07-28 19:34:53 +00002022 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00002023 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00002024 pItem++;
2025 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00002026 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00002027}
drhaffa8552016-04-11 18:25:05 +00002028void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2029 if( pList ) exprListDeleteNN(db, pList);
2030}
drha76b5df2002-02-23 02:32:10 +00002031
2032/*
drh2308ed32015-02-09 16:09:34 +00002033** Return the bitwise-OR of all Expr.flags fields in the given
2034** ExprList.
drh885a5b02015-02-09 15:21:36 +00002035*/
drh2308ed32015-02-09 16:09:34 +00002036u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00002037 int i;
drh2308ed32015-02-09 16:09:34 +00002038 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00002039 assert( pList!=0 );
2040 for(i=0; i<pList->nExpr; i++){
2041 Expr *pExpr = pList->a[i].pExpr;
2042 assert( pExpr!=0 );
2043 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00002044 }
drh2308ed32015-02-09 16:09:34 +00002045 return m;
drh885a5b02015-02-09 15:21:36 +00002046}
2047
2048/*
drh7e6f9802017-09-04 00:33:04 +00002049** This is a SELECT-node callback for the expression walker that
2050** always "fails". By "fail" in this case, we mean set
2051** pWalker->eCode to zero and abort.
2052**
2053** This callback is used by multiple expression walkers.
2054*/
2055int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
2056 UNUSED_PARAMETER(NotUsed);
2057 pWalker->eCode = 0;
2058 return WRC_Abort;
2059}
2060
2061/*
drh0cbec592020-01-03 02:20:37 +00002062** Check the input string to see if it is "true" or "false" (in any case).
2063**
2064** If the string is.... Return
2065** "true" EP_IsTrue
2066** "false" EP_IsFalse
2067** anything else 0
2068*/
2069u32 sqlite3IsTrueOrFalse(const char *zIn){
2070 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
2071 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
2072 return 0;
2073}
2074
2075
2076/*
drh171d16b2018-02-26 20:15:54 +00002077** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00002078** then convert it into an TK_TRUEFALSE term. Return non-zero if
2079** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00002080*/
2081int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00002082 u32 v;
drh171d16b2018-02-26 20:15:54 +00002083 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drhf9751072021-10-07 13:40:29 +00002084 if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
drh0cbec592020-01-03 02:20:37 +00002085 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00002086 ){
2087 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00002088 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00002089 return 1;
2090 }
2091 return 0;
2092}
2093
drh43c4ac82018-02-26 21:26:27 +00002094/*
drh96acafb2018-02-27 14:49:25 +00002095** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002096** and 0 if it is FALSE.
2097*/
drh96acafb2018-02-27 14:49:25 +00002098int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002099 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002100 assert( pExpr->op==TK_TRUEFALSE );
drhf9751072021-10-07 13:40:29 +00002101 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh43c4ac82018-02-26 21:26:27 +00002102 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2103 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2104 return pExpr->u.zToken[4]==0;
2105}
2106
drh17180fc2019-04-19 17:26:19 +00002107/*
2108** If pExpr is an AND or OR expression, try to simplify it by eliminating
2109** terms that are always true or false. Return the simplified expression.
2110** Or return the original expression if no simplification is possible.
2111**
2112** Examples:
2113**
2114** (x<10) AND true => (x<10)
2115** (x<10) AND false => false
2116** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2117** (x<10) AND (y=22 OR true) => (x<10)
2118** (y=22) OR true => true
2119*/
2120Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2121 assert( pExpr!=0 );
2122 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2123 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2124 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2125 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2126 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2127 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2128 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2129 }
2130 }
2131 return pExpr;
2132}
2133
drh171d16b2018-02-26 20:15:54 +00002134
2135/*
drh059b2d52014-10-24 19:28:09 +00002136** These routines are Walker callbacks used to check expressions to
2137** see if they are "constant" for some definition of constant. The
2138** Walker.eCode value determines the type of "constant" we are looking
2139** for.
drh73b211a2005-01-18 04:00:42 +00002140**
drh7d10d5a2008-08-20 16:35:10 +00002141** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002142**
drh059b2d52014-10-24 19:28:09 +00002143** sqlite3ExprIsConstant() pWalker->eCode==1
2144** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002145** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002146** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002147**
drh059b2d52014-10-24 19:28:09 +00002148** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2149** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002150**
drh014fff22020-01-08 22:22:36 +00002151** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2152** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002153** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002154** when processing a new CREATE TABLE statement. A bound parameter raises
2155** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002156** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002157** contain a bound parameter because they were generated by older versions
2158** of SQLite to be parsed by newer versions of SQLite without raising a
2159** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002160*/
drh7d10d5a2008-08-20 16:35:10 +00002161static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002162
drh059b2d52014-10-24 19:28:09 +00002163 /* If pWalker->eCode is 2 then any term of the expression that comes from
2164 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002165 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002166 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2167 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002168 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002169 }
2170
drh626a8792005-01-17 22:08:19 +00002171 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002172 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002173 ** and either pWalker->eCode==4 or 5 or the function has the
2174 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002175 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002176 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2177 && !ExprHasProperty(pExpr, EP_WinFunc)
2178 ){
drh014fff22020-01-08 22:22:36 +00002179 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002180 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002181 }else{
2182 pWalker->eCode = 0;
2183 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002184 }
drh626a8792005-01-17 22:08:19 +00002185 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002186 /* Convert "true" or "false" in a DEFAULT clause into the
2187 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002188 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002189 return WRC_Prune;
2190 }
drh08b92082020-08-10 14:18:00 +00002191 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002192 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002193 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002194 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002195 testcase( pExpr->op==TK_ID );
2196 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002197 testcase( pExpr->op==TK_AGG_FUNCTION );
2198 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002199 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002200 return WRC_Continue;
2201 }
drh059b2d52014-10-24 19:28:09 +00002202 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2203 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002204 }
drh08b92082020-08-10 14:18:00 +00002205 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002206 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002207 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002208 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002209 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002210 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002211 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002212 pWalker->eCode = 0;
2213 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002214 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002215 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002216 /* Silently convert bound parameters that appear inside of CREATE
2217 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002218 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002219 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002220 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002221 /* A bound parameter in a CREATE statement that originates from
2222 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002223 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002224 return WRC_Abort;
2225 }
drh08b92082020-08-10 14:18:00 +00002226 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002227 default:
drh6e341b92018-04-17 18:50:40 +00002228 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2229 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002230 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002231 }
2232}
drh059b2d52014-10-24 19:28:09 +00002233static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002234 Walker w;
drh059b2d52014-10-24 19:28:09 +00002235 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002236 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002237 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002238#ifdef SQLITE_DEBUG
2239 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2240#endif
drh059b2d52014-10-24 19:28:09 +00002241 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002242 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002243 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002244}
drh626a8792005-01-17 22:08:19 +00002245
2246/*
drh059b2d52014-10-24 19:28:09 +00002247** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002248** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002249**
2250** For the purposes of this function, a double-quoted string (ex: "abc")
2251** is considered a variable but a single-quoted string (ex: 'abc') is
2252** a constant.
drhfef52082000-06-06 01:50:43 +00002253*/
danielk19774adee202004-05-08 08:23:19 +00002254int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002255 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002256}
2257
2258/*
drh07aded62018-07-28 16:24:08 +00002259** Walk an expression tree. Return non-zero if
2260**
2261** (1) the expression is constant, and
2262** (2) the expression does originate in the ON or USING clause
2263** of a LEFT JOIN, and
2264** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2265** operands created by the constant propagation optimization.
2266**
2267** When this routine returns true, it indicates that the expression
2268** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002269** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002270*/
2271int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002272 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002273}
2274
2275/*
drhfcb9f4f2015-06-01 18:13:16 +00002276** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002277** for any single row of the table with cursor iCur. In other words, the
2278** expression must not refer to any non-deterministic function nor any
2279** table other than iCur.
2280*/
2281int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2282 return exprIsConst(p, 3, iCur);
2283}
2284
danab31a842017-04-29 20:53:09 +00002285
2286/*
2287** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2288*/
2289static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2290 ExprList *pGroupBy = pWalker->u.pGroupBy;
2291 int i;
2292
2293 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2294 ** it constant. */
2295 for(i=0; i<pGroupBy->nExpr; i++){
2296 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002297 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002298 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002299 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002300 return WRC_Prune;
2301 }
2302 }
2303 }
2304
2305 /* Check if pExpr is a sub-select. If so, consider it variable. */
drha4eeccd2021-10-07 17:43:30 +00002306 if( ExprUseXSelect(pExpr) ){
danab31a842017-04-29 20:53:09 +00002307 pWalker->eCode = 0;
2308 return WRC_Abort;
2309 }
2310
2311 return exprNodeIsConstant(pWalker, pExpr);
2312}
2313
2314/*
2315** Walk the expression tree passed as the first argument. Return non-zero
2316** if the expression consists entirely of constants or copies of terms
2317** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002318**
2319** This routine is used to determine if a term of the HAVING clause can
2320** be promoted into the WHERE clause. In order for such a promotion to work,
2321** the value of the HAVING clause term must be the same for all members of
2322** a "group". The requirement that the GROUP BY term must be BINARY
2323** assumes that no other collating sequence will have a finer-grained
2324** grouping than binary. In other words (A=B COLLATE binary) implies
2325** A=B in every other collating sequence. The requirement that the
2326** GROUP BY be BINARY is stricter than necessary. It would also work
2327** to promote HAVING clauses that use the same alternative collating
2328** sequence as the GROUP BY term, but that is much harder to check,
2329** alternative collating sequences are uncommon, and this is only an
2330** optimization, so we take the easy way out and simply require the
2331** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002332*/
2333int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2334 Walker w;
danab31a842017-04-29 20:53:09 +00002335 w.eCode = 1;
2336 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002337 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002338 w.u.pGroupBy = pGroupBy;
2339 w.pParse = pParse;
2340 sqlite3WalkExpr(&w, p);
2341 return w.eCode;
2342}
2343
drh059b2d52014-10-24 19:28:09 +00002344/*
drh014fff22020-01-08 22:22:36 +00002345** Walk an expression tree for the DEFAULT field of a column definition
2346** in a CREATE TABLE statement. Return non-zero if the expression is
2347** acceptable for use as a DEFAULT. That is to say, return non-zero if
2348** the expression is constant or a function call with constant arguments.
2349** Return and 0 if there are any variables.
2350**
drh1e32bed2020-06-19 13:33:53 +00002351** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002352** processing a new CREATE TABLE statement. When isInit is true, parameters
2353** (such as ? or $abc) in the expression are converted into NULL. When
2354** isInit is false, parameters raise an error. Parameters should not be
2355** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002356** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002357** backwards compatibility.
2358**
2359** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002360**
2361** For the purposes of this function, a double-quoted string (ex: "abc")
2362** is considered a variable but a single-quoted string (ex: 'abc') is
2363** a constant.
2364*/
drhfeada2d2014-09-24 13:20:22 +00002365int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2366 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002367 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002368}
2369
drh5b88bc42013-12-07 23:35:21 +00002370#ifdef SQLITE_ENABLE_CURSOR_HINTS
2371/*
2372** Walk an expression tree. Return 1 if the expression contains a
2373** subquery of some kind. Return 0 if there are no subqueries.
2374*/
2375int sqlite3ExprContainsSubquery(Expr *p){
2376 Walker w;
drhbec24762015-08-13 20:07:13 +00002377 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002378 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002379 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002380#ifdef SQLITE_DEBUG
2381 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2382#endif
drh5b88bc42013-12-07 23:35:21 +00002383 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002384 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002385}
2386#endif
2387
drheb55bd22005-06-30 17:04:21 +00002388/*
drh73b211a2005-01-18 04:00:42 +00002389** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002390** to fit in a 32-bit integer, return 1 and put the value of the integer
2391** in *pValue. If the expression is not an integer or if it is too big
2392** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002393*/
drhb6dad522021-09-24 16:14:47 +00002394int sqlite3ExprIsInteger(const Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002395 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002396 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002397
2398 /* If an expression is an integer literal that fits in a signed 32-bit
2399 ** integer, then the EP_IntValue flag will have already been set */
2400 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2401 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2402
drh92b01d52008-06-24 00:32:35 +00002403 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002404 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002405 return 1;
2406 }
drhe4de1fe2002-06-02 16:09:01 +00002407 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002408 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002409 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002410 break;
drh4b59ab52002-08-24 18:24:51 +00002411 }
drhe4de1fe2002-06-02 16:09:01 +00002412 case TK_UMINUS: {
drhc59ffa82021-10-04 15:08:49 +00002413 int v = 0;
danielk19774adee202004-05-08 08:23:19 +00002414 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
drhc59ffa82021-10-04 15:08:49 +00002415 assert( ((unsigned int)v)!=0x80000000 );
drhe4de1fe2002-06-02 16:09:01 +00002416 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002417 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002418 }
2419 break;
2420 }
2421 default: break;
2422 }
drh92b01d52008-06-24 00:32:35 +00002423 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002424}
2425
2426/*
drh039fc322009-11-17 18:31:47 +00002427** Return FALSE if there is no chance that the expression can be NULL.
2428**
2429** If the expression might be NULL or if the expression is too complex
2430** to tell return TRUE.
2431**
2432** This routine is used as an optimization, to skip OP_IsNull opcodes
2433** when we know that a value cannot be NULL. Hence, a false positive
2434** (returning TRUE when in fact the expression can never be NULL) might
2435** be a small performance hit but is otherwise harmless. On the other
2436** hand, a false negative (returning FALSE when the result could be NULL)
2437** will likely result in an incorrect answer. So when in doubt, return
2438** TRUE.
2439*/
2440int sqlite3ExprCanBeNull(const Expr *p){
2441 u8 op;
drh3c6edc82021-04-26 15:28:06 +00002442 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002443 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2444 p = p->pLeft;
drh3c6edc82021-04-26 15:28:06 +00002445 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002446 }
drh039fc322009-11-17 18:31:47 +00002447 op = p->op;
2448 if( op==TK_REGISTER ) op = p->op2;
2449 switch( op ){
2450 case TK_INTEGER:
2451 case TK_STRING:
2452 case TK_FLOAT:
2453 case TK_BLOB:
2454 return 0;
drh7248a8b2014-08-04 18:50:54 +00002455 case TK_COLUMN:
drh477572b2021-10-07 20:46:29 +00002456 assert( ExprUseYTab(p) );
drh72673a22014-12-04 16:27:17 +00002457 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002458 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002459 (p->iColumn>=0
drh6df8c0c2021-11-28 19:54:38 +00002460 && p->y.pTab->aCol!=0 /* Possible due to prior error */
drh4eac5f02019-12-24 15:01:17 +00002461 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002462 default:
2463 return 1;
2464 }
2465}
2466
2467/*
2468** Return TRUE if the given expression is a constant which would be
2469** unchanged by OP_Affinity with the affinity given in the second
2470** argument.
2471**
2472** This routine is used to determine if the OP_Affinity operation
2473** can be omitted. When in doubt return FALSE. A false negative
2474** is harmless. A false positive, however, can result in the wrong
2475** answer.
2476*/
2477int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2478 u8 op;
drhaf866402019-08-22 11:11:28 +00002479 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002480 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002481 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2482 if( p->op==TK_UMINUS ) unaryMinus = 1;
2483 p = p->pLeft;
2484 }
drh039fc322009-11-17 18:31:47 +00002485 op = p->op;
2486 if( op==TK_REGISTER ) op = p->op2;
2487 switch( op ){
2488 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002489 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002490 }
2491 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002492 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002493 }
2494 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002495 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002496 }
2497 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002498 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002499 }
drh2f2855b2009-11-18 01:25:26 +00002500 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002501 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002502 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002503 }
drh039fc322009-11-17 18:31:47 +00002504 default: {
2505 return 0;
2506 }
2507 }
2508}
2509
2510/*
drhc4a3c772001-04-04 11:48:57 +00002511** Return TRUE if the given string is a row-id column name.
2512*/
danielk19774adee202004-05-08 08:23:19 +00002513int sqlite3IsRowid(const char *z){
2514 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2515 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2516 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002517 return 0;
2518}
2519
danielk19779a96b662007-11-29 17:05:18 +00002520/*
drh69c355b2016-03-09 15:34:51 +00002521** pX is the RHS of an IN operator. If pX is a SELECT statement
2522** that can be simplified to a direct table access, then return
2523** a pointer to the SELECT statement. If pX is not a SELECT statement,
2524** or if the SELECT statement needs to be manifested into a transient
2525** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002526*/
2527#ifndef SQLITE_OMIT_SUBQUERY
drhb6dad522021-09-24 16:14:47 +00002528static Select *isCandidateForInOpt(const Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002529 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002530 SrcList *pSrc;
2531 ExprList *pEList;
2532 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002533 int i;
drha4eeccd2021-10-07 17:43:30 +00002534 if( !ExprUseXSelect(pX) ) return 0; /* Not a subquery */
drh69c355b2016-03-09 15:34:51 +00002535 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2536 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002537 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002538 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002539 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2540 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2541 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002542 }
drh2e26a602020-01-06 18:59:46 +00002543 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002544 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002545 if( p->pWhere ) return 0; /* Has no WHERE clause */
2546 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002547 assert( pSrc!=0 );
2548 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002549 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002550 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002551 assert( pTab!=0 );
drhf38524d2021-08-02 16:41:57 +00002552 assert( !IsView(pTab) ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002553 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2554 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002555 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002556 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002557 for(i=0; i<pEList->nExpr; i++){
2558 Expr *pRes = pEList->a[i].pExpr;
2559 if( pRes->op!=TK_COLUMN ) return 0;
2560 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002561 }
drh69c355b2016-03-09 15:34:51 +00002562 return p;
drhb287f4b2008-04-25 00:08:38 +00002563}
2564#endif /* SQLITE_OMIT_SUBQUERY */
2565
danf9b2e052016-08-02 17:45:00 +00002566#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002567/*
drh4c259e92014-08-01 21:12:35 +00002568** Generate code that checks the left-most column of index table iCur to see if
2569** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002570** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2571** to be set to NULL if iCur contains one or more NULL values.
2572*/
2573static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002574 int addr1;
drh6be515e2014-08-01 21:00:53 +00002575 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002576 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002577 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2578 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002579 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002580 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002581}
danf9b2e052016-08-02 17:45:00 +00002582#endif
drh6be515e2014-08-01 21:00:53 +00002583
drhbb53ecb2014-08-02 21:03:33 +00002584
2585#ifndef SQLITE_OMIT_SUBQUERY
2586/*
2587** The argument is an IN operator with a list (not a subquery) on the
2588** right-hand side. Return TRUE if that list is constant.
2589*/
2590static int sqlite3InRhsIsConstant(Expr *pIn){
2591 Expr *pLHS;
2592 int res;
2593 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2594 pLHS = pIn->pLeft;
2595 pIn->pLeft = 0;
2596 res = sqlite3ExprIsConstant(pIn);
2597 pIn->pLeft = pLHS;
2598 return res;
2599}
2600#endif
2601
drh6be515e2014-08-01 21:00:53 +00002602/*
danielk19779a96b662007-11-29 17:05:18 +00002603** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002604** The pX parameter is the expression on the RHS of the IN operator, which
2605** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002606**
drhd4305ca2012-09-18 17:08:33 +00002607** The job of this routine is to find or create a b-tree object that can
2608** be used either to test for membership in the RHS set or to iterate through
2609** all members of the RHS set, skipping duplicates.
2610**
drh3a856252014-08-01 14:46:57 +00002611** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002612** and pX->iTable is set to the index of that cursor.
2613**
drhb74b1012009-05-28 21:04:37 +00002614** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002615**
drh1ccce442013-03-12 20:38:51 +00002616** IN_INDEX_ROWID - The cursor was opened on a database table.
2617** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2618** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2619** IN_INDEX_EPH - The cursor was opened on a specially created and
2620** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002621** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2622** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002623**
drhd4305ca2012-09-18 17:08:33 +00002624** An existing b-tree might be used if the RHS expression pX is a simple
2625** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002626**
dan553168c2016-08-01 20:14:31 +00002627** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002628**
drhd4305ca2012-09-18 17:08:33 +00002629** If the RHS of the IN operator is a list or a more complex subquery, then
2630** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002631** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002632** existing table.
drhd4305ca2012-09-18 17:08:33 +00002633**
drh7fc0ba02017-11-17 15:02:00 +00002634** The inFlags parameter must contain, at a minimum, one of the bits
2635** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2636** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2637** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2638** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002639**
2640** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2641** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002642** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002643** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2644** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002645**
drh3a856252014-08-01 14:46:57 +00002646** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2647** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002648** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2649** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002650**
drhbb53ecb2014-08-02 21:03:33 +00002651** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2652** if the RHS of the IN operator is a list (not a subquery) then this
2653** routine might decide that creating an ephemeral b-tree for membership
2654** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2655** calling routine should implement the IN operator using a sequence
2656** of Eq or Ne comparison operations.
2657**
drhb74b1012009-05-28 21:04:37 +00002658** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002659** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002660** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002661** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002662** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002663** to *prRhsHasNull. If there is no chance that the (...) contains a
2664** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002665**
drhe21a6e12014-08-01 18:00:24 +00002666** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002667** the value in that register will be NULL if the b-tree contains one or more
2668** NULL values, and it will be some non-NULL value if the b-tree contains no
2669** NULL values.
dan553168c2016-08-01 20:14:31 +00002670**
2671** If the aiMap parameter is not NULL, it must point to an array containing
2672** one element for each column returned by the SELECT statement on the RHS
2673** of the IN(...) operator. The i'th entry of the array is populated with the
2674** offset of the index column that matches the i'th column returned by the
2675** SELECT. For example, if the expression and selected index are:
2676**
2677** (?,?,?) IN (SELECT a, b, c FROM t1)
2678** CREATE INDEX i1 ON t1(b, c, a);
2679**
2680** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002681*/
danielk1977284f4ac2007-12-10 05:03:46 +00002682#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002683int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002684 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002685 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002686 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2687 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002688 int *aiMap, /* Mapping from Index fields to RHS fields */
2689 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002690){
drhb74b1012009-05-28 21:04:37 +00002691 Select *p; /* SELECT to the right of IN operator */
2692 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2693 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002694 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002695 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002696
drh1450bc62009-10-30 13:25:56 +00002697 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002698 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002699
dan7b35a772016-07-28 19:47:15 +00002700 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2701 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002702 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002703 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002704 ** set prRhsHasNull to 0 before continuing. */
drha4eeccd2021-10-07 17:43:30 +00002705 if( prRhsHasNull && ExprUseXSelect(pX) ){
dan7b35a772016-07-28 19:47:15 +00002706 int i;
2707 ExprList *pEList = pX->x.pSelect->pEList;
2708 for(i=0; i<pEList->nExpr; i++){
2709 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2710 }
2711 if( i==pEList->nExpr ){
2712 prRhsHasNull = 0;
2713 }
2714 }
2715
drhb74b1012009-05-28 21:04:37 +00002716 /* Check to see if an existing table or index can be used to
2717 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002718 ** ephemeral table. */
2719 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002720 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002721 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002722 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002723 ExprList *pEList = p->pEList;
2724 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002725
drhb07028f2011-10-14 21:49:18 +00002726 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2727 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2728 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2729 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002730
drhb22f7c82014-02-06 23:56:27 +00002731 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002732 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002733 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002734 sqlite3CodeVerifySchema(pParse, iDb);
2735 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002736
drha84a2832016-08-26 21:15:35 +00002737 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002738 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002739 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002740 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002741 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002742
2743 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2744 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002745 ExplainQueryPlan((pParse, 0,
2746 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002747 sqlite3VdbeJumpHere(v, iAddr);
2748 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002749 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002750 int affinity_ok = 1;
2751 int i;
2752
2753 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002754 ** comparison is the same as the affinity of each column in table
2755 ** on the RHS of the IN operator. If it not, it is not possible to
2756 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002757 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002758 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002759 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002760 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002761 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002762 testcase( cmpaff==SQLITE_AFF_BLOB );
2763 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002764 switch( cmpaff ){
2765 case SQLITE_AFF_BLOB:
2766 break;
2767 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002768 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2769 ** other has no affinity and the other side is TEXT. Hence,
2770 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2771 ** and for the term on the LHS of the IN to have no affinity. */
2772 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002773 break;
2774 default:
2775 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2776 }
2777 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002778
drha84a2832016-08-26 21:15:35 +00002779 if( affinity_ok ){
2780 /* Search for an existing index that will work for this IN operator */
2781 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2782 Bitmask colUsed; /* Columns of the index used */
2783 Bitmask mCol; /* Mask for the current column */
2784 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002785 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002786 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2787 ** BITMASK(nExpr) without overflowing */
2788 testcase( pIdx->nColumn==BMS-2 );
2789 testcase( pIdx->nColumn==BMS-1 );
2790 if( pIdx->nColumn>=BMS-1 ) continue;
2791 if( mustBeUnique ){
2792 if( pIdx->nKeyCol>nExpr
2793 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2794 ){
2795 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002796 }
danielk19770cdc0222008-06-26 18:04:03 +00002797 }
drha84a2832016-08-26 21:15:35 +00002798
2799 colUsed = 0; /* Columns of index used so far */
2800 for(i=0; i<nExpr; i++){
2801 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2802 Expr *pRhs = pEList->a[i].pExpr;
2803 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2804 int j;
2805
drh146121f2021-11-12 14:39:49 +00002806 assert( pReq!=0 || pRhs->iColumn==XN_ROWID
2807 || pParse->nErr || db->mallocFailed );
drha84a2832016-08-26 21:15:35 +00002808 for(j=0; j<nExpr; j++){
2809 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2810 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002811 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2812 continue;
2813 }
drha84a2832016-08-26 21:15:35 +00002814 break;
2815 }
2816 if( j==nExpr ) break;
2817 mCol = MASKBIT(j);
2818 if( mCol & colUsed ) break; /* Each column used only once */
2819 colUsed |= mCol;
2820 if( aiMap ) aiMap[i] = j;
2821 }
2822
2823 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2824 if( colUsed==(MASKBIT(nExpr)-1) ){
2825 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002826 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002827 ExplainQueryPlan((pParse, 0,
2828 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002829 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2830 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2831 VdbeComment((v, "%s", pIdx->zName));
2832 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2833 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2834
2835 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002836#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002837 i64 mask = (1<<nExpr)-1;
2838 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2839 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002840#endif
2841 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002842 if( nExpr==1 ){
2843 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2844 }
2845 }
2846 sqlite3VdbeJumpHere(v, iAddr);
2847 }
2848 } /* End loop over indexes */
2849 } /* End if( affinity_ok ) */
2850 } /* End if not an rowid index */
2851 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002852
drhbb53ecb2014-08-02 21:03:33 +00002853 /* If no preexisting index is available for the IN clause
2854 ** and IN_INDEX_NOOP is an allowed reply
2855 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002856 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002857 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002858 ** the IN operator so return IN_INDEX_NOOP.
2859 */
2860 if( eType==0
2861 && (inFlags & IN_INDEX_NOOP_OK)
drha4eeccd2021-10-07 17:43:30 +00002862 && ExprUseXList(pX)
drhbb53ecb2014-08-02 21:03:33 +00002863 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2864 ){
2865 eType = IN_INDEX_NOOP;
2866 }
drhbb53ecb2014-08-02 21:03:33 +00002867
danielk19779a96b662007-11-29 17:05:18 +00002868 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002869 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002870 ** We will have to generate an ephemeral table to do the job.
2871 */
drh8e23daf2013-06-11 13:30:04 +00002872 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002873 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002874 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002875 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002876 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002877 }else if( prRhsHasNull ){
2878 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002879 }
drh85bcdce2018-12-23 21:27:29 +00002880 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002881 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002882 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002883 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002884 }
drhcf4d38a2010-07-28 02:53:36 +00002885 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002886 }
danba00e302016-07-23 20:24:06 +00002887
2888 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2889 int i, n;
2890 n = sqlite3ExprVectorSize(pX->pLeft);
2891 for(i=0; i<n; i++) aiMap[i] = i;
2892 }
drh2c041312018-12-24 02:34:49 +00002893 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002894 return eType;
2895}
danielk1977284f4ac2007-12-10 05:03:46 +00002896#endif
drh626a8792005-01-17 22:08:19 +00002897
danf9b2e052016-08-02 17:45:00 +00002898#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002899/*
2900** Argument pExpr is an (?, ?...) IN(...) expression. This
2901** function allocates and returns a nul-terminated string containing
2902** the affinities to be used for each column of the comparison.
2903**
2904** It is the responsibility of the caller to ensure that the returned
2905** string is eventually freed using sqlite3DbFree().
2906*/
drhb6dad522021-09-24 16:14:47 +00002907static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
dan71c57db2016-07-09 20:23:55 +00002908 Expr *pLeft = pExpr->pLeft;
2909 int nVal = sqlite3ExprVectorSize(pLeft);
drha4eeccd2021-10-07 17:43:30 +00002910 Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002911 char *zRet;
2912
dan553168c2016-08-01 20:14:31 +00002913 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002914 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002915 if( zRet ){
2916 int i;
2917 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002918 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002919 char a = sqlite3ExprAffinity(pA);
2920 if( pSelect ){
2921 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2922 }else{
2923 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002924 }
dan71c57db2016-07-09 20:23:55 +00002925 }
2926 zRet[nVal] = '\0';
2927 }
2928 return zRet;
2929}
danf9b2e052016-08-02 17:45:00 +00002930#endif
dan71c57db2016-07-09 20:23:55 +00002931
dan8da209b2016-07-26 18:06:08 +00002932#ifndef SQLITE_OMIT_SUBQUERY
2933/*
2934** Load the Parse object passed as the first argument with an error
2935** message of the form:
2936**
2937** "sub-select returns N columns - expected M"
2938*/
2939void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002940 if( pParse->nErr==0 ){
2941 const char *zFmt = "sub-select returns %d columns - expected %d";
2942 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2943 }
dan8da209b2016-07-26 18:06:08 +00002944}
2945#endif
2946
drh626a8792005-01-17 22:08:19 +00002947/*
dan44c56042016-12-07 15:38:37 +00002948** Expression pExpr is a vector that has been used in a context where
2949** it is not permitted. If pExpr is a sub-select vector, this routine
2950** loads the Parse object with a message of the form:
2951**
2952** "sub-select returns N columns - expected 1"
2953**
2954** Or, if it is a regular scalar vector:
2955**
2956** "row value misused"
2957*/
2958void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2959#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00002960 if( ExprUseXSelect(pExpr) ){
dan44c56042016-12-07 15:38:37 +00002961 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2962 }else
2963#endif
2964 {
2965 sqlite3ErrorMsg(pParse, "row value misused");
2966 }
2967}
2968
drh85bcdce2018-12-23 21:27:29 +00002969#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002970/*
drh85bcdce2018-12-23 21:27:29 +00002971** Generate code that will construct an ephemeral table containing all terms
2972** in the RHS of an IN operator. The IN operator can be in either of two
2973** forms:
drh626a8792005-01-17 22:08:19 +00002974**
drh9cbe6352005-11-29 03:13:21 +00002975** x IN (4,5,11) -- IN operator with list on right-hand side
2976** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002977**
drh2c041312018-12-24 02:34:49 +00002978** The pExpr parameter is the IN operator. The cursor number for the
2979** constructed ephermeral table is returned. The first time the ephemeral
2980** table is computed, the cursor number is also stored in pExpr->iTable,
2981** however the cursor number returned might not be the same, as it might
2982** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002983**
drh85bcdce2018-12-23 21:27:29 +00002984** If the LHS expression ("x" in the examples) is a column value, or
2985** the SELECT statement returns a column value, then the affinity of that
2986** column is used to build the index keys. If both 'x' and the
2987** SELECT... statement are columns, then numeric affinity is used
2988** if either column has NUMERIC or INTEGER affinity. If neither
2989** 'x' nor the SELECT... statement are columns, then numeric affinity
2990** is used.
drhcce7d172000-05-31 15:34:51 +00002991*/
drh85bcdce2018-12-23 21:27:29 +00002992void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002993 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002994 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002995 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002996){
drh2c041312018-12-24 02:34:49 +00002997 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002998 int addr; /* Address of OP_OpenEphemeral instruction */
2999 Expr *pLeft; /* the LHS of the IN operator */
3000 KeyInfo *pKeyInfo = 0; /* Key information */
3001 int nVal; /* Size of vector pLeft */
3002 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00003003
drh2c041312018-12-24 02:34:49 +00003004 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003005 assert( v!=0 );
3006
drh2c041312018-12-24 02:34:49 +00003007 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00003008 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00003009 **
3010 ** * The right-hand side is a correlated subquery
3011 ** * The right-hand side is an expression list containing variables
3012 ** * We are inside a trigger
3013 **
drh2c041312018-12-24 02:34:49 +00003014 ** If all of the above are false, then we can compute the RHS just once
3015 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00003016 */
drhefb699f2018-12-24 11:55:44 +00003017 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00003018 /* Reuse of the RHS is allowed */
3019 /* If this routine has already been coded, but the previous code
3020 ** might not have been invoked yet, so invoke it now as a subroutine.
3021 */
3022 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00003023 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha4eeccd2021-10-07 17:43:30 +00003024 if( ExprUseXSelect(pExpr) ){
drhbd462bc2018-12-24 20:21:06 +00003025 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3026 pExpr->x.pSelect->selId));
3027 }
drh477572b2021-10-07 20:46:29 +00003028 assert( ExprUseYSub(pExpr) );
drh2c041312018-12-24 02:34:49 +00003029 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3030 pExpr->y.sub.iAddr);
3031 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00003032 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00003033 return;
3034 }
3035
3036 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003037 assert( !ExprUseYWin(pExpr) );
drh2c041312018-12-24 02:34:49 +00003038 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00003039 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00003040 pExpr->y.sub.regReturn = ++pParse->nMem;
3041 pExpr->y.sub.iAddr =
3042 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3043 VdbeComment((v, "return address"));
3044
3045 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003046 }
3047
drh85bcdce2018-12-23 21:27:29 +00003048 /* Check to see if this is a vector IN operator */
3049 pLeft = pExpr->pLeft;
3050 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00003051
drh85bcdce2018-12-23 21:27:29 +00003052 /* Construct the ephemeral table that will contain the content of
3053 ** RHS of the IN operator.
3054 */
drh2c041312018-12-24 02:34:49 +00003055 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00003056 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00003057#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drha4eeccd2021-10-07 17:43:30 +00003058 if( ExprUseXSelect(pExpr) ){
drh2c041312018-12-24 02:34:49 +00003059 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
3060 }else{
3061 VdbeComment((v, "RHS of IN operator"));
3062 }
3063#endif
drh50ef6712019-02-22 23:29:56 +00003064 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00003065
drha4eeccd2021-10-07 17:43:30 +00003066 if( ExprUseXSelect(pExpr) ){
drh85bcdce2018-12-23 21:27:29 +00003067 /* Case 1: expr IN (SELECT ...)
3068 **
3069 ** Generate code to write the results of the select into the temporary
3070 ** table allocated and opened above.
3071 */
3072 Select *pSelect = pExpr->x.pSelect;
3073 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00003074
drh2c041312018-12-24 02:34:49 +00003075 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
3076 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00003077 ));
drh85bcdce2018-12-23 21:27:29 +00003078 /* If the LHS and RHS of the IN operator do not match, that
3079 ** error will have been caught long before we reach this point. */
3080 if( ALWAYS(pEList->nExpr==nVal) ){
drh14c4d422021-05-26 18:46:51 +00003081 Select *pCopy;
drh85bcdce2018-12-23 21:27:29 +00003082 SelectDest dest;
3083 int i;
drh14c4d422021-05-26 18:46:51 +00003084 int rc;
drhbd462bc2018-12-24 20:21:06 +00003085 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00003086 dest.zAffSdst = exprINAffinity(pParse, pExpr);
3087 pSelect->iLimit = 0;
3088 testcase( pSelect->selFlags & SF_Distinct );
3089 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh14c4d422021-05-26 18:46:51 +00003090 pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
3091 rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
3092 sqlite3SelectDelete(pParse->db, pCopy);
3093 sqlite3DbFree(pParse->db, dest.zAffSdst);
3094 if( rc ){
drh85bcdce2018-12-23 21:27:29 +00003095 sqlite3KeyInfoUnref(pKeyInfo);
3096 return;
drh14c4d422021-05-26 18:46:51 +00003097 }
drh85bcdce2018-12-23 21:27:29 +00003098 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
3099 assert( pEList!=0 );
3100 assert( pEList->nExpr>0 );
3101 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3102 for(i=0; i<nVal; i++){
3103 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3104 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3105 pParse, p, pEList->a[i].pExpr
3106 );
danielk197741a05b72008-10-02 13:50:55 +00003107 }
drh85bcdce2018-12-23 21:27:29 +00003108 }
3109 }else if( ALWAYS(pExpr->x.pList!=0) ){
3110 /* Case 2: expr IN (exprlist)
3111 **
3112 ** For each expression, build an index key from the evaluation and
3113 ** store it in the temporary table. If <expr> is a column, then use
3114 ** that columns affinity when building index keys. If <expr> is not
3115 ** a column, use numeric affinity.
3116 */
3117 char affinity; /* Affinity of the LHS of the IN */
3118 int i;
3119 ExprList *pList = pExpr->x.pList;
3120 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003121 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003122 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003123 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003124 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003125 }else if( affinity==SQLITE_AFF_REAL ){
3126 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003127 }
3128 if( pKeyInfo ){
3129 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3130 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003131 }
3132
drh85bcdce2018-12-23 21:27:29 +00003133 /* Loop through each expression in <exprlist>. */
3134 r1 = sqlite3GetTempReg(pParse);
3135 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003136 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3137 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003138
3139 /* If the expression is not constant then we will need to
3140 ** disable the test that was generated above that makes sure
3141 ** this code only executes once. Because for a non-constant
3142 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003143 */
drh2c041312018-12-24 02:34:49 +00003144 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
3145 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003146 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003147 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003148 }
drh1398ad32005-01-19 23:24:50 +00003149
drh85bcdce2018-12-23 21:27:29 +00003150 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003151 sqlite3ExprCode(pParse, pE2, r1);
3152 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3153 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003154 }
drh85bcdce2018-12-23 21:27:29 +00003155 sqlite3ReleaseTempReg(pParse, r1);
3156 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003157 }
drh85bcdce2018-12-23 21:27:29 +00003158 if( pKeyInfo ){
3159 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3160 }
drh2c041312018-12-24 02:34:49 +00003161 if( addrOnce ){
3162 sqlite3VdbeJumpHere(v, addrOnce);
3163 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003164 assert( ExprUseYSub(pExpr) );
drh2c041312018-12-24 02:34:49 +00003165 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3166 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003167 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003168 }
3169}
3170#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003171
drh85bcdce2018-12-23 21:27:29 +00003172/*
3173** Generate code for scalar subqueries used as a subquery expression
3174** or EXISTS operator:
3175**
3176** (SELECT a FROM b) -- subquery
3177** EXISTS (SELECT a FROM b) -- EXISTS subquery
3178**
3179** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3180**
drhd86fe442019-08-26 13:45:49 +00003181** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003182** the result is stored in a contiguous array of registers and the
3183** return value is the register of the left-most result column.
3184** Return 0 if an error occurs.
3185*/
3186#ifndef SQLITE_OMIT_SUBQUERY
3187int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003188 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003189 int rReg = 0; /* Register storing resulting */
3190 Select *pSel; /* SELECT statement to encode */
3191 SelectDest dest; /* How to deal with SELECT result */
3192 int nReg; /* Registers to allocate */
3193 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003194
3195 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003196 assert( v!=0 );
drh05428122021-05-24 00:17:04 +00003197 if( pParse->nErr ) return 0;
drhbd462bc2018-12-24 20:21:06 +00003198 testcase( pExpr->op==TK_EXISTS );
3199 testcase( pExpr->op==TK_SELECT );
3200 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
drha4eeccd2021-10-07 17:43:30 +00003201 assert( ExprUseXSelect(pExpr) );
drhbd462bc2018-12-24 20:21:06 +00003202 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003203
drh14c4d422021-05-26 18:46:51 +00003204 /* If this routine has already been coded, then invoke it as a
3205 ** subroutine. */
3206 if( ExprHasProperty(pExpr, EP_Subrtn) ){
3207 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh477572b2021-10-07 20:46:29 +00003208 assert( ExprUseYSub(pExpr) );
drh14c4d422021-05-26 18:46:51 +00003209 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3210 pExpr->y.sub.iAddr);
3211 return pExpr->iTable;
3212 }
3213
3214 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003215 assert( !ExprUseYWin(pExpr) );
3216 assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
drh14c4d422021-05-26 18:46:51 +00003217 ExprSetProperty(pExpr, EP_Subrtn);
3218 pExpr->y.sub.regReturn = ++pParse->nMem;
3219 pExpr->y.sub.iAddr =
3220 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3221 VdbeComment((v, "return address"));
3222
3223
drh5198ff52018-12-24 12:09:47 +00003224 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003225 ** is encountered if any of the following is true:
3226 **
3227 ** * The right-hand side is a correlated subquery
3228 ** * The right-hand side is an expression list containing variables
3229 ** * We are inside a trigger
3230 **
3231 ** If all of the above are false, then we can run this code just once
3232 ** save the results, and reuse the same result on subsequent invocations.
3233 */
3234 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh2c041312018-12-24 02:34:49 +00003235 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003236 }
drh85bcdce2018-12-23 21:27:29 +00003237
3238 /* For a SELECT, generate code to put the values for all columns of
3239 ** the first row into an array of registers and return the index of
3240 ** the first register.
3241 **
3242 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3243 ** into a register and return that register number.
3244 **
3245 ** In both cases, the query is augmented with "LIMIT 1". Any
3246 ** preexisting limit is discarded in place of the new LIMIT 1.
3247 */
drhbd462bc2018-12-24 20:21:06 +00003248 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3249 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003250 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3251 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3252 pParse->nMem += nReg;
3253 if( pExpr->op==TK_SELECT ){
3254 dest.eDest = SRT_Mem;
3255 dest.iSdst = dest.iSDParm;
3256 dest.nSdst = nReg;
3257 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3258 VdbeComment((v, "Init subquery result"));
3259 }else{
3260 dest.eDest = SRT_Exists;
3261 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3262 VdbeComment((v, "Init EXISTS result"));
3263 }
drh85bcdce2018-12-23 21:27:29 +00003264 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003265 /* The subquery already has a limit. If the pre-existing limit is X
3266 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3267 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003268 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003269 if( pLimit ){
3270 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3271 pLimit = sqlite3PExpr(pParse, TK_NE,
3272 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3273 }
3274 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003275 pSel->pLimit->pLeft = pLimit;
3276 }else{
drh7ca13472019-09-23 11:55:22 +00003277 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003278 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003279 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3280 }
3281 pSel->iLimit = 0;
3282 if( sqlite3Select(pParse, pSel, &dest) ){
drhbf7f3a02021-05-24 11:35:16 +00003283 if( pParse->nErr ){
3284 pExpr->op2 = pExpr->op;
3285 pExpr->op = TK_ERROR;
3286 }
drh85bcdce2018-12-23 21:27:29 +00003287 return 0;
3288 }
drh2c041312018-12-24 02:34:49 +00003289 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003290 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003291 if( addrOnce ){
3292 sqlite3VdbeJumpHere(v, addrOnce);
drh5198ff52018-12-24 12:09:47 +00003293 }
drh2c041312018-12-24 02:34:49 +00003294
drh14c4d422021-05-26 18:46:51 +00003295 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003296 assert( ExprUseYSub(pExpr) );
drh14c4d422021-05-26 18:46:51 +00003297 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3298 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
3299 sqlite3ClearTempRegCache(pParse);
drh1450bc62009-10-30 13:25:56 +00003300 return rReg;
drhcce7d172000-05-31 15:34:51 +00003301}
drh51522cd2005-01-20 13:36:19 +00003302#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003303
drhe3365e62009-11-12 17:52:24 +00003304#ifndef SQLITE_OMIT_SUBQUERY
3305/*
dan7b35a772016-07-28 19:47:15 +00003306** Expr pIn is an IN(...) expression. This function checks that the
3307** sub-select on the RHS of the IN() operator has the same number of
3308** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3309** a sub-query, that the LHS is a vector of size 1.
3310*/
3311int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3312 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
drha4eeccd2021-10-07 17:43:30 +00003313 if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
dan7b35a772016-07-28 19:47:15 +00003314 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3315 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3316 return 1;
3317 }
3318 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003319 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003320 return 1;
3321 }
3322 return 0;
3323}
3324#endif
3325
3326#ifndef SQLITE_OMIT_SUBQUERY
3327/*
drhe3365e62009-11-12 17:52:24 +00003328** Generate code for an IN expression.
3329**
3330** x IN (SELECT ...)
3331** x IN (value, value, ...)
3332**
drhecb87ac2016-08-25 15:46:25 +00003333** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003334** right-hand side (RHS) is an array of zero or more scalar values, or a
3335** subquery. If the RHS is a subquery, the number of result columns must
3336** match the number of columns in the vector on the LHS. If the RHS is
3337** a list of values, the LHS must be a scalar.
3338**
3339** The IN operator is true if the LHS value is contained within the RHS.
3340** The result is false if the LHS is definitely not in the RHS. The
3341** result is NULL if the presence of the LHS in the RHS cannot be
3342** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003343**
drh6be515e2014-08-01 21:00:53 +00003344** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003345** contained within the RHS. If due to NULLs we cannot determine if the LHS
3346** is contained in the RHS then jump to destIfNull. If the LHS is contained
3347** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003348**
3349** See the separate in-operator.md documentation file in the canonical
3350** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003351*/
3352static void sqlite3ExprCodeIN(
3353 Parse *pParse, /* Parsing and code generating context */
3354 Expr *pExpr, /* The IN expression */
3355 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3356 int destIfNull /* Jump here if the results are unknown due to NULLs */
3357){
3358 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003359 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003360 int rLhs; /* Register(s) holding the LHS values */
3361 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003362 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003363 int *aiMap = 0; /* Map from vector field to index column */
3364 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003365 int nVector; /* Size of vectors for this IN operator */
3366 int iDummy; /* Dummy parameter to exprCodeVector() */
3367 Expr *pLeft; /* The LHS of the IN operator */
3368 int i; /* loop counter */
3369 int destStep2; /* Where to jump when NULLs seen in step 2 */
3370 int destStep6 = 0; /* Start of code for Step 6 */
3371 int addrTruthOp; /* Address of opcode that determines the IN is true */
3372 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3373 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003374 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003375 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003376
drhe7375bf2020-03-10 19:24:38 +00003377 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003378 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003379 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003380 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003381 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3382 aiMap = (int*)sqlite3DbMallocZero(
3383 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3384 );
drhe347d3e2016-08-25 21:14:34 +00003385 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003386
danba00e302016-07-23 20:24:06 +00003387 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003388 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003389 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3390 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003391 v = pParse->pVdbe;
3392 assert( v!=0 ); /* OOM detected prior to this routine */
3393 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003394 eType = sqlite3FindInIndex(pParse, pExpr,
3395 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003396 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3397 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003398
danba00e302016-07-23 20:24:06 +00003399 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3400 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3401 );
drhecb87ac2016-08-25 15:46:25 +00003402#ifdef SQLITE_DEBUG
3403 /* Confirm that aiMap[] contains nVector integer values between 0 and
3404 ** nVector-1. */
3405 for(i=0; i<nVector; i++){
3406 int j, cnt;
3407 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3408 assert( cnt==1 );
3409 }
3410#endif
drhe3365e62009-11-12 17:52:24 +00003411
danba00e302016-07-23 20:24:06 +00003412 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3413 ** vector, then it is stored in an array of nVector registers starting
3414 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003415 **
3416 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3417 ** so that the fields are in the same order as an existing index. The
3418 ** aiMap[] array contains a mapping from the original LHS field order to
3419 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003420 **
3421 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3422 ** even if it is constant, as OP_Affinity may be used on the register
3423 ** by code generated below. */
3424 assert( pParse->okConstFactor==okConstFactor );
3425 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003426 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003427 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003428 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003429 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003430 /* LHS fields are not reordered */
3431 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003432 }else{
3433 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003434 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003435 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003436 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003437 }
danba00e302016-07-23 20:24:06 +00003438 }
drhe3365e62009-11-12 17:52:24 +00003439
drhbb53ecb2014-08-02 21:03:33 +00003440 /* If sqlite3FindInIndex() did not find or create an index that is
3441 ** suitable for evaluating the IN operator, then evaluate using a
3442 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003443 **
3444 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003445 */
drhbb53ecb2014-08-02 21:03:33 +00003446 if( eType==IN_INDEX_NOOP ){
drha4eeccd2021-10-07 17:43:30 +00003447 ExprList *pList;
3448 CollSeq *pColl;
drhec4ccdb2018-12-29 02:26:59 +00003449 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003450 int r2, regToFree;
3451 int regCkNull = 0;
3452 int ii;
drha4eeccd2021-10-07 17:43:30 +00003453 assert( ExprUseXList(pExpr) );
3454 pList = pExpr->x.pList;
3455 pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhbb53ecb2014-08-02 21:03:33 +00003456 if( destIfNull!=destIfFalse ){
3457 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003458 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003459 }
3460 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003461 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003462 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003463 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3464 }
drhf6ea97e2020-01-04 15:21:47 +00003465 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003466 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003467 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3468 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003469 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003470 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3471 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3472 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3473 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003474 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003475 }else{
drh47994882019-12-22 23:48:36 +00003476 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003477 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003478 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3479 (void*)pColl, P4_COLLSEQ);
3480 VdbeCoverageIf(v, op==OP_Ne);
3481 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003482 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003483 }
drhbb53ecb2014-08-02 21:03:33 +00003484 }
3485 if( regCkNull ){
3486 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003487 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003488 }
3489 sqlite3VdbeResolveLabel(v, labelOk);
3490 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003491 goto sqlite3ExprCodeIN_finished;
3492 }
3493
3494 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3495 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3496 ** We will then skip the binary search of the RHS.
3497 */
3498 if( destIfNull==destIfFalse ){
3499 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003500 }else{
drhec4ccdb2018-12-29 02:26:59 +00003501 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003502 }
drh4eac5f02019-12-24 15:01:17 +00003503 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003504 for(i=0; i<nVector; i++){
3505 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
drh4c4a2572021-04-06 12:50:24 +00003506 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
drhe347d3e2016-08-25 21:14:34 +00003507 if( sqlite3ExprCanBeNull(p) ){
3508 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003509 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003510 }
drhe3365e62009-11-12 17:52:24 +00003511 }
drhe347d3e2016-08-25 21:14:34 +00003512
3513 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3514 ** of the RHS using the LHS as a probe. If found, the result is
3515 ** true.
3516 */
3517 if( eType==IN_INDEX_ROWID ){
3518 /* In this case, the RHS is the ROWID of table b-tree and so we also
3519 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3520 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003521 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003522 VdbeCoverage(v);
3523 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3524 }else{
3525 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3526 if( destIfFalse==destIfNull ){
3527 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003528 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003529 rLhs, nVector); VdbeCoverage(v);
3530 goto sqlite3ExprCodeIN_finished;
3531 }
3532 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003533 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003534 rLhs, nVector); VdbeCoverage(v);
3535 }
3536
3537 /* Step 4. If the RHS is known to be non-NULL and we did not find
3538 ** an match on the search above, then the result must be FALSE.
3539 */
3540 if( rRhsHasNull && nVector==1 ){
3541 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3542 VdbeCoverage(v);
3543 }
3544
3545 /* Step 5. If we do not care about the difference between NULL and
3546 ** FALSE, then just return false.
3547 */
3548 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3549
3550 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3551 ** If any comparison is NULL, then the result is NULL. If all
3552 ** comparisons are FALSE then the final result is FALSE.
3553 **
3554 ** For a scalar LHS, it is sufficient to check just the first row
3555 ** of the RHS.
3556 */
3557 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003558 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003559 VdbeCoverage(v);
3560 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003561 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003562 }else{
3563 /* For nVector==1, combine steps 6 and 7 by immediately returning
3564 ** FALSE if the first comparison is not NULL */
3565 destNotNull = destIfFalse;
3566 }
3567 for(i=0; i<nVector; i++){
3568 Expr *p;
3569 CollSeq *pColl;
3570 int r3 = sqlite3GetTempReg(pParse);
3571 p = sqlite3VectorFieldSubexpr(pLeft, i);
3572 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003573 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003574 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3575 (void*)pColl, P4_COLLSEQ);
3576 VdbeCoverage(v);
3577 sqlite3ReleaseTempReg(pParse, r3);
3578 }
3579 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3580 if( nVector>1 ){
3581 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003582 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003583 VdbeCoverage(v);
3584
3585 /* Step 7: If we reach this point, we know that the result must
3586 ** be false. */
3587 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3588 }
3589
3590 /* Jumps here in order to return true. */
3591 sqlite3VdbeJumpHere(v, addrTruthOp);
3592
3593sqlite3ExprCodeIN_finished:
3594 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003595 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003596sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003597 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003598 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003599}
3600#endif /* SQLITE_OMIT_SUBQUERY */
3601
drh13573c72010-01-12 17:04:07 +00003602#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003603/*
3604** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003605** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003606**
3607** The z[] string will probably not be zero-terminated. But the
3608** z[n] character is guaranteed to be something that does not look
3609** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003610*/
drhb7916a72009-05-27 10:31:29 +00003611static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003612 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003613 double value;
drh9339da12010-09-30 00:50:49 +00003614 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003615 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3616 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003617 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003618 }
3619}
drh13573c72010-01-12 17:04:07 +00003620#endif
drh598f1342007-10-23 15:39:45 +00003621
3622
3623/*
drhfec19aa2004-05-19 20:41:03 +00003624** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003625** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003626**
shaneh5f1d6b62010-09-30 16:51:25 +00003627** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003628*/
drh13573c72010-01-12 17:04:07 +00003629static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3630 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003631 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003632 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003633 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003634 if( negFlag ) i = -i;
3635 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003636 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003637 int c;
3638 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003639 const char *z = pExpr->u.zToken;
3640 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003641 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003642 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003643#ifdef SQLITE_OMIT_FLOATING_POINT
3644 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3645#else
drh1b7ddc52014-07-23 14:52:05 +00003646#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003647 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003648 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003649 }else
3650#endif
3651 {
drh9296c182014-07-23 13:40:49 +00003652 codeReal(v, z, negFlag, iMem);
3653 }
drh13573c72010-01-12 17:04:07 +00003654#endif
drh77320ea2016-11-30 14:47:37 +00003655 }else{
drh84d4f1a2017-09-20 10:47:10 +00003656 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003657 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003658 }
drhfec19aa2004-05-19 20:41:03 +00003659 }
3660}
3661
drh5cd79232009-05-25 11:46:29 +00003662
drh1f9ca2c2015-08-25 16:57:52 +00003663/* Generate code that will load into register regOut a value that is
3664** appropriate for the iIdxCol-th column of index pIdx.
3665*/
3666void sqlite3ExprCodeLoadIndexColumn(
3667 Parse *pParse, /* The parsing context */
3668 Index *pIdx, /* The index whose column is to be loaded */
3669 int iTabCur, /* Cursor pointing to a table row */
3670 int iIdxCol, /* The column of the index to be loaded */
3671 int regOut /* Store the index column value in this register */
3672){
3673 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003674 if( iTabCol==XN_EXPR ){
3675 assert( pIdx->aColExpr );
3676 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003677 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003678 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003679 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003680 }else{
drh6df9c4b2019-10-18 12:52:08 +00003681 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003682 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003683 }
drh1f9ca2c2015-08-25 16:57:52 +00003684}
3685
drhe70fa7f2019-10-22 21:01:34 +00003686#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3687/*
3688** Generate code that will compute the value of generated column pCol
3689** and store the result in register regOut
3690*/
3691void sqlite3ExprCodeGeneratedColumn(
drh79cf2b72021-07-31 20:30:41 +00003692 Parse *pParse, /* Parsing context */
3693 Table *pTab, /* Table containing the generated column */
3694 Column *pCol, /* The generated column */
3695 int regOut /* Put the result in this register */
drhe70fa7f2019-10-22 21:01:34 +00003696){
drh4dad7ed2019-12-16 16:52:22 +00003697 int iAddr;
3698 Vdbe *v = pParse->pVdbe;
3699 assert( v!=0 );
3700 assert( pParse->iSelfTab!=0 );
3701 if( pParse->iSelfTab>0 ){
3702 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3703 }else{
3704 iAddr = 0;
3705 }
drh79cf2b72021-07-31 20:30:41 +00003706 sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
drhe70fa7f2019-10-22 21:01:34 +00003707 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003708 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003709 }
drh4dad7ed2019-12-16 16:52:22 +00003710 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003711}
3712#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3713
drh5cd79232009-05-25 11:46:29 +00003714/*
drh5c092e82010-05-14 19:24:02 +00003715** Generate code to extract the value of the iCol-th column of a table.
3716*/
3717void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003718 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003719 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003720 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003721 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003722 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003723){
drhab45fc02019-10-16 22:01:56 +00003724 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003725 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003726 if( pTab==0 ){
3727 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3728 return;
3729 }
drh5c092e82010-05-14 19:24:02 +00003730 if( iCol<0 || iCol==pTab->iPKey ){
3731 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3732 }else{
drh81f7b372019-10-16 12:18:59 +00003733 int op;
3734 int x;
3735 if( IsVirtual(pTab) ){
3736 op = OP_VColumn;
3737 x = iCol;
3738#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003739 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003740 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003741 if( pCol->colFlags & COLFLAG_BUSY ){
drhcf9d36d2021-08-02 18:03:43 +00003742 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3743 pCol->zCnName);
drhab45fc02019-10-16 22:01:56 +00003744 }else{
3745 int savedSelfTab = pParse->iSelfTab;
3746 pCol->colFlags |= COLFLAG_BUSY;
3747 pParse->iSelfTab = iTabCur+1;
drh79cf2b72021-07-31 20:30:41 +00003748 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003749 pParse->iSelfTab = savedSelfTab;
3750 pCol->colFlags &= ~COLFLAG_BUSY;
3751 }
drh81f7b372019-10-16 12:18:59 +00003752 return;
3753#endif
3754 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003755 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003756 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003757 op = OP_Column;
3758 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003759 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003760 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003761 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003762 }
3763 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003764 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3765 }
3766}
3767
3768/*
drh945498f2007-02-24 11:52:52 +00003769** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003770** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003771**
3772** There must be an open cursor to pTab in iTable when this routine
3773** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003774*/
drhe55cbd72008-03-31 23:48:03 +00003775int sqlite3ExprCodeGetColumn(
3776 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003777 Table *pTab, /* Description of the table we are reading from */
3778 int iColumn, /* Index of the table column */
3779 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003780 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003781 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003782){
drh81f7b372019-10-16 12:18:59 +00003783 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003784 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003785 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003786 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3787 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003788 }
drhe55cbd72008-03-31 23:48:03 +00003789 return iReg;
3790}
drhe55cbd72008-03-31 23:48:03 +00003791
3792/*
drhb21e7c72008-06-22 12:37:57 +00003793** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003794** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003795*/
drhb21e7c72008-06-22 12:37:57 +00003796void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003797 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003798}
3799
drh652fbf52008-04-01 01:42:41 +00003800/*
drh12abf402016-08-22 14:30:05 +00003801** Convert a scalar expression node to a TK_REGISTER referencing
3802** register iReg. The caller must ensure that iReg already contains
3803** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003804*/
dan069d1b12019-06-16 08:58:14 +00003805static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003806 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003807 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003808 p->op2 = p->op;
3809 p->op = TK_REGISTER;
3810 p->iTable = iReg;
3811 ExprClearProperty(p, EP_Skip);
3812}
3813
drh12abf402016-08-22 14:30:05 +00003814/*
3815** Evaluate an expression (either a vector or a scalar expression) and store
3816** the result in continguous temporary registers. Return the index of
3817** the first register used to store the result.
3818**
3819** If the returned result register is a temporary scalar, then also write
3820** that register number into *piFreeable. If the returned result register
3821** is not a temporary or if the expression is a vector set *piFreeable
3822** to 0.
3823*/
3824static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3825 int iResult;
3826 int nResult = sqlite3ExprVectorSize(p);
3827 if( nResult==1 ){
3828 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3829 }else{
3830 *piFreeable = 0;
3831 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003832#if SQLITE_OMIT_SUBQUERY
3833 iResult = 0;
3834#else
drh85bcdce2018-12-23 21:27:29 +00003835 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003836#endif
drh12abf402016-08-22 14:30:05 +00003837 }else{
3838 int i;
3839 iResult = pParse->nMem+1;
3840 pParse->nMem += nResult;
drha4eeccd2021-10-07 17:43:30 +00003841 assert( ExprUseXList(p) );
drh12abf402016-08-22 14:30:05 +00003842 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003843 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003844 }
3845 }
3846 }
3847 return iResult;
3848}
3849
drh25c42962020-01-01 13:55:08 +00003850/*
drh92a27f72020-02-04 01:41:44 +00003851** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3852** so that a subsequent copy will not be merged into this one.
3853*/
3854static void setDoNotMergeFlagOnCopy(Vdbe *v){
3855 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3856 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3857 }
3858}
3859
3860/*
drh25c42962020-01-01 13:55:08 +00003861** Generate code to implement special SQL functions that are implemented
3862** in-line rather than by using the usual callbacks.
3863*/
3864static int exprCodeInlineFunction(
3865 Parse *pParse, /* Parsing context */
3866 ExprList *pFarg, /* List of function arguments */
3867 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3868 int target /* Store function result in this register */
3869){
3870 int nFarg;
3871 Vdbe *v = pParse->pVdbe;
3872 assert( v!=0 );
3873 assert( pFarg!=0 );
3874 nFarg = pFarg->nExpr;
3875 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3876 switch( iFuncId ){
3877 case INLINEFUNC_coalesce: {
3878 /* Attempt a direct implementation of the built-in COALESCE() and
3879 ** IFNULL() functions. This avoids unnecessary evaluation of
3880 ** arguments past the first non-NULL argument.
3881 */
3882 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3883 int i;
3884 assert( nFarg>=2 );
3885 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3886 for(i=1; i<nFarg; i++){
3887 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3888 VdbeCoverage(v);
3889 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3890 }
drh92a27f72020-02-04 01:41:44 +00003891 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003892 sqlite3VdbeResolveLabel(v, endCoalesce);
3893 break;
3894 }
drh3c0e6062020-05-13 18:03:34 +00003895 case INLINEFUNC_iif: {
3896 Expr caseExpr;
3897 memset(&caseExpr, 0, sizeof(caseExpr));
3898 caseExpr.op = TK_CASE;
3899 caseExpr.x.pList = pFarg;
3900 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3901 }
drh25c42962020-01-01 13:55:08 +00003902
drh171c50e2020-01-01 15:43:30 +00003903 default: {
drh25c42962020-01-01 13:55:08 +00003904 /* The UNLIKELY() function is a no-op. The result is the value
3905 ** of the first argument.
3906 */
drh171c50e2020-01-01 15:43:30 +00003907 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003908 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3909 break;
3910 }
3911
drh171c50e2020-01-01 15:43:30 +00003912 /***********************************************************************
3913 ** Test-only SQL functions that are only usable if enabled
3914 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3915 */
drh3780f9a2021-09-17 13:07:15 +00003916#if !defined(SQLITE_UNTESTABLE)
drh171c50e2020-01-01 15:43:30 +00003917 case INLINEFUNC_expr_compare: {
3918 /* Compare two expressions using sqlite3ExprCompare() */
3919 assert( nFarg==2 );
3920 sqlite3VdbeAddOp2(v, OP_Integer,
3921 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3922 target);
3923 break;
3924 }
3925
3926 case INLINEFUNC_expr_implies_expr: {
3927 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3928 assert( nFarg==2 );
3929 sqlite3VdbeAddOp2(v, OP_Integer,
3930 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3931 target);
3932 break;
3933 }
3934
3935 case INLINEFUNC_implies_nonnull_row: {
3936 /* REsult of sqlite3ExprImpliesNonNullRow() */
3937 Expr *pA1;
3938 assert( nFarg==2 );
3939 pA1 = pFarg->a[1].pExpr;
3940 if( pA1->op==TK_COLUMN ){
3941 sqlite3VdbeAddOp2(v, OP_Integer,
3942 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3943 target);
3944 }else{
3945 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3946 }
3947 break;
3948 }
3949
drh25c42962020-01-01 13:55:08 +00003950 case INLINEFUNC_affinity: {
3951 /* The AFFINITY() function evaluates to a string that describes
3952 ** the type affinity of the argument. This is used for testing of
3953 ** the SQLite type logic.
3954 */
3955 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3956 char aff;
3957 assert( nFarg==1 );
3958 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3959 sqlite3VdbeLoadString(v, target,
3960 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3961 break;
3962 }
drh3780f9a2021-09-17 13:07:15 +00003963#endif /* !defined(SQLITE_UNTESTABLE) */
drh25c42962020-01-01 13:55:08 +00003964 }
3965 return target;
3966}
3967
dan71c57db2016-07-09 20:23:55 +00003968
drha4c3c872013-09-12 17:29:25 +00003969/*
drhcce7d172000-05-31 15:34:51 +00003970** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003971** expression. Attempt to store the results in register "target".
3972** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003973**
drh8b213892008-08-29 02:14:02 +00003974** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003975** be stored in target. The result might be stored in some other
3976** register if it is convenient to do so. The calling function
3977** must check the return code and move the results to the desired
3978** register.
drhcce7d172000-05-31 15:34:51 +00003979*/
drh678ccce2008-03-31 18:19:54 +00003980int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003981 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3982 int op; /* The opcode being coded */
3983 int inReg = target; /* Results stored in register inReg */
3984 int regFree1 = 0; /* If non-zero free this temporary register */
3985 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003986 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003987 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003988 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003989
drh9cbf3422008-01-17 16:22:13 +00003990 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003991 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003992
drh1efa8022018-04-28 04:16:43 +00003993expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003994 if( pExpr==0 ){
3995 op = TK_NULL;
3996 }else{
drhe7375bf2020-03-10 19:24:38 +00003997 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003998 op = pExpr->op;
3999 }
drhf2bc0132004-10-04 13:19:23 +00004000 switch( op ){
drh13449892005-09-07 21:22:45 +00004001 case TK_AGG_COLUMN: {
4002 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004003 struct AggInfo_col *pCol;
4004 assert( pAggInfo!=0 );
4005 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4006 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00004007 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00004008 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00004009 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00004010 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00004011 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00004012 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00004013 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00004014 if( pCol->iColumn<0 ){
4015 VdbeComment((v,"%s.rowid",pTab->zName));
4016 }else{
drhcf9d36d2021-08-02 18:03:43 +00004017 VdbeComment((v,"%s.%s",
4018 pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
drh8d5cea62020-03-11 02:04:15 +00004019 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
4020 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4021 }
drh0c76e892020-03-10 11:50:43 +00004022 }
drhc332cc32016-09-19 10:24:19 +00004023 return target;
drh13449892005-09-07 21:22:45 +00004024 }
4025 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00004026 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00004027 }
drh967e8b72000-06-21 13:59:10 +00004028 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00004029 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00004030 int iReg;
drhefad2e22018-07-27 16:57:11 +00004031 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00004032 /* This COLUMN expression is really a constant due to WHERE clause
4033 ** constraints, and that constant is coded by the pExpr->pLeft
4034 ** expresssion. However, make sure the constant has the correct
4035 ** datatype by applying the Affinity of the table column to the
4036 ** constant.
4037 */
drh57f7ece2019-11-21 18:28:44 +00004038 int aff;
drh67b9ba12019-12-20 20:45:02 +00004039 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh477572b2021-10-07 20:46:29 +00004040 assert( ExprUseYTab(pExpr) );
drh57f7ece2019-11-21 18:28:44 +00004041 if( pExpr->y.pTab ){
4042 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
4043 }else{
4044 aff = pExpr->affExpr;
4045 }
drh96fb16e2019-08-06 14:37:24 +00004046 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00004047 static const char zAff[] = "B\000C\000D\000E";
4048 assert( SQLITE_AFF_BLOB=='A' );
4049 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00004050 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4051 &zAff[(aff-'B')*2], P4_STATIC);
4052 }
4053 return iReg;
drhefad2e22018-07-27 16:57:11 +00004054 }
drhb2b9d3d2013-08-01 01:14:43 +00004055 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00004056 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00004057 /* Other columns in the same row for CHECK constraints or
4058 ** generated columns or for inserting into partial index.
4059 ** The row is unpacked into registers beginning at
4060 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
4061 ** immediately prior to the first column.
4062 */
4063 Column *pCol;
drh477572b2021-10-07 20:46:29 +00004064 Table *pTab;
drh9942ef02019-10-18 02:19:18 +00004065 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00004066 int iCol = pExpr->iColumn;
drh477572b2021-10-07 20:46:29 +00004067 assert( ExprUseYTab(pExpr) );
4068 pTab = pExpr->y.pTab;
drh9942ef02019-10-18 02:19:18 +00004069 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00004070 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00004071 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00004072 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00004073 return -1-pParse->iSelfTab;
4074 }
drhc5f808d2019-10-19 15:01:52 +00004075 pCol = pTab->aCol + iCol;
4076 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4077 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00004078#ifndef SQLITE_OMIT_GENERATED_COLUMNS
4079 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00004080 if( pCol->colFlags & COLFLAG_BUSY ){
4081 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
drhcf9d36d2021-08-02 18:03:43 +00004082 pCol->zCnName);
drh4e8e5332019-11-07 02:32:54 +00004083 return 0;
4084 }
4085 pCol->colFlags |= COLFLAG_BUSY;
4086 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
drh79cf2b72021-07-31 20:30:41 +00004087 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
drh4e8e5332019-11-07 02:32:54 +00004088 }
4089 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00004090 return iSrc;
drh9942ef02019-10-18 02:19:18 +00004091 }else
4092#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
4093 if( pCol->affinity==SQLITE_AFF_REAL ){
4094 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00004095 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4096 return target;
4097 }else{
drh9942ef02019-10-18 02:19:18 +00004098 return iSrc;
drhbffdd632019-09-02 00:58:44 +00004099 }
drhb2b9d3d2013-08-01 01:14:43 +00004100 }else{
drh1f9ca2c2015-08-25 16:57:52 +00004101 /* Coding an expression that is part of an index where column names
4102 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00004103 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00004104 }
drh22827922000-06-06 17:27:05 +00004105 }
drh477572b2021-10-07 20:46:29 +00004106 assert( ExprUseYTab(pExpr) );
drh67b9ba12019-12-20 20:45:02 +00004107 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00004108 pExpr->iColumn, iTab, target,
4109 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00004110 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
4111 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
4112 }
4113 return iReg;
drhcce7d172000-05-31 15:34:51 +00004114 }
4115 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00004116 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00004117 return target;
drhfec19aa2004-05-19 20:41:03 +00004118 }
drh8abed7b2018-02-26 18:49:05 +00004119 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00004120 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00004121 return target;
4122 }
drh13573c72010-01-12 17:04:07 +00004123#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004124 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004125 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4126 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004127 return target;
drh598f1342007-10-23 15:39:45 +00004128 }
drh13573c72010-01-12 17:04:07 +00004129#endif
drhfec19aa2004-05-19 20:41:03 +00004130 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004131 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004132 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004133 return target;
drhcce7d172000-05-31 15:34:51 +00004134 }
drhaac30f92019-12-14 15:01:55 +00004135 default: {
drhc29af652019-12-18 21:22:40 +00004136 /* Make NULL the default case so that if a bug causes an illegal
4137 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004138 ** sanely and not crash. But keep the assert() to bring the problem
4139 ** to the attention of the developers. */
drh05428122021-05-24 00:17:04 +00004140 assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
drh9de221d2008-01-05 06:51:30 +00004141 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004142 return target;
drhf0863fe2005-06-12 21:35:51 +00004143 }
danielk19775338a5f2005-01-20 13:03:10 +00004144#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004145 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004146 int n;
4147 const char *z;
drhca48c902008-01-18 14:08:24 +00004148 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00004149 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4150 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4151 assert( pExpr->u.zToken[1]=='\'' );
4152 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004153 n = sqlite3Strlen30(z) - 1;
4154 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004155 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4156 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004157 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004158 }
danielk19775338a5f2005-01-20 13:03:10 +00004159#endif
drh50457892003-09-06 01:10:47 +00004160 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004161 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4162 assert( pExpr->u.zToken!=0 );
4163 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004164 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4165 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004166 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004167 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004168 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004169 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004170 }
drhc332cc32016-09-19 10:24:19 +00004171 return target;
drh50457892003-09-06 01:10:47 +00004172 }
drh4e0cff62004-11-05 05:10:28 +00004173 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004174 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004175 }
drh487e2622005-06-25 18:42:14 +00004176#ifndef SQLITE_OMIT_CAST
4177 case TK_CAST: {
4178 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004179 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004180 if( inReg!=target ){
4181 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4182 inReg = target;
4183 }
drhf9751072021-10-07 13:40:29 +00004184 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh4169e432014-08-25 20:11:52 +00004185 sqlite3VdbeAddOp2(v, OP_Cast, target,
4186 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004187 return inReg;
drh487e2622005-06-25 18:42:14 +00004188 }
4189#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004190 case TK_IS:
4191 case TK_ISNOT:
4192 op = (op==TK_IS) ? TK_EQ : TK_NE;
4193 p5 = SQLITE_NULLEQ;
4194 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004195 case TK_LT:
4196 case TK_LE:
4197 case TK_GT:
4198 case TK_GE:
4199 case TK_NE:
4200 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004201 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004202 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004203 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004204 }else{
4205 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4206 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004207 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4208 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4209 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004210 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004211 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4212 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4213 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4214 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4215 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4216 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004217 if( p5==SQLITE_NULLEQ ){
4218 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4219 }else{
4220 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4221 }
dan71c57db2016-07-09 20:23:55 +00004222 testcase( regFree1==0 );
4223 testcase( regFree2==0 );
4224 }
drh6a2fe092009-09-23 02:29:36 +00004225 break;
4226 }
drhcce7d172000-05-31 15:34:51 +00004227 case TK_AND:
4228 case TK_OR:
4229 case TK_PLUS:
4230 case TK_STAR:
4231 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004232 case TK_REM:
4233 case TK_BITAND:
4234 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004235 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004236 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004237 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004238 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004239 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4240 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4241 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4242 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4243 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4244 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4245 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4246 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4247 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4248 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4249 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004250 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4251 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004252 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004253 testcase( regFree1==0 );
4254 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004255 break;
4256 }
drhcce7d172000-05-31 15:34:51 +00004257 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004258 Expr *pLeft = pExpr->pLeft;
4259 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004260 if( pLeft->op==TK_INTEGER ){
4261 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004262 return target;
drh13573c72010-01-12 17:04:07 +00004263#ifndef SQLITE_OMIT_FLOATING_POINT
4264 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004265 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4266 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004267 return target;
drh13573c72010-01-12 17:04:07 +00004268#endif
drh3c84ddf2008-01-09 02:15:38 +00004269 }else{
drh10d1edf2013-11-15 15:52:39 +00004270 tempX.op = TK_INTEGER;
4271 tempX.flags = EP_IntValue|EP_TokenOnly;
4272 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004273 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004274 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004275 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004276 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004277 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004278 }
drh3c84ddf2008-01-09 02:15:38 +00004279 break;
drh6e142f52000-06-08 13:36:40 +00004280 }
drhbf4133c2001-10-13 02:59:08 +00004281 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004282 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004283 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4284 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004285 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4286 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004287 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004288 break;
4289 }
drh8abed7b2018-02-26 18:49:05 +00004290 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004291 int isTrue; /* IS TRUE or IS NOT TRUE */
4292 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004293 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4294 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004295 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4296 bNormal = pExpr->op2==TK_IS;
4297 testcase( isTrue && bNormal);
4298 testcase( !isTrue && bNormal);
4299 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004300 break;
4301 }
drhcce7d172000-05-31 15:34:51 +00004302 case TK_ISNULL:
4303 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004304 int addr;
drh7d176102014-02-18 03:07:12 +00004305 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4306 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004307 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004308 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004309 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004310 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004311 VdbeCoverageIf(v, op==TK_ISNULL);
4312 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004313 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004314 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004315 break;
drhcce7d172000-05-31 15:34:51 +00004316 }
drh22827922000-06-06 17:27:05 +00004317 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004318 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004319 if( pInfo==0
4320 || NEVER(pExpr->iAgg<0)
4321 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4322 ){
drh33e619f2009-05-28 01:00:55 +00004323 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4324 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004325 }else{
drhc332cc32016-09-19 10:24:19 +00004326 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004327 }
drh22827922000-06-06 17:27:05 +00004328 break;
4329 }
drhcce7d172000-05-31 15:34:51 +00004330 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004331 ExprList *pFarg; /* List of function arguments */
4332 int nFarg; /* Number of function arguments */
4333 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004334 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004335 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004336 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004337 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004338 u8 enc = ENC(db); /* The text encoding used by this database */
4339 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004340
dan67a9b8e2018-06-22 20:51:35 +00004341#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004342 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4343 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004344 }
dan67a9b8e2018-06-22 20:51:35 +00004345#endif
dan86fb6e12018-05-16 20:58:07 +00004346
drh1e9b53f2017-01-04 01:07:24 +00004347 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004348 /* SQL functions can be expensive. So try to avoid running them
4349 ** multiple times if we know they always give the same result */
4350 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004351 }
drhe7375bf2020-03-10 19:24:38 +00004352 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
drha4eeccd2021-10-07 17:43:30 +00004353 assert( ExprUseXList(pExpr) );
drhe7375bf2020-03-10 19:24:38 +00004354 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004355 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004356 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4357 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004358 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004359#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4360 if( pDef==0 && pParse->explain ){
4361 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4362 }
4363#endif
danb6e9f7a2018-05-19 14:15:29 +00004364 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004365 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004366 break;
4367 }
drh25c42962020-01-01 13:55:08 +00004368 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004369 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4370 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004371 return exprCodeInlineFunction(pParse, pFarg,
4372 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004373 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4374 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004375 }
4376
drhd1a01ed2013-11-21 16:08:52 +00004377 for(i=0; i<nFarg; i++){
4378 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004379 testcase( i==31 );
4380 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004381 }
4382 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4383 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4384 }
4385 }
drh12ffee82009-04-08 13:51:51 +00004386 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004387 if( constMask ){
4388 r1 = pParse->nMem+1;
4389 pParse->nMem += nFarg;
4390 }else{
4391 r1 = sqlite3GetTempRange(pParse, nFarg);
4392 }
drha748fdc2012-03-28 01:34:47 +00004393
4394 /* For length() and typeof() functions with a column argument,
4395 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4396 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4397 ** loading.
4398 */
drhd36e1042013-09-06 13:10:12 +00004399 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004400 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004401 assert( nFarg==1 );
4402 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004403 exprOp = pFarg->a[0].pExpr->op;
4404 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004405 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4406 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004407 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4408 pFarg->a[0].pExpr->op2 =
4409 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004410 }
4411 }
4412
drh5579d592015-08-26 14:01:41 +00004413 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004414 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004415 }else{
drh12ffee82009-04-08 13:51:51 +00004416 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004417 }
drhb7f6f682006-07-08 17:06:43 +00004418#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004419 /* Possibly overload the function if the first argument is
4420 ** a virtual table column.
4421 **
4422 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4423 ** second argument, not the first, as the argument to test to
4424 ** see if it is a column in a virtual table. This is done because
4425 ** the left operand of infix functions (the operand we want to
4426 ** control overloading) ends up as the second argument to the
4427 ** function. The expression "A glob B" is equivalent to
4428 ** "glob(B,A). We want to use the A in "A glob B" to test
4429 ** for function overloading. But we use the B term in "glob(B,A)".
4430 */
drh59155062018-05-26 18:03:48 +00004431 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004432 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4433 }else if( nFarg>0 ){
4434 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004435 }
4436#endif
drhd36e1042013-09-06 13:10:12 +00004437 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004438 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004439 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004440 }
drh092457b2017-12-29 15:04:49 +00004441#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh7d4c94b2021-10-04 22:34:38 +00004442 if( (pDef->funcFlags & SQLITE_FUNC_OFFSET)!=0 && ALWAYS(pFarg!=0) ){
drh2fc865c2017-12-16 20:20:37 +00004443 Expr *pArg = pFarg->a[0].pExpr;
4444 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004445 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004446 }else{
4447 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4448 }
drh092457b2017-12-29 15:04:49 +00004449 }else
4450#endif
4451 {
drh920cf592019-10-30 16:29:02 +00004452 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004453 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004454 }
drh13d79502019-12-23 02:18:49 +00004455 if( nFarg ){
4456 if( constMask==0 ){
4457 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4458 }else{
drh3aef2fb2020-01-02 17:46:02 +00004459 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004460 }
drh2dcef112008-01-12 19:03:48 +00004461 }
drhc332cc32016-09-19 10:24:19 +00004462 return target;
drhcce7d172000-05-31 15:34:51 +00004463 }
drhfe2093d2005-01-20 22:48:47 +00004464#ifndef SQLITE_OMIT_SUBQUERY
4465 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004466 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004467 int nCol;
drhc5499be2008-04-01 15:06:33 +00004468 testcase( op==TK_EXISTS );
4469 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004470 if( pParse->db->mallocFailed ){
4471 return 0;
drha4eeccd2021-10-07 17:43:30 +00004472 }else if( op==TK_SELECT
4473 && ALWAYS( ExprUseXSelect(pExpr) )
4474 && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4475 ){
dan8da209b2016-07-26 18:06:08 +00004476 sqlite3SubselectError(pParse, nCol, 1);
4477 }else{
drh85bcdce2018-12-23 21:27:29 +00004478 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004479 }
drh19a775c2000-06-05 18:54:46 +00004480 break;
4481 }
drhfc7f27b2016-08-20 00:07:01 +00004482 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004483 int n;
drhfc7f27b2016-08-20 00:07:01 +00004484 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004485 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004486 }
drh10f08272021-07-05 01:11:26 +00004487 assert( pExpr->pLeft->op==TK_SELECT || pExpr->pLeft->op==TK_ERROR );
4488 n = sqlite3ExprVectorSize(pExpr->pLeft);
4489 if( pExpr->iTable!=n ){
drh966e2912017-01-03 02:58:01 +00004490 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4491 pExpr->iTable, n);
4492 }
drhc332cc32016-09-19 10:24:19 +00004493 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004494 }
drhfef52082000-06-06 01:50:43 +00004495 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004496 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4497 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004498 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4499 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4500 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4501 sqlite3VdbeResolveLabel(v, destIfFalse);
4502 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4503 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004504 return target;
drhfef52082000-06-06 01:50:43 +00004505 }
drhe3365e62009-11-12 17:52:24 +00004506#endif /* SQLITE_OMIT_SUBQUERY */
4507
4508
drh2dcef112008-01-12 19:03:48 +00004509 /*
4510 ** x BETWEEN y AND z
4511 **
4512 ** This is equivalent to
4513 **
4514 ** x>=y AND x<=z
4515 **
4516 ** X is stored in pExpr->pLeft.
4517 ** Y is stored in pExpr->pList->a[0].pExpr.
4518 ** Z is stored in pExpr->pList->a[1].pExpr.
4519 */
drhfef52082000-06-06 01:50:43 +00004520 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004521 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004522 return target;
drhfef52082000-06-06 01:50:43 +00004523 }
drh94fa9c42016-02-27 21:16:04 +00004524 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004525 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004526 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004527 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004528 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004529 }
drh2dcef112008-01-12 19:03:48 +00004530
dan165921a2009-08-28 18:53:45 +00004531 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004532 /* If the opcode is TK_TRIGGER, then the expression is a reference
4533 ** to a column in the new.* or old.* pseudo-tables available to
4534 ** trigger programs. In this case Expr.iTable is set to 1 for the
4535 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4536 ** is set to the column of the pseudo-table to read, or to -1 to
4537 ** read the rowid field.
4538 **
4539 ** The expression is implemented using an OP_Param opcode. The p1
4540 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4541 ** to reference another column of the old.* pseudo-table, where
4542 ** i is the index of the column. For a new.rowid reference, p1 is
4543 ** set to (n+1), where n is the number of columns in each pseudo-table.
4544 ** For a reference to any other column in the new.* pseudo-table, p1
4545 ** is set to (n+2+i), where n and i are as defined previously. For
4546 ** example, if the table on which triggers are being fired is
4547 ** declared as:
4548 **
4549 ** CREATE TABLE t1(a, b);
4550 **
4551 ** Then p1 is interpreted as follows:
4552 **
4553 ** p1==0 -> old.rowid p1==3 -> new.rowid
4554 ** p1==1 -> old.a p1==4 -> new.a
4555 ** p1==2 -> old.b p1==5 -> new.b
4556 */
drh477572b2021-10-07 20:46:29 +00004557 Table *pTab;
4558 int iCol;
4559 int p1;
4560
4561 assert( ExprUseYTab(pExpr) );
4562 pTab = pExpr->y.pTab;
4563 iCol = pExpr->iColumn;
4564 p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004565 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004566
4567 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004568 assert( iCol>=-1 && iCol<pTab->nCol );
4569 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004570 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4571
4572 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004573 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004574 (pExpr->iTable ? "new" : "old"),
drhcf9d36d2021-08-02 18:03:43 +00004575 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
dan165921a2009-08-28 18:53:45 +00004576 ));
dan65a7cd12009-09-01 12:16:01 +00004577
drh44dbca82010-01-13 04:22:20 +00004578#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004579 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004580 ** integer. Use OP_RealAffinity to make sure it is really real.
4581 **
4582 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4583 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004584 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004585 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4586 }
drh44dbca82010-01-13 04:22:20 +00004587#endif
dan165921a2009-08-28 18:53:45 +00004588 break;
4589 }
4590
dan71c57db2016-07-09 20:23:55 +00004591 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004592 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004593 break;
4594 }
4595
drh9e9a67a2019-08-17 17:07:15 +00004596 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4597 ** that derive from the right-hand table of a LEFT JOIN. The
4598 ** Expr.iTable value is the table number for the right-hand table.
4599 ** The expression is only evaluated if that table is not currently
4600 ** on a LEFT JOIN NULL row.
4601 */
drh31d6fd52017-04-14 19:03:10 +00004602 case TK_IF_NULL_ROW: {
4603 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004604 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004605 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004606 /* Temporarily disable factoring of constant expressions, since
4607 ** even though expressions may appear to be constant, they are not
4608 ** really constant because they originate from the right-hand side
4609 ** of a LEFT JOIN. */
4610 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004611 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004612 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004613 sqlite3VdbeJumpHere(v, addrINR);
4614 sqlite3VdbeChangeP3(v, addrINR, inReg);
4615 break;
4616 }
4617
drh2dcef112008-01-12 19:03:48 +00004618 /*
4619 ** Form A:
4620 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4621 **
4622 ** Form B:
4623 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4624 **
4625 ** Form A is can be transformed into the equivalent form B as follows:
4626 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4627 ** WHEN x=eN THEN rN ELSE y END
4628 **
4629 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004630 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4631 ** odd. The Y is also optional. If the number of elements in x.pList
4632 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004633 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4634 **
4635 ** The result of the expression is the Ri for the first matching Ei,
4636 ** or if there is no matching Ei, the ELSE term Y, or if there is
4637 ** no ELSE term, NULL.
4638 */
drhaac30f92019-12-14 15:01:55 +00004639 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004640 int endLabel; /* GOTO label for end of CASE stmt */
4641 int nextCase; /* GOTO label for next WHEN clause */
4642 int nExpr; /* 2x number of WHEN terms */
4643 int i; /* Loop counter */
4644 ExprList *pEList; /* List of WHEN terms */
4645 struct ExprList_item *aListelem; /* Array of WHEN terms */
4646 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004647 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004648 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004649 Expr *pDel = 0;
4650 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004651
drha4eeccd2021-10-07 17:43:30 +00004652 assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00004653 assert(pExpr->x.pList->nExpr > 0);
4654 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004655 aListelem = pEList->a;
4656 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004657 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004658 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004659 pDel = sqlite3ExprDup(db, pX, 0);
4660 if( db->mallocFailed ){
4661 sqlite3ExprDelete(db, pDel);
4662 break;
4663 }
drh33cd4902009-05-30 20:49:20 +00004664 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004665 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004666 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004667 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004668 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004669 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004670 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004671 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4672 ** The value in regFree1 might get SCopy-ed into the file result.
4673 ** So make sure that the regFree1 register is not reused for other
4674 ** purposes and possibly overwritten. */
4675 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004676 }
drhc5cd1242013-09-12 16:50:49 +00004677 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004678 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004679 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004680 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004681 }else{
drh2dcef112008-01-12 19:03:48 +00004682 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004683 }
drhec4ccdb2018-12-29 02:26:59 +00004684 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004685 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004686 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004687 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004688 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004689 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004690 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004691 }
drhc5cd1242013-09-12 16:50:49 +00004692 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004693 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004694 }else{
drh9de221d2008-01-05 06:51:30 +00004695 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004696 }
dan8b65e592019-07-17 14:34:17 +00004697 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004698 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004699 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004700 break;
4701 }
danielk19775338a5f2005-01-20 13:03:10 +00004702#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004703 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004704 assert( pExpr->affExpr==OE_Rollback
4705 || pExpr->affExpr==OE_Abort
4706 || pExpr->affExpr==OE_Fail
4707 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004708 );
drh9e5fdc42020-05-08 19:02:21 +00004709 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004710 sqlite3ErrorMsg(pParse,
4711 "RAISE() may only be used within a trigger-program");
4712 return 0;
4713 }
drh11949042019-08-05 18:01:42 +00004714 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004715 sqlite3MayAbort(pParse);
4716 }
dan165921a2009-08-28 18:53:45 +00004717 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004718 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004719 sqlite3VdbeAddOp4(
4720 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004721 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004722 }else{
drh9e5fdc42020-05-08 19:02:21 +00004723 sqlite3HaltConstraint(pParse,
4724 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4725 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004726 }
4727
drhffe07b22005-11-03 00:41:17 +00004728 break;
drh17a7f8d2002-03-24 13:13:27 +00004729 }
danielk19775338a5f2005-01-20 13:03:10 +00004730#endif
drhffe07b22005-11-03 00:41:17 +00004731 }
drh2dcef112008-01-12 19:03:48 +00004732 sqlite3ReleaseTempReg(pParse, regFree1);
4733 sqlite3ReleaseTempReg(pParse, regFree2);
4734 return inReg;
4735}
4736
4737/*
drh9b258c52020-03-11 19:41:49 +00004738** Generate code that will evaluate expression pExpr just one time
4739** per prepared statement execution.
4740**
4741** If the expression uses functions (that might throw an exception) then
4742** guard them with an OP_Once opcode to ensure that the code is only executed
4743** once. If no functions are involved, then factor the code out and put it at
4744** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004745**
drhad879ff2017-01-04 04:10:02 +00004746** If regDest>=0 then the result is always stored in that register and the
4747** result is not reusable. If regDest<0 then this routine is free to
4748** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004749** is stored is returned. When regDest<0, two identical expressions might
4750** code to the same register, if they do not contain function calls and hence
4751** are factored out into the initialization section at the end of the
4752** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004753*/
drh9b258c52020-03-11 19:41:49 +00004754int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004755 Parse *pParse, /* Parsing context */
4756 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004757 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004758){
drhd1a01ed2013-11-21 16:08:52 +00004759 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004760 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004761 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004762 if( regDest<0 && p ){
4763 struct ExprList_item *pItem;
4764 int i;
4765 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004766 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004767 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004768 }
4769 }
drh1e9b53f2017-01-04 01:07:24 +00004770 }
drhd1a01ed2013-11-21 16:08:52 +00004771 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004772 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4773 Vdbe *v = pParse->pVdbe;
4774 int addr;
4775 assert( v );
4776 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4777 pParse->okConstFactor = 0;
4778 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004779 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004780 sqlite3ExprCode(pParse, pExpr, regDest);
4781 }
4782 pParse->okConstFactor = 1;
4783 sqlite3ExprDelete(pParse->db, pExpr);
4784 sqlite3VdbeJumpHere(v, addr);
4785 }else{
4786 p = sqlite3ExprListAppend(pParse, p, pExpr);
4787 if( p ){
4788 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4789 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004790 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004791 pItem->u.iConstExprReg = regDest;
4792 }
4793 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004794 }
drh1e9b53f2017-01-04 01:07:24 +00004795 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004796}
4797
4798/*
drh2dcef112008-01-12 19:03:48 +00004799** Generate code to evaluate an expression and store the results
4800** into a register. Return the register number where the results
4801** are stored.
4802**
4803** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004804** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004805** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004806**
4807** If pExpr is a constant, then this routine might generate this
4808** code to fill the register in the initialization section of the
4809** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004810*/
4811int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004812 int r2;
drh0d950af2019-08-22 16:38:42 +00004813 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004814 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004815 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004816 && pExpr->op!=TK_REGISTER
4817 && sqlite3ExprIsConstantNotJoin(pExpr)
4818 ){
drhf30a9692013-11-15 01:10:18 +00004819 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004820 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004821 }else{
drhf30a9692013-11-15 01:10:18 +00004822 int r1 = sqlite3GetTempReg(pParse);
4823 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4824 if( r2==r1 ){
4825 *pReg = r1;
4826 }else{
4827 sqlite3ReleaseTempReg(pParse, r1);
4828 *pReg = 0;
4829 }
drh2dcef112008-01-12 19:03:48 +00004830 }
4831 return r2;
4832}
4833
4834/*
4835** Generate code that will evaluate expression pExpr and store the
4836** results in register target. The results are guaranteed to appear
4837** in register target.
4838*/
drh05a86c52014-02-16 01:55:49 +00004839void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004840 int inReg;
4841
drhe7375bf2020-03-10 19:24:38 +00004842 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004843 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004844 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004845 if( pParse->pVdbe==0 ) return;
4846 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4847 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004848 u8 op;
drh952f35b2021-10-02 17:46:24 +00004849 if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
drh629b88c2020-01-02 02:50:45 +00004850 op = OP_Copy;
4851 }else{
4852 op = OP_SCopy;
4853 }
4854 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004855 }
drhcce7d172000-05-31 15:34:51 +00004856}
4857
4858/*
drh1c75c9d2015-12-21 15:22:13 +00004859** Make a transient copy of expression pExpr and then code it using
4860** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4861** except that the input expression is guaranteed to be unchanged.
4862*/
4863void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4864 sqlite3 *db = pParse->db;
4865 pExpr = sqlite3ExprDup(db, pExpr, 0);
4866 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4867 sqlite3ExprDelete(db, pExpr);
4868}
4869
4870/*
drh05a86c52014-02-16 01:55:49 +00004871** Generate code that will evaluate expression pExpr and store the
4872** results in register target. The results are guaranteed to appear
4873** in register target. If the expression is constant, then this routine
4874** might choose to code the expression at initialization time.
4875*/
4876void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004877 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004878 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004879 }else{
drh088489e2020-03-10 02:57:37 +00004880 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004881 }
drhcce7d172000-05-31 15:34:51 +00004882}
4883
4884/*
drh268380c2004-02-25 13:47:31 +00004885** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004886** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004887**
drh3df6c3b2017-09-15 15:38:01 +00004888** Return the number of elements evaluated. The number returned will
4889** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4890** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004891**
4892** The SQLITE_ECEL_DUP flag prevents the arguments from being
4893** filled using OP_SCopy. OP_Copy must be used instead.
4894**
4895** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4896** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004897**
4898** The SQLITE_ECEL_REF flag means that expressions in the list with
4899** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4900** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004901** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4902** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004903*/
danielk19774adee202004-05-08 08:23:19 +00004904int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004905 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004906 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004907 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004908 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004909 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004910){
4911 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004912 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004913 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004914 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004915 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004916 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004917 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004918 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004919 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004920 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004921 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004922#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4923 if( pItem->bSorterRef ){
4924 i--;
4925 n--;
4926 }else
4927#endif
dan257c13f2016-11-10 20:14:06 +00004928 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4929 if( flags & SQLITE_ECEL_OMITREF ){
4930 i--;
4931 n--;
4932 }else{
4933 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4934 }
drhb8b06692018-08-04 15:16:20 +00004935 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4936 && sqlite3ExprIsConstantNotJoin(pExpr)
4937 ){
drh9b258c52020-03-11 19:41:49 +00004938 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004939 }else{
4940 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4941 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004942 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004943 if( copyOp==OP_Copy
4944 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4945 && pOp->p1+pOp->p3+1==inReg
4946 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004947 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004948 ){
4949 pOp->p3++;
4950 }else{
4951 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4952 }
drhd1a01ed2013-11-21 16:08:52 +00004953 }
drhd1766112008-09-17 00:13:12 +00004954 }
drh268380c2004-02-25 13:47:31 +00004955 }
drhf9b596e2004-05-26 16:54:42 +00004956 return n;
drh268380c2004-02-25 13:47:31 +00004957}
4958
4959/*
drh36c563a2009-11-12 13:32:22 +00004960** Generate code for a BETWEEN operator.
4961**
4962** x BETWEEN y AND z
4963**
4964** The above is equivalent to
4965**
4966** x>=y AND x<=z
4967**
4968** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004969** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004970**
4971** The xJumpIf parameter determines details:
4972**
4973** NULL: Store the boolean result in reg[dest]
4974** sqlite3ExprIfTrue: Jump to dest if true
4975** sqlite3ExprIfFalse: Jump to dest if false
4976**
4977** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004978*/
4979static void exprCodeBetween(
4980 Parse *pParse, /* Parsing and code generating context */
4981 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004982 int dest, /* Jump destination or storage location */
4983 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004984 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4985){
dan8b65e592019-07-17 14:34:17 +00004986 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004987 Expr compLeft; /* The x>=y term */
4988 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004989 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004990 Expr *pDel = 0;
4991 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004992
dan71c57db2016-07-09 20:23:55 +00004993 memset(&compLeft, 0, sizeof(Expr));
4994 memset(&compRight, 0, sizeof(Expr));
4995 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004996
drha4eeccd2021-10-07 17:43:30 +00004997 assert( ExprUseXList(pExpr) );
dan8b65e592019-07-17 14:34:17 +00004998 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4999 if( db->mallocFailed==0 ){
5000 exprAnd.op = TK_AND;
5001 exprAnd.pLeft = &compLeft;
5002 exprAnd.pRight = &compRight;
5003 compLeft.op = TK_GE;
5004 compLeft.pLeft = pDel;
5005 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
5006 compRight.op = TK_LE;
5007 compRight.pLeft = pDel;
5008 compRight.pRight = pExpr->x.pList->a[1].pExpr;
5009 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
5010 if( xJump ){
5011 xJump(pParse, &exprAnd, dest, jumpIfNull);
5012 }else{
5013 /* Mark the expression is being from the ON or USING clause of a join
5014 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
5015 ** it into the Parse.pConstExpr list. We should use a new bit for this,
5016 ** for clarity, but we are out of bits in the Expr.flags field so we
5017 ** have to reuse the EP_FromJoin bit. Bummer. */
5018 pDel->flags |= EP_FromJoin;
5019 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
5020 }
5021 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00005022 }
dan8b65e592019-07-17 14:34:17 +00005023 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00005024
5025 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00005026 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
5027 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
5028 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
5029 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
5030 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5031 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5032 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5033 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00005034 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00005035}
5036
5037/*
drhcce7d172000-05-31 15:34:51 +00005038** Generate code for a boolean expression such that a jump is made
5039** to the label "dest" if the expression is true but execution
5040** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00005041**
5042** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00005043** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00005044**
5045** This code depends on the fact that certain token values (ex: TK_EQ)
5046** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5047** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
5048** the make process cause these values to align. Assert()s in the code
5049** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00005050*/
danielk19774adee202004-05-08 08:23:19 +00005051void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005052 Vdbe *v = pParse->pVdbe;
5053 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005054 int regFree1 = 0;
5055 int regFree2 = 0;
5056 int r1, r2;
5057
drh35573352008-01-08 23:54:25 +00005058 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005059 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005060 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00005061 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005062 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00005063 switch( op ){
drh17180fc2019-04-19 17:26:19 +00005064 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005065 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005066 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5067 if( pAlt!=pExpr ){
5068 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
5069 }else if( op==TK_AND ){
5070 int d2 = sqlite3VdbeMakeLabel(pParse);
5071 testcase( jumpIfNull==0 );
5072 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
5073 jumpIfNull^SQLITE_JUMPIFNULL);
5074 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5075 sqlite3VdbeResolveLabel(v, d2);
5076 }else{
5077 testcase( jumpIfNull==0 );
5078 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5079 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5080 }
drhcce7d172000-05-31 15:34:51 +00005081 break;
5082 }
5083 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00005084 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005085 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005086 break;
5087 }
drh8abed7b2018-02-26 18:49:05 +00005088 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005089 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5090 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00005091 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005092 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005093 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005094 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005095 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005096 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005097 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
5098 isNot ? SQLITE_JUMPIFNULL : 0);
5099 }else{
5100 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5101 isNot ? SQLITE_JUMPIFNULL : 0);
5102 }
drh007c8432018-02-26 03:20:18 +00005103 break;
5104 }
drhde845c22016-03-17 19:07:52 +00005105 case TK_IS:
5106 case TK_ISNOT:
5107 testcase( op==TK_IS );
5108 testcase( op==TK_ISNOT );
5109 op = (op==TK_IS) ? TK_EQ : TK_NE;
5110 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005111 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005112 case TK_LT:
5113 case TK_LE:
5114 case TK_GT:
5115 case TK_GE:
5116 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00005117 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005118 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005119 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005120 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5121 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005122 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005123 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005124 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5125 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5126 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5127 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005128 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5129 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5130 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5131 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5132 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5133 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005134 testcase( regFree1==0 );
5135 testcase( regFree2==0 );
5136 break;
5137 }
drhcce7d172000-05-31 15:34:51 +00005138 case TK_ISNULL:
5139 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005140 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5141 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005142 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5143 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005144 VdbeCoverageIf(v, op==TK_ISNULL);
5145 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005146 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005147 break;
5148 }
drhfef52082000-06-06 01:50:43 +00005149 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005150 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005151 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005152 break;
5153 }
drh84e30ca2011-02-10 17:46:14 +00005154#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005155 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005156 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005157 int destIfNull = jumpIfNull ? dest : destIfFalse;
5158 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005159 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005160 sqlite3VdbeResolveLabel(v, destIfFalse);
5161 break;
5162 }
shanehbb201342011-02-09 19:55:20 +00005163#endif
drhcce7d172000-05-31 15:34:51 +00005164 default: {
dan7b35a772016-07-28 19:47:15 +00005165 default_expr:
drhad317272019-04-19 16:21:51 +00005166 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005167 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005168 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005169 /* No-op */
5170 }else{
5171 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5172 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005173 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005174 testcase( regFree1==0 );
5175 testcase( jumpIfNull==0 );
5176 }
drhcce7d172000-05-31 15:34:51 +00005177 break;
5178 }
5179 }
drh2dcef112008-01-12 19:03:48 +00005180 sqlite3ReleaseTempReg(pParse, regFree1);
5181 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005182}
5183
5184/*
drh66b89c82000-11-28 20:47:17 +00005185** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005186** to the label "dest" if the expression is false but execution
5187** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005188**
5189** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005190** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5191** is 0.
drhcce7d172000-05-31 15:34:51 +00005192*/
danielk19774adee202004-05-08 08:23:19 +00005193void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005194 Vdbe *v = pParse->pVdbe;
5195 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005196 int regFree1 = 0;
5197 int regFree2 = 0;
5198 int r1, r2;
5199
drh35573352008-01-08 23:54:25 +00005200 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005201 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005202 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005203 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005204
5205 /* The value of pExpr->op and op are related as follows:
5206 **
5207 ** pExpr->op op
5208 ** --------- ----------
5209 ** TK_ISNULL OP_NotNull
5210 ** TK_NOTNULL OP_IsNull
5211 ** TK_NE OP_Eq
5212 ** TK_EQ OP_Ne
5213 ** TK_GT OP_Le
5214 ** TK_LE OP_Gt
5215 ** TK_GE OP_Lt
5216 ** TK_LT OP_Ge
5217 **
5218 ** For other values of pExpr->op, op is undefined and unused.
5219 ** The value of TK_ and OP_ constants are arranged such that we
5220 ** can compute the mapping above using the following expression.
5221 ** Assert()s verify that the computation is correct.
5222 */
5223 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5224
5225 /* Verify correct alignment of TK_ and OP_ constants
5226 */
5227 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5228 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5229 assert( pExpr->op!=TK_NE || op==OP_Eq );
5230 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5231 assert( pExpr->op!=TK_LT || op==OP_Ge );
5232 assert( pExpr->op!=TK_LE || op==OP_Gt );
5233 assert( pExpr->op!=TK_GT || op==OP_Le );
5234 assert( pExpr->op!=TK_GE || op==OP_Lt );
5235
danba00e302016-07-23 20:24:06 +00005236 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005237 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005238 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005239 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5240 if( pAlt!=pExpr ){
5241 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5242 }else if( pExpr->op==TK_AND ){
5243 testcase( jumpIfNull==0 );
5244 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5245 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5246 }else{
5247 int d2 = sqlite3VdbeMakeLabel(pParse);
5248 testcase( jumpIfNull==0 );
5249 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5250 jumpIfNull^SQLITE_JUMPIFNULL);
5251 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5252 sqlite3VdbeResolveLabel(v, d2);
5253 }
drhcce7d172000-05-31 15:34:51 +00005254 break;
5255 }
5256 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005257 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005258 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005259 break;
5260 }
drh8abed7b2018-02-26 18:49:05 +00005261 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005262 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5263 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005264 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005265 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005266 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005267 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005268 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005269 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005270 /* IS TRUE and IS NOT FALSE */
5271 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5272 isNot ? 0 : SQLITE_JUMPIFNULL);
5273
5274 }else{
5275 /* IS FALSE and IS NOT TRUE */
5276 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005277 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005278 }
drh007c8432018-02-26 03:20:18 +00005279 break;
5280 }
drhde845c22016-03-17 19:07:52 +00005281 case TK_IS:
5282 case TK_ISNOT:
5283 testcase( pExpr->op==TK_IS );
5284 testcase( pExpr->op==TK_ISNOT );
5285 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5286 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005287 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005288 case TK_LT:
5289 case TK_LE:
5290 case TK_GT:
5291 case TK_GE:
5292 case TK_NE:
5293 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005294 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005295 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005296 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5297 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005298 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005299 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005300 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5301 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5302 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5303 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005304 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5305 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5306 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5307 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5308 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5309 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005310 testcase( regFree1==0 );
5311 testcase( regFree2==0 );
5312 break;
5313 }
drhcce7d172000-05-31 15:34:51 +00005314 case TK_ISNULL:
5315 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005316 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5317 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005318 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5319 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005320 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005321 break;
5322 }
drhfef52082000-06-06 01:50:43 +00005323 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005324 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005325 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005326 break;
5327 }
drh84e30ca2011-02-10 17:46:14 +00005328#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005329 case TK_IN: {
5330 if( jumpIfNull ){
5331 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5332 }else{
drhec4ccdb2018-12-29 02:26:59 +00005333 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005334 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5335 sqlite3VdbeResolveLabel(v, destIfNull);
5336 }
5337 break;
5338 }
shanehbb201342011-02-09 19:55:20 +00005339#endif
drhcce7d172000-05-31 15:34:51 +00005340 default: {
danba00e302016-07-23 20:24:06 +00005341 default_expr:
drhad317272019-04-19 16:21:51 +00005342 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005343 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005344 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005345 /* no-op */
5346 }else{
5347 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5348 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005349 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005350 testcase( regFree1==0 );
5351 testcase( jumpIfNull==0 );
5352 }
drhcce7d172000-05-31 15:34:51 +00005353 break;
5354 }
5355 }
drh2dcef112008-01-12 19:03:48 +00005356 sqlite3ReleaseTempReg(pParse, regFree1);
5357 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005358}
drh22827922000-06-06 17:27:05 +00005359
5360/*
drh72bc8202015-06-11 13:58:35 +00005361** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5362** code generation, and that copy is deleted after code generation. This
5363** ensures that the original pExpr is unchanged.
5364*/
5365void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5366 sqlite3 *db = pParse->db;
5367 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5368 if( db->mallocFailed==0 ){
5369 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5370 }
5371 sqlite3ExprDelete(db, pCopy);
5372}
5373
dan5aa550c2017-06-24 18:10:29 +00005374/*
5375** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5376** type of expression.
5377**
5378** If pExpr is a simple SQL value - an integer, real, string, blob
5379** or NULL value - then the VDBE currently being prepared is configured
5380** to re-prepare each time a new value is bound to variable pVar.
5381**
5382** Additionally, if pExpr is a simple SQL value and the value is the
5383** same as that currently bound to variable pVar, non-zero is returned.
5384** Otherwise, if the values are not the same or if pExpr is not a simple
5385** SQL value, zero is returned.
5386*/
drh1580d502021-09-25 17:07:57 +00005387static int exprCompareVariable(
5388 const Parse *pParse,
5389 const Expr *pVar,
5390 const Expr *pExpr
5391){
dan5aa550c2017-06-24 18:10:29 +00005392 int res = 0;
drhc0804222017-06-28 21:47:16 +00005393 int iVar;
5394 sqlite3_value *pL, *pR = 0;
5395
5396 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5397 if( pR ){
5398 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005399 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005400 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005401 if( pL ){
5402 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5403 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5404 }
5405 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005406 }
drhc0804222017-06-28 21:47:16 +00005407 sqlite3ValueFree(pR);
5408 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005409 }
5410
5411 return res;
5412}
drh72bc8202015-06-11 13:58:35 +00005413
5414/*
drh1d9da702010-01-07 15:17:02 +00005415** Do a deep comparison of two expression trees. Return 0 if the two
5416** expressions are completely identical. Return 1 if they differ only
5417** by a COLLATE operator at the top level. Return 2 if there are differences
5418** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005419**
drh619a1302013-08-01 13:04:46 +00005420** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5421** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5422**
drh66518ca2013-08-01 15:09:57 +00005423** The pA side might be using TK_REGISTER. If that is the case and pB is
5424** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5425**
drh1d9da702010-01-07 15:17:02 +00005426** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005427** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005428** identical, we return 2 just to be safe. So if this routine
5429** returns 2, then you do not really know for certain if the two
5430** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005431** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005432** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005433** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005434** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005435**
drhc0804222017-06-28 21:47:16 +00005436** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5437** pParse->pReprepare can be matched against literals in pB. The
5438** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5439** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5440** Argument pParse should normally be NULL. If it is not NULL and pA or
5441** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005442*/
drh1580d502021-09-25 17:07:57 +00005443int sqlite3ExprCompare(
5444 const Parse *pParse,
5445 const Expr *pA,
5446 const Expr *pB,
5447 int iTab
5448){
drh10d1edf2013-11-15 15:52:39 +00005449 u32 combinedFlags;
5450 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005451 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005452 }
dan5aa550c2017-06-24 18:10:29 +00005453 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5454 return 0;
5455 }
drh10d1edf2013-11-15 15:52:39 +00005456 combinedFlags = pA->flags | pB->flags;
5457 if( combinedFlags & EP_IntValue ){
5458 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5459 return 0;
5460 }
drh1d9da702010-01-07 15:17:02 +00005461 return 2;
drh22827922000-06-06 17:27:05 +00005462 }
dan16dd3982018-12-20 15:04:38 +00005463 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005464 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005465 return 1;
5466 }
dan5aa550c2017-06-24 18:10:29 +00005467 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005468 return 1;
5469 }
5470 return 2;
5471 }
drha51e6002021-11-19 19:11:58 +00005472 assert( !ExprHasProperty(pA, EP_IntValue) );
5473 assert( !ExprHasProperty(pB, EP_IntValue) );
5474 if( pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005475 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005476 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005477#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005478 assert( pA->op==pB->op );
5479 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5480 return 2;
5481 }
drheda079c2018-09-20 19:02:15 +00005482 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005483 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5484 return 2;
5485 }
drheda079c2018-09-20 19:02:15 +00005486 }
5487#endif
drhf20bbc52019-01-17 01:06:00 +00005488 }else if( pA->op==TK_NULL ){
5489 return 0;
drhd5af5422018-04-13 14:27:01 +00005490 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005491 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drha51e6002021-11-19 19:11:58 +00005492 }else
5493 if( pB->u.zToken!=0
5494 && pA->op!=TK_COLUMN
5495 && pA->op!=TK_AGG_COLUMN
5496 && strcmp(pA->u.zToken,pB->u.zToken)!=0
5497 ){
drhd5af5422018-04-13 14:27:01 +00005498 return 2;
drh2646da72005-12-09 20:02:05 +00005499 }
drh22827922000-06-06 17:27:05 +00005500 }
drh898c5272019-10-22 00:03:41 +00005501 if( (pA->flags & (EP_Distinct|EP_Commuted))
5502 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005503 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005504 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005505 if( (combinedFlags & EP_FixedCol)==0
5506 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005507 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005508 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005509 if( pA->op!=TK_STRING
5510 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005511 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005512 ){
drh10d1edf2013-11-15 15:52:39 +00005513 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005514 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005515 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5516 return 2;
5517 }
drh10d1edf2013-11-15 15:52:39 +00005518 }
5519 }
drh1d9da702010-01-07 15:17:02 +00005520 return 0;
drh22827922000-06-06 17:27:05 +00005521}
5522
drh8c6f6662010-04-26 19:17:26 +00005523/*
danfbb6e9f2020-01-09 20:11:29 +00005524** Compare two ExprList objects. Return 0 if they are identical, 1
5525** if they are certainly different, or 2 if it is not possible to
5526** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005527**
drh619a1302013-08-01 13:04:46 +00005528** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5529** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5530**
drh8c6f6662010-04-26 19:17:26 +00005531** This routine might return non-zero for equivalent ExprLists. The
5532** only consequence will be disabled optimizations. But this routine
5533** must never return 0 if the two ExprList objects are different, or
5534** a malfunction will result.
5535**
5536** Two NULL pointers are considered to be the same. But a NULL pointer
5537** always differs from a non-NULL pointer.
5538*/
drh1580d502021-09-25 17:07:57 +00005539int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005540 int i;
5541 if( pA==0 && pB==0 ) return 0;
5542 if( pA==0 || pB==0 ) return 1;
5543 if( pA->nExpr!=pB->nExpr ) return 1;
5544 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005545 int res;
drh8c6f6662010-04-26 19:17:26 +00005546 Expr *pExprA = pA->a[i].pExpr;
5547 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005548 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005549 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005550 }
5551 return 0;
5552}
drh13449892005-09-07 21:22:45 +00005553
drh22827922000-06-06 17:27:05 +00005554/*
drhf9463df2017-02-11 14:59:58 +00005555** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5556** are ignored.
5557*/
drh1580d502021-09-25 17:07:57 +00005558int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005559 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005560 sqlite3ExprSkipCollateAndLikely(pA),
5561 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005562 iTab);
5563}
5564
5565/*
drhc51cf862019-05-11 19:36:03 +00005566** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005567**
5568** Or if seenNot is true, return non-zero if Expr p can only be
5569** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005570*/
5571static int exprImpliesNotNull(
drh1580d502021-09-25 17:07:57 +00005572 const Parse *pParse,/* Parsing context */
5573 const Expr *p, /* The expression to be checked */
5574 const Expr *pNN, /* The expression that is NOT NULL */
drhc51cf862019-05-11 19:36:03 +00005575 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005576 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005577){
5578 assert( p );
5579 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005580 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5581 return pNN->op!=TK_NULL;
5582 }
drhc51cf862019-05-11 19:36:03 +00005583 switch( p->op ){
5584 case TK_IN: {
5585 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
drha4eeccd2021-10-07 17:43:30 +00005586 assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005587 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005588 }
5589 case TK_BETWEEN: {
drha4eeccd2021-10-07 17:43:30 +00005590 ExprList *pList;
5591 assert( ExprUseXList(p) );
5592 pList = p->x.pList;
drhc51cf862019-05-11 19:36:03 +00005593 assert( pList!=0 );
5594 assert( pList->nExpr==2 );
5595 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005596 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5597 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005598 ){
5599 return 1;
5600 }
drh7a231b42019-08-30 15:11:08 +00005601 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005602 }
5603 case TK_EQ:
5604 case TK_NE:
5605 case TK_LT:
5606 case TK_LE:
5607 case TK_GT:
5608 case TK_GE:
5609 case TK_PLUS:
5610 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005611 case TK_BITOR:
5612 case TK_LSHIFT:
5613 case TK_RSHIFT:
5614 case TK_CONCAT:
5615 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005616 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005617 case TK_STAR:
5618 case TK_REM:
5619 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005620 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005621 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005622 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005623 }
5624 case TK_SPAN:
5625 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005626 case TK_UPLUS:
5627 case TK_UMINUS: {
5628 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5629 }
5630 case TK_TRUTH: {
5631 if( seenNot ) return 0;
5632 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005633 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005634 }
dan1cd382e2019-08-29 15:06:35 +00005635 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005636 case TK_NOT: {
5637 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5638 }
5639 }
5640 return 0;
5641}
5642
5643/*
drh4bd5f732013-07-31 23:22:39 +00005644** Return true if we can prove the pE2 will always be true if pE1 is
5645** true. Return false if we cannot complete the proof or if pE2 might
5646** be false. Examples:
5647**
drh619a1302013-08-01 13:04:46 +00005648** pE1: x==5 pE2: x==5 Result: true
5649** pE1: x>0 pE2: x==5 Result: false
5650** pE1: x=21 pE2: x=21 OR y=43 Result: true
5651** pE1: x!=123 pE2: x IS NOT NULL Result: true
5652** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5653** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5654** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005655**
5656** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5657** Expr.iTable<0 then assume a table number given by iTab.
5658**
drhc0804222017-06-28 21:47:16 +00005659** If pParse is not NULL, then the values of bound variables in pE1 are
5660** compared against literal values in pE2 and pParse->pVdbe->expmask is
5661** modified to record which bound variables are referenced. If pParse
5662** is NULL, then false will be returned if pE1 contains any bound variables.
5663**
drh4bd5f732013-07-31 23:22:39 +00005664** When in doubt, return false. Returning true might give a performance
5665** improvement. Returning false might cause a performance reduction, but
5666** it will always give the correct answer and is hence always safe.
5667*/
drh1580d502021-09-25 17:07:57 +00005668int sqlite3ExprImpliesExpr(
5669 const Parse *pParse,
5670 const Expr *pE1,
5671 const Expr *pE2,
5672 int iTab
5673){
dan5aa550c2017-06-24 18:10:29 +00005674 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005675 return 1;
5676 }
5677 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005678 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5679 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005680 ){
5681 return 1;
5682 }
drh664d6d12019-05-04 17:32:07 +00005683 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005684 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005685 ){
drhc51cf862019-05-11 19:36:03 +00005686 return 1;
drh619a1302013-08-01 13:04:46 +00005687 }
5688 return 0;
drh4bd5f732013-07-31 23:22:39 +00005689}
5690
5691/*
drh6c68d752019-11-04 02:05:52 +00005692** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005693** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005694** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5695**
5696** This routine controls an optimization. False positives (setting
5697** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5698** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005699*/
5700static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005701 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005702 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005703 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5704 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005705 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005706 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005707 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005708 case TK_IS:
5709 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005710 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005711 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005712 case TK_IN:
drh25897872018-03-20 21:16:15 +00005713 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005714 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005715 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005716 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005717 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005718 testcase( pExpr->op==TK_IS );
5719 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005720 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005721 testcase( pExpr->op==TK_CASE );
5722 testcase( pExpr->op==TK_IN );
5723 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005724 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005725 return WRC_Prune;
5726 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005727 if( pWalker->u.iCur==pExpr->iTable ){
5728 pWalker->eCode = 1;
5729 return WRC_Abort;
5730 }
5731 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005732
dan9d23ea72019-08-29 19:34:29 +00005733 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005734 if( pWalker->eCode==0 ){
5735 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5736 if( pWalker->eCode ){
5737 pWalker->eCode = 0;
5738 sqlite3WalkExpr(pWalker, pExpr->pRight);
5739 }
dan9d23ea72019-08-29 19:34:29 +00005740 }
5741 return WRC_Prune;
5742
5743 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005744 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5745 assert( pWalker->eCode );
5746 return WRC_Abort;
5747 }
dan9d23ea72019-08-29 19:34:29 +00005748 return WRC_Prune;
5749
drh98811552018-04-03 14:04:48 +00005750 /* Virtual tables are allowed to use constraints like x=NULL. So
5751 ** a term of the form x=y does not prove that y is not null if x
5752 ** is the column of a virtual table */
5753 case TK_EQ:
5754 case TK_NE:
5755 case TK_LT:
5756 case TK_LE:
5757 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005758 case TK_GE: {
5759 Expr *pLeft = pExpr->pLeft;
5760 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005761 testcase( pExpr->op==TK_EQ );
5762 testcase( pExpr->op==TK_NE );
5763 testcase( pExpr->op==TK_LT );
5764 testcase( pExpr->op==TK_LE );
5765 testcase( pExpr->op==TK_GT );
5766 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005767 /* The y.pTab=0 assignment in wherecode.c always happens after the
5768 ** impliesNotNullRow() test */
drh477572b2021-10-07 20:46:29 +00005769 assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
5770 assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
5771 if( (pLeft->op==TK_COLUMN
5772 && pLeft->y.pTab!=0
5773 && IsVirtual(pLeft->y.pTab))
5774 || (pRight->op==TK_COLUMN
5775 && pRight->y.pTab!=0
5776 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005777 ){
drh78d1d222020-02-17 19:25:07 +00005778 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005779 }
drh08b92082020-08-10 14:18:00 +00005780 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005781 }
drh25897872018-03-20 21:16:15 +00005782 default:
5783 return WRC_Continue;
5784 }
5785}
5786
5787/*
5788** Return true (non-zero) if expression p can only be true if at least
5789** one column of table iTab is non-null. In other words, return true
5790** if expression p will always be NULL or false if every column of iTab
5791** is NULL.
5792**
drh821b6102018-03-24 18:01:51 +00005793** False negatives are acceptable. In other words, it is ok to return
5794** zero even if expression p will never be true of every column of iTab
5795** is NULL. A false negative is merely a missed optimization opportunity.
5796**
5797** False positives are not allowed, however. A false positive may result
5798** in an incorrect answer.
5799**
drh25897872018-03-20 21:16:15 +00005800** Terms of p that are marked with EP_FromJoin (and hence that come from
5801** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5802**
5803** This routine is used to check if a LEFT JOIN can be converted into
5804** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5805** clause requires that some column of the right table of the LEFT JOIN
5806** be non-NULL, then the LEFT JOIN can be safely converted into an
5807** ordinary join.
5808*/
5809int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5810 Walker w;
drh0d950af2019-08-22 16:38:42 +00005811 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005812 if( p==0 ) return 0;
5813 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005814 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005815 }else{
5816 while( p->op==TK_AND ){
5817 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5818 p = p->pRight;
5819 }
drhd6db6592019-04-01 19:42:42 +00005820 }
drh25897872018-03-20 21:16:15 +00005821 w.xExprCallback = impliesNotNullRow;
5822 w.xSelectCallback = 0;
5823 w.xSelectCallback2 = 0;
5824 w.eCode = 0;
5825 w.u.iCur = iTab;
5826 sqlite3WalkExpr(&w, p);
5827 return w.eCode;
5828}
5829
5830/*
drh030796d2012-08-23 16:18:10 +00005831** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005832** to determine if an expression can be evaluated by reference to the
5833** index only, without having to do a search for the corresponding
5834** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5835** is the cursor for the table.
5836*/
5837struct IdxCover {
5838 Index *pIdx; /* The index to be tested for coverage */
5839 int iCur; /* Cursor number for the table corresponding to the index */
5840};
5841
5842/*
5843** Check to see if there are references to columns in table
5844** pWalker->u.pIdxCover->iCur can be satisfied using the index
5845** pWalker->u.pIdxCover->pIdx.
5846*/
5847static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5848 if( pExpr->op==TK_COLUMN
5849 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005850 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005851 ){
5852 pWalker->eCode = 1;
5853 return WRC_Abort;
5854 }
5855 return WRC_Continue;
5856}
5857
5858/*
drhe604ec02016-07-27 19:20:58 +00005859** Determine if an index pIdx on table with cursor iCur contains will
5860** the expression pExpr. Return true if the index does cover the
5861** expression and false if the pExpr expression references table columns
5862** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005863**
5864** An index covering an expression means that the expression can be
5865** evaluated using only the index and without having to lookup the
5866** corresponding table entry.
5867*/
5868int sqlite3ExprCoveredByIndex(
5869 Expr *pExpr, /* The index to be tested */
5870 int iCur, /* The cursor number for the corresponding table */
5871 Index *pIdx /* The index that might be used for coverage */
5872){
5873 Walker w;
5874 struct IdxCover xcov;
5875 memset(&w, 0, sizeof(w));
5876 xcov.iCur = iCur;
5877 xcov.pIdx = pIdx;
5878 w.xExprCallback = exprIdxCover;
5879 w.u.pIdxCover = &xcov;
5880 sqlite3WalkExpr(&w, pExpr);
5881 return !w.eCode;
5882}
5883
5884
drh90cf38b2021-11-08 23:24:00 +00005885/* Structure used to pass information throught the Walker in order to
5886** implement sqlite3ReferencesSrcList().
drh374fdce2012-04-17 16:38:53 +00005887*/
drh90cf38b2021-11-08 23:24:00 +00005888struct RefSrcList {
5889 sqlite3 *db; /* Database connection used for sqlite3DbRealloc() */
5890 SrcList *pRef; /* Looking for references to these tables */
drh913306a2021-11-26 17:10:18 +00005891 i64 nExclude; /* Number of tables to exclude from the search */
drh90cf38b2021-11-08 23:24:00 +00005892 int *aiExclude; /* Cursor IDs for tables to exclude from the search */
drh030796d2012-08-23 16:18:10 +00005893};
5894
5895/*
drh90cf38b2021-11-08 23:24:00 +00005896** Walker SELECT callbacks for sqlite3ReferencesSrcList().
5897**
5898** When entering a new subquery on the pExpr argument, add all FROM clause
5899** entries for that subquery to the exclude list.
5900**
5901** When leaving the subquery, remove those entries from the exclude list.
daned41a962020-06-09 17:45:48 +00005902*/
drh90cf38b2021-11-08 23:24:00 +00005903static int selectRefEnter(Walker *pWalker, Select *pSelect){
5904 struct RefSrcList *p = pWalker->u.pRefSrcList;
5905 SrcList *pSrc = pSelect->pSrc;
drh913306a2021-11-26 17:10:18 +00005906 i64 i, j;
5907 int *piNew;
drh90cf38b2021-11-08 23:24:00 +00005908 if( pSrc->nSrc==0 ) return WRC_Continue;
5909 j = p->nExclude;
5910 p->nExclude += pSrc->nSrc;
5911 piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
5912 if( piNew==0 ){
5913 p->nExclude = 0;
5914 return WRC_Abort;
5915 }else{
5916 p->aiExclude = piNew;
5917 }
5918 for(i=0; i<pSrc->nSrc; i++, j++){
5919 p->aiExclude[j] = pSrc->a[i].iCursor;
daned41a962020-06-09 17:45:48 +00005920 }
5921 return WRC_Continue;
5922}
drh90cf38b2021-11-08 23:24:00 +00005923static void selectRefLeave(Walker *pWalker, Select *pSelect){
5924 struct RefSrcList *p = pWalker->u.pRefSrcList;
5925 SrcList *pSrc = pSelect->pSrc;
5926 if( p->nExclude ){
5927 assert( p->nExclude>=pSrc->nSrc );
5928 p->nExclude -= pSrc->nSrc;
5929 }
5930}
daned41a962020-06-09 17:45:48 +00005931
drh90cf38b2021-11-08 23:24:00 +00005932/* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
5933**
5934** Set the 0x01 bit of pWalker->eCode if there is a reference to any
5935** of the tables shown in RefSrcList.pRef.
5936**
5937** Set the 0x02 bit of pWalker->eCode if there is a reference to a
5938** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
drh030796d2012-08-23 16:18:10 +00005939*/
drh90cf38b2021-11-08 23:24:00 +00005940static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
5941 if( pExpr->op==TK_COLUMN
5942 || pExpr->op==TK_AGG_COLUMN
5943 ){
drh374fdce2012-04-17 16:38:53 +00005944 int i;
drh90cf38b2021-11-08 23:24:00 +00005945 struct RefSrcList *p = pWalker->u.pRefSrcList;
5946 SrcList *pSrc = p->pRef;
drh655814d2015-01-09 01:27:29 +00005947 int nSrc = pSrc ? pSrc->nSrc : 0;
5948 for(i=0; i<nSrc; i++){
drh90cf38b2021-11-08 23:24:00 +00005949 if( pExpr->iTable==pSrc->a[i].iCursor ){
5950 pWalker->eCode |= 1;
5951 return WRC_Continue;
5952 }
drh374fdce2012-04-17 16:38:53 +00005953 }
drh90cf38b2021-11-08 23:24:00 +00005954 for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
5955 if( i>=p->nExclude ){
5956 pWalker->eCode |= 2;
drh030796d2012-08-23 16:18:10 +00005957 }
drh374fdce2012-04-17 16:38:53 +00005958 }
drh030796d2012-08-23 16:18:10 +00005959 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005960}
5961
5962/*
drh90cf38b2021-11-08 23:24:00 +00005963** Check to see if pExpr references any tables in pSrcList.
5964** Possible return values:
5965**
5966** 1 pExpr does references a table in pSrcList.
5967**
5968** 0 pExpr references some table that is not defined in either
5969** pSrcList or in subqueries of pExpr itself.
5970**
5971** -1 pExpr only references no tables at all, or it only
5972** references tables defined in subqueries of pExpr itself.
5973**
5974** As currently used, pExpr is always an aggregate function call. That
5975** fact is exploited for efficiency.
drh374fdce2012-04-17 16:38:53 +00005976*/
drh90cf38b2021-11-08 23:24:00 +00005977int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005978 Walker w;
drh90cf38b2021-11-08 23:24:00 +00005979 struct RefSrcList x;
drh80f6bfc2019-08-31 20:13:30 +00005980 memset(&w, 0, sizeof(w));
drh90cf38b2021-11-08 23:24:00 +00005981 memset(&x, 0, sizeof(x));
5982 w.xExprCallback = exprRefToSrcList;
5983 w.xSelectCallback = selectRefEnter;
5984 w.xSelectCallback2 = selectRefLeave;
5985 w.u.pRefSrcList = &x;
5986 x.db = pParse->db;
5987 x.pRef = pSrcList;
5988 assert( pExpr->op==TK_AGG_FUNCTION );
drha4eeccd2021-10-07 17:43:30 +00005989 assert( ExprUseXList(pExpr) );
drh030796d2012-08-23 16:18:10 +00005990 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005991#ifndef SQLITE_OMIT_WINDOWFUNC
5992 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5993 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5994 }
5995#endif
drh90cf38b2021-11-08 23:24:00 +00005996 sqlite3DbFree(pParse->db, x.aiExclude);
5997 if( w.eCode & 0x01 ){
5998 return 1;
5999 }else if( w.eCode ){
6000 return 0;
6001 }else{
6002 return -1;
6003 }
drh374fdce2012-04-17 16:38:53 +00006004}
6005
6006/*
drh89636622020-06-07 17:33:18 +00006007** This is a Walker expression node callback.
6008**
6009** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
6010** object that is referenced does not refer directly to the Expr. If
6011** it does, make a copy. This is done because the pExpr argument is
6012** subject to change.
6013**
6014** The copy is stored on pParse->pConstExpr with a register number of 0.
6015** This will cause the expression to be deleted automatically when the
6016** Parse object is destroyed, but the zero register number means that it
6017** will not generate any code in the preamble.
6018*/
6019static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00006020 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00006021 && pExpr->pAggInfo!=0
6022 ){
6023 AggInfo *pAggInfo = pExpr->pAggInfo;
6024 int iAgg = pExpr->iAgg;
6025 Parse *pParse = pWalker->pParse;
6026 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00006027 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
6028 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00006029 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00006030 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006031 pExpr = sqlite3ExprDup(db, pExpr, 0);
6032 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006033 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006034 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006035 }
6036 }
6037 }else{
6038 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00006039 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006040 pExpr = sqlite3ExprDup(db, pExpr, 0);
6041 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006042 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006043 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006044 }
6045 }
6046 }
6047 }
6048 return WRC_Continue;
6049}
6050
6051/*
6052** Initialize a Walker object so that will persist AggInfo entries referenced
6053** by the tree that is walked.
6054*/
6055void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
6056 memset(pWalker, 0, sizeof(*pWalker));
6057 pWalker->pParse = pParse;
6058 pWalker->xExprCallback = agginfoPersistExprCb;
6059 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
6060}
6061
6062/*
drh13449892005-09-07 21:22:45 +00006063** Add a new element to the pAggInfo->aCol[] array. Return the index of
6064** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00006065*/
drh17435752007-08-16 04:30:38 +00006066static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006067 int i;
drhcf643722007-03-27 13:36:37 +00006068 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006069 db,
drhcf643722007-03-27 13:36:37 +00006070 pInfo->aCol,
6071 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00006072 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00006073 &i
6074 );
drh13449892005-09-07 21:22:45 +00006075 return i;
6076}
6077
6078/*
6079** Add a new element to the pAggInfo->aFunc[] array. Return the index of
6080** the new element. Return a negative number if malloc fails.
6081*/
drh17435752007-08-16 04:30:38 +00006082static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006083 int i;
drhcf643722007-03-27 13:36:37 +00006084 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006085 db,
drhcf643722007-03-27 13:36:37 +00006086 pInfo->aFunc,
6087 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00006088 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00006089 &i
6090 );
drh13449892005-09-07 21:22:45 +00006091 return i;
drh89636622020-06-07 17:33:18 +00006092}
drh22827922000-06-06 17:27:05 +00006093
6094/*
drh7d10d5a2008-08-20 16:35:10 +00006095** This is the xExprCallback for a tree walker. It is used to
6096** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00006097** for additional information.
drh22827922000-06-06 17:27:05 +00006098*/
drh7d10d5a2008-08-20 16:35:10 +00006099static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00006100 int i;
drh7d10d5a2008-08-20 16:35:10 +00006101 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00006102 Parse *pParse = pNC->pParse;
6103 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00006104 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00006105
drh25c3b8c2018-04-16 10:34:13 +00006106 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00006107 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00006108 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00006109 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00006110 testcase( pExpr->op==TK_AGG_COLUMN );
6111 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00006112 /* Check to see if the column is in one of the tables in the FROM
6113 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00006114 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00006115 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00006116 for(i=0; i<pSrcList->nSrc; i++, pItem++){
6117 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00006118 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00006119 if( pExpr->iTable==pItem->iCursor ){
6120 /* If we reach this point, it means that pExpr refers to a table
6121 ** that is in the FROM clause of the aggregate query.
6122 **
6123 ** Make an entry for the column in pAggInfo->aCol[] if there
6124 ** is not an entry there already.
6125 */
drh7f906d62007-03-12 23:48:52 +00006126 int k;
drh13449892005-09-07 21:22:45 +00006127 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00006128 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00006129 if( pCol->iTable==pExpr->iTable &&
6130 pCol->iColumn==pExpr->iColumn ){
6131 break;
6132 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006133 }
danielk19771e536952007-08-16 10:09:01 +00006134 if( (k>=pAggInfo->nColumn)
6135 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
6136 ){
drh7f906d62007-03-12 23:48:52 +00006137 pCol = &pAggInfo->aCol[k];
drh477572b2021-10-07 20:46:29 +00006138 assert( ExprUseYTab(pExpr) );
drheda079c2018-09-20 19:02:15 +00006139 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00006140 pCol->iTable = pExpr->iTable;
6141 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00006142 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00006143 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00006144 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00006145 if( pAggInfo->pGroupBy ){
6146 int j, n;
6147 ExprList *pGB = pAggInfo->pGroupBy;
6148 struct ExprList_item *pTerm = pGB->a;
6149 n = pGB->nExpr;
6150 for(j=0; j<n; j++, pTerm++){
6151 Expr *pE = pTerm->pExpr;
6152 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
6153 pE->iColumn==pExpr->iColumn ){
6154 pCol->iSorterColumn = j;
6155 break;
6156 }
6157 }
6158 }
6159 if( pCol->iSorterColumn<0 ){
6160 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
6161 }
6162 }
6163 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
6164 ** because it was there before or because we just created it).
6165 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
6166 ** pAggInfo->aCol[] entry.
6167 */
drhebb6a652013-09-12 23:42:22 +00006168 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00006169 pExpr->pAggInfo = pAggInfo;
6170 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00006171 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00006172 break;
6173 } /* endif pExpr->iTable==pItem->iCursor */
6174 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00006175 }
drh7d10d5a2008-08-20 16:35:10 +00006176 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00006177 }
6178 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00006179 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00006180 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00006181 ){
drh13449892005-09-07 21:22:45 +00006182 /* Check to see if pExpr is a duplicate of another aggregate
6183 ** function that is already in the pAggInfo structure
6184 */
6185 struct AggInfo_func *pItem = pAggInfo->aFunc;
6186 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan19e4eef2021-06-03 18:56:42 +00006187 if( pItem->pFExpr==pExpr ) break;
drh81185a52020-06-09 13:38:12 +00006188 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00006189 break;
6190 }
drh22827922000-06-06 17:27:05 +00006191 }
drh13449892005-09-07 21:22:45 +00006192 if( i>=pAggInfo->nFunc ){
6193 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
6194 */
danielk197714db2662006-01-09 16:12:04 +00006195 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006196 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006197 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006198 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006199 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006200 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00006201 pItem->iMem = ++pParse->nMem;
drha4eeccd2021-10-07 17:43:30 +00006202 assert( ExprUseUToken(pExpr) );
drh13449892005-09-07 21:22:45 +00006203 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006204 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006205 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006206 if( pExpr->flags & EP_Distinct ){
6207 pItem->iDistinct = pParse->nTab++;
6208 }else{
6209 pItem->iDistinct = -1;
6210 }
drh13449892005-09-07 21:22:45 +00006211 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006212 }
drh13449892005-09-07 21:22:45 +00006213 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6214 */
drhc5cd1242013-09-12 16:50:49 +00006215 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006216 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006217 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006218 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006219 return WRC_Prune;
6220 }else{
6221 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006222 }
drh22827922000-06-06 17:27:05 +00006223 }
6224 }
drh7d10d5a2008-08-20 16:35:10 +00006225 return WRC_Continue;
6226}
drh626a8792005-01-17 22:08:19 +00006227
6228/*
drhe8abb4c2012-11-02 18:24:57 +00006229** Analyze the pExpr expression looking for aggregate functions and
6230** for variables that need to be added to AggInfo object that pNC->pAggInfo
6231** points to. Additional entries are made on the AggInfo object as
6232** necessary.
drh626a8792005-01-17 22:08:19 +00006233**
6234** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006235** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006236*/
drhd2b3e232008-01-23 14:51:49 +00006237void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006238 Walker w;
6239 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006240 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6241 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006242 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006243 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006244 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006245 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006246 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006247}
drh5d9a4af2005-08-30 00:54:01 +00006248
6249/*
6250** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6251** expression list. Return the number of errors.
6252**
6253** If an error is found, the analysis is cut short.
6254*/
drhd2b3e232008-01-23 14:51:49 +00006255void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006256 struct ExprList_item *pItem;
6257 int i;
drh5d9a4af2005-08-30 00:54:01 +00006258 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006259 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6260 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006261 }
6262 }
drh5d9a4af2005-08-30 00:54:01 +00006263}
drh892d3172008-01-10 03:46:36 +00006264
6265/*
drhceea3322009-04-23 13:22:42 +00006266** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006267*/
6268int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006269 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006270 return ++pParse->nMem;
6271 }
danielk19772f425f62008-07-04 09:41:39 +00006272 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006273}
drhceea3322009-04-23 13:22:42 +00006274
6275/*
6276** Deallocate a register, making available for reuse for some other
6277** purpose.
drhceea3322009-04-23 13:22:42 +00006278*/
drh892d3172008-01-10 03:46:36 +00006279void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006280 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006281 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006282 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6283 pParse->aTempReg[pParse->nTempReg++] = iReg;
6284 }
drh892d3172008-01-10 03:46:36 +00006285 }
6286}
6287
6288/*
drhed24da42016-09-06 14:37:05 +00006289** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006290*/
6291int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006292 int i, n;
drhed24da42016-09-06 14:37:05 +00006293 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006294 i = pParse->iRangeReg;
6295 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006296 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006297 pParse->iRangeReg += nReg;
6298 pParse->nRangeReg -= nReg;
6299 }else{
6300 i = pParse->nMem+1;
6301 pParse->nMem += nReg;
6302 }
6303 return i;
6304}
6305void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006306 if( nReg==1 ){
6307 sqlite3ReleaseTempReg(pParse, iReg);
6308 return;
6309 }
drh3aef2fb2020-01-02 17:46:02 +00006310 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006311 if( nReg>pParse->nRangeReg ){
6312 pParse->nRangeReg = nReg;
6313 pParse->iRangeReg = iReg;
6314 }
6315}
drhcdc69552011-12-06 13:24:59 +00006316
6317/*
6318** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006319**
6320** Always invoke this procedure after coding a subroutine or co-routine
6321** that might be invoked from other parts of the code, to ensure that
6322** the sub/co-routine does not use registers in common with the code that
6323** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006324*/
6325void sqlite3ClearTempRegCache(Parse *pParse){
6326 pParse->nTempReg = 0;
6327 pParse->nRangeReg = 0;
6328}
drhbb9b5f22016-03-19 00:35:02 +00006329
6330/*
6331** Validate that no temporary register falls within the range of
6332** iFirst..iLast, inclusive. This routine is only call from within assert()
6333** statements.
6334*/
6335#ifdef SQLITE_DEBUG
6336int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6337 int i;
6338 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006339 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6340 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006341 ){
6342 return 0;
6343 }
6344 for(i=0; i<pParse->nTempReg; i++){
6345 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6346 return 0;
6347 }
6348 }
6349 return 1;
6350}
6351#endif /* SQLITE_DEBUG */