blob: fe316550a744ada17c32af51ebc9b8b7cf6eabde [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;
drh580c8c12012-12-08 03:34:04 +000047 op = pExpr->op;
drh6042e302022-12-13 13:33:28 +000048 while( 1 /* exit-by-break */ ){
49 if( op==TK_COLUMN || (op==TK_AGG_COLUMN && pExpr->y.pTab!=0) ){
50 assert( ExprUseYTab(pExpr) );
51 assert( pExpr->y.pTab!=0 );
52 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
53 }
54 if( op==TK_SELECT ){
55 assert( ExprUseXSelect(pExpr) );
56 assert( pExpr->x.pSelect!=0 );
57 assert( pExpr->x.pSelect->pEList!=0 );
58 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
59 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
60 }
drh487e2622005-06-25 18:42:14 +000061#ifndef SQLITE_OMIT_CAST
drh6042e302022-12-13 13:33:28 +000062 if( op==TK_CAST ){
63 assert( !ExprHasProperty(pExpr, EP_IntValue) );
64 return sqlite3AffinityType(pExpr->u.zToken, 0);
65 }
drh487e2622005-06-25 18:42:14 +000066#endif
drh6042e302022-12-13 13:33:28 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft!=0 && ExprUseXSelect(pExpr->pLeft) );
69 assert( pExpr->iColumn < pExpr->iTable );
70 assert( pExpr->iTable==pExpr->pLeft->x.pSelect->pEList->nExpr );
71 return sqlite3ExprAffinity(
72 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
73 );
74 }
75 if( op==TK_VECTOR ){
76 assert( ExprUseXList(pExpr) );
77 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
78 }
79 if( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
80 assert( pExpr->op==TK_COLLATE
81 || pExpr->op==TK_IF_NULL_ROW
82 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
83 pExpr = pExpr->pLeft;
84 op = pExpr->op;
85 continue;
86 }
87 if( op!=TK_REGISTER || (op = pExpr->op2)==TK_REGISTER ) break;
drhdb36e252019-10-22 19:51:29 +000088 }
drh11949042019-08-05 18:01:42 +000089 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000090}
91
drh53db1452004-05-20 13:54:53 +000092/*
drhed07d0e2022-12-14 14:41:35 +000093** Make a guess at all the possible datatypes of the result that could
94** be returned by an expression. Return a bitmask indicating the answer:
95**
96** 0x01 Numeric
97** 0x02 Text
98** 0x04 Blob
99**
100** If the expression must return NULL, then 0x00 is returned.
101*/
102int sqlite3ExprDataType(const Expr *pExpr){
103 while( pExpr ){
104 switch( pExpr->op ){
105 case TK_COLLATE:
106 case TK_IF_NULL_ROW:
107 case TK_UPLUS: {
108 pExpr = pExpr->pLeft;
109 break;
110 }
111 case TK_NULL: {
drhda698022022-12-14 23:53:29 +0000112 pExpr = 0;
113 break;
drhed07d0e2022-12-14 14:41:35 +0000114 }
115 case TK_STRING: {
116 return 0x02;
117 }
118 case TK_BLOB: {
119 return 0x04;
120 }
121 case TK_CONCAT: {
122 return 0x06;
123 }
124 case TK_VARIABLE:
125 case TK_AGG_FUNCTION:
126 case TK_FUNCTION: {
127 return 0x07;
128 }
129 case TK_COLUMN:
130 case TK_AGG_COLUMN:
131 case TK_SELECT:
132 case TK_CAST:
133 case TK_SELECT_COLUMN:
134 case TK_VECTOR: {
135 int aff = sqlite3ExprAffinity(pExpr);
136 if( aff>=SQLITE_AFF_NUMERIC ) return 0x05;
137 if( aff==SQLITE_AFF_TEXT ) return 0x06;
138 return 0x07;
139 }
140 case TK_CASE: {
141 int res = 0;
142 int ii;
143 ExprList *pList = pExpr->x.pList;
144 assert( ExprUseXList(pExpr) && pList!=0 );
145 assert( pList->nExpr > 0);
146 for(ii=1; ii<pList->nExpr; ii+=2){
147 res |= sqlite3ExprDataType(pList->a[ii].pExpr);
148 }
drhda698022022-12-14 23:53:29 +0000149 if( pList->nExpr % 2 ){
150 res |= sqlite3ExprDataType(pList->a[pList->nExpr-1].pExpr);
151 }
drhed07d0e2022-12-14 14:41:35 +0000152 return res;
153 }
154 default: {
155 return 0x01;
156 }
157 } /* End of switch(op) */
158 } /* End of while(pExpr) */
drhda698022022-12-14 23:53:29 +0000159 return 0x00;
drhed07d0e2022-12-14 14:41:35 +0000160}
161
162/*
drh8b4c40d2007-02-01 23:02:45 +0000163** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +0000164** sequence named by pToken. Return a pointer to a new Expr node that
165** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +0000166**
167** If a memory allocation error occurs, that fact is recorded in pParse->db
168** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +0000169*/
drh4ef7efa2014-03-20 15:14:08 +0000170Expr *sqlite3ExprAddCollateToken(
drhb6dad522021-09-24 16:14:47 +0000171 const Parse *pParse, /* Parsing context */
drh4ef7efa2014-03-20 15:14:08 +0000172 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +0000173 const Token *pCollName, /* Name of collating sequence */
174 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +0000175){
drh433a3e92021-05-04 12:07:16 +0000176 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +0000177 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000178 if( pNew ){
179 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000180 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000181 pExpr = pNew;
182 }
drhae80dde2012-12-06 21:16:43 +0000183 }
drh0a8a4062012-12-07 18:38:16 +0000184 return pExpr;
185}
drhb6dad522021-09-24 16:14:47 +0000186Expr *sqlite3ExprAddCollateString(
187 const Parse *pParse, /* Parsing context */
188 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
189 const char *zC /* The collating sequence name */
190){
drh261d8a52012-12-08 21:36:26 +0000191 Token s;
192 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000193 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000194 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000195}
196
197/*
drh0d950af2019-08-22 16:38:42 +0000198** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000199*/
200Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000201 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000202 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000203 pExpr = pExpr->pLeft;
204 }
205 return pExpr;
206}
207
208/*
209** Skip over any TK_COLLATE operators and/or any unlikely()
210** or likelihood() or likely() functions at the root of an
211** expression.
212*/
213Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000214 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000215 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drha4eeccd2021-10-07 17:43:30 +0000216 assert( ExprUseXList(pExpr) );
drhcca9f3d2013-09-06 15:23:29 +0000217 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000218 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000219 pExpr = pExpr->x.pList->a[0].pExpr;
220 }else{
drh46fe1382020-08-19 23:32:06 +0000221 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000222 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000223 }
drha4c3c872013-09-12 17:29:25 +0000224 }
drh0a8a4062012-12-07 18:38:16 +0000225 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000226}
227
228/*
drhae80dde2012-12-06 21:16:43 +0000229** Return the collation sequence for the expression pExpr. If
230** there is no defined collating sequence, return NULL.
231**
drh70efa842017-09-28 01:58:23 +0000232** See also: sqlite3ExprNNCollSeq()
233**
234** The sqlite3ExprNNCollSeq() works the same exact that it returns the
235** default collation if pExpr has no defined collation.
236**
drhae80dde2012-12-06 21:16:43 +0000237** The collating sequence might be determined by a COLLATE operator
238** or by the presence of a column with a defined collating sequence.
239** COLLATE operators take first precedence. Left operands take
240** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000241*/
drhe7375bf2020-03-10 19:24:38 +0000242CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000243 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000244 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000245 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000246 while( p ){
drhae80dde2012-12-06 21:16:43 +0000247 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000248 if( op==TK_REGISTER ) op = p->op2;
drh2e30d952022-11-23 18:51:04 +0000249 if( (op==TK_AGG_COLUMN && p->y.pTab!=0)
250 || op==TK_COLUMN || op==TK_TRIGGER
251 ){
drh63b3a642022-10-20 13:36:32 +0000252 int j;
drh477572b2021-10-07 20:46:29 +0000253 assert( ExprUseYTab(p) );
drh63b3a642022-10-20 13:36:32 +0000254 assert( p->y.pTab!=0 );
255 if( (j = p->iColumn)>=0 ){
256 const char *zColl = sqlite3ColumnColl(&p->y.pTab->aCol[j]);
257 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000258 }
drh63b3a642022-10-20 13:36:32 +0000259 break;
danielk19770202b292004-06-09 09:55:16 +0000260 }
drhe081d732018-07-27 18:19:12 +0000261 if( op==TK_CAST || op==TK_UPLUS ){
262 p = p->pLeft;
263 continue;
264 }
drh269d3222019-10-23 18:09:39 +0000265 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000266 assert( ExprUseXList(p) );
drh269d3222019-10-23 18:09:39 +0000267 p = p->x.pList->a[0].pExpr;
268 continue;
269 }
drhcb0e04f2018-12-12 21:34:17 +0000270 if( op==TK_COLLATE ){
drhf9751072021-10-07 13:40:29 +0000271 assert( !ExprHasProperty(p, EP_IntValue) );
drhe081d732018-07-27 18:19:12 +0000272 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
273 break;
274 }
drhae80dde2012-12-06 21:16:43 +0000275 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000276 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000277 p = p->pLeft;
278 }else{
drh2308ed32015-02-09 16:09:34 +0000279 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000280 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +0000281 assert( ExprUseXList(p) );
drh6728cd92015-02-09 18:28:03 +0000282 assert( p->x.pList==0 || p->pRight==0 );
drhb32b3092022-01-24 20:16:37 +0000283 if( p->x.pList!=0 && !db->mallocFailed ){
drh2308ed32015-02-09 16:09:34 +0000284 int i;
drh5b107652020-07-13 15:35:08 +0000285 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000286 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
287 pNext = p->x.pList->a[i].pExpr;
288 break;
289 }
290 }
291 }
292 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000293 }
294 }else{
drh7d10d5a2008-08-20 16:35:10 +0000295 break;
296 }
danielk19770202b292004-06-09 09:55:16 +0000297 }
danielk19777cedc8d2004-06-10 10:50:08 +0000298 if( sqlite3CheckCollSeq(pParse, pColl) ){
299 pColl = 0;
300 }
301 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000302}
303
304/*
drh70efa842017-09-28 01:58:23 +0000305** Return the collation sequence for the expression pExpr. If
306** there is no defined collating sequence, return a pointer to the
307** defautl collation sequence.
308**
309** See also: sqlite3ExprCollSeq()
310**
311** The sqlite3ExprCollSeq() routine works the same except that it
312** returns NULL if there is no defined collation.
313*/
drhe7375bf2020-03-10 19:24:38 +0000314CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000315 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
316 if( p==0 ) p = pParse->db->pDfltColl;
317 assert( p!=0 );
318 return p;
319}
320
321/*
322** Return TRUE if the two expressions have equivalent collating sequences.
323*/
drhe7375bf2020-03-10 19:24:38 +0000324int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000325 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
326 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
327 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
328}
329
330/*
drh626a8792005-01-17 22:08:19 +0000331** pExpr is an operand of a comparison operator. aff2 is the
332** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000333** type affinity that should be used for the comparison operator.
334*/
drhe7375bf2020-03-10 19:24:38 +0000335char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000336 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000337 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000338 /* Both sides of the comparison are columns. If one has numeric
339 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000340 */
drh8a512562005-11-14 22:29:05 +0000341 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000342 return SQLITE_AFF_NUMERIC;
343 }else{
drh05883a32015-06-02 15:32:08 +0000344 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000345 }
danielk1977e014a832004-05-17 10:48:57 +0000346 }else{
347 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000348 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
349 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000350 }
351}
352
drh53db1452004-05-20 13:54:53 +0000353/*
354** pExpr is a comparison operator. Return the type affinity that should
355** be applied to both operands prior to doing the comparison.
356*/
drhe7375bf2020-03-10 19:24:38 +0000357static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000358 char aff;
359 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
360 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000361 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000362 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000363 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000364 if( pExpr->pRight ){
365 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
drha4eeccd2021-10-07 17:43:30 +0000366 }else if( ExprUseXSelect(pExpr) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000367 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000368 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000369 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000370 }
371 return aff;
372}
373
374/*
375** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
376** idx_affinity is the affinity of an indexed column. Return true
377** if the index with affinity idx_affinity may be used to implement
378** the comparison in pExpr.
379*/
drhe7375bf2020-03-10 19:24:38 +0000380int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000381 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000382 if( aff<SQLITE_AFF_TEXT ){
383 return 1;
drh8a512562005-11-14 22:29:05 +0000384 }
drh915e4342019-08-06 15:18:15 +0000385 if( aff==SQLITE_AFF_TEXT ){
386 return idx_affinity==SQLITE_AFF_TEXT;
387 }
388 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000389}
390
danielk1977a37cdde2004-05-16 11:15:36 +0000391/*
drh35573352008-01-08 23:54:25 +0000392** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000393** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000394*/
drhe7375bf2020-03-10 19:24:38 +0000395static u8 binaryCompareP5(
396 const Expr *pExpr1, /* Left operand */
397 const Expr *pExpr2, /* Right operand */
398 int jumpIfNull /* Extra flags added to P5 */
399){
drh35573352008-01-08 23:54:25 +0000400 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000401 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000402 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000403}
404
drha2e00042002-01-22 03:13:42 +0000405/*
danielk19770202b292004-06-09 09:55:16 +0000406** Return a pointer to the collation sequence that should be used by
407** a binary comparison operator comparing pLeft and pRight.
408**
409** If the left hand expression has a collating sequence type, then it is
410** used. Otherwise the collation sequence for the right hand expression
411** is used, or the default (BINARY) if neither expression has a collating
412** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000413**
414** Argument pRight (but not pLeft) may be a null pointer. In this case,
415** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000416*/
drh0a0e1312007-08-07 17:04:59 +0000417CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000418 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000419 const Expr *pLeft,
420 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000421){
drhec41dda2007-02-07 13:09:45 +0000422 CollSeq *pColl;
423 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000424 if( pLeft->flags & EP_Collate ){
425 pColl = sqlite3ExprCollSeq(pParse, pLeft);
426 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
427 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000428 }else{
429 pColl = sqlite3ExprCollSeq(pParse, pLeft);
430 if( !pColl ){
431 pColl = sqlite3ExprCollSeq(pParse, pRight);
432 }
danielk19770202b292004-06-09 09:55:16 +0000433 }
434 return pColl;
435}
436
drh898c5272019-10-22 00:03:41 +0000437/* Expresssion p is a comparison operator. Return a collation sequence
438** appropriate for the comparison operator.
439**
440** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
441** However, if the OP_Commuted flag is set, then the order of the operands
442** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
443** correct collating sequence is found.
444*/
drhe7375bf2020-03-10 19:24:38 +0000445CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000446 if( ExprHasProperty(p, EP_Commuted) ){
447 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
448 }else{
449 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
450 }
451}
452
danielk19770202b292004-06-09 09:55:16 +0000453/*
drhbe5c89a2004-07-26 00:31:09 +0000454** Generate code for a comparison operator.
455*/
456static int codeCompare(
457 Parse *pParse, /* The parsing (and code generating) context */
458 Expr *pLeft, /* The left operand */
459 Expr *pRight, /* The right operand */
460 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000461 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000462 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000463 int jumpIfNull, /* If true, jump if either operand is NULL */
464 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000465){
drh35573352008-01-08 23:54:25 +0000466 int p5;
467 int addr;
468 CollSeq *p4;
469
drh86541862019-12-19 20:37:32 +0000470 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000471 if( isCommuted ){
472 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
473 }else{
474 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
475 }
drh35573352008-01-08 23:54:25 +0000476 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
477 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
478 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000479 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000480 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000481}
482
dancfbb5e82016-07-13 19:48:13 +0000483/*
dan870a0702016-08-01 16:37:43 +0000484** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000485**
486** A vector is defined as any expression that results in two or more
487** columns of result. Every TK_VECTOR node is an vector because the
488** parser will not generate a TK_VECTOR with fewer than two entries.
489** But a TK_SELECT might be either a vector or a scalar. It is only
490** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000491*/
drhb6dad522021-09-24 16:14:47 +0000492int sqlite3ExprIsVector(const Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000493 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000494}
495
496/*
dancfbb5e82016-07-13 19:48:13 +0000497** If the expression passed as the only argument is of type TK_VECTOR
498** return the number of expressions in the vector. Or, if the expression
499** is a sub-select, return the number of columns in the sub-select. For
500** any other type of expression, return 1.
501*/
drhb6dad522021-09-24 16:14:47 +0000502int sqlite3ExprVectorSize(const Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000503 u8 op = pExpr->op;
504 if( op==TK_REGISTER ) op = pExpr->op2;
505 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000506 assert( ExprUseXList(pExpr) );
drh76dbe7a2016-08-20 21:02:38 +0000507 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000508 }else if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000509 assert( ExprUseXSelect(pExpr) );
dan71c57db2016-07-09 20:23:55 +0000510 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000511 }else{
512 return 1;
dan71c57db2016-07-09 20:23:55 +0000513 }
dan71c57db2016-07-09 20:23:55 +0000514}
515
danba00e302016-07-23 20:24:06 +0000516/*
drhfc7f27b2016-08-20 00:07:01 +0000517** Return a pointer to a subexpression of pVector that is the i-th
518** column of the vector (numbered starting with 0). The caller must
519** ensure that i is within range.
520**
drh76dbe7a2016-08-20 21:02:38 +0000521** If pVector is really a scalar (and "scalar" here includes subqueries
522** that return a single column!) then return pVector unmodified.
523**
drhfc7f27b2016-08-20 00:07:01 +0000524** pVector retains ownership of the returned subexpression.
525**
526** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000527** just the expression for the i-th term of the result set, and may
528** not be ready for evaluation because the table cursor has not yet
529** been positioned.
danba00e302016-07-23 20:24:06 +0000530*/
drhfc7f27b2016-08-20 00:07:01 +0000531Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
drhbf7f3a02021-05-24 11:35:16 +0000532 assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
dan870a0702016-08-01 16:37:43 +0000533 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000534 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
535 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000536 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000537 return pVector->x.pSelect->pEList->a[i].pExpr;
538 }else{
drha4eeccd2021-10-07 17:43:30 +0000539 assert( ExprUseXList(pVector) );
dan870a0702016-08-01 16:37:43 +0000540 return pVector->x.pList->a[i].pExpr;
541 }
dan71c57db2016-07-09 20:23:55 +0000542 }
dan870a0702016-08-01 16:37:43 +0000543 return pVector;
dan71c57db2016-07-09 20:23:55 +0000544}
drhfc7f27b2016-08-20 00:07:01 +0000545
drhfc7f27b2016-08-20 00:07:01 +0000546/*
547** Compute and return a new Expr object which when passed to
548** sqlite3ExprCode() will generate all necessary code to compute
549** the iField-th column of the vector expression pVector.
550**
drh8762ec12016-08-20 01:06:22 +0000551** It is ok for pVector to be a scalar (as long as iField==0).
552** In that case, this routine works like sqlite3ExprDup().
553**
drhfc7f27b2016-08-20 00:07:01 +0000554** The caller owns the returned Expr object and is responsible for
555** ensuring that the returned value eventually gets freed.
556**
drh8762ec12016-08-20 01:06:22 +0000557** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000558** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000559** valid for the life of the returned object. If pVector is a TK_VECTOR
560** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000561** returns.
drh8762ec12016-08-20 01:06:22 +0000562**
563** A trick to cause a TK_SELECT pVector to be deleted together with
564** the returned Expr object is to attach the pVector to the pRight field
565** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000566*/
567Expr *sqlite3ExprForVectorField(
568 Parse *pParse, /* Parsing context */
569 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drh10f08272021-07-05 01:11:26 +0000570 int iField, /* Which column of the vector to return */
571 int nField /* Total number of columns in the vector */
drhfc7f27b2016-08-20 00:07:01 +0000572){
573 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000574 if( pVector->op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000575 assert( ExprUseXSelect(pVector) );
drhfc7f27b2016-08-20 00:07:01 +0000576 /* The TK_SELECT_COLUMN Expr node:
577 **
drh966e2912017-01-03 02:58:01 +0000578 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000579 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000580 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000581 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000582 ** pLeft->iTable: First in an array of register holding result, or 0
583 ** if the result is not yet computed.
584 **
585 ** sqlite3ExprDelete() specifically skips the recursive delete of
586 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000587 ** can be attached to pRight to cause this node to take ownership of
588 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
589 ** with the same pLeft pointer to the pVector, but only one of them
590 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000591 */
drhabfd35e2016-12-06 22:47:23 +0000592 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000593 if( pRet ){
drh10f08272021-07-05 01:11:26 +0000594 pRet->iTable = nField;
drh8bd0d582016-08-20 18:06:14 +0000595 pRet->iColumn = iField;
596 pRet->pLeft = pVector;
597 }
drhfc7f27b2016-08-20 00:07:01 +0000598 }else{
danab632bc2021-09-29 18:33:26 +0000599 if( pVector->op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000600 Expr **ppVector;
601 assert( ExprUseXList(pVector) );
602 ppVector = &pVector->x.pList->a[iField].pExpr;
danab632bc2021-09-29 18:33:26 +0000603 pVector = *ppVector;
604 if( IN_RENAME_OBJECT ){
605 /* This must be a vector UPDATE inside a trigger */
606 *ppVector = 0;
607 return pVector;
608 }
dan5a69d192021-09-27 15:44:03 +0000609 }
danab632bc2021-09-29 18:33:26 +0000610 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
drhfc7f27b2016-08-20 00:07:01 +0000611 }
612 return pRet;
613}
dan71c57db2016-07-09 20:23:55 +0000614
dan5c288b92016-07-30 21:02:33 +0000615/*
616** If expression pExpr is of type TK_SELECT, generate code to evaluate
617** it. Return the register in which the result is stored (or, if the
618** sub-select returns more than one column, the first in an array
619** of registers in which the result is stored).
620**
621** If pExpr is not a TK_SELECT expression, return 0.
622*/
623static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000624 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000625#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000626 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000627 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000628 }
danf9b2e052016-08-02 17:45:00 +0000629#endif
dan8da209b2016-07-26 18:06:08 +0000630 return reg;
631}
632
dan5c288b92016-07-30 21:02:33 +0000633/*
634** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000635** or TK_SELECT that returns more than one column. This function returns
636** the register number of a register that contains the value of
637** element iField of the vector.
638**
639** If pVector is a TK_SELECT expression, then code for it must have
640** already been generated using the exprCodeSubselect() routine. In this
641** case parameter regSelect should be the first in an array of registers
642** containing the results of the sub-select.
643**
644** If pVector is of type TK_VECTOR, then code for the requested field
645** is generated. In this case (*pRegFree) may be set to the number of
646** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000647**
648** Before returning, output parameter (*ppExpr) is set to point to the
649** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000650*/
651static int exprVectorRegister(
652 Parse *pParse, /* Parse context */
653 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000654 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000655 int regSelect, /* First in array of registers */
656 Expr **ppExpr, /* OUT: Expression element */
657 int *pRegFree /* OUT: Temp register to free */
658){
drh12abf402016-08-22 14:30:05 +0000659 u8 op = pVector->op;
drh05428122021-05-24 00:17:04 +0000660 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
drh12abf402016-08-22 14:30:05 +0000661 if( op==TK_REGISTER ){
662 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
663 return pVector->iTable+iField;
664 }
665 if( op==TK_SELECT ){
drha4eeccd2021-10-07 17:43:30 +0000666 assert( ExprUseXSelect(pVector) );
dan870a0702016-08-01 16:37:43 +0000667 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
668 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000669 }
drh05428122021-05-24 00:17:04 +0000670 if( op==TK_VECTOR ){
drha4eeccd2021-10-07 17:43:30 +0000671 assert( ExprUseXList(pVector) );
drh05428122021-05-24 00:17:04 +0000672 *ppExpr = pVector->x.pList->a[iField].pExpr;
673 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
674 }
675 return 0;
dan5c288b92016-07-30 21:02:33 +0000676}
677
678/*
679** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000680** the result of the comparison (1, 0, or NULL) and write that
681** result into register dest.
682**
683** The caller must satisfy the following preconditions:
684**
685** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
686** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
687** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000688*/
drh79752b62016-08-13 10:02:17 +0000689static void codeVectorCompare(
690 Parse *pParse, /* Code generator context */
691 Expr *pExpr, /* The comparison operation */
692 int dest, /* Write results into this register */
693 u8 op, /* Comparison operator */
694 u8 p5 /* SQLITE_NULLEQ or zero */
695){
dan71c57db2016-07-09 20:23:55 +0000696 Vdbe *v = pParse->pVdbe;
697 Expr *pLeft = pExpr->pLeft;
698 Expr *pRight = pExpr->pRight;
699 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000700 int i;
701 int regLeft = 0;
702 int regRight = 0;
703 u8 opx = op;
drh4bc20452021-03-29 18:53:47 +0000704 int addrCmp = 0;
drhec4ccdb2018-12-29 02:26:59 +0000705 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000706 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000707
drhe7375bf2020-03-10 19:24:38 +0000708 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh340fd0b2021-03-19 16:29:40 +0000709 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000710 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
711 sqlite3ErrorMsg(pParse, "row value misused");
712 return;
713 }
drhb29e60c2016-09-05 12:02:34 +0000714 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
715 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
716 || pExpr->op==TK_LT || pExpr->op==TK_GT
717 || pExpr->op==TK_LE || pExpr->op==TK_GE
718 );
719 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
720 || (pExpr->op==TK_ISNOT && op==TK_NE) );
721 assert( p5==0 || pExpr->op!=op );
722 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000723
drh4bc20452021-03-29 18:53:47 +0000724 if( op==TK_LE ) opx = TK_LT;
725 if( op==TK_GE ) opx = TK_GT;
726 if( op==TK_NE ) opx = TK_EQ;
dan71c57db2016-07-09 20:23:55 +0000727
drhb29e60c2016-09-05 12:02:34 +0000728 regLeft = exprCodeSubselect(pParse, pLeft);
729 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000730
drh4bc20452021-03-29 18:53:47 +0000731 sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
drhb29e60c2016-09-05 12:02:34 +0000732 for(i=0; 1 /*Loop exits by "break"*/; i++){
733 int regFree1 = 0, regFree2 = 0;
drhabc15f12021-06-04 16:11:19 +0000734 Expr *pL = 0, *pR = 0;
drhb29e60c2016-09-05 12:02:34 +0000735 int r1, r2;
736 assert( i>=0 && i<nLeft );
drh4bc20452021-03-29 18:53:47 +0000737 if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000738 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
739 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh4bc20452021-03-29 18:53:47 +0000740 addrCmp = sqlite3VdbeCurrentAddr(v);
741 codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000742 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
743 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
744 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
745 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
746 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
747 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
748 sqlite3ReleaseTempReg(pParse, regFree1);
749 sqlite3ReleaseTempReg(pParse, regFree2);
drh4bc20452021-03-29 18:53:47 +0000750 if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
751 addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
752 testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
753 testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
754 }
755 if( p5==SQLITE_NULLEQ ){
756 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
757 }else{
758 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
759 }
drhb29e60c2016-09-05 12:02:34 +0000760 if( i==nLeft-1 ){
761 break;
dan71c57db2016-07-09 20:23:55 +0000762 }
drhb29e60c2016-09-05 12:02:34 +0000763 if( opx==TK_EQ ){
drh4bc20452021-03-29 18:53:47 +0000764 sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
drhb29e60c2016-09-05 12:02:34 +0000765 }else{
766 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
drh4bc20452021-03-29 18:53:47 +0000767 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
drhb29e60c2016-09-05 12:02:34 +0000768 if( i==nLeft-2 ) opx = op;
769 }
dan71c57db2016-07-09 20:23:55 +0000770 }
drh4bc20452021-03-29 18:53:47 +0000771 sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000772 sqlite3VdbeResolveLabel(v, addrDone);
drh4bc20452021-03-29 18:53:47 +0000773 if( op==TK_NE ){
774 sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
775 }
dan71c57db2016-07-09 20:23:55 +0000776}
777
danielk19774b5255a2008-06-05 16:47:39 +0000778#if SQLITE_MAX_EXPR_DEPTH>0
779/*
780** Check that argument nHeight is less than or equal to the maximum
781** expression depth allowed. If it is not, leave an error message in
782** pParse.
783*/
drh7d10d5a2008-08-20 16:35:10 +0000784int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000785 int rc = SQLITE_OK;
786 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
787 if( nHeight>mxHeight ){
788 sqlite3ErrorMsg(pParse,
789 "Expression tree is too large (maximum depth %d)", mxHeight
790 );
791 rc = SQLITE_ERROR;
792 }
793 return rc;
794}
795
796/* The following three functions, heightOfExpr(), heightOfExprList()
797** and heightOfSelect(), are used to determine the maximum height
798** of any expression tree referenced by the structure passed as the
799** first argument.
800**
801** If this maximum height is greater than the current value pointed
802** to by pnHeight, the second parameter, then set *pnHeight to that
803** value.
804*/
drhb6dad522021-09-24 16:14:47 +0000805static void heightOfExpr(const Expr *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000806 if( p ){
807 if( p->nHeight>*pnHeight ){
808 *pnHeight = p->nHeight;
809 }
810 }
811}
drhb6dad522021-09-24 16:14:47 +0000812static void heightOfExprList(const ExprList *p, int *pnHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000813 if( p ){
814 int i;
815 for(i=0; i<p->nExpr; i++){
816 heightOfExpr(p->a[i].pExpr, pnHeight);
817 }
818 }
819}
drhb6dad522021-09-24 16:14:47 +0000820static void heightOfSelect(const Select *pSelect, int *pnHeight){
821 const Select *p;
dan1a3a3082018-01-18 19:00:54 +0000822 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000823 heightOfExpr(p->pWhere, pnHeight);
824 heightOfExpr(p->pHaving, pnHeight);
825 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000826 heightOfExprList(p->pEList, pnHeight);
827 heightOfExprList(p->pGroupBy, pnHeight);
828 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000829 }
830}
831
832/*
833** Set the Expr.nHeight variable in the structure passed as an
834** argument. An expression with no children, Expr.pList or
835** Expr.pSelect member has a height of 1. Any other expression
836** has a height equal to the maximum height of any other
837** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000838**
839** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
840** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000841*/
842static void exprSetHeight(Expr *p){
drh2ef11112022-02-06 11:51:23 +0000843 int nHeight = p->pLeft ? p->pLeft->nHeight : 0;
drh47e2fe32022-07-25 20:21:57 +0000844 if( NEVER(p->pRight) && p->pRight->nHeight>nHeight ){
845 nHeight = p->pRight->nHeight;
846 }
drha4eeccd2021-10-07 17:43:30 +0000847 if( ExprUseXSelect(p) ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000848 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000849 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000850 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000851 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000852 }
danielk19774b5255a2008-06-05 16:47:39 +0000853 p->nHeight = nHeight + 1;
854}
855
856/*
857** Set the Expr.nHeight variable using the exprSetHeight() function. If
858** the height is greater than the maximum allowed expression depth,
859** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000860**
861** Also propagate all EP_Propagate flags from the Expr.x.pList into
862** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000863*/
drh2308ed32015-02-09 16:09:34 +0000864void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000865 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000866 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000867 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000868}
869
870/*
871** Return the maximum height of any expression tree referenced
872** by the select statement passed as an argument.
873*/
drhb6dad522021-09-24 16:14:47 +0000874int sqlite3SelectExprHeight(const Select *p){
danielk19774b5255a2008-06-05 16:47:39 +0000875 int nHeight = 0;
876 heightOfSelect(p, &nHeight);
877 return nHeight;
878}
drh2308ed32015-02-09 16:09:34 +0000879#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
880/*
881** Propagate all EP_Propagate flags from the Expr.x.pList into
882** Expr.flags.
883*/
884void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000885 if( pParse->nErr ) return;
drha4eeccd2021-10-07 17:43:30 +0000886 if( p && ExprUseXList(p) && p->x.pList ){
drh2308ed32015-02-09 16:09:34 +0000887 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
888 }
889}
890#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000891#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
892
drhbe5c89a2004-07-26 00:31:09 +0000893/*
drhb7916a72009-05-27 10:31:29 +0000894** This routine is the core allocator for Expr nodes.
895**
drha76b5df2002-02-23 02:32:10 +0000896** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000897** for this node and for the pToken argument is a single allocation
898** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000899** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000900**
901** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000902** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000903** parameter is ignored if pToken is NULL or if the token does not
904** appear to be quoted. If the quotes were of the form "..." (double-quotes)
905** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000906**
907** Special case: If op==TK_INTEGER and pToken points to a string that
908** can be translated into a 32-bit integer, then the token is not
909** stored in u.zToken. Instead, the integer values is written
910** into u.iValue and the EP_IntValue flag is set. No extra storage
911** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000912*/
drhb7916a72009-05-27 10:31:29 +0000913Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000914 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000915 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000916 const Token *pToken, /* Token argument. Might be NULL */
917 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000918){
drha76b5df2002-02-23 02:32:10 +0000919 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000920 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000921 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000922
drh575fad62016-02-05 13:38:36 +0000923 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000924 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000925 if( op!=TK_INTEGER || pToken->z==0
926 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
927 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000928 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000929 }
drhb7916a72009-05-27 10:31:29 +0000930 }
drh575fad62016-02-05 13:38:36 +0000931 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000932 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000933 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000934 pNew->op = (u8)op;
935 pNew->iAgg = -1;
936 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000937 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000938 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000939 pNew->u.iValue = iValue;
940 }else{
drh33e619f2009-05-28 01:00:55 +0000941 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000942 assert( pToken->z!=0 || pToken->n==0 );
943 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000944 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000945 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000946 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000947 }
drhb7916a72009-05-27 10:31:29 +0000948 }
949 }
950#if SQLITE_MAX_EXPR_DEPTH>0
951 pNew->nHeight = 1;
952#endif
953 }
drha76b5df2002-02-23 02:32:10 +0000954 return pNew;
955}
956
957/*
drhb7916a72009-05-27 10:31:29 +0000958** Allocate a new expression node from a zero-terminated token that has
959** already been dequoted.
960*/
961Expr *sqlite3Expr(
962 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
963 int op, /* Expression opcode */
964 const char *zToken /* Token argument. Might be NULL */
965){
966 Token x;
967 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000968 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000969 return sqlite3ExprAlloc(db, op, &x, 0);
970}
971
972/*
973** Attach subtrees pLeft and pRight to the Expr node pRoot.
974**
975** If pRoot==NULL that means that a memory allocation error has occurred.
976** In that case, delete the subtrees pLeft and pRight.
977*/
978void sqlite3ExprAttachSubtrees(
979 sqlite3 *db,
980 Expr *pRoot,
981 Expr *pLeft,
982 Expr *pRight
983){
984 if( pRoot==0 ){
985 assert( db->mallocFailed );
986 sqlite3ExprDelete(db, pLeft);
987 sqlite3ExprDelete(db, pRight);
988 }else{
drh47e2fe32022-07-25 20:21:57 +0000989 assert( ExprUseXList(pRoot) );
990 assert( pRoot->x.pSelect==0 );
drhb7916a72009-05-27 10:31:29 +0000991 if( pRight ){
992 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000993 pRoot->flags |= EP_Propagate & pRight->flags;
drh47e2fe32022-07-25 20:21:57 +0000994#if SQLITE_MAX_EXPR_DEPTH>0
995 pRoot->nHeight = pRight->nHeight+1;
996 }else{
997 pRoot->nHeight = 1;
998#endif
drhb7916a72009-05-27 10:31:29 +0000999 }
1000 if( pLeft ){
1001 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +00001002 pRoot->flags |= EP_Propagate & pLeft->flags;
drh47e2fe32022-07-25 20:21:57 +00001003#if SQLITE_MAX_EXPR_DEPTH>0
1004 if( pLeft->nHeight>=pRoot->nHeight ){
1005 pRoot->nHeight = pLeft->nHeight+1;
1006 }
1007#endif
drhb7916a72009-05-27 10:31:29 +00001008 }
drhb7916a72009-05-27 10:31:29 +00001009 }
1010}
1011
1012/*
peter.d.reid60ec9142014-09-06 16:39:46 +00001013** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +00001014**
drhbf664462009-06-19 18:32:54 +00001015** One or both of the subtrees can be NULL. Return a pointer to the new
1016** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
1017** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +00001018*/
drh17435752007-08-16 04:30:38 +00001019Expr *sqlite3PExpr(
1020 Parse *pParse, /* Parsing context */
1021 int op, /* Expression opcode */
1022 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +00001023 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +00001024){
drh5fb52ca2012-03-31 02:34:35 +00001025 Expr *p;
drhd5c851c2019-04-19 13:38:34 +00001026 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
1027 if( p ){
1028 memset(p, 0, sizeof(Expr));
1029 p->op = op & 0xff;
1030 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +00001031 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +00001032 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +00001033 }else{
1034 sqlite3ExprDelete(pParse->db, pLeft);
1035 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +00001036 }
drh4e0cff62004-11-05 05:10:28 +00001037 return p;
1038}
1039
1040/*
drh08de4f72016-04-11 01:06:47 +00001041** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
1042** do a memory allocation failure) then delete the pSelect object.
1043*/
1044void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
1045 if( pExpr ){
1046 pExpr->x.pSelect = pSelect;
1047 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
1048 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
1049 }else{
1050 assert( pParse->db->mallocFailed );
1051 sqlite3SelectDelete(pParse->db, pSelect);
1052 }
1053}
1054
dan9289f512021-07-06 20:44:32 +00001055/*
1056** Expression list pEList is a list of vector values. This function
1057** converts the contents of pEList to a VALUES(...) Select statement
dan74777f92021-07-07 13:53:55 +00001058** returning 1 row for each element of the list. For example, the
1059** expression list:
dan9289f512021-07-06 20:44:32 +00001060**
dan74777f92021-07-07 13:53:55 +00001061** ( (1,2), (3,4) (5,6) )
dan9289f512021-07-06 20:44:32 +00001062**
dan74777f92021-07-07 13:53:55 +00001063** is translated to the equivalent of:
dan9289f512021-07-06 20:44:32 +00001064**
dan74777f92021-07-07 13:53:55 +00001065** VALUES(1,2), (3,4), (5,6)
dan9289f512021-07-06 20:44:32 +00001066**
dan74777f92021-07-07 13:53:55 +00001067** Each of the vector values in pEList must contain exactly nElem terms.
1068** If a list element that is not a vector or does not contain nElem terms,
1069** an error message is left in pParse.
dan9289f512021-07-06 20:44:32 +00001070**
1071** This is used as part of processing IN(...) expressions with a list
1072** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
1073*/
dan74777f92021-07-07 13:53:55 +00001074Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
dan9289f512021-07-06 20:44:32 +00001075 int ii;
1076 Select *pRet = 0;
dan2931a662021-07-07 15:52:44 +00001077 assert( nElem>1 );
dan9289f512021-07-06 20:44:32 +00001078 for(ii=0; ii<pEList->nExpr; ii++){
1079 Select *pSel;
dan9289f512021-07-06 20:44:32 +00001080 Expr *pExpr = pEList->a[ii].pExpr;
drha4eeccd2021-10-07 17:43:30 +00001081 int nExprElem;
1082 if( pExpr->op==TK_VECTOR ){
1083 assert( ExprUseXList(pExpr) );
1084 nExprElem = pExpr->x.pList->nExpr;
1085 }else{
1086 nExprElem = 1;
1087 }
dan74777f92021-07-07 13:53:55 +00001088 if( nExprElem!=nElem ){
1089 sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
1090 nExprElem, nExprElem>1?"s":"", nElem
1091 );
1092 break;
dan9289f512021-07-06 20:44:32 +00001093 }
drha4eeccd2021-10-07 17:43:30 +00001094 assert( ExprUseXList(pExpr) );
dan74777f92021-07-07 13:53:55 +00001095 pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
1096 pExpr->x.pList = 0;
dan9289f512021-07-06 20:44:32 +00001097 if( pSel ){
1098 if( pRet ){
1099 pSel->op = TK_ALL;
1100 pSel->pPrior = pRet;
1101 }
1102 pRet = pSel;
1103 }
1104 }
1105
1106 if( pRet && pRet->pPrior ){
1107 pRet->selFlags |= SF_MultiValue;
1108 }
1109 sqlite3ExprListDelete(pParse->db, pEList);
1110 return pRet;
1111}
drh08de4f72016-04-11 01:06:47 +00001112
1113/*
drh91bb0ee2004-09-01 03:06:34 +00001114** Join two expressions using an AND operator. If either expression is
1115** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +00001116**
1117** If one side or the other of the AND is known to be false, then instead
1118** of returning an AND expression, just return a constant expression with
1119** a value of false.
drh91bb0ee2004-09-01 03:06:34 +00001120*/
drhd5c851c2019-04-19 13:38:34 +00001121Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1122 sqlite3 *db = pParse->db;
1123 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +00001124 return pRight;
1125 }else if( pRight==0 ){
1126 return pLeft;
dan2b6e6702019-12-30 06:55:31 +00001127 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
1128 && !IN_RENAME_OBJECT
1129 ){
drhb3ad4e62021-03-31 13:31:33 +00001130 sqlite3ExprDeferredDelete(pParse, pLeft);
1131 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +00001132 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +00001133 }else{
drhd5c851c2019-04-19 13:38:34 +00001134 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +00001135 }
1136}
1137
1138/*
1139** Construct a new expression node for a function with multiple
1140** arguments.
1141*/
drh954733b2018-07-27 23:33:16 +00001142Expr *sqlite3ExprFunction(
1143 Parse *pParse, /* Parsing context */
1144 ExprList *pList, /* Argument list */
drhb6dad522021-09-24 16:14:47 +00001145 const Token *pToken, /* Name of the function */
drh954733b2018-07-27 23:33:16 +00001146 int eDistinct /* SF_Distinct or SF_ALL or 0 */
1147){
drha76b5df2002-02-23 02:32:10 +00001148 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +00001149 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +00001150 assert( pToken );
drhb7916a72009-05-27 10:31:29 +00001151 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +00001152 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +00001153 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +00001154 return 0;
1155 }
drha6e8ee12022-05-13 16:38:40 +00001156 assert( !ExprHasProperty(pNew, EP_InnerON|EP_OuterON) );
drh62fc0692022-02-06 00:30:04 +00001157 pNew->w.iOfst = (int)(pToken->z - pParse->zTail);
drh14a1b1c2021-06-30 11:53:21 +00001158 if( pList
1159 && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
1160 && !pParse->nested
1161 ){
drh954733b2018-07-27 23:33:16 +00001162 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1163 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001164 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +00001165 ExprSetProperty(pNew, EP_HasFunc);
drha4eeccd2021-10-07 17:43:30 +00001166 assert( ExprUseXList(pNew) );
drh2308ed32015-02-09 16:09:34 +00001167 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +00001168 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +00001169 return pNew;
1170}
1171
1172/*
drh0dfa5252020-01-08 17:28:19 +00001173** Check to see if a function is usable according to current access
1174** rules:
1175**
1176** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1177**
1178** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1179** top-level SQL
1180**
1181** If the function is not usable, create an error.
1182*/
1183void sqlite3ExprFunctionUsable(
1184 Parse *pParse, /* Parsing and code generating context */
drhb6dad522021-09-24 16:14:47 +00001185 const Expr *pExpr, /* The function invocation */
1186 const FuncDef *pDef /* The function being invoked */
drh0dfa5252020-01-08 17:28:19 +00001187){
1188 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001189 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1190 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001191 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1192 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1193 ){
1194 /* Functions prohibited in triggers and views if:
1195 ** (1) tagged with SQLITE_DIRECTONLY
1196 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1197 ** is tagged with SQLITE_FUNC_UNSAFE) and
1198 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1199 ** that the schema is possibly tainted).
1200 */
drh62fc0692022-02-06 00:30:04 +00001201 sqlite3ErrorMsg(pParse, "unsafe use of %#T()", pExpr);
drh0dfa5252020-01-08 17:28:19 +00001202 }
1203 }
1204}
1205
1206/*
drhfa6bc002004-09-07 16:19:52 +00001207** Assign a variable number to an expression that encodes a wildcard
1208** in the original SQL statement.
1209**
1210** Wildcards consisting of a single "?" are assigned the next sequential
1211** variable number.
1212**
1213** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001214** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001215** the SQL statement comes from an external source.
1216**
drh51f49f12009-05-21 20:41:32 +00001217** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001218** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001219** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001220** assigned.
1221*/
drhde25a882016-10-03 15:28:24 +00001222void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001223 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001224 const char *z;
drhf326d662016-12-23 13:30:53 +00001225 ynVar x;
drh17435752007-08-16 04:30:38 +00001226
drhfa6bc002004-09-07 16:19:52 +00001227 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001228 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001229 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001230 assert( z!=0 );
1231 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001232 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001233 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001234 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001235 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001236 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001237 }else{
drhf326d662016-12-23 13:30:53 +00001238 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001239 if( z[0]=='?' ){
1240 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1241 ** use it as the variable number */
1242 i64 i;
drh18814df2017-01-31 03:52:34 +00001243 int bOk;
1244 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1245 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1246 bOk = 1;
1247 }else{
1248 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1249 }
drh124c0b42011-06-01 18:15:55 +00001250 testcase( i==0 );
1251 testcase( i==1 );
1252 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1253 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1254 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1255 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1256 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drh62fc0692022-02-06 00:30:04 +00001257 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
drhc9b39282016-10-03 16:33:14 +00001258 return;
drhfa6bc002004-09-07 16:19:52 +00001259 }
drh8e74e7b2017-01-31 12:41:48 +00001260 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001261 if( x>pParse->nVar ){
1262 pParse->nVar = (int)x;
1263 doAdd = 1;
1264 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1265 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001266 }
1267 }else{
1268 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1269 ** number as the prior appearance of the same name, or if the name
1270 ** has never appeared before, reuse the same variable number
1271 */
drh9bf755c2016-12-23 03:59:31 +00001272 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1273 if( x==0 ){
1274 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001275 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001276 }
drhfa6bc002004-09-07 16:19:52 +00001277 }
drhf326d662016-12-23 13:30:53 +00001278 if( doAdd ){
1279 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1280 }
1281 }
1282 pExpr->iColumn = x;
1283 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001284 sqlite3ErrorMsg(pParse, "too many SQL variables");
drh62fc0692022-02-06 00:30:04 +00001285 sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
danielk1977832b2662007-05-09 11:37:22 +00001286 }
drhfa6bc002004-09-07 16:19:52 +00001287}
1288
1289/*
danf6963f92009-11-23 14:39:14 +00001290** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001291*/
drh4f0010b2016-04-11 14:49:39 +00001292static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1293 assert( p!=0 );
drh41ce47c2022-08-22 02:00:26 +00001294 assert( db!=0 );
drh477572b2021-10-07 20:46:29 +00001295 assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1296 assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1297 assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1298 assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
drh209bc522016-09-23 21:36:24 +00001299#ifdef SQLITE_DEBUG
1300 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1301 assert( p->pLeft==0 );
1302 assert( p->pRight==0 );
drha4eeccd2021-10-07 17:43:30 +00001303 assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1304 assert( !ExprUseXList(p) || p->x.pList==0 );
drh209bc522016-09-23 21:36:24 +00001305 }
1306#endif
1307 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001308 /* The Expr.x union is never used at the same time as Expr.pRight */
drha4eeccd2021-10-07 17:43:30 +00001309 assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001310 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001311 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001312 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001313 sqlite3ExprDeleteNN(db, p->pRight);
drha4eeccd2021-10-07 17:43:30 +00001314 }else if( ExprUseXSelect(p) ){
dan4f9adee2019-07-13 16:22:50 +00001315 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001316 sqlite3SelectDelete(db, p->x.pSelect);
1317 }else{
1318 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001319#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001320 if( ExprHasProperty(p, EP_WinFunc) ){
1321 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001322 }
dan6ba7ab02019-07-02 11:56:47 +00001323#endif
dan8117f112019-07-10 20:16:53 +00001324 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001325 }
drh33e619f2009-05-28 01:00:55 +00001326 if( !ExprHasProperty(p, EP_Static) ){
drh41ce47c2022-08-22 02:00:26 +00001327 sqlite3DbNNFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001328 }
drha2e00042002-01-22 03:13:42 +00001329}
drh4f0010b2016-04-11 14:49:39 +00001330void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1331 if( p ) sqlite3ExprDeleteNN(db, p);
1332}
drha2e00042002-01-22 03:13:42 +00001333
drhd44f8b22022-04-07 01:11:13 +00001334/*
1335** Clear both elements of an OnOrUsing object
1336*/
1337void sqlite3ClearOnOrUsing(sqlite3 *db, OnOrUsing *p){
1338 if( p==0 ){
1339 /* Nothing to clear */
1340 }else if( p->pOn ){
1341 sqlite3ExprDeleteNN(db, p->pOn);
1342 }else if( p->pUsing ){
1343 sqlite3IdListDelete(db, p->pUsing);
1344 }
1345}
drhb3ad4e62021-03-31 13:31:33 +00001346
1347/*
1348** Arrange to cause pExpr to be deleted when the pParse is deleted.
1349** This is similar to sqlite3ExprDelete() except that the delete is
1350** deferred untilthe pParse is deleted.
1351**
1352** The pExpr might be deleted immediately on an OOM error.
1353**
1354** The deferred delete is (currently) implemented by adding the
1355** pExpr to the pParse->pConstExpr list with a register number of 0.
1356*/
1357void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
drhee6b80c2022-07-23 00:44:44 +00001358 sqlite3ParserAddCleanup(pParse,
1359 (void(*)(sqlite3*,void*))sqlite3ExprDelete,
1360 pExpr);
drhb3ad4e62021-03-31 13:31:33 +00001361}
1362
drh8e34e402019-06-11 10:43:56 +00001363/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1364** expression.
1365*/
1366void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1367 if( p ){
1368 if( IN_RENAME_OBJECT ){
1369 sqlite3RenameExprUnmap(pParse, p);
1370 }
1371 sqlite3ExprDeleteNN(pParse->db, p);
1372 }
1373}
1374
drhd2687b72005-08-12 22:56:09 +00001375/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001376** Return the number of bytes allocated for the expression structure
1377** passed as the first argument. This is always one of EXPR_FULLSIZE,
1378** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1379*/
drhb6dad522021-09-24 16:14:47 +00001380static int exprStructSize(const Expr *p){
danielk19776ab3a2e2009-02-19 14:39:25 +00001381 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001382 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1383 return EXPR_FULLSIZE;
1384}
1385
1386/*
drh33e619f2009-05-28 01:00:55 +00001387** The dupedExpr*Size() routines each return the number of bytes required
1388** to store a copy of an expression or expression tree. They differ in
1389** how much of the tree is measured.
1390**
1391** dupedExprStructSize() Size of only the Expr structure
1392** dupedExprNodeSize() Size of Expr + space for token
1393** dupedExprSize() Expr + token + subtree components
1394**
1395***************************************************************************
1396**
1397** The dupedExprStructSize() function returns two values OR-ed together:
1398** (1) the space required for a copy of the Expr structure only and
1399** (2) the EP_xxx flags that indicate what the structure size should be.
1400** The return values is always one of:
1401**
1402** EXPR_FULLSIZE
1403** EXPR_REDUCEDSIZE | EP_Reduced
1404** EXPR_TOKENONLYSIZE | EP_TokenOnly
1405**
1406** The size of the structure can be found by masking the return value
1407** of this routine with 0xfff. The flags can be found by masking the
1408** return value with EP_Reduced|EP_TokenOnly.
1409**
1410** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1411** (unreduced) Expr objects as they or originally constructed by the parser.
1412** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001413** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001414** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001415** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001416** to reduce a pristine expression tree from the parser. The implementation
1417** of dupedExprStructSize() contain multiple assert() statements that attempt
1418** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001419*/
drhb6dad522021-09-24 16:14:47 +00001420static int dupedExprStructSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001421 int nSize;
drh33e619f2009-05-28 01:00:55 +00001422 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001423 assert( EXPR_FULLSIZE<=0xfff );
1424 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001425 if( 0==flags || p->op==TK_SELECT_COLUMN
1426#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001427 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001428#endif
1429 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001430 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001431 }else{
drhc5cd1242013-09-12 16:50:49 +00001432 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh67a99db2022-05-13 14:52:04 +00001433 assert( !ExprHasProperty(p, EP_OuterON) );
drhe7375bf2020-03-10 19:24:38 +00001434 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001435 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001436 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1437 }else{
drhaecd8022013-09-13 18:15:15 +00001438 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001439 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1440 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001441 }
1442 return nSize;
1443}
1444
1445/*
drh33e619f2009-05-28 01:00:55 +00001446** This function returns the space in bytes required to store the copy
1447** of the Expr structure and a copy of the Expr.u.zToken string (if that
1448** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001449*/
drhb6dad522021-09-24 16:14:47 +00001450static int dupedExprNodeSize(const Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001451 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1452 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001453 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001454 }
danielk1977bc739712009-03-23 04:33:32 +00001455 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001456}
1457
1458/*
1459** Return the number of bytes required to create a duplicate of the
1460** expression passed as the first argument. The second argument is a
1461** mask containing EXPRDUP_XXX flags.
1462**
1463** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001464** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001465**
1466** If the EXPRDUP_REDUCE flag is set, then the return value includes
1467** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1468** and Expr.pRight variables (but not for any structures pointed to or
1469** descended from the Expr.x.pList or Expr.x.pSelect variables).
1470*/
drhb6dad522021-09-24 16:14:47 +00001471static int dupedExprSize(const Expr *p, int flags){
danielk19776ab3a2e2009-02-19 14:39:25 +00001472 int nByte = 0;
1473 if( p ){
1474 nByte = dupedExprNodeSize(p, flags);
1475 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001476 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001477 }
1478 }
1479 return nByte;
1480}
1481
1482/*
1483** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1484** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001485** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001486** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001487** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001488** portion of the buffer copied into by this function.
1489*/
drhb6dad522021-09-24 16:14:47 +00001490static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
drh3c194692016-04-11 16:43:43 +00001491 Expr *pNew; /* Value to return */
1492 u8 *zAlloc; /* Memory space from which to build Expr object */
1493 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1494
drh575fad62016-02-05 13:38:36 +00001495 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001496 assert( p );
1497 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1498 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001499
drh3c194692016-04-11 16:43:43 +00001500 /* Figure out where to write the new Expr structure. */
1501 if( pzBuffer ){
1502 zAlloc = *pzBuffer;
1503 staticFlag = EP_Static;
drh3c6edc82021-04-26 15:28:06 +00001504 assert( zAlloc!=0 );
drh3c194692016-04-11 16:43:43 +00001505 }else{
1506 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1507 staticFlag = 0;
1508 }
1509 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001510
drh3c194692016-04-11 16:43:43 +00001511 if( pNew ){
1512 /* Set nNewSize to the size allocated for the structure pointed to
1513 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1514 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1515 ** by the copy of the p->u.zToken string (if any).
1516 */
1517 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1518 const int nNewSize = nStructSize & 0xfff;
1519 int nToken;
1520 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1521 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001522 }else{
drh3c194692016-04-11 16:43:43 +00001523 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001524 }
drh3c194692016-04-11 16:43:43 +00001525 if( dupFlags ){
1526 assert( ExprHasProperty(p, EP_Reduced)==0 );
1527 memcpy(zAlloc, p, nNewSize);
1528 }else{
1529 u32 nSize = (u32)exprStructSize(p);
1530 memcpy(zAlloc, p, nSize);
1531 if( nSize<EXPR_FULLSIZE ){
1532 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1533 }
1534 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001535
drh3c194692016-04-11 16:43:43 +00001536 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
drh825fa172022-07-22 19:28:04 +00001537 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
drh3c194692016-04-11 16:43:43 +00001538 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1539 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001540 ExprClearVVAProperties(pNew);
1541 if( dupFlags ){
1542 ExprSetVVAProperty(pNew, EP_Immutable);
1543 }
drh3c194692016-04-11 16:43:43 +00001544
1545 /* Copy the p->u.zToken string, if any. */
1546 if( nToken ){
1547 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1548 memcpy(zToken, p->u.zToken, nToken);
1549 }
1550
drh209bc522016-09-23 21:36:24 +00001551 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001552 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
drha4eeccd2021-10-07 17:43:30 +00001553 if( ExprUseXSelect(p) ){
drh3c194692016-04-11 16:43:43 +00001554 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001555 }else{
drh3c194692016-04-11 16:43:43 +00001556 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001557 }
drh3c194692016-04-11 16:43:43 +00001558 }
1559
1560 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001561 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001562 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001563 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001564 pNew->pLeft = p->pLeft ?
1565 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1566 pNew->pRight = p->pRight ?
1567 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001568 }
dan67a9b8e2018-06-22 20:51:35 +00001569#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001570 if( ExprHasProperty(p, EP_WinFunc) ){
1571 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1572 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001573 }
dan67a9b8e2018-06-22 20:51:35 +00001574#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001575 if( pzBuffer ){
1576 *pzBuffer = zAlloc;
1577 }
1578 }else{
drh209bc522016-09-23 21:36:24 +00001579 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001580 if( pNew->op==TK_SELECT_COLUMN ){
1581 pNew->pLeft = p->pLeft;
drh5cc9daf2021-04-12 23:18:18 +00001582 assert( p->pRight==0 || p->pRight==p->pLeft
1583 || ExprHasProperty(p->pLeft, EP_Subquery) );
drh98542602016-08-20 17:00:16 +00001584 }else{
1585 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1586 }
drh3c194692016-04-11 16:43:43 +00001587 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001588 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001589 }
1590 }
1591 return pNew;
1592}
1593
1594/*
danbfe31e72014-01-15 14:17:31 +00001595** Create and return a deep copy of the object passed as the second
1596** argument. If an OOM condition is encountered, NULL is returned
1597** and the db->mallocFailed flag set.
1598*/
daneede6a52014-01-15 19:42:23 +00001599#ifndef SQLITE_OMIT_CTE
dan26d61e52021-06-11 11:14:24 +00001600With *sqlite3WithDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001601 With *pRet = 0;
1602 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001603 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001604 pRet = sqlite3DbMallocZero(db, nByte);
1605 if( pRet ){
1606 int i;
1607 pRet->nCte = p->nCte;
1608 for(i=0; i<p->nCte; i++){
1609 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1610 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1611 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
drh67f70be2022-04-22 16:15:48 +00001612 pRet->a[i].eM10d = p->a[i].eM10d;
dan4e9119d2014-01-13 15:12:23 +00001613 }
1614 }
1615 }
1616 return pRet;
1617}
daneede6a52014-01-15 19:42:23 +00001618#else
dan26d61e52021-06-11 11:14:24 +00001619# define sqlite3WithDup(x,y) 0
daneede6a52014-01-15 19:42:23 +00001620#endif
dan4e9119d2014-01-13 15:12:23 +00001621
drha8389972018-12-06 22:04:19 +00001622#ifndef SQLITE_OMIT_WINDOWFUNC
1623/*
1624** The gatherSelectWindows() procedure and its helper routine
1625** gatherSelectWindowsCallback() are used to scan all the expressions
1626** an a newly duplicated SELECT statement and gather all of the Window
1627** objects found there, assembling them onto the linked list at Select->pWin.
1628*/
1629static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001630 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001631 Select *pSelect = pWalker->u.pSelect;
1632 Window *pWin = pExpr->y.pWin;
1633 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001634 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001635 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001636 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001637 }
1638 return WRC_Continue;
1639}
drha37b6a52018-12-06 22:12:18 +00001640static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1641 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1642}
drha8389972018-12-06 22:04:19 +00001643static void gatherSelectWindows(Select *p){
1644 Walker w;
1645 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001646 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1647 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001648 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001649 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001650 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001651}
1652#endif
1653
1654
drha76b5df2002-02-23 02:32:10 +00001655/*
drhff78bd22002-02-27 01:47:11 +00001656** The following group of routines make deep copies of expressions,
1657** expression lists, ID lists, and select statements. The copies can
1658** be deleted (by being passed to their respective ...Delete() routines)
1659** without effecting the originals.
1660**
danielk19774adee202004-05-08 08:23:19 +00001661** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1662** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001663** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001664**
drhad3cab52002-05-24 02:04:32 +00001665** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001666**
drhb7916a72009-05-27 10:31:29 +00001667** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001668** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1669** truncated version of the usual Expr structure that will be stored as
1670** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001671*/
drhb6dad522021-09-24 16:14:47 +00001672Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001673 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001674 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001675}
drhb6dad522021-09-24 16:14:47 +00001676ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001677 ExprList *pNew;
drhb6dad522021-09-24 16:14:47 +00001678 struct ExprList_item *pItem;
1679 const struct ExprList_item *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001680 int i;
drhe46292a2021-07-05 02:40:29 +00001681 Expr *pPriorSelectColOld = 0;
1682 Expr *pPriorSelectColNew = 0;
drh575fad62016-02-05 13:38:36 +00001683 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001684 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001685 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001686 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001687 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001688 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001689 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001690 pOldItem = p->a;
1691 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001692 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001693 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001694 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001695 if( pOldExpr
1696 && pOldExpr->op==TK_SELECT_COLUMN
1697 && (pNewExpr = pItem->pExpr)!=0
1698 ){
drhe46292a2021-07-05 02:40:29 +00001699 if( pNewExpr->pRight ){
1700 pPriorSelectColOld = pOldExpr->pRight;
1701 pPriorSelectColNew = pNewExpr->pRight;
1702 pNewExpr->pLeft = pNewExpr->pRight;
drhb1637482017-01-03 00:27:16 +00001703 }else{
drhe46292a2021-07-05 02:40:29 +00001704 if( pOldExpr->pLeft!=pPriorSelectColOld ){
1705 pPriorSelectColOld = pOldExpr->pLeft;
1706 pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1707 pNewExpr->pRight = pPriorSelectColNew;
1708 }
1709 pNewExpr->pLeft = pPriorSelectColNew;
drh47073f62017-01-02 22:36:32 +00001710 }
1711 }
drh41cee662019-12-12 20:22:34 +00001712 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
drhd88fd532022-05-02 20:49:30 +00001713 pItem->fg = pOldItem->fg;
1714 pItem->fg.done = 0;
drhc2acc4e2013-11-15 18:15:19 +00001715 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001716 }
1717 return pNew;
1718}
danielk197793758c82005-01-21 08:13:14 +00001719
1720/*
1721** If cursors, triggers, views and subqueries are all omitted from
1722** the build, then none of the following routines, except for
1723** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1724** called with a NULL argument.
1725*/
danielk19776a67fe82005-02-04 04:07:16 +00001726#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1727 || !defined(SQLITE_OMIT_SUBQUERY)
drhb6dad522021-09-24 16:14:47 +00001728SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001729 SrcList *pNew;
1730 int i;
drh113088e2003-03-20 01:16:58 +00001731 int nByte;
drh575fad62016-02-05 13:38:36 +00001732 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001733 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001734 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001735 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001736 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001737 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001738 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001739 SrcItem *pNewItem = &pNew->a[i];
drhb6dad522021-09-24 16:14:47 +00001740 const SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001741 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001742 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001743 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1744 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1745 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001746 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001747 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001748 pNewItem->addrFillSub = pOldItem->addrFillSub;
1749 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001750 if( pNewItem->fg.isIndexedBy ){
1751 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1752 }
drha79e2a22021-02-21 23:44:14 +00001753 pNewItem->u2 = pOldItem->u2;
1754 if( pNewItem->fg.isCte ){
1755 pNewItem->u2.pCteUse->nUse++;
1756 }
drh8a48b9c2015-08-19 15:20:00 +00001757 if( pNewItem->fg.isTabFunc ){
1758 pNewItem->u1.pFuncArg =
1759 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1760 }
drhed8a3bb2005-06-06 21:19:56 +00001761 pTab = pNewItem->pTab = pOldItem->pTab;
1762 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001763 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001764 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001765 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
drhd44f8b22022-04-07 01:11:13 +00001766 if( pOldItem->fg.isUsing ){
1767 assert( pNewItem->fg.isUsing );
1768 pNewItem->u3.pUsing = sqlite3IdListDup(db, pOldItem->u3.pUsing);
1769 }else{
1770 pNewItem->u3.pOn = sqlite3ExprDup(db, pOldItem->u3.pOn, flags);
1771 }
danielk19776c18b6e2005-01-30 09:17:58 +00001772 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001773 }
1774 return pNew;
1775}
drhb6dad522021-09-24 16:14:47 +00001776IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
drhff78bd22002-02-27 01:47:11 +00001777 IdList *pNew;
1778 int i;
drh575fad62016-02-05 13:38:36 +00001779 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001780 if( p==0 ) return 0;
drha99e3252022-04-15 15:47:14 +00001781 assert( p->eU4!=EU4_EXPR );
1782 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew)+(p->nId-1)*sizeof(p->a[0]) );
drhff78bd22002-02-27 01:47:11 +00001783 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001784 pNew->nId = p->nId;
drha99e3252022-04-15 15:47:14 +00001785 pNew->eU4 = p->eU4;
drhff78bd22002-02-27 01:47:11 +00001786 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001787 struct IdList_item *pNewItem = &pNew->a[i];
drha99e3252022-04-15 15:47:14 +00001788 const struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001789 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drha99e3252022-04-15 15:47:14 +00001790 pNewItem->u4 = pOldItem->u4;
drhff78bd22002-02-27 01:47:11 +00001791 }
1792 return pNew;
1793}
drhb6dad522021-09-24 16:14:47 +00001794Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
dana7466202017-02-03 14:44:52 +00001795 Select *pRet = 0;
1796 Select *pNext = 0;
1797 Select **pp = &pRet;
drhb6dad522021-09-24 16:14:47 +00001798 const Select *p;
dana7466202017-02-03 14:44:52 +00001799
drh575fad62016-02-05 13:38:36 +00001800 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001801 for(p=pDup; p; p=p->pPrior){
1802 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1803 if( pNew==0 ) break;
1804 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1805 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1806 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1807 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1808 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1809 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1810 pNew->op = p->op;
1811 pNew->pNext = pNext;
1812 pNew->pPrior = 0;
1813 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001814 pNew->iLimit = 0;
1815 pNew->iOffset = 0;
1816 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1817 pNew->addrOpenEphm[0] = -1;
1818 pNew->addrOpenEphm[1] = -1;
1819 pNew->nSelectRow = p->nSelectRow;
dan26d61e52021-06-11 11:14:24 +00001820 pNew->pWith = sqlite3WithDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001821#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001822 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001823 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001824 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001825#endif
drhfef37762018-07-10 19:48:35 +00001826 pNew->selId = p->selId;
drh9da977f2021-04-20 12:14:12 +00001827 if( db->mallocFailed ){
1828 /* Any prior OOM might have left the Select object incomplete.
1829 ** Delete the whole thing rather than allow an incomplete Select
1830 ** to be used by the code generator. */
1831 pNew->pNext = 0;
1832 sqlite3SelectDelete(db, pNew);
1833 break;
1834 }
dana7466202017-02-03 14:44:52 +00001835 *pp = pNew;
1836 pp = &pNew->pPrior;
1837 pNext = pNew;
1838 }
1839
1840 return pRet;
drhff78bd22002-02-27 01:47:11 +00001841}
danielk197793758c82005-01-21 08:13:14 +00001842#else
drhf76d2872021-10-27 17:15:08 +00001843Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001844 assert( p==0 );
1845 return 0;
1846}
1847#endif
drhff78bd22002-02-27 01:47:11 +00001848
1849
1850/*
drha76b5df2002-02-23 02:32:10 +00001851** Add a new element to the end of an expression list. If pList is
1852** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001853**
drha19543f2017-09-15 15:17:48 +00001854** The pList argument must be either NULL or a pointer to an ExprList
1855** obtained from a prior call to sqlite3ExprListAppend(). This routine
1856** may not be used with an ExprList obtained from sqlite3ExprListDup().
1857** Reason: This routine assumes that the number of slots in pList->a[]
1858** is a power of two. That is true for sqlite3ExprListAppend() returns
1859** but is not necessarily true from the return value of sqlite3ExprListDup().
1860**
drhb7916a72009-05-27 10:31:29 +00001861** If a memory allocation error occurs, the entire list is freed and
1862** NULL is returned. If non-NULL is returned, then it is guaranteed
1863** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001864*/
larrybrdabada62021-04-04 12:52:58 +00001865static const struct ExprList_item zeroItem = {0};
drh50e43c52021-03-23 14:27:35 +00001866SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1867 sqlite3 *db, /* Database handle. Used for memory allocation */
1868 Expr *pExpr /* Expression to be appended. Might be NULL */
1869){
1870 struct ExprList_item *pItem;
1871 ExprList *pList;
1872
1873 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1874 if( pList==0 ){
1875 sqlite3ExprDelete(db, pExpr);
1876 return 0;
1877 }
1878 pList->nAlloc = 4;
1879 pList->nExpr = 1;
1880 pItem = &pList->a[0];
1881 *pItem = zeroItem;
1882 pItem->pExpr = pExpr;
1883 return pList;
1884}
1885SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1886 sqlite3 *db, /* Database handle. Used for memory allocation */
1887 ExprList *pList, /* List to which to append. Might be NULL */
1888 Expr *pExpr /* Expression to be appended. Might be NULL */
1889){
1890 struct ExprList_item *pItem;
1891 ExprList *pNew;
1892 pList->nAlloc *= 2;
1893 pNew = sqlite3DbRealloc(db, pList,
1894 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1895 if( pNew==0 ){
1896 sqlite3ExprListDelete(db, pList);
1897 sqlite3ExprDelete(db, pExpr);
1898 return 0;
1899 }else{
1900 pList = pNew;
1901 }
1902 pItem = &pList->a[pList->nExpr++];
1903 *pItem = zeroItem;
1904 pItem->pExpr = pExpr;
1905 return pList;
1906}
drh17435752007-08-16 04:30:38 +00001907ExprList *sqlite3ExprListAppend(
1908 Parse *pParse, /* Parsing context */
1909 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001910 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001911){
drh43606172017-04-05 11:32:13 +00001912 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001913 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001914 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1915 }
1916 if( pList->nAlloc<pList->nExpr+1 ){
1917 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001918 }
drh43606172017-04-05 11:32:13 +00001919 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001920 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001921 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001922 return pList;
1923}
1924
1925/*
drh8762ec12016-08-20 01:06:22 +00001926** pColumns and pExpr form a vector assignment which is part of the SET
1927** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001928**
1929** (a,b,c) = (expr1,expr2,expr3)
1930** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1931**
1932** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001933** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001934** TK_SELECT_COLUMN expressions.
1935*/
1936ExprList *sqlite3ExprListAppendVector(
1937 Parse *pParse, /* Parsing context */
1938 ExprList *pList, /* List to which to append. Might be NULL */
1939 IdList *pColumns, /* List of names of LHS of the assignment */
1940 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1941){
1942 sqlite3 *db = pParse->db;
1943 int n;
1944 int i;
drh66860af2016-08-23 18:30:10 +00001945 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001946 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1947 ** exit prior to this routine being invoked */
1948 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001949 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001950
1951 /* If the RHS is a vector, then we can immediately check to see that
1952 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1953 ** wildcards ("*") in the result set of the SELECT must be expanded before
1954 ** we can do the size check, so defer the size check until code generation.
1955 */
1956 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001957 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1958 pColumns->nId, n);
1959 goto vector_append_error;
1960 }
drh966e2912017-01-03 02:58:01 +00001961
1962 for(i=0; i<pColumns->nId; i++){
drh10f08272021-07-05 01:11:26 +00001963 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
drh554a9dc2019-08-26 14:18:28 +00001964 assert( pSubExpr!=0 || db->mallocFailed );
drh554a9dc2019-08-26 14:18:28 +00001965 if( pSubExpr==0 ) continue;
drha1251bc2016-08-20 00:51:37 +00001966 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1967 if( pList ){
drh66860af2016-08-23 18:30:10 +00001968 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001969 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001970 pColumns->a[i].zName = 0;
1971 }
1972 }
drh966e2912017-01-03 02:58:01 +00001973
drhffe28052017-05-06 18:09:36 +00001974 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001975 Expr *pFirst = pList->a[iFirst].pExpr;
1976 assert( pFirst!=0 );
1977 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001978
drhf4dd26c2017-04-05 11:49:06 +00001979 /* Store the SELECT statement in pRight so it will be deleted when
1980 ** sqlite3ExprListDelete() is called */
1981 pFirst->pRight = pExpr;
1982 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001983
drhf4dd26c2017-04-05 11:49:06 +00001984 /* Remember the size of the LHS in iTable so that we can check that
1985 ** the RHS and LHS sizes match during code generation. */
1986 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001987 }
1988
1989vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001990 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001991 sqlite3IdListDelete(db, pColumns);
1992 return pList;
1993}
1994
1995/*
drhbc622bc2015-08-24 15:39:42 +00001996** Set the sort order for the last element on the given ExprList.
1997*/
dan6e118922019-08-12 16:36:38 +00001998void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001999 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00002000 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00002001 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00002002
2003 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
2004 assert( iSortOrder==SQLITE_SO_UNDEFINED
2005 || iSortOrder==SQLITE_SO_ASC
2006 || iSortOrder==SQLITE_SO_DESC
2007 );
2008 assert( eNulls==SQLITE_SO_UNDEFINED
2009 || eNulls==SQLITE_SO_ASC
2010 || eNulls==SQLITE_SO_DESC
2011 );
2012
dan9105fd52019-08-19 17:26:32 +00002013 pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00002014 assert( pItem->fg.bNulls==0 );
dan9105fd52019-08-19 17:26:32 +00002015 if( iSortOrder==SQLITE_SO_UNDEFINED ){
2016 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00002017 }
drhd88fd532022-05-02 20:49:30 +00002018 pItem->fg.sortFlags = (u8)iSortOrder;
dan9105fd52019-08-19 17:26:32 +00002019
2020 if( eNulls!=SQLITE_SO_UNDEFINED ){
drhd88fd532022-05-02 20:49:30 +00002021 pItem->fg.bNulls = 1;
dan9105fd52019-08-19 17:26:32 +00002022 if( iSortOrder!=eNulls ){
drhd88fd532022-05-02 20:49:30 +00002023 pItem->fg.sortFlags |= KEYINFO_ORDER_BIGNULL;
dan9105fd52019-08-19 17:26:32 +00002024 }
drhbc622bc2015-08-24 15:39:42 +00002025 }
drhbc622bc2015-08-24 15:39:42 +00002026}
2027
2028/*
drh41cee662019-12-12 20:22:34 +00002029** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00002030** on the expression list.
2031**
2032** pList might be NULL following an OOM error. But pName should never be
2033** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
2034** is set.
2035*/
2036void sqlite3ExprListSetName(
2037 Parse *pParse, /* Parsing context */
2038 ExprList *pList, /* List to which to add the span. */
drhb6dad522021-09-24 16:14:47 +00002039 const Token *pName, /* Name to be added */
drhb7916a72009-05-27 10:31:29 +00002040 int dequote /* True to cause the name to be dequoted */
2041){
2042 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00002043 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00002044 if( pList ){
2045 struct ExprList_item *pItem;
2046 assert( pList->nExpr>0 );
2047 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00002048 assert( pItem->zEName==0 );
drhd88fd532022-05-02 20:49:30 +00002049 assert( pItem->fg.eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00002050 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00002051 if( dequote ){
2052 /* If dequote==0, then pName->z does not point to part of a DDL
2053 ** statement handled by the parser. And so no token need be added
2054 ** to the token-map. */
2055 sqlite3Dequote(pItem->zEName);
2056 if( IN_RENAME_OBJECT ){
drhb6dad522021-09-24 16:14:47 +00002057 sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
dan85f2c762020-04-06 16:37:05 +00002058 }
dan5be60c52018-08-15 20:28:39 +00002059 }
drhb7916a72009-05-27 10:31:29 +00002060 }
2061}
2062
2063/*
2064** Set the ExprList.a[].zSpan element of the most recently added item
2065** on the expression list.
2066**
2067** pList might be NULL following an OOM error. But pSpan should never be
2068** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
2069** is set.
2070*/
2071void sqlite3ExprListSetSpan(
2072 Parse *pParse, /* Parsing context */
2073 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00002074 const char *zStart, /* Start of the span */
2075 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00002076){
2077 sqlite3 *db = pParse->db;
2078 assert( pList!=0 || db->mallocFailed!=0 );
2079 if( pList ){
2080 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
2081 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00002082 if( pItem->zEName==0 ){
2083 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
drhd88fd532022-05-02 20:49:30 +00002084 pItem->fg.eEName = ENAME_SPAN;
drhcbb9da32019-12-12 22:11:33 +00002085 }
drhb7916a72009-05-27 10:31:29 +00002086 }
2087}
2088
2089/*
danielk19777a15a4b2007-05-08 17:54:43 +00002090** If the expression list pEList contains more than iLimit elements,
2091** leave an error message in pParse.
2092*/
2093void sqlite3ExprListCheckLength(
2094 Parse *pParse,
2095 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00002096 const char *zObject
2097){
drhb1a6c3c2008-03-20 16:30:17 +00002098 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00002099 testcase( pEList && pEList->nExpr==mx );
2100 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00002101 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00002102 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
2103 }
2104}
2105
2106/*
drha76b5df2002-02-23 02:32:10 +00002107** Delete an entire expression list.
2108*/
drhaffa8552016-04-11 18:25:05 +00002109static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00002110 int i = pList->nExpr;
2111 struct ExprList_item *pItem = pList->a;
2112 assert( pList->nExpr>0 );
drh41ce47c2022-08-22 02:00:26 +00002113 assert( db!=0 );
drhac48b752017-04-05 11:57:56 +00002114 do{
drh633e6d52008-07-28 19:34:53 +00002115 sqlite3ExprDelete(db, pItem->pExpr);
drh41ce47c2022-08-22 02:00:26 +00002116 if( pItem->zEName ) sqlite3DbNNFreeNN(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00002117 pItem++;
2118 }while( --i>0 );
drh41ce47c2022-08-22 02:00:26 +00002119 sqlite3DbNNFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00002120}
drhaffa8552016-04-11 18:25:05 +00002121void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2122 if( pList ) exprListDeleteNN(db, pList);
2123}
drha76b5df2002-02-23 02:32:10 +00002124
2125/*
drh2308ed32015-02-09 16:09:34 +00002126** Return the bitwise-OR of all Expr.flags fields in the given
2127** ExprList.
drh885a5b02015-02-09 15:21:36 +00002128*/
drh2308ed32015-02-09 16:09:34 +00002129u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00002130 int i;
drh2308ed32015-02-09 16:09:34 +00002131 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00002132 assert( pList!=0 );
2133 for(i=0; i<pList->nExpr; i++){
2134 Expr *pExpr = pList->a[i].pExpr;
2135 assert( pExpr!=0 );
2136 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00002137 }
drh2308ed32015-02-09 16:09:34 +00002138 return m;
drh885a5b02015-02-09 15:21:36 +00002139}
2140
2141/*
drh7e6f9802017-09-04 00:33:04 +00002142** This is a SELECT-node callback for the expression walker that
2143** always "fails". By "fail" in this case, we mean set
2144** pWalker->eCode to zero and abort.
2145**
2146** This callback is used by multiple expression walkers.
2147*/
2148int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
2149 UNUSED_PARAMETER(NotUsed);
2150 pWalker->eCode = 0;
2151 return WRC_Abort;
2152}
2153
2154/*
drh0cbec592020-01-03 02:20:37 +00002155** Check the input string to see if it is "true" or "false" (in any case).
2156**
2157** If the string is.... Return
2158** "true" EP_IsTrue
2159** "false" EP_IsFalse
2160** anything else 0
2161*/
2162u32 sqlite3IsTrueOrFalse(const char *zIn){
2163 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
2164 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
2165 return 0;
2166}
2167
2168
2169/*
drh171d16b2018-02-26 20:15:54 +00002170** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00002171** then convert it into an TK_TRUEFALSE term. Return non-zero if
2172** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00002173*/
2174int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00002175 u32 v;
drh171d16b2018-02-26 20:15:54 +00002176 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drhf9751072021-10-07 13:40:29 +00002177 if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
drh0cbec592020-01-03 02:20:37 +00002178 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00002179 ){
2180 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00002181 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00002182 return 1;
2183 }
2184 return 0;
2185}
2186
drh43c4ac82018-02-26 21:26:27 +00002187/*
drh96acafb2018-02-27 14:49:25 +00002188** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002189** and 0 if it is FALSE.
2190*/
drh96acafb2018-02-27 14:49:25 +00002191int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002192 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002193 assert( pExpr->op==TK_TRUEFALSE );
drhf9751072021-10-07 13:40:29 +00002194 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh43c4ac82018-02-26 21:26:27 +00002195 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2196 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2197 return pExpr->u.zToken[4]==0;
2198}
2199
drh17180fc2019-04-19 17:26:19 +00002200/*
2201** If pExpr is an AND or OR expression, try to simplify it by eliminating
2202** terms that are always true or false. Return the simplified expression.
2203** Or return the original expression if no simplification is possible.
2204**
2205** Examples:
2206**
2207** (x<10) AND true => (x<10)
2208** (x<10) AND false => false
2209** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2210** (x<10) AND (y=22 OR true) => (x<10)
2211** (y=22) OR true => true
2212*/
2213Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2214 assert( pExpr!=0 );
2215 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2216 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2217 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2218 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2219 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2220 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2221 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2222 }
2223 }
2224 return pExpr;
2225}
2226
drh171d16b2018-02-26 20:15:54 +00002227
2228/*
drh059b2d52014-10-24 19:28:09 +00002229** These routines are Walker callbacks used to check expressions to
2230** see if they are "constant" for some definition of constant. The
2231** Walker.eCode value determines the type of "constant" we are looking
2232** for.
drh73b211a2005-01-18 04:00:42 +00002233**
drh7d10d5a2008-08-20 16:35:10 +00002234** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002235**
drh059b2d52014-10-24 19:28:09 +00002236** sqlite3ExprIsConstant() pWalker->eCode==1
2237** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002238** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002239** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002240**
drh059b2d52014-10-24 19:28:09 +00002241** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2242** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002243**
drh014fff22020-01-08 22:22:36 +00002244** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2245** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002246** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002247** when processing a new CREATE TABLE statement. A bound parameter raises
2248** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002249** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002250** contain a bound parameter because they were generated by older versions
2251** of SQLite to be parsed by newer versions of SQLite without raising a
2252** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002253*/
drh7d10d5a2008-08-20 16:35:10 +00002254static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002255
drh059b2d52014-10-24 19:28:09 +00002256 /* If pWalker->eCode is 2 then any term of the expression that comes from
drhb77c07a2022-04-11 11:59:25 +00002257 ** the ON or USING clauses of an outer join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002258 ** from being considered constant. */
drh67a99db2022-05-13 14:52:04 +00002259 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_OuterON) ){
drh059b2d52014-10-24 19:28:09 +00002260 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002261 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002262 }
2263
drh626a8792005-01-17 22:08:19 +00002264 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002265 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002266 ** and either pWalker->eCode==4 or 5 or the function has the
2267 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002268 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002269 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2270 && !ExprHasProperty(pExpr, EP_WinFunc)
2271 ){
drh014fff22020-01-08 22:22:36 +00002272 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002273 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002274 }else{
2275 pWalker->eCode = 0;
2276 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002277 }
drh626a8792005-01-17 22:08:19 +00002278 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002279 /* Convert "true" or "false" in a DEFAULT clause into the
2280 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002281 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002282 return WRC_Prune;
2283 }
drh08b92082020-08-10 14:18:00 +00002284 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002285 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002286 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002287 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002288 testcase( pExpr->op==TK_ID );
2289 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002290 testcase( pExpr->op==TK_AGG_FUNCTION );
2291 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002292 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002293 return WRC_Continue;
2294 }
drh059b2d52014-10-24 19:28:09 +00002295 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2296 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002297 }
drh08b92082020-08-10 14:18:00 +00002298 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002299 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002300 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002301 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002302 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002303 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002304 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002305 pWalker->eCode = 0;
2306 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002307 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002308 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002309 /* Silently convert bound parameters that appear inside of CREATE
2310 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002311 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002312 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002313 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002314 /* A bound parameter in a CREATE statement that originates from
2315 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002316 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002317 return WRC_Abort;
2318 }
drh08b92082020-08-10 14:18:00 +00002319 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002320 default:
drh6e341b92018-04-17 18:50:40 +00002321 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2322 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002323 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002324 }
2325}
drh059b2d52014-10-24 19:28:09 +00002326static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002327 Walker w;
drh059b2d52014-10-24 19:28:09 +00002328 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002329 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002330 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002331#ifdef SQLITE_DEBUG
2332 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2333#endif
drh059b2d52014-10-24 19:28:09 +00002334 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002335 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002336 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002337}
drh626a8792005-01-17 22:08:19 +00002338
2339/*
drh059b2d52014-10-24 19:28:09 +00002340** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002341** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002342**
2343** For the purposes of this function, a double-quoted string (ex: "abc")
2344** is considered a variable but a single-quoted string (ex: 'abc') is
2345** a constant.
drhfef52082000-06-06 01:50:43 +00002346*/
danielk19774adee202004-05-08 08:23:19 +00002347int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002348 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002349}
2350
2351/*
drh07aded62018-07-28 16:24:08 +00002352** Walk an expression tree. Return non-zero if
2353**
2354** (1) the expression is constant, and
2355** (2) the expression does originate in the ON or USING clause
2356** of a LEFT JOIN, and
2357** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2358** operands created by the constant propagation optimization.
2359**
2360** When this routine returns true, it indicates that the expression
2361** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002362** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002363*/
2364int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002365 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002366}
2367
2368/*
drhfcb9f4f2015-06-01 18:13:16 +00002369** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002370** for any single row of the table with cursor iCur. In other words, the
2371** expression must not refer to any non-deterministic function nor any
2372** table other than iCur.
2373*/
2374int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2375 return exprIsConst(p, 3, iCur);
2376}
2377
drha9cdb902022-04-25 19:40:33 +00002378/*
2379** Check pExpr to see if it is an invariant constraint on data source pSrc.
2380** This is an optimization. False negatives will perhaps cause slower
2381** queries, but false positives will yield incorrect answers. So when in
drh22b541b2022-04-27 18:38:46 +00002382** doubt, return 0.
drha9cdb902022-04-25 19:40:33 +00002383**
2384** To be an invariant constraint, the following must be true:
2385**
2386** (1) pExpr cannot refer to any table other than pSrc->iCursor.
2387**
2388** (2) pExpr cannot use subqueries or non-deterministic functions.
2389**
2390** (3) pSrc cannot be part of the left operand for a RIGHT JOIN.
2391** (Is there some way to relax this constraint?)
2392**
2393** (4) If pSrc is the right operand of a LEFT JOIN, then...
2394** (4a) pExpr must come from an ON clause..
2395 (4b) and specifically the ON clause associated with the LEFT JOIN.
2396**
2397** (5) If pSrc is not the right operand of a LEFT JOIN or the left
2398** operand of a RIGHT JOIN, then pExpr must be from the WHERE
2399** clause, not an ON clause.
2400*/
2401int sqlite3ExprIsTableConstraint(Expr *pExpr, const SrcItem *pSrc){
2402 if( pSrc->fg.jointype & JT_LTORJ ){
2403 return 0; /* rule (3) */
2404 }
2405 if( pSrc->fg.jointype & JT_LEFT ){
drh67a99db2022-05-13 14:52:04 +00002406 if( !ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (4a) */
drha9cdb902022-04-25 19:40:33 +00002407 if( pExpr->w.iJoin!=pSrc->iCursor ) return 0; /* rule (4b) */
2408 }else{
drh67a99db2022-05-13 14:52:04 +00002409 if( ExprHasProperty(pExpr, EP_OuterON) ) return 0; /* rule (5) */
drha9cdb902022-04-25 19:40:33 +00002410 }
2411 return sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor); /* rules (1), (2) */
2412}
2413
danab31a842017-04-29 20:53:09 +00002414
2415/*
2416** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2417*/
2418static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2419 ExprList *pGroupBy = pWalker->u.pGroupBy;
2420 int i;
2421
2422 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2423 ** it constant. */
2424 for(i=0; i<pGroupBy->nExpr; i++){
2425 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002426 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002427 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002428 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002429 return WRC_Prune;
2430 }
2431 }
2432 }
2433
2434 /* Check if pExpr is a sub-select. If so, consider it variable. */
drha4eeccd2021-10-07 17:43:30 +00002435 if( ExprUseXSelect(pExpr) ){
danab31a842017-04-29 20:53:09 +00002436 pWalker->eCode = 0;
2437 return WRC_Abort;
2438 }
2439
2440 return exprNodeIsConstant(pWalker, pExpr);
2441}
2442
2443/*
2444** Walk the expression tree passed as the first argument. Return non-zero
2445** if the expression consists entirely of constants or copies of terms
2446** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002447**
2448** This routine is used to determine if a term of the HAVING clause can
2449** be promoted into the WHERE clause. In order for such a promotion to work,
2450** the value of the HAVING clause term must be the same for all members of
2451** a "group". The requirement that the GROUP BY term must be BINARY
2452** assumes that no other collating sequence will have a finer-grained
2453** grouping than binary. In other words (A=B COLLATE binary) implies
2454** A=B in every other collating sequence. The requirement that the
2455** GROUP BY be BINARY is stricter than necessary. It would also work
2456** to promote HAVING clauses that use the same alternative collating
2457** sequence as the GROUP BY term, but that is much harder to check,
2458** alternative collating sequences are uncommon, and this is only an
2459** optimization, so we take the easy way out and simply require the
2460** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002461*/
2462int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2463 Walker w;
danab31a842017-04-29 20:53:09 +00002464 w.eCode = 1;
2465 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002466 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002467 w.u.pGroupBy = pGroupBy;
2468 w.pParse = pParse;
2469 sqlite3WalkExpr(&w, p);
2470 return w.eCode;
2471}
2472
drh059b2d52014-10-24 19:28:09 +00002473/*
drh014fff22020-01-08 22:22:36 +00002474** Walk an expression tree for the DEFAULT field of a column definition
2475** in a CREATE TABLE statement. Return non-zero if the expression is
2476** acceptable for use as a DEFAULT. That is to say, return non-zero if
2477** the expression is constant or a function call with constant arguments.
2478** Return and 0 if there are any variables.
2479**
drh1e32bed2020-06-19 13:33:53 +00002480** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002481** processing a new CREATE TABLE statement. When isInit is true, parameters
2482** (such as ? or $abc) in the expression are converted into NULL. When
2483** isInit is false, parameters raise an error. Parameters should not be
2484** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002485** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002486** backwards compatibility.
2487**
2488** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002489**
2490** For the purposes of this function, a double-quoted string (ex: "abc")
2491** is considered a variable but a single-quoted string (ex: 'abc') is
2492** a constant.
2493*/
drhfeada2d2014-09-24 13:20:22 +00002494int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2495 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002496 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002497}
2498
drh5b88bc42013-12-07 23:35:21 +00002499#ifdef SQLITE_ENABLE_CURSOR_HINTS
2500/*
2501** Walk an expression tree. Return 1 if the expression contains a
2502** subquery of some kind. Return 0 if there are no subqueries.
2503*/
2504int sqlite3ExprContainsSubquery(Expr *p){
2505 Walker w;
drhbec24762015-08-13 20:07:13 +00002506 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002507 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002508 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002509#ifdef SQLITE_DEBUG
2510 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2511#endif
drh5b88bc42013-12-07 23:35:21 +00002512 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002513 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002514}
2515#endif
2516
drheb55bd22005-06-30 17:04:21 +00002517/*
drh73b211a2005-01-18 04:00:42 +00002518** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002519** to fit in a 32-bit integer, return 1 and put the value of the integer
2520** in *pValue. If the expression is not an integer or if it is too big
2521** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002522*/
drhb6dad522021-09-24 16:14:47 +00002523int sqlite3ExprIsInteger(const Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002524 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002525 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002526
2527 /* If an expression is an integer literal that fits in a signed 32-bit
2528 ** integer, then the EP_IntValue flag will have already been set */
2529 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2530 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2531
drh92b01d52008-06-24 00:32:35 +00002532 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002533 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002534 return 1;
2535 }
drhe4de1fe2002-06-02 16:09:01 +00002536 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002537 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002538 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002539 break;
drh4b59ab52002-08-24 18:24:51 +00002540 }
drhe4de1fe2002-06-02 16:09:01 +00002541 case TK_UMINUS: {
drhc59ffa82021-10-04 15:08:49 +00002542 int v = 0;
danielk19774adee202004-05-08 08:23:19 +00002543 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
drhc59ffa82021-10-04 15:08:49 +00002544 assert( ((unsigned int)v)!=0x80000000 );
drhe4de1fe2002-06-02 16:09:01 +00002545 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002546 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002547 }
2548 break;
2549 }
2550 default: break;
2551 }
drh92b01d52008-06-24 00:32:35 +00002552 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002553}
2554
2555/*
drh039fc322009-11-17 18:31:47 +00002556** Return FALSE if there is no chance that the expression can be NULL.
2557**
2558** If the expression might be NULL or if the expression is too complex
2559** to tell return TRUE.
2560**
2561** This routine is used as an optimization, to skip OP_IsNull opcodes
2562** when we know that a value cannot be NULL. Hence, a false positive
2563** (returning TRUE when in fact the expression can never be NULL) might
2564** be a small performance hit but is otherwise harmless. On the other
2565** hand, a false negative (returning FALSE when the result could be NULL)
2566** will likely result in an incorrect answer. So when in doubt, return
2567** TRUE.
2568*/
2569int sqlite3ExprCanBeNull(const Expr *p){
2570 u8 op;
drh3c6edc82021-04-26 15:28:06 +00002571 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002572 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2573 p = p->pLeft;
drh3c6edc82021-04-26 15:28:06 +00002574 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002575 }
drh039fc322009-11-17 18:31:47 +00002576 op = p->op;
2577 if( op==TK_REGISTER ) op = p->op2;
2578 switch( op ){
2579 case TK_INTEGER:
2580 case TK_STRING:
2581 case TK_FLOAT:
2582 case TK_BLOB:
2583 return 0;
drh7248a8b2014-08-04 18:50:54 +00002584 case TK_COLUMN:
drh477572b2021-10-07 20:46:29 +00002585 assert( ExprUseYTab(p) );
drh72673a22014-12-04 16:27:17 +00002586 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002587 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002588 (p->iColumn>=0
drh6df8c0c2021-11-28 19:54:38 +00002589 && p->y.pTab->aCol!=0 /* Possible due to prior error */
drh4eac5f02019-12-24 15:01:17 +00002590 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002591 default:
2592 return 1;
2593 }
2594}
2595
2596/*
2597** Return TRUE if the given expression is a constant which would be
2598** unchanged by OP_Affinity with the affinity given in the second
2599** argument.
2600**
2601** This routine is used to determine if the OP_Affinity operation
2602** can be omitted. When in doubt return FALSE. A false negative
2603** is harmless. A false positive, however, can result in the wrong
2604** answer.
2605*/
2606int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2607 u8 op;
drhaf866402019-08-22 11:11:28 +00002608 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002609 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002610 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2611 if( p->op==TK_UMINUS ) unaryMinus = 1;
2612 p = p->pLeft;
2613 }
drh039fc322009-11-17 18:31:47 +00002614 op = p->op;
2615 if( op==TK_REGISTER ) op = p->op2;
2616 switch( op ){
2617 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002618 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002619 }
2620 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002621 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002622 }
2623 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002624 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002625 }
2626 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002627 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002628 }
drh2f2855b2009-11-18 01:25:26 +00002629 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002630 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002631 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002632 }
drh039fc322009-11-17 18:31:47 +00002633 default: {
2634 return 0;
2635 }
2636 }
2637}
2638
2639/*
drhc4a3c772001-04-04 11:48:57 +00002640** Return TRUE if the given string is a row-id column name.
2641*/
danielk19774adee202004-05-08 08:23:19 +00002642int sqlite3IsRowid(const char *z){
2643 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2644 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2645 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002646 return 0;
2647}
2648
danielk19779a96b662007-11-29 17:05:18 +00002649/*
drh69c355b2016-03-09 15:34:51 +00002650** pX is the RHS of an IN operator. If pX is a SELECT statement
2651** that can be simplified to a direct table access, then return
2652** a pointer to the SELECT statement. If pX is not a SELECT statement,
2653** or if the SELECT statement needs to be manifested into a transient
2654** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002655*/
2656#ifndef SQLITE_OMIT_SUBQUERY
drhb6dad522021-09-24 16:14:47 +00002657static Select *isCandidateForInOpt(const Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002658 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002659 SrcList *pSrc;
2660 ExprList *pEList;
2661 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002662 int i;
drha4eeccd2021-10-07 17:43:30 +00002663 if( !ExprUseXSelect(pX) ) return 0; /* Not a subquery */
drh69c355b2016-03-09 15:34:51 +00002664 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2665 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002666 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002667 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002668 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2669 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2670 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002671 }
drh2e26a602020-01-06 18:59:46 +00002672 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002673 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002674 if( p->pWhere ) return 0; /* Has no WHERE clause */
2675 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002676 assert( pSrc!=0 );
2677 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002678 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002679 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002680 assert( pTab!=0 );
drhf38524d2021-08-02 16:41:57 +00002681 assert( !IsView(pTab) ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002682 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2683 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002684 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002685 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002686 for(i=0; i<pEList->nExpr; i++){
2687 Expr *pRes = pEList->a[i].pExpr;
2688 if( pRes->op!=TK_COLUMN ) return 0;
2689 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002690 }
drh69c355b2016-03-09 15:34:51 +00002691 return p;
drhb287f4b2008-04-25 00:08:38 +00002692}
2693#endif /* SQLITE_OMIT_SUBQUERY */
2694
danf9b2e052016-08-02 17:45:00 +00002695#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002696/*
drh4c259e92014-08-01 21:12:35 +00002697** Generate code that checks the left-most column of index table iCur to see if
2698** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002699** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2700** to be set to NULL if iCur contains one or more NULL values.
2701*/
2702static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002703 int addr1;
drh6be515e2014-08-01 21:00:53 +00002704 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002705 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002706 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2707 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002708 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002709 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002710}
danf9b2e052016-08-02 17:45:00 +00002711#endif
drh6be515e2014-08-01 21:00:53 +00002712
drhbb53ecb2014-08-02 21:03:33 +00002713
2714#ifndef SQLITE_OMIT_SUBQUERY
2715/*
2716** The argument is an IN operator with a list (not a subquery) on the
2717** right-hand side. Return TRUE if that list is constant.
2718*/
2719static int sqlite3InRhsIsConstant(Expr *pIn){
2720 Expr *pLHS;
2721 int res;
2722 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2723 pLHS = pIn->pLeft;
2724 pIn->pLeft = 0;
2725 res = sqlite3ExprIsConstant(pIn);
2726 pIn->pLeft = pLHS;
2727 return res;
2728}
2729#endif
2730
drh6be515e2014-08-01 21:00:53 +00002731/*
danielk19779a96b662007-11-29 17:05:18 +00002732** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002733** The pX parameter is the expression on the RHS of the IN operator, which
2734** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002735**
drhd4305ca2012-09-18 17:08:33 +00002736** The job of this routine is to find or create a b-tree object that can
2737** be used either to test for membership in the RHS set or to iterate through
2738** all members of the RHS set, skipping duplicates.
2739**
drh3a856252014-08-01 14:46:57 +00002740** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhb94182b2022-05-02 11:24:21 +00002741** and the *piTab parameter is set to the index of that cursor.
drhd4305ca2012-09-18 17:08:33 +00002742**
drhb74b1012009-05-28 21:04:37 +00002743** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002744**
drh1ccce442013-03-12 20:38:51 +00002745** IN_INDEX_ROWID - The cursor was opened on a database table.
2746** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2747** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2748** IN_INDEX_EPH - The cursor was opened on a specially created and
2749** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002750** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2751** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002752**
drhd4305ca2012-09-18 17:08:33 +00002753** An existing b-tree might be used if the RHS expression pX is a simple
2754** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002755**
dan553168c2016-08-01 20:14:31 +00002756** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002757**
drhd4305ca2012-09-18 17:08:33 +00002758** If the RHS of the IN operator is a list or a more complex subquery, then
2759** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002760** pX->iTable made to point to the ephemeral table instead of an
drhb94182b2022-05-02 11:24:21 +00002761** existing table. In this case, the creation and initialization of the
2762** ephmeral table might be put inside of a subroutine, the EP_Subrtn flag
2763** will be set on pX and the pX->y.sub fields will be set to show where
2764** the subroutine is coded.
drhd4305ca2012-09-18 17:08:33 +00002765**
drh7fc0ba02017-11-17 15:02:00 +00002766** The inFlags parameter must contain, at a minimum, one of the bits
2767** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2768** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2769** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2770** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002771**
2772** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2773** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002774** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002775** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2776** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002777**
drh3a856252014-08-01 14:46:57 +00002778** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2779** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002780** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2781** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002782**
drhbb53ecb2014-08-02 21:03:33 +00002783** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2784** if the RHS of the IN operator is a list (not a subquery) then this
2785** routine might decide that creating an ephemeral b-tree for membership
2786** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2787** calling routine should implement the IN operator using a sequence
2788** of Eq or Ne comparison operations.
2789**
drhb74b1012009-05-28 21:04:37 +00002790** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002791** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002792** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002793** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002794** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002795** to *prRhsHasNull. If there is no chance that the (...) contains a
2796** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002797**
drhe21a6e12014-08-01 18:00:24 +00002798** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002799** the value in that register will be NULL if the b-tree contains one or more
2800** NULL values, and it will be some non-NULL value if the b-tree contains no
2801** NULL values.
dan553168c2016-08-01 20:14:31 +00002802**
2803** If the aiMap parameter is not NULL, it must point to an array containing
2804** one element for each column returned by the SELECT statement on the RHS
2805** of the IN(...) operator. The i'th entry of the array is populated with the
2806** offset of the index column that matches the i'th column returned by the
2807** SELECT. For example, if the expression and selected index are:
2808**
2809** (?,?,?) IN (SELECT a, b, c FROM t1)
2810** CREATE INDEX i1 ON t1(b, c, a);
2811**
2812** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002813*/
danielk1977284f4ac2007-12-10 05:03:46 +00002814#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002815int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002816 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002817 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002818 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2819 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002820 int *aiMap, /* Mapping from Index fields to RHS fields */
2821 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002822){
drhb74b1012009-05-28 21:04:37 +00002823 Select *p; /* SELECT to the right of IN operator */
2824 int eType = 0; /* Type of RHS table. IN_INDEX_* */
drh3a45d302022-05-02 14:32:56 +00002825 int iTab; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002826 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002827 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002828
drh1450bc62009-10-30 13:25:56 +00002829 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002830 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drhf69dad82022-05-13 19:50:29 +00002831 iTab = pParse->nTab++;
drh1450bc62009-10-30 13:25:56 +00002832
dan7b35a772016-07-28 19:47:15 +00002833 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2834 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002835 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002836 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002837 ** set prRhsHasNull to 0 before continuing. */
drha4eeccd2021-10-07 17:43:30 +00002838 if( prRhsHasNull && ExprUseXSelect(pX) ){
dan7b35a772016-07-28 19:47:15 +00002839 int i;
2840 ExprList *pEList = pX->x.pSelect->pEList;
2841 for(i=0; i<pEList->nExpr; i++){
2842 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2843 }
2844 if( i==pEList->nExpr ){
2845 prRhsHasNull = 0;
2846 }
2847 }
2848
drhb74b1012009-05-28 21:04:37 +00002849 /* Check to see if an existing table or index can be used to
2850 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002851 ** ephemeral table. */
2852 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002853 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002854 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002855 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002856 ExprList *pEList = p->pEList;
2857 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002858
drhb07028f2011-10-14 21:49:18 +00002859 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2860 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2861 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2862 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002863
drhb22f7c82014-02-06 23:56:27 +00002864 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002865 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002866 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002867 sqlite3CodeVerifySchema(pParse, iDb);
2868 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002869
drha84a2832016-08-26 21:15:35 +00002870 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002871 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002872 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002873 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002874 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002875
2876 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2877 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002878 ExplainQueryPlan((pParse, 0,
2879 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002880 sqlite3VdbeJumpHere(v, iAddr);
2881 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002882 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002883 int affinity_ok = 1;
2884 int i;
2885
2886 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002887 ** comparison is the same as the affinity of each column in table
2888 ** on the RHS of the IN operator. If it not, it is not possible to
2889 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002890 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002891 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002892 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002893 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002894 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002895 testcase( cmpaff==SQLITE_AFF_BLOB );
2896 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002897 switch( cmpaff ){
2898 case SQLITE_AFF_BLOB:
2899 break;
2900 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002901 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2902 ** other has no affinity and the other side is TEXT. Hence,
2903 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2904 ** and for the term on the LHS of the IN to have no affinity. */
2905 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002906 break;
2907 default:
2908 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2909 }
2910 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002911
drha84a2832016-08-26 21:15:35 +00002912 if( affinity_ok ){
2913 /* Search for an existing index that will work for this IN operator */
2914 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2915 Bitmask colUsed; /* Columns of the index used */
2916 Bitmask mCol; /* Mask for the current column */
2917 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002918 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002919 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2920 ** BITMASK(nExpr) without overflowing */
2921 testcase( pIdx->nColumn==BMS-2 );
2922 testcase( pIdx->nColumn==BMS-1 );
2923 if( pIdx->nColumn>=BMS-1 ) continue;
2924 if( mustBeUnique ){
2925 if( pIdx->nKeyCol>nExpr
2926 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2927 ){
2928 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002929 }
danielk19770cdc0222008-06-26 18:04:03 +00002930 }
drha84a2832016-08-26 21:15:35 +00002931
2932 colUsed = 0; /* Columns of index used so far */
2933 for(i=0; i<nExpr; i++){
2934 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2935 Expr *pRhs = pEList->a[i].pExpr;
2936 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2937 int j;
2938
drh0c7d3d32022-01-24 16:47:12 +00002939 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
drha84a2832016-08-26 21:15:35 +00002940 for(j=0; j<nExpr; j++){
2941 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2942 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002943 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2944 continue;
2945 }
drha84a2832016-08-26 21:15:35 +00002946 break;
2947 }
2948 if( j==nExpr ) break;
2949 mCol = MASKBIT(j);
2950 if( mCol & colUsed ) break; /* Each column used only once */
2951 colUsed |= mCol;
2952 if( aiMap ) aiMap[i] = j;
2953 }
2954
2955 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2956 if( colUsed==(MASKBIT(nExpr)-1) ){
2957 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002958 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002959 ExplainQueryPlan((pParse, 0,
2960 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002961 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2962 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2963 VdbeComment((v, "%s", pIdx->zName));
2964 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2965 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2966
2967 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002968#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002969 i64 mask = (1<<nExpr)-1;
2970 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2971 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002972#endif
2973 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002974 if( nExpr==1 ){
2975 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2976 }
2977 }
2978 sqlite3VdbeJumpHere(v, iAddr);
2979 }
2980 } /* End loop over indexes */
2981 } /* End if( affinity_ok ) */
2982 } /* End if not an rowid index */
2983 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002984
drhbb53ecb2014-08-02 21:03:33 +00002985 /* If no preexisting index is available for the IN clause
2986 ** and IN_INDEX_NOOP is an allowed reply
2987 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002988 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002989 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002990 ** the IN operator so return IN_INDEX_NOOP.
2991 */
2992 if( eType==0
2993 && (inFlags & IN_INDEX_NOOP_OK)
drha4eeccd2021-10-07 17:43:30 +00002994 && ExprUseXList(pX)
drhbb53ecb2014-08-02 21:03:33 +00002995 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2996 ){
drhb94182b2022-05-02 11:24:21 +00002997 pParse->nTab--; /* Back out the allocation of the unused cursor */
2998 iTab = -1; /* Cursor is not allocated */
drhbb53ecb2014-08-02 21:03:33 +00002999 eType = IN_INDEX_NOOP;
3000 }
drhbb53ecb2014-08-02 21:03:33 +00003001
danielk19779a96b662007-11-29 17:05:18 +00003002 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00003003 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00003004 ** We will have to generate an ephemeral table to do the job.
3005 */
drh8e23daf2013-06-11 13:30:04 +00003006 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00003007 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00003008 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00003009 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00003010 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00003011 }else if( prRhsHasNull ){
3012 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00003013 }
drh85bcdce2018-12-23 21:27:29 +00003014 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00003015 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00003016 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00003017 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00003018 }
drhcf4d38a2010-07-28 02:53:36 +00003019 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00003020 }
danba00e302016-07-23 20:24:06 +00003021
3022 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
3023 int i, n;
3024 n = sqlite3ExprVectorSize(pX->pLeft);
3025 for(i=0; i<n; i++) aiMap[i] = i;
3026 }
drh2c041312018-12-24 02:34:49 +00003027 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00003028 return eType;
3029}
danielk1977284f4ac2007-12-10 05:03:46 +00003030#endif
drh626a8792005-01-17 22:08:19 +00003031
danf9b2e052016-08-02 17:45:00 +00003032#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00003033/*
3034** Argument pExpr is an (?, ?...) IN(...) expression. This
3035** function allocates and returns a nul-terminated string containing
3036** the affinities to be used for each column of the comparison.
3037**
3038** It is the responsibility of the caller to ensure that the returned
3039** string is eventually freed using sqlite3DbFree().
3040*/
drhb6dad522021-09-24 16:14:47 +00003041static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
dan71c57db2016-07-09 20:23:55 +00003042 Expr *pLeft = pExpr->pLeft;
3043 int nVal = sqlite3ExprVectorSize(pLeft);
drha4eeccd2021-10-07 17:43:30 +00003044 Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00003045 char *zRet;
3046
dan553168c2016-08-01 20:14:31 +00003047 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00003048 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00003049 if( zRet ){
3050 int i;
3051 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00003052 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00003053 char a = sqlite3ExprAffinity(pA);
3054 if( pSelect ){
3055 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
3056 }else{
3057 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00003058 }
dan71c57db2016-07-09 20:23:55 +00003059 }
3060 zRet[nVal] = '\0';
3061 }
3062 return zRet;
3063}
danf9b2e052016-08-02 17:45:00 +00003064#endif
dan71c57db2016-07-09 20:23:55 +00003065
dan8da209b2016-07-26 18:06:08 +00003066#ifndef SQLITE_OMIT_SUBQUERY
3067/*
3068** Load the Parse object passed as the first argument with an error
3069** message of the form:
3070**
3071** "sub-select returns N columns - expected M"
3072*/
3073void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00003074 if( pParse->nErr==0 ){
3075 const char *zFmt = "sub-select returns %d columns - expected %d";
3076 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
3077 }
dan8da209b2016-07-26 18:06:08 +00003078}
3079#endif
3080
drh626a8792005-01-17 22:08:19 +00003081/*
dan44c56042016-12-07 15:38:37 +00003082** Expression pExpr is a vector that has been used in a context where
3083** it is not permitted. If pExpr is a sub-select vector, this routine
3084** loads the Parse object with a message of the form:
3085**
3086** "sub-select returns N columns - expected 1"
3087**
3088** Or, if it is a regular scalar vector:
3089**
3090** "row value misused"
3091*/
3092void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
3093#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00003094 if( ExprUseXSelect(pExpr) ){
dan44c56042016-12-07 15:38:37 +00003095 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
3096 }else
3097#endif
3098 {
3099 sqlite3ErrorMsg(pParse, "row value misused");
3100 }
3101}
3102
drh85bcdce2018-12-23 21:27:29 +00003103#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00003104/*
drh85bcdce2018-12-23 21:27:29 +00003105** Generate code that will construct an ephemeral table containing all terms
3106** in the RHS of an IN operator. The IN operator can be in either of two
3107** forms:
drh626a8792005-01-17 22:08:19 +00003108**
drh9cbe6352005-11-29 03:13:21 +00003109** x IN (4,5,11) -- IN operator with list on right-hand side
3110** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00003111**
drh2c041312018-12-24 02:34:49 +00003112** The pExpr parameter is the IN operator. The cursor number for the
3113** constructed ephermeral table is returned. The first time the ephemeral
3114** table is computed, the cursor number is also stored in pExpr->iTable,
3115** however the cursor number returned might not be the same, as it might
3116** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00003117**
drh85bcdce2018-12-23 21:27:29 +00003118** If the LHS expression ("x" in the examples) is a column value, or
3119** the SELECT statement returns a column value, then the affinity of that
3120** column is used to build the index keys. If both 'x' and the
3121** SELECT... statement are columns, then numeric affinity is used
3122** if either column has NUMERIC or INTEGER affinity. If neither
3123** 'x' nor the SELECT... statement are columns, then numeric affinity
3124** is used.
drhcce7d172000-05-31 15:34:51 +00003125*/
drh85bcdce2018-12-23 21:27:29 +00003126void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00003127 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00003128 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00003129 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00003130){
drh2c041312018-12-24 02:34:49 +00003131 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00003132 int addr; /* Address of OP_OpenEphemeral instruction */
3133 Expr *pLeft; /* the LHS of the IN operator */
3134 KeyInfo *pKeyInfo = 0; /* Key information */
3135 int nVal; /* Size of vector pLeft */
3136 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00003137
drh2c041312018-12-24 02:34:49 +00003138 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003139 assert( v!=0 );
3140
drh2c041312018-12-24 02:34:49 +00003141 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00003142 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00003143 **
3144 ** * The right-hand side is a correlated subquery
3145 ** * The right-hand side is an expression list containing variables
3146 ** * We are inside a trigger
3147 **
drh2c041312018-12-24 02:34:49 +00003148 ** If all of the above are false, then we can compute the RHS just once
3149 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00003150 */
drhefb699f2018-12-24 11:55:44 +00003151 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00003152 /* Reuse of the RHS is allowed */
3153 /* If this routine has already been coded, but the previous code
3154 ** might not have been invoked yet, so invoke it now as a subroutine.
3155 */
3156 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00003157 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha4eeccd2021-10-07 17:43:30 +00003158 if( ExprUseXSelect(pExpr) ){
drhbd462bc2018-12-24 20:21:06 +00003159 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3160 pExpr->x.pSelect->selId));
3161 }
drh477572b2021-10-07 20:46:29 +00003162 assert( ExprUseYSub(pExpr) );
drh2c041312018-12-24 02:34:49 +00003163 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3164 pExpr->y.sub.iAddr);
drh086b8002022-05-13 23:01:28 +00003165 assert( iTab!=pExpr->iTable );
3166 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00003167 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00003168 return;
3169 }
3170
3171 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003172 assert( !ExprUseYWin(pExpr) );
drh2c041312018-12-24 02:34:49 +00003173 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00003174 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00003175 pExpr->y.sub.regReturn = ++pParse->nMem;
3176 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003177 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh2c041312018-12-24 02:34:49 +00003178
3179 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003180 }
3181
drh85bcdce2018-12-23 21:27:29 +00003182 /* Check to see if this is a vector IN operator */
3183 pLeft = pExpr->pLeft;
3184 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00003185
drh85bcdce2018-12-23 21:27:29 +00003186 /* Construct the ephemeral table that will contain the content of
3187 ** RHS of the IN operator.
3188 */
drh2c041312018-12-24 02:34:49 +00003189 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00003190 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00003191#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drha4eeccd2021-10-07 17:43:30 +00003192 if( ExprUseXSelect(pExpr) ){
drh2c041312018-12-24 02:34:49 +00003193 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
3194 }else{
3195 VdbeComment((v, "RHS of IN operator"));
3196 }
3197#endif
drh50ef6712019-02-22 23:29:56 +00003198 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00003199
drha4eeccd2021-10-07 17:43:30 +00003200 if( ExprUseXSelect(pExpr) ){
drh85bcdce2018-12-23 21:27:29 +00003201 /* Case 1: expr IN (SELECT ...)
3202 **
3203 ** Generate code to write the results of the select into the temporary
3204 ** table allocated and opened above.
3205 */
3206 Select *pSelect = pExpr->x.pSelect;
3207 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00003208
drh2c041312018-12-24 02:34:49 +00003209 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
3210 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00003211 ));
drh85bcdce2018-12-23 21:27:29 +00003212 /* If the LHS and RHS of the IN operator do not match, that
3213 ** error will have been caught long before we reach this point. */
3214 if( ALWAYS(pEList->nExpr==nVal) ){
drh14c4d422021-05-26 18:46:51 +00003215 Select *pCopy;
drh85bcdce2018-12-23 21:27:29 +00003216 SelectDest dest;
3217 int i;
drh14c4d422021-05-26 18:46:51 +00003218 int rc;
drhbd462bc2018-12-24 20:21:06 +00003219 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00003220 dest.zAffSdst = exprINAffinity(pParse, pExpr);
3221 pSelect->iLimit = 0;
3222 testcase( pSelect->selFlags & SF_Distinct );
3223 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
drh14c4d422021-05-26 18:46:51 +00003224 pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
3225 rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
3226 sqlite3SelectDelete(pParse->db, pCopy);
3227 sqlite3DbFree(pParse->db, dest.zAffSdst);
3228 if( rc ){
drh85bcdce2018-12-23 21:27:29 +00003229 sqlite3KeyInfoUnref(pKeyInfo);
3230 return;
drh14c4d422021-05-26 18:46:51 +00003231 }
drh85bcdce2018-12-23 21:27:29 +00003232 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
3233 assert( pEList!=0 );
3234 assert( pEList->nExpr>0 );
3235 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3236 for(i=0; i<nVal; i++){
3237 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3238 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3239 pParse, p, pEList->a[i].pExpr
3240 );
danielk197741a05b72008-10-02 13:50:55 +00003241 }
drh85bcdce2018-12-23 21:27:29 +00003242 }
3243 }else if( ALWAYS(pExpr->x.pList!=0) ){
3244 /* Case 2: expr IN (exprlist)
3245 **
3246 ** For each expression, build an index key from the evaluation and
3247 ** store it in the temporary table. If <expr> is a column, then use
3248 ** that columns affinity when building index keys. If <expr> is not
3249 ** a column, use numeric affinity.
3250 */
3251 char affinity; /* Affinity of the LHS of the IN */
3252 int i;
3253 ExprList *pList = pExpr->x.pList;
3254 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003255 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003256 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003257 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003258 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003259 }else if( affinity==SQLITE_AFF_REAL ){
3260 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003261 }
3262 if( pKeyInfo ){
3263 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3264 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003265 }
3266
drh85bcdce2018-12-23 21:27:29 +00003267 /* Loop through each expression in <exprlist>. */
3268 r1 = sqlite3GetTempReg(pParse);
3269 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003270 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3271 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003272
3273 /* If the expression is not constant then we will need to
3274 ** disable the test that was generated above that makes sure
3275 ** this code only executes once. Because for a non-constant
3276 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003277 */
drh2c041312018-12-24 02:34:49 +00003278 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
drh19025162022-03-03 15:00:44 +00003279 sqlite3VdbeChangeToNoop(v, addrOnce-1);
drh2c041312018-12-24 02:34:49 +00003280 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003281 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003282 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003283 }
drh1398ad32005-01-19 23:24:50 +00003284
drh85bcdce2018-12-23 21:27:29 +00003285 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003286 sqlite3ExprCode(pParse, pE2, r1);
3287 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3288 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003289 }
drh85bcdce2018-12-23 21:27:29 +00003290 sqlite3ReleaseTempReg(pParse, r1);
3291 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003292 }
drh85bcdce2018-12-23 21:27:29 +00003293 if( pKeyInfo ){
3294 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3295 }
drh2c041312018-12-24 02:34:49 +00003296 if( addrOnce ){
drh8b9a3d12022-09-20 19:22:17 +00003297 sqlite3VdbeAddOp1(v, OP_NullRow, iTab);
drh2c041312018-12-24 02:34:49 +00003298 sqlite3VdbeJumpHere(v, addrOnce);
3299 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003300 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003301 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3302 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003303 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3304 pExpr->y.sub.iAddr, 1);
3305 VdbeCoverage(v);
drh6d2566d2019-09-18 20:34:54 +00003306 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003307 }
3308}
3309#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003310
drh85bcdce2018-12-23 21:27:29 +00003311/*
3312** Generate code for scalar subqueries used as a subquery expression
3313** or EXISTS operator:
3314**
3315** (SELECT a FROM b) -- subquery
3316** EXISTS (SELECT a FROM b) -- EXISTS subquery
3317**
3318** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3319**
drhd86fe442019-08-26 13:45:49 +00003320** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003321** the result is stored in a contiguous array of registers and the
3322** return value is the register of the left-most result column.
3323** Return 0 if an error occurs.
3324*/
3325#ifndef SQLITE_OMIT_SUBQUERY
3326int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003327 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003328 int rReg = 0; /* Register storing resulting */
3329 Select *pSel; /* SELECT statement to encode */
3330 SelectDest dest; /* How to deal with SELECT result */
3331 int nReg; /* Registers to allocate */
3332 Expr *pLimit; /* New limit expression */
dan231ff4b2022-12-02 20:32:22 +00003333#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
danf6f01f12022-12-03 18:16:25 +00003334 int addrExplain; /* Address of OP_Explain instruction */
dan231ff4b2022-12-02 20:32:22 +00003335#endif
drh2c041312018-12-24 02:34:49 +00003336
3337 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003338 assert( v!=0 );
drh05428122021-05-24 00:17:04 +00003339 if( pParse->nErr ) return 0;
drhbd462bc2018-12-24 20:21:06 +00003340 testcase( pExpr->op==TK_EXISTS );
3341 testcase( pExpr->op==TK_SELECT );
3342 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
drha4eeccd2021-10-07 17:43:30 +00003343 assert( ExprUseXSelect(pExpr) );
drhbd462bc2018-12-24 20:21:06 +00003344 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003345
drh14c4d422021-05-26 18:46:51 +00003346 /* If this routine has already been coded, then invoke it as a
3347 ** subroutine. */
3348 if( ExprHasProperty(pExpr, EP_Subrtn) ){
3349 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh477572b2021-10-07 20:46:29 +00003350 assert( ExprUseYSub(pExpr) );
drh14c4d422021-05-26 18:46:51 +00003351 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3352 pExpr->y.sub.iAddr);
3353 return pExpr->iTable;
3354 }
3355
3356 /* Begin coding the subroutine */
drh477572b2021-10-07 20:46:29 +00003357 assert( !ExprUseYWin(pExpr) );
3358 assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
drh14c4d422021-05-26 18:46:51 +00003359 ExprSetProperty(pExpr, EP_Subrtn);
3360 pExpr->y.sub.regReturn = ++pParse->nMem;
3361 pExpr->y.sub.iAddr =
drh19025162022-03-03 15:00:44 +00003362 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
drh14c4d422021-05-26 18:46:51 +00003363
drh5198ff52018-12-24 12:09:47 +00003364 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003365 ** is encountered if any of the following is true:
3366 **
3367 ** * The right-hand side is a correlated subquery
3368 ** * The right-hand side is an expression list containing variables
3369 ** * We are inside a trigger
3370 **
3371 ** If all of the above are false, then we can run this code just once
3372 ** save the results, and reuse the same result on subsequent invocations.
3373 */
3374 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh2c041312018-12-24 02:34:49 +00003375 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003376 }
drh85bcdce2018-12-23 21:27:29 +00003377
3378 /* For a SELECT, generate code to put the values for all columns of
3379 ** the first row into an array of registers and return the index of
3380 ** the first register.
3381 **
3382 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3383 ** into a register and return that register number.
3384 **
3385 ** In both cases, the query is augmented with "LIMIT 1". Any
3386 ** preexisting limit is discarded in place of the new LIMIT 1.
3387 */
dan231ff4b2022-12-02 20:32:22 +00003388 ExplainQueryPlan2(addrExplain, (pParse, 1, "%sSCALAR SUBQUERY %d",
drhbd462bc2018-12-24 20:21:06 +00003389 addrOnce?"":"CORRELATED ", pSel->selId));
dana3d0c152022-12-05 18:19:56 +00003390 sqlite3VdbeScanStatusCounters(v, addrExplain, addrExplain, -1);
drh85bcdce2018-12-23 21:27:29 +00003391 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3392 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3393 pParse->nMem += nReg;
3394 if( pExpr->op==TK_SELECT ){
3395 dest.eDest = SRT_Mem;
3396 dest.iSdst = dest.iSDParm;
3397 dest.nSdst = nReg;
3398 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3399 VdbeComment((v, "Init subquery result"));
3400 }else{
3401 dest.eDest = SRT_Exists;
3402 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3403 VdbeComment((v, "Init EXISTS result"));
3404 }
drh85bcdce2018-12-23 21:27:29 +00003405 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003406 /* The subquery already has a limit. If the pre-existing limit is X
3407 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3408 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003409 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003410 if( pLimit ){
3411 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3412 pLimit = sqlite3PExpr(pParse, TK_NE,
3413 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3414 }
drh95530162022-07-20 20:36:26 +00003415 sqlite3ExprDeferredDelete(pParse, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003416 pSel->pLimit->pLeft = pLimit;
3417 }else{
drh7ca13472019-09-23 11:55:22 +00003418 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003419 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003420 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3421 }
3422 pSel->iLimit = 0;
3423 if( sqlite3Select(pParse, pSel, &dest) ){
drh1da88b52022-01-24 19:38:56 +00003424 pExpr->op2 = pExpr->op;
3425 pExpr->op = TK_ERROR;
drh85bcdce2018-12-23 21:27:29 +00003426 return 0;
3427 }
drh2c041312018-12-24 02:34:49 +00003428 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003429 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003430 if( addrOnce ){
3431 sqlite3VdbeJumpHere(v, addrOnce);
drh5198ff52018-12-24 12:09:47 +00003432 }
danf6f01f12022-12-03 18:16:25 +00003433 sqlite3VdbeScanStatusRange(v, addrExplain, addrExplain, -1);
drh2c041312018-12-24 02:34:49 +00003434
drh14c4d422021-05-26 18:46:51 +00003435 /* Subroutine return */
drh477572b2021-10-07 20:46:29 +00003436 assert( ExprUseYSub(pExpr) );
drh19025162022-03-03 15:00:44 +00003437 assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
3438 || pParse->nErr );
drh2bd9f442022-04-17 20:30:52 +00003439 sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
3440 pExpr->y.sub.iAddr, 1);
3441 VdbeCoverage(v);
drh14c4d422021-05-26 18:46:51 +00003442 sqlite3ClearTempRegCache(pParse);
drh1450bc62009-10-30 13:25:56 +00003443 return rReg;
drhcce7d172000-05-31 15:34:51 +00003444}
drh51522cd2005-01-20 13:36:19 +00003445#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003446
drhe3365e62009-11-12 17:52:24 +00003447#ifndef SQLITE_OMIT_SUBQUERY
3448/*
dan7b35a772016-07-28 19:47:15 +00003449** Expr pIn is an IN(...) expression. This function checks that the
3450** sub-select on the RHS of the IN() operator has the same number of
3451** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3452** a sub-query, that the LHS is a vector of size 1.
3453*/
3454int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3455 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
drha4eeccd2021-10-07 17:43:30 +00003456 if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
dan7b35a772016-07-28 19:47:15 +00003457 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3458 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3459 return 1;
3460 }
3461 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003462 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003463 return 1;
3464 }
3465 return 0;
3466}
3467#endif
3468
3469#ifndef SQLITE_OMIT_SUBQUERY
3470/*
drhe3365e62009-11-12 17:52:24 +00003471** Generate code for an IN expression.
3472**
3473** x IN (SELECT ...)
3474** x IN (value, value, ...)
3475**
drhecb87ac2016-08-25 15:46:25 +00003476** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003477** right-hand side (RHS) is an array of zero or more scalar values, or a
3478** subquery. If the RHS is a subquery, the number of result columns must
3479** match the number of columns in the vector on the LHS. If the RHS is
3480** a list of values, the LHS must be a scalar.
3481**
3482** The IN operator is true if the LHS value is contained within the RHS.
3483** The result is false if the LHS is definitely not in the RHS. The
3484** result is NULL if the presence of the LHS in the RHS cannot be
3485** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003486**
drh6be515e2014-08-01 21:00:53 +00003487** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003488** contained within the RHS. If due to NULLs we cannot determine if the LHS
3489** is contained in the RHS then jump to destIfNull. If the LHS is contained
3490** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003491**
3492** See the separate in-operator.md documentation file in the canonical
3493** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003494*/
3495static void sqlite3ExprCodeIN(
3496 Parse *pParse, /* Parsing and code generating context */
3497 Expr *pExpr, /* The IN expression */
3498 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3499 int destIfNull /* Jump here if the results are unknown due to NULLs */
3500){
3501 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003502 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003503 int rLhs; /* Register(s) holding the LHS values */
3504 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003505 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003506 int *aiMap = 0; /* Map from vector field to index column */
3507 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003508 int nVector; /* Size of vectors for this IN operator */
3509 int iDummy; /* Dummy parameter to exprCodeVector() */
3510 Expr *pLeft; /* The LHS of the IN operator */
3511 int i; /* loop counter */
3512 int destStep2; /* Where to jump when NULLs seen in step 2 */
3513 int destStep6 = 0; /* Start of code for Step 6 */
3514 int addrTruthOp; /* Address of opcode that determines the IN is true */
3515 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3516 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003517 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003518 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003519
drhe7375bf2020-03-10 19:24:38 +00003520 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003521 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003522 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003523 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003524 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3525 aiMap = (int*)sqlite3DbMallocZero(
3526 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3527 );
drhe347d3e2016-08-25 21:14:34 +00003528 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003529
danba00e302016-07-23 20:24:06 +00003530 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003531 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003532 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3533 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003534 v = pParse->pVdbe;
3535 assert( v!=0 ); /* OOM detected prior to this routine */
3536 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003537 eType = sqlite3FindInIndex(pParse, pExpr,
3538 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003539 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3540 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003541
danba00e302016-07-23 20:24:06 +00003542 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3543 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3544 );
drhecb87ac2016-08-25 15:46:25 +00003545#ifdef SQLITE_DEBUG
3546 /* Confirm that aiMap[] contains nVector integer values between 0 and
3547 ** nVector-1. */
3548 for(i=0; i<nVector; i++){
3549 int j, cnt;
3550 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3551 assert( cnt==1 );
3552 }
3553#endif
drhe3365e62009-11-12 17:52:24 +00003554
danba00e302016-07-23 20:24:06 +00003555 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3556 ** vector, then it is stored in an array of nVector registers starting
3557 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003558 **
3559 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3560 ** so that the fields are in the same order as an existing index. The
3561 ** aiMap[] array contains a mapping from the original LHS field order to
3562 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003563 **
3564 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3565 ** even if it is constant, as OP_Affinity may be used on the register
3566 ** by code generated below. */
3567 assert( pParse->okConstFactor==okConstFactor );
3568 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003569 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003570 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003571 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003572 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003573 /* LHS fields are not reordered */
3574 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003575 }else{
3576 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003577 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003578 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003579 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003580 }
danba00e302016-07-23 20:24:06 +00003581 }
drhe3365e62009-11-12 17:52:24 +00003582
drhbb53ecb2014-08-02 21:03:33 +00003583 /* If sqlite3FindInIndex() did not find or create an index that is
3584 ** suitable for evaluating the IN operator, then evaluate using a
3585 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003586 **
3587 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003588 */
drhbb53ecb2014-08-02 21:03:33 +00003589 if( eType==IN_INDEX_NOOP ){
drha4eeccd2021-10-07 17:43:30 +00003590 ExprList *pList;
3591 CollSeq *pColl;
drhec4ccdb2018-12-29 02:26:59 +00003592 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003593 int r2, regToFree;
3594 int regCkNull = 0;
3595 int ii;
drha4eeccd2021-10-07 17:43:30 +00003596 assert( ExprUseXList(pExpr) );
3597 pList = pExpr->x.pList;
3598 pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhbb53ecb2014-08-02 21:03:33 +00003599 if( destIfNull!=destIfFalse ){
3600 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003601 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003602 }
3603 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003604 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003605 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003606 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3607 }
drhf6ea97e2020-01-04 15:21:47 +00003608 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003609 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003610 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3611 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003612 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003613 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3614 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3615 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3616 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003617 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003618 }else{
drh47994882019-12-22 23:48:36 +00003619 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003620 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003621 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3622 (void*)pColl, P4_COLLSEQ);
3623 VdbeCoverageIf(v, op==OP_Ne);
3624 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003625 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003626 }
drhbb53ecb2014-08-02 21:03:33 +00003627 }
3628 if( regCkNull ){
3629 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003630 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003631 }
3632 sqlite3VdbeResolveLabel(v, labelOk);
3633 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003634 goto sqlite3ExprCodeIN_finished;
3635 }
3636
3637 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3638 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3639 ** We will then skip the binary search of the RHS.
3640 */
3641 if( destIfNull==destIfFalse ){
3642 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003643 }else{
drhec4ccdb2018-12-29 02:26:59 +00003644 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003645 }
3646 for(i=0; i<nVector; i++){
3647 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
drh1da88b52022-01-24 19:38:56 +00003648 if( pParse->nErr ) goto sqlite3ExprCodeIN_oom_error;
drhe347d3e2016-08-25 21:14:34 +00003649 if( sqlite3ExprCanBeNull(p) ){
3650 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003651 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003652 }
drhe3365e62009-11-12 17:52:24 +00003653 }
drhe347d3e2016-08-25 21:14:34 +00003654
3655 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3656 ** of the RHS using the LHS as a probe. If found, the result is
3657 ** true.
3658 */
3659 if( eType==IN_INDEX_ROWID ){
3660 /* In this case, the RHS is the ROWID of table b-tree and so we also
3661 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3662 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003663 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003664 VdbeCoverage(v);
3665 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3666 }else{
3667 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3668 if( destIfFalse==destIfNull ){
3669 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003670 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003671 rLhs, nVector); VdbeCoverage(v);
3672 goto sqlite3ExprCodeIN_finished;
3673 }
3674 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003675 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003676 rLhs, nVector); VdbeCoverage(v);
3677 }
3678
3679 /* Step 4. If the RHS is known to be non-NULL and we did not find
3680 ** an match on the search above, then the result must be FALSE.
3681 */
3682 if( rRhsHasNull && nVector==1 ){
3683 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3684 VdbeCoverage(v);
3685 }
3686
3687 /* Step 5. If we do not care about the difference between NULL and
3688 ** FALSE, then just return false.
3689 */
3690 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3691
3692 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3693 ** If any comparison is NULL, then the result is NULL. If all
3694 ** comparisons are FALSE then the final result is FALSE.
3695 **
3696 ** For a scalar LHS, it is sufficient to check just the first row
3697 ** of the RHS.
3698 */
3699 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003700 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003701 VdbeCoverage(v);
3702 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003703 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003704 }else{
3705 /* For nVector==1, combine steps 6 and 7 by immediately returning
3706 ** FALSE if the first comparison is not NULL */
3707 destNotNull = destIfFalse;
3708 }
3709 for(i=0; i<nVector; i++){
3710 Expr *p;
3711 CollSeq *pColl;
3712 int r3 = sqlite3GetTempReg(pParse);
3713 p = sqlite3VectorFieldSubexpr(pLeft, i);
3714 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003715 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003716 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3717 (void*)pColl, P4_COLLSEQ);
3718 VdbeCoverage(v);
3719 sqlite3ReleaseTempReg(pParse, r3);
3720 }
3721 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3722 if( nVector>1 ){
3723 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003724 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003725 VdbeCoverage(v);
3726
3727 /* Step 7: If we reach this point, we know that the result must
3728 ** be false. */
3729 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3730 }
3731
3732 /* Jumps here in order to return true. */
3733 sqlite3VdbeJumpHere(v, addrTruthOp);
3734
3735sqlite3ExprCodeIN_finished:
3736 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003737 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003738sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003739 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003740 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003741}
3742#endif /* SQLITE_OMIT_SUBQUERY */
3743
drh13573c72010-01-12 17:04:07 +00003744#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003745/*
3746** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003747** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003748**
3749** The z[] string will probably not be zero-terminated. But the
3750** z[n] character is guaranteed to be something that does not look
3751** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003752*/
drhb7916a72009-05-27 10:31:29 +00003753static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003754 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003755 double value;
drh9339da12010-09-30 00:50:49 +00003756 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003757 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3758 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003759 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003760 }
3761}
drh13573c72010-01-12 17:04:07 +00003762#endif
drh598f1342007-10-23 15:39:45 +00003763
3764
3765/*
drhfec19aa2004-05-19 20:41:03 +00003766** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003767** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003768**
shaneh5f1d6b62010-09-30 16:51:25 +00003769** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003770*/
drh13573c72010-01-12 17:04:07 +00003771static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3772 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003773 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003774 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003775 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003776 if( negFlag ) i = -i;
3777 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003778 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003779 int c;
3780 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003781 const char *z = pExpr->u.zToken;
3782 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003783 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003784 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003785#ifdef SQLITE_OMIT_FLOATING_POINT
drh62fc0692022-02-06 00:30:04 +00003786 sqlite3ErrorMsg(pParse, "oversized integer: %s%#T", negFlag?"-":"",pExpr);
drh13573c72010-01-12 17:04:07 +00003787#else
drh1b7ddc52014-07-23 14:52:05 +00003788#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003789 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh62fc0692022-02-06 00:30:04 +00003790 sqlite3ErrorMsg(pParse, "hex literal too big: %s%#T",
3791 negFlag?"-":"",pExpr);
drh1b7ddc52014-07-23 14:52:05 +00003792 }else
3793#endif
3794 {
drh9296c182014-07-23 13:40:49 +00003795 codeReal(v, z, negFlag, iMem);
3796 }
drh13573c72010-01-12 17:04:07 +00003797#endif
drh77320ea2016-11-30 14:47:37 +00003798 }else{
drh84d4f1a2017-09-20 10:47:10 +00003799 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003800 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003801 }
drhfec19aa2004-05-19 20:41:03 +00003802 }
3803}
3804
drh5cd79232009-05-25 11:46:29 +00003805
drh1f9ca2c2015-08-25 16:57:52 +00003806/* Generate code that will load into register regOut a value that is
3807** appropriate for the iIdxCol-th column of index pIdx.
3808*/
3809void sqlite3ExprCodeLoadIndexColumn(
3810 Parse *pParse, /* The parsing context */
3811 Index *pIdx, /* The index whose column is to be loaded */
3812 int iTabCur, /* Cursor pointing to a table row */
3813 int iIdxCol, /* The column of the index to be loaded */
3814 int regOut /* Store the index column value in this register */
3815){
3816 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003817 if( iTabCol==XN_EXPR ){
3818 assert( pIdx->aColExpr );
3819 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003820 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003821 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003822 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003823 }else{
drh6df9c4b2019-10-18 12:52:08 +00003824 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003825 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003826 }
drh1f9ca2c2015-08-25 16:57:52 +00003827}
3828
drhe70fa7f2019-10-22 21:01:34 +00003829#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3830/*
3831** Generate code that will compute the value of generated column pCol
3832** and store the result in register regOut
3833*/
3834void sqlite3ExprCodeGeneratedColumn(
drh79cf2b72021-07-31 20:30:41 +00003835 Parse *pParse, /* Parsing context */
3836 Table *pTab, /* Table containing the generated column */
3837 Column *pCol, /* The generated column */
3838 int regOut /* Put the result in this register */
drhe70fa7f2019-10-22 21:01:34 +00003839){
drh4dad7ed2019-12-16 16:52:22 +00003840 int iAddr;
3841 Vdbe *v = pParse->pVdbe;
3842 assert( v!=0 );
3843 assert( pParse->iSelfTab!=0 );
3844 if( pParse->iSelfTab>0 ){
3845 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3846 }else{
3847 iAddr = 0;
3848 }
drh79cf2b72021-07-31 20:30:41 +00003849 sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
drhe70fa7f2019-10-22 21:01:34 +00003850 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003851 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003852 }
drh4dad7ed2019-12-16 16:52:22 +00003853 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003854}
3855#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3856
drh5cd79232009-05-25 11:46:29 +00003857/*
drh5c092e82010-05-14 19:24:02 +00003858** Generate code to extract the value of the iCol-th column of a table.
3859*/
3860void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003861 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003862 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003863 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003864 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003865 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003866){
drhab45fc02019-10-16 22:01:56 +00003867 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003868 assert( v!=0 );
drh63b3a642022-10-20 13:36:32 +00003869 assert( pTab!=0 );
drh5c092e82010-05-14 19:24:02 +00003870 if( iCol<0 || iCol==pTab->iPKey ){
3871 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
drh088b6152022-04-18 13:57:57 +00003872 VdbeComment((v, "%s.rowid", pTab->zName));
drh5c092e82010-05-14 19:24:02 +00003873 }else{
drh81f7b372019-10-16 12:18:59 +00003874 int op;
3875 int x;
3876 if( IsVirtual(pTab) ){
3877 op = OP_VColumn;
3878 x = iCol;
3879#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003880 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003881 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003882 if( pCol->colFlags & COLFLAG_BUSY ){
drhcf9d36d2021-08-02 18:03:43 +00003883 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3884 pCol->zCnName);
drhab45fc02019-10-16 22:01:56 +00003885 }else{
3886 int savedSelfTab = pParse->iSelfTab;
3887 pCol->colFlags |= COLFLAG_BUSY;
3888 pParse->iSelfTab = iTabCur+1;
drh79cf2b72021-07-31 20:30:41 +00003889 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003890 pParse->iSelfTab = savedSelfTab;
3891 pCol->colFlags &= ~COLFLAG_BUSY;
3892 }
drh81f7b372019-10-16 12:18:59 +00003893 return;
3894#endif
3895 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003896 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003897 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003898 op = OP_Column;
3899 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003900 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003901 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003902 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003903 }
3904 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003905 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3906 }
3907}
3908
3909/*
drh945498f2007-02-24 11:52:52 +00003910** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003911** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003912**
3913** There must be an open cursor to pTab in iTable when this routine
3914** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003915*/
drhe55cbd72008-03-31 23:48:03 +00003916int sqlite3ExprCodeGetColumn(
3917 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003918 Table *pTab, /* Description of the table we are reading from */
3919 int iColumn, /* Index of the table column */
3920 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003921 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003922 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003923){
drh81f7b372019-10-16 12:18:59 +00003924 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003925 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003926 if( p5 ){
drh058e9952022-07-25 19:05:24 +00003927 VdbeOp *pOp = sqlite3VdbeGetLastOp(pParse->pVdbe);
drh99670ab2019-12-14 17:43:37 +00003928 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003929 }
drhe55cbd72008-03-31 23:48:03 +00003930 return iReg;
3931}
drhe55cbd72008-03-31 23:48:03 +00003932
3933/*
drhb21e7c72008-06-22 12:37:57 +00003934** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003935** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003936*/
drhb21e7c72008-06-22 12:37:57 +00003937void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003938 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003939}
3940
drh652fbf52008-04-01 01:42:41 +00003941/*
drh12abf402016-08-22 14:30:05 +00003942** Convert a scalar expression node to a TK_REGISTER referencing
3943** register iReg. The caller must ensure that iReg already contains
3944** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003945*/
dan069d1b12019-06-16 08:58:14 +00003946static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003947 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003948 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003949 p->op2 = p->op;
3950 p->op = TK_REGISTER;
3951 p->iTable = iReg;
3952 ExprClearProperty(p, EP_Skip);
3953}
3954
drh12abf402016-08-22 14:30:05 +00003955/*
3956** Evaluate an expression (either a vector or a scalar expression) and store
3957** the result in continguous temporary registers. Return the index of
3958** the first register used to store the result.
3959**
3960** If the returned result register is a temporary scalar, then also write
3961** that register number into *piFreeable. If the returned result register
3962** is not a temporary or if the expression is a vector set *piFreeable
3963** to 0.
3964*/
3965static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3966 int iResult;
3967 int nResult = sqlite3ExprVectorSize(p);
3968 if( nResult==1 ){
3969 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3970 }else{
3971 *piFreeable = 0;
3972 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003973#if SQLITE_OMIT_SUBQUERY
3974 iResult = 0;
3975#else
drh85bcdce2018-12-23 21:27:29 +00003976 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003977#endif
drh12abf402016-08-22 14:30:05 +00003978 }else{
3979 int i;
3980 iResult = pParse->nMem+1;
3981 pParse->nMem += nResult;
drha4eeccd2021-10-07 17:43:30 +00003982 assert( ExprUseXList(p) );
drh12abf402016-08-22 14:30:05 +00003983 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003984 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003985 }
3986 }
3987 }
3988 return iResult;
3989}
3990
drh25c42962020-01-01 13:55:08 +00003991/*
drh92a27f72020-02-04 01:41:44 +00003992** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3993** so that a subsequent copy will not be merged into this one.
3994*/
3995static void setDoNotMergeFlagOnCopy(Vdbe *v){
drh058e9952022-07-25 19:05:24 +00003996 if( sqlite3VdbeGetLastOp(v)->opcode==OP_Copy ){
drh92a27f72020-02-04 01:41:44 +00003997 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3998 }
3999}
4000
4001/*
drh25c42962020-01-01 13:55:08 +00004002** Generate code to implement special SQL functions that are implemented
4003** in-line rather than by using the usual callbacks.
4004*/
4005static int exprCodeInlineFunction(
4006 Parse *pParse, /* Parsing context */
4007 ExprList *pFarg, /* List of function arguments */
4008 int iFuncId, /* Function ID. One of the INTFUNC_... values */
4009 int target /* Store function result in this register */
4010){
4011 int nFarg;
4012 Vdbe *v = pParse->pVdbe;
4013 assert( v!=0 );
4014 assert( pFarg!=0 );
4015 nFarg = pFarg->nExpr;
4016 assert( nFarg>0 ); /* All in-line functions have at least one argument */
4017 switch( iFuncId ){
4018 case INLINEFUNC_coalesce: {
4019 /* Attempt a direct implementation of the built-in COALESCE() and
4020 ** IFNULL() functions. This avoids unnecessary evaluation of
4021 ** arguments past the first non-NULL argument.
4022 */
4023 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
4024 int i;
4025 assert( nFarg>=2 );
4026 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
4027 for(i=1; i<nFarg; i++){
4028 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
4029 VdbeCoverage(v);
4030 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
4031 }
drh92a27f72020-02-04 01:41:44 +00004032 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00004033 sqlite3VdbeResolveLabel(v, endCoalesce);
4034 break;
4035 }
drh3c0e6062020-05-13 18:03:34 +00004036 case INLINEFUNC_iif: {
4037 Expr caseExpr;
4038 memset(&caseExpr, 0, sizeof(caseExpr));
4039 caseExpr.op = TK_CASE;
4040 caseExpr.x.pList = pFarg;
4041 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
4042 }
drh6d013d82022-06-01 13:32:05 +00004043#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh645682a2022-06-01 11:05:59 +00004044 case INLINEFUNC_sqlite_offset: {
4045 Expr *pArg = pFarg->a[0].pExpr;
4046 if( pArg->op==TK_COLUMN && pArg->iTable>=0 ){
4047 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
4048 }else{
4049 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4050 }
4051 break;
4052 }
drh6d013d82022-06-01 13:32:05 +00004053#endif
drh171c50e2020-01-01 15:43:30 +00004054 default: {
drh25c42962020-01-01 13:55:08 +00004055 /* The UNLIKELY() function is a no-op. The result is the value
4056 ** of the first argument.
4057 */
drh171c50e2020-01-01 15:43:30 +00004058 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00004059 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
4060 break;
4061 }
4062
drh171c50e2020-01-01 15:43:30 +00004063 /***********************************************************************
4064 ** Test-only SQL functions that are only usable if enabled
4065 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
4066 */
drh3780f9a2021-09-17 13:07:15 +00004067#if !defined(SQLITE_UNTESTABLE)
drh171c50e2020-01-01 15:43:30 +00004068 case INLINEFUNC_expr_compare: {
4069 /* Compare two expressions using sqlite3ExprCompare() */
4070 assert( nFarg==2 );
4071 sqlite3VdbeAddOp2(v, OP_Integer,
4072 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
4073 target);
4074 break;
4075 }
4076
4077 case INLINEFUNC_expr_implies_expr: {
4078 /* Compare two expressions using sqlite3ExprImpliesExpr() */
4079 assert( nFarg==2 );
4080 sqlite3VdbeAddOp2(v, OP_Integer,
4081 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
4082 target);
4083 break;
4084 }
4085
4086 case INLINEFUNC_implies_nonnull_row: {
4087 /* REsult of sqlite3ExprImpliesNonNullRow() */
4088 Expr *pA1;
4089 assert( nFarg==2 );
4090 pA1 = pFarg->a[1].pExpr;
4091 if( pA1->op==TK_COLUMN ){
4092 sqlite3VdbeAddOp2(v, OP_Integer,
4093 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
4094 target);
4095 }else{
4096 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4097 }
4098 break;
4099 }
4100
drh25c42962020-01-01 13:55:08 +00004101 case INLINEFUNC_affinity: {
4102 /* The AFFINITY() function evaluates to a string that describes
4103 ** the type affinity of the argument. This is used for testing of
4104 ** the SQLite type logic.
4105 */
4106 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
4107 char aff;
4108 assert( nFarg==1 );
4109 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
4110 sqlite3VdbeLoadString(v, target,
4111 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
4112 break;
4113 }
drh3780f9a2021-09-17 13:07:15 +00004114#endif /* !defined(SQLITE_UNTESTABLE) */
drh25c42962020-01-01 13:55:08 +00004115 }
4116 return target;
4117}
4118
drh4bc1cc12022-10-13 21:08:34 +00004119/*
drh03af6d72022-11-21 16:40:12 +00004120** Check to see if pExpr is one of the indexed expressions on pParse->pIdxEpr.
drh4bc1cc12022-10-13 21:08:34 +00004121** If it is, then resolve the expression by reading from the index and
drhe70d4582022-10-17 14:46:39 +00004122** return the register into which the value has been read. If pExpr is
4123** not an indexed expression, then return negative.
drh4bc1cc12022-10-13 21:08:34 +00004124*/
drhe70d4582022-10-17 14:46:39 +00004125static SQLITE_NOINLINE int sqlite3IndexedExprLookup(
drh4bc1cc12022-10-13 21:08:34 +00004126 Parse *pParse, /* The parsing context */
4127 Expr *pExpr, /* The expression to potentially bypass */
4128 int target /* Where to store the result of the expression */
4129){
drhe70d4582022-10-17 14:46:39 +00004130 IndexedExpr *p;
drh7a989372022-10-15 11:27:01 +00004131 Vdbe *v;
drh03af6d72022-11-21 16:40:12 +00004132 for(p=pParse->pIdxEpr; p; p=p->pIENext){
drha331cf72022-10-18 16:47:41 +00004133 int iDataCur = p->iDataCur;
4134 if( iDataCur<0 ) continue;
4135 if( pParse->iSelfTab ){
4136 if( p->iDataCur!=pParse->iSelfTab-1 ) continue;
4137 iDataCur = -1;
4138 }
4139 if( sqlite3ExprCompare(0, pExpr, p->pExpr, iDataCur)!=0 ) continue;
drh7a989372022-10-15 11:27:01 +00004140 v = pParse->pVdbe;
4141 assert( v!=0 );
4142 if( p->bMaybeNullRow ){
4143 /* If the index is on a NULL row due to an outer join, then we
4144 ** cannot extract the value from the index. The value must be
4145 ** computed using the original expression. */
4146 int addr = sqlite3VdbeCurrentAddr(v);
4147 sqlite3VdbeAddOp3(v, OP_IfNullRow, p->iIdxCur, addr+3, target);
4148 VdbeCoverage(v);
4149 sqlite3VdbeAddOp3(v, OP_Column, p->iIdxCur, p->iIdxCol, target);
drh7a2a8ce2022-10-18 20:27:02 +00004150 VdbeComment((v, "%s expr-column %d", p->zIdxName, p->iIdxCol));
drh7a989372022-10-15 11:27:01 +00004151 sqlite3VdbeGoto(v, 0);
drh03af6d72022-11-21 16:40:12 +00004152 p = pParse->pIdxEpr;
4153 pParse->pIdxEpr = 0;
drh7a989372022-10-15 11:27:01 +00004154 sqlite3ExprCode(pParse, pExpr, target);
drh03af6d72022-11-21 16:40:12 +00004155 pParse->pIdxEpr = p;
drh7a989372022-10-15 11:27:01 +00004156 sqlite3VdbeJumpHere(v, addr+2);
4157 }else{
4158 sqlite3VdbeAddOp3(v, OP_Column, p->iIdxCur, p->iIdxCol, target);
drh7a2a8ce2022-10-18 20:27:02 +00004159 VdbeComment((v, "%s expr-column %d", p->zIdxName, p->iIdxCol));
drh7a989372022-10-15 11:27:01 +00004160 }
drh4bc1cc12022-10-13 21:08:34 +00004161 return target;
4162 }
4163 return -1; /* Not found */
4164}
4165
dan71c57db2016-07-09 20:23:55 +00004166
drha4c3c872013-09-12 17:29:25 +00004167/*
drhcce7d172000-05-31 15:34:51 +00004168** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00004169** expression. Attempt to store the results in register "target".
4170** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00004171**
drh8b213892008-08-29 02:14:02 +00004172** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00004173** be stored in target. The result might be stored in some other
4174** register if it is convenient to do so. The calling function
4175** must check the return code and move the results to the desired
4176** register.
drhcce7d172000-05-31 15:34:51 +00004177*/
drh678ccce2008-03-31 18:19:54 +00004178int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00004179 Vdbe *v = pParse->pVdbe; /* The VM under construction */
4180 int op; /* The opcode being coded */
4181 int inReg = target; /* Results stored in register inReg */
4182 int regFree1 = 0; /* If non-zero free this temporary register */
4183 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00004184 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00004185 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00004186 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00004187
drh9cbf3422008-01-17 16:22:13 +00004188 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00004189 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00004190
drha331cf72022-10-18 16:47:41 +00004191expr_code_doover:
4192 if( pExpr==0 ){
4193 op = TK_NULL;
drh03af6d72022-11-21 16:40:12 +00004194 }else if( pParse->pIdxEpr!=0
drh4bc1cc12022-10-13 21:08:34 +00004195 && !ExprHasProperty(pExpr, EP_Leaf)
drhe70d4582022-10-17 14:46:39 +00004196 && (r1 = sqlite3IndexedExprLookup(pParse, pExpr, target))>=0
drh4bc1cc12022-10-13 21:08:34 +00004197 ){
4198 return r1;
drh389a1ad2008-01-03 23:44:53 +00004199 }else{
drhe7375bf2020-03-10 19:24:38 +00004200 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00004201 op = pExpr->op;
4202 }
drhf2bc0132004-10-04 13:19:23 +00004203 switch( op ){
drh13449892005-09-07 21:22:45 +00004204 case TK_AGG_COLUMN: {
4205 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004206 struct AggInfo_col *pCol;
4207 assert( pAggInfo!=0 );
4208 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4209 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00004210 if( !pAggInfo->directMode ){
drh3c8e4382022-11-22 15:43:16 +00004211 return AggInfoColumnReg(pAggInfo, pExpr->iAgg);
drh13449892005-09-07 21:22:45 +00004212 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00004213 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00004214 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00004215 pCol->iSorterColumn, target);
drhe644f7c2022-11-24 19:02:40 +00004216 if( pTab==0 ){
4217 /* No comment added */
4218 }else if( pCol->iColumn<0 ){
drh8d5cea62020-03-11 02:04:15 +00004219 VdbeComment((v,"%s.rowid",pTab->zName));
drhe644f7c2022-11-24 19:02:40 +00004220 }else{
drhcf9d36d2021-08-02 18:03:43 +00004221 VdbeComment((v,"%s.%s",
4222 pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
drh8d5cea62020-03-11 02:04:15 +00004223 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
4224 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4225 }
drh0c76e892020-03-10 11:50:43 +00004226 }
drhc332cc32016-09-19 10:24:19 +00004227 return target;
drhb669bb52022-11-24 13:19:25 +00004228 }else if( pExpr->y.pTab==0 ){
4229 /* This case happens when the argument to an aggregate function
4230 ** is rewritten by aggregateConvertIndexedExprRefToColumn() */
4231 sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, pExpr->iColumn, target);
4232 return target;
drh13449892005-09-07 21:22:45 +00004233 }
4234 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00004235 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00004236 }
drh967e8b72000-06-21 13:59:10 +00004237 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00004238 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00004239 int iReg;
drhefad2e22018-07-27 16:57:11 +00004240 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00004241 /* This COLUMN expression is really a constant due to WHERE clause
4242 ** constraints, and that constant is coded by the pExpr->pLeft
4243 ** expresssion. However, make sure the constant has the correct
4244 ** datatype by applying the Affinity of the table column to the
4245 ** constant.
4246 */
drh57f7ece2019-11-21 18:28:44 +00004247 int aff;
drh67b9ba12019-12-20 20:45:02 +00004248 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh477572b2021-10-07 20:46:29 +00004249 assert( ExprUseYTab(pExpr) );
drh63b3a642022-10-20 13:36:32 +00004250 assert( pExpr->y.pTab!=0 );
4251 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00004252 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00004253 static const char zAff[] = "B\000C\000D\000E";
4254 assert( SQLITE_AFF_BLOB=='A' );
4255 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00004256 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4257 &zAff[(aff-'B')*2], P4_STATIC);
4258 }
4259 return iReg;
drhefad2e22018-07-27 16:57:11 +00004260 }
drhb2b9d3d2013-08-01 01:14:43 +00004261 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00004262 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00004263 /* Other columns in the same row for CHECK constraints or
4264 ** generated columns or for inserting into partial index.
4265 ** The row is unpacked into registers beginning at
4266 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
4267 ** immediately prior to the first column.
4268 */
4269 Column *pCol;
drh477572b2021-10-07 20:46:29 +00004270 Table *pTab;
drh9942ef02019-10-18 02:19:18 +00004271 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00004272 int iCol = pExpr->iColumn;
drh477572b2021-10-07 20:46:29 +00004273 assert( ExprUseYTab(pExpr) );
4274 pTab = pExpr->y.pTab;
drh9942ef02019-10-18 02:19:18 +00004275 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00004276 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00004277 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00004278 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00004279 return -1-pParse->iSelfTab;
4280 }
drhc5f808d2019-10-19 15:01:52 +00004281 pCol = pTab->aCol + iCol;
4282 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4283 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00004284#ifndef SQLITE_OMIT_GENERATED_COLUMNS
4285 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00004286 if( pCol->colFlags & COLFLAG_BUSY ){
4287 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
drhcf9d36d2021-08-02 18:03:43 +00004288 pCol->zCnName);
drh4e8e5332019-11-07 02:32:54 +00004289 return 0;
4290 }
4291 pCol->colFlags |= COLFLAG_BUSY;
4292 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
drh79cf2b72021-07-31 20:30:41 +00004293 sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
drh4e8e5332019-11-07 02:32:54 +00004294 }
4295 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00004296 return iSrc;
drh9942ef02019-10-18 02:19:18 +00004297 }else
4298#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
4299 if( pCol->affinity==SQLITE_AFF_REAL ){
4300 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00004301 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4302 return target;
4303 }else{
drh9942ef02019-10-18 02:19:18 +00004304 return iSrc;
drhbffdd632019-09-02 00:58:44 +00004305 }
drhb2b9d3d2013-08-01 01:14:43 +00004306 }else{
drh1f9ca2c2015-08-25 16:57:52 +00004307 /* Coding an expression that is part of an index where column names
4308 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00004309 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00004310 }
drh22827922000-06-06 17:27:05 +00004311 }
drh477572b2021-10-07 20:46:29 +00004312 assert( ExprUseYTab(pExpr) );
drh63b3a642022-10-20 13:36:32 +00004313 assert( pExpr->y.pTab!=0 );
drh67b9ba12019-12-20 20:45:02 +00004314 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00004315 pExpr->iColumn, iTab, target,
4316 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00004317 return iReg;
drhcce7d172000-05-31 15:34:51 +00004318 }
4319 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00004320 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00004321 return target;
drhfec19aa2004-05-19 20:41:03 +00004322 }
drh8abed7b2018-02-26 18:49:05 +00004323 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00004324 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00004325 return target;
4326 }
drh13573c72010-01-12 17:04:07 +00004327#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004328 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004329 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4330 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004331 return target;
drh598f1342007-10-23 15:39:45 +00004332 }
drh13573c72010-01-12 17:04:07 +00004333#endif
drhfec19aa2004-05-19 20:41:03 +00004334 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004335 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004336 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004337 return target;
drhcce7d172000-05-31 15:34:51 +00004338 }
drhaac30f92019-12-14 15:01:55 +00004339 default: {
drhc29af652019-12-18 21:22:40 +00004340 /* Make NULL the default case so that if a bug causes an illegal
4341 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004342 ** sanely and not crash. But keep the assert() to bring the problem
4343 ** to the attention of the developers. */
drh05428122021-05-24 00:17:04 +00004344 assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
drh9de221d2008-01-05 06:51:30 +00004345 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004346 return target;
drhf0863fe2005-06-12 21:35:51 +00004347 }
danielk19775338a5f2005-01-20 13:03:10 +00004348#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004349 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004350 int n;
4351 const char *z;
drhca48c902008-01-18 14:08:24 +00004352 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00004353 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4354 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4355 assert( pExpr->u.zToken[1]=='\'' );
4356 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004357 n = sqlite3Strlen30(z) - 1;
4358 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004359 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4360 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004361 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004362 }
danielk19775338a5f2005-01-20 13:03:10 +00004363#endif
drh50457892003-09-06 01:10:47 +00004364 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004365 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4366 assert( pExpr->u.zToken!=0 );
4367 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004368 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4369 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004370 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004371 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004372 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004373 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004374 }
drhc332cc32016-09-19 10:24:19 +00004375 return target;
drh50457892003-09-06 01:10:47 +00004376 }
drh4e0cff62004-11-05 05:10:28 +00004377 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004378 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004379 }
drh487e2622005-06-25 18:42:14 +00004380#ifndef SQLITE_OMIT_CAST
4381 case TK_CAST: {
4382 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004383 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004384 if( inReg!=target ){
4385 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4386 inReg = target;
4387 }
drhf9751072021-10-07 13:40:29 +00004388 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh4169e432014-08-25 20:11:52 +00004389 sqlite3VdbeAddOp2(v, OP_Cast, target,
4390 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004391 return inReg;
drh487e2622005-06-25 18:42:14 +00004392 }
4393#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004394 case TK_IS:
4395 case TK_ISNOT:
4396 op = (op==TK_IS) ? TK_EQ : TK_NE;
4397 p5 = SQLITE_NULLEQ;
4398 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004399 case TK_LT:
4400 case TK_LE:
4401 case TK_GT:
4402 case TK_GE:
4403 case TK_NE:
4404 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004405 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004406 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004407 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004408 }else{
4409 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4410 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004411 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4412 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4413 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004414 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004415 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4416 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4417 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4418 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4419 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4420 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004421 if( p5==SQLITE_NULLEQ ){
4422 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4423 }else{
4424 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4425 }
dan71c57db2016-07-09 20:23:55 +00004426 testcase( regFree1==0 );
4427 testcase( regFree2==0 );
4428 }
drh6a2fe092009-09-23 02:29:36 +00004429 break;
4430 }
drhcce7d172000-05-31 15:34:51 +00004431 case TK_AND:
4432 case TK_OR:
4433 case TK_PLUS:
4434 case TK_STAR:
4435 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004436 case TK_REM:
4437 case TK_BITAND:
4438 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004439 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004440 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004441 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004442 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004443 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4444 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4445 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4446 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4447 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4448 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4449 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4450 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4451 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4452 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4453 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004454 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4455 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004456 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004457 testcase( regFree1==0 );
4458 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004459 break;
4460 }
drhcce7d172000-05-31 15:34:51 +00004461 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004462 Expr *pLeft = pExpr->pLeft;
4463 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004464 if( pLeft->op==TK_INTEGER ){
4465 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004466 return target;
drh13573c72010-01-12 17:04:07 +00004467#ifndef SQLITE_OMIT_FLOATING_POINT
4468 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004469 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4470 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004471 return target;
drh13573c72010-01-12 17:04:07 +00004472#endif
drh3c84ddf2008-01-09 02:15:38 +00004473 }else{
drh10d1edf2013-11-15 15:52:39 +00004474 tempX.op = TK_INTEGER;
4475 tempX.flags = EP_IntValue|EP_TokenOnly;
4476 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004477 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004478 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004479 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004480 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004481 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004482 }
drh3c84ddf2008-01-09 02:15:38 +00004483 break;
drh6e142f52000-06-08 13:36:40 +00004484 }
drhbf4133c2001-10-13 02:59:08 +00004485 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004486 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004487 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4488 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004489 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4490 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004491 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004492 break;
4493 }
drh8abed7b2018-02-26 18:49:05 +00004494 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004495 int isTrue; /* IS TRUE or IS NOT TRUE */
4496 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004497 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4498 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004499 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4500 bNormal = pExpr->op2==TK_IS;
4501 testcase( isTrue && bNormal);
4502 testcase( !isTrue && bNormal);
4503 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004504 break;
4505 }
drhcce7d172000-05-31 15:34:51 +00004506 case TK_ISNULL:
4507 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004508 int addr;
drh7d176102014-02-18 03:07:12 +00004509 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4510 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004511 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004512 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004513 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004514 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004515 VdbeCoverageIf(v, op==TK_ISNULL);
4516 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004517 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004518 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004519 break;
drhcce7d172000-05-31 15:34:51 +00004520 }
drh22827922000-06-06 17:27:05 +00004521 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004522 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004523 if( pInfo==0
4524 || NEVER(pExpr->iAgg<0)
4525 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4526 ){
drh33e619f2009-05-28 01:00:55 +00004527 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh62fc0692022-02-06 00:30:04 +00004528 sqlite3ErrorMsg(pParse, "misuse of aggregate: %#T()", pExpr);
drh7e56e712005-11-16 12:53:15 +00004529 }else{
drh3c8e4382022-11-22 15:43:16 +00004530 return AggInfoFuncReg(pInfo, pExpr->iAgg);
drh7e56e712005-11-16 12:53:15 +00004531 }
drh22827922000-06-06 17:27:05 +00004532 break;
4533 }
drhcce7d172000-05-31 15:34:51 +00004534 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004535 ExprList *pFarg; /* List of function arguments */
4536 int nFarg; /* Number of function arguments */
4537 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004538 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004539 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004540 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004541 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004542 u8 enc = ENC(db); /* The text encoding used by this database */
4543 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004544
dan67a9b8e2018-06-22 20:51:35 +00004545#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004546 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4547 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004548 }
dan67a9b8e2018-06-22 20:51:35 +00004549#endif
dan86fb6e12018-05-16 20:58:07 +00004550
drh1e9b53f2017-01-04 01:07:24 +00004551 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004552 /* SQL functions can be expensive. So try to avoid running them
4553 ** multiple times if we know they always give the same result */
4554 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004555 }
drhe7375bf2020-03-10 19:24:38 +00004556 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
drha4eeccd2021-10-07 17:43:30 +00004557 assert( ExprUseXList(pExpr) );
drhe7375bf2020-03-10 19:24:38 +00004558 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004559 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004560 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4561 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004562 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004563#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4564 if( pDef==0 && pParse->explain ){
4565 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4566 }
4567#endif
danb6e9f7a2018-05-19 14:15:29 +00004568 if( pDef==0 || pDef->xFinalize!=0 ){
drh62fc0692022-02-06 00:30:04 +00004569 sqlite3ErrorMsg(pParse, "unknown function: %#T()", pExpr);
drhfeb306f2009-08-18 16:05:46 +00004570 break;
4571 }
drh25c42962020-01-01 13:55:08 +00004572 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004573 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4574 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004575 return exprCodeInlineFunction(pParse, pFarg,
4576 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004577 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4578 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004579 }
4580
drhd1a01ed2013-11-21 16:08:52 +00004581 for(i=0; i<nFarg; i++){
4582 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004583 testcase( i==31 );
4584 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004585 }
4586 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4587 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4588 }
4589 }
drh12ffee82009-04-08 13:51:51 +00004590 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004591 if( constMask ){
4592 r1 = pParse->nMem+1;
4593 pParse->nMem += nFarg;
4594 }else{
4595 r1 = sqlite3GetTempRange(pParse, nFarg);
4596 }
drha748fdc2012-03-28 01:34:47 +00004597
4598 /* For length() and typeof() functions with a column argument,
4599 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4600 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4601 ** loading.
4602 */
drhd36e1042013-09-06 13:10:12 +00004603 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004604 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004605 assert( nFarg==1 );
4606 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004607 exprOp = pFarg->a[0].pExpr->op;
4608 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004609 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4610 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004611 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4612 pFarg->a[0].pExpr->op2 =
4613 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004614 }
4615 }
4616
drh5579d592015-08-26 14:01:41 +00004617 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004618 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004619 }else{
drh12ffee82009-04-08 13:51:51 +00004620 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004621 }
drhb7f6f682006-07-08 17:06:43 +00004622#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004623 /* Possibly overload the function if the first argument is
4624 ** a virtual table column.
4625 **
4626 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4627 ** second argument, not the first, as the argument to test to
4628 ** see if it is a column in a virtual table. This is done because
4629 ** the left operand of infix functions (the operand we want to
4630 ** control overloading) ends up as the second argument to the
4631 ** function. The expression "A glob B" is equivalent to
4632 ** "glob(B,A). We want to use the A in "A glob B" to test
4633 ** for function overloading. But we use the B term in "glob(B,A)".
4634 */
drh59155062018-05-26 18:03:48 +00004635 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004636 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4637 }else if( nFarg>0 ){
4638 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004639 }
4640#endif
drhd36e1042013-09-06 13:10:12 +00004641 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004642 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004643 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004644 }
drh645682a2022-06-01 11:05:59 +00004645 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
4646 pDef, pExpr->op2);
drh13d79502019-12-23 02:18:49 +00004647 if( nFarg ){
4648 if( constMask==0 ){
4649 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4650 }else{
drh3aef2fb2020-01-02 17:46:02 +00004651 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004652 }
drh2dcef112008-01-12 19:03:48 +00004653 }
drhc332cc32016-09-19 10:24:19 +00004654 return target;
drhcce7d172000-05-31 15:34:51 +00004655 }
drhfe2093d2005-01-20 22:48:47 +00004656#ifndef SQLITE_OMIT_SUBQUERY
4657 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004658 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004659 int nCol;
drhc5499be2008-04-01 15:06:33 +00004660 testcase( op==TK_EXISTS );
4661 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004662 if( pParse->db->mallocFailed ){
4663 return 0;
drha4eeccd2021-10-07 17:43:30 +00004664 }else if( op==TK_SELECT
4665 && ALWAYS( ExprUseXSelect(pExpr) )
4666 && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4667 ){
dan8da209b2016-07-26 18:06:08 +00004668 sqlite3SubselectError(pParse, nCol, 1);
4669 }else{
drh85bcdce2018-12-23 21:27:29 +00004670 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004671 }
drh19a775c2000-06-05 18:54:46 +00004672 break;
4673 }
drhfc7f27b2016-08-20 00:07:01 +00004674 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004675 int n;
drh2c31c002022-04-14 16:34:07 +00004676 Expr *pLeft = pExpr->pLeft;
4677 if( pLeft->iTable==0 || pParse->withinRJSubrtn > pLeft->op2 ){
4678 pLeft->iTable = sqlite3CodeSubselect(pParse, pLeft);
4679 pLeft->op2 = pParse->withinRJSubrtn;
drhfc7f27b2016-08-20 00:07:01 +00004680 }
drh2c31c002022-04-14 16:34:07 +00004681 assert( pLeft->op==TK_SELECT || pLeft->op==TK_ERROR );
4682 n = sqlite3ExprVectorSize(pLeft);
drh10f08272021-07-05 01:11:26 +00004683 if( pExpr->iTable!=n ){
drh966e2912017-01-03 02:58:01 +00004684 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4685 pExpr->iTable, n);
4686 }
drh2c31c002022-04-14 16:34:07 +00004687 return pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004688 }
drhfef52082000-06-06 01:50:43 +00004689 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004690 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4691 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004692 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4693 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4694 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4695 sqlite3VdbeResolveLabel(v, destIfFalse);
4696 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4697 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004698 return target;
drhfef52082000-06-06 01:50:43 +00004699 }
drhe3365e62009-11-12 17:52:24 +00004700#endif /* SQLITE_OMIT_SUBQUERY */
4701
4702
drh2dcef112008-01-12 19:03:48 +00004703 /*
4704 ** x BETWEEN y AND z
4705 **
4706 ** This is equivalent to
4707 **
4708 ** x>=y AND x<=z
4709 **
4710 ** X is stored in pExpr->pLeft.
4711 ** Y is stored in pExpr->pList->a[0].pExpr.
4712 ** Z is stored in pExpr->pList->a[1].pExpr.
4713 */
drhfef52082000-06-06 01:50:43 +00004714 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004715 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004716 return target;
drhfef52082000-06-06 01:50:43 +00004717 }
drh8878f8a2022-06-09 16:19:01 +00004718 case TK_COLLATE: {
4719 if( !ExprHasProperty(pExpr, EP_Collate)
4720 && ALWAYS(pExpr->pLeft)
4721 && pExpr->pLeft->op==TK_FUNCTION
4722 ){
4723 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
4724 if( inReg!=target ){
4725 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4726 inReg = target;
4727 }
4728 sqlite3VdbeAddOp1(v, OP_ClrSubtype, inReg);
4729 return inReg;
4730 }else{
4731 pExpr = pExpr->pLeft;
4732 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. */
4733 }
4734 }
drh94fa9c42016-02-27 21:16:04 +00004735 case TK_SPAN:
drh4f07e5f2007-05-14 11:34:46 +00004736 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004737 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004738 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004739 }
drh2dcef112008-01-12 19:03:48 +00004740
dan165921a2009-08-28 18:53:45 +00004741 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004742 /* If the opcode is TK_TRIGGER, then the expression is a reference
4743 ** to a column in the new.* or old.* pseudo-tables available to
4744 ** trigger programs. In this case Expr.iTable is set to 1 for the
4745 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4746 ** is set to the column of the pseudo-table to read, or to -1 to
4747 ** read the rowid field.
4748 **
4749 ** The expression is implemented using an OP_Param opcode. The p1
4750 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4751 ** to reference another column of the old.* pseudo-table, where
4752 ** i is the index of the column. For a new.rowid reference, p1 is
4753 ** set to (n+1), where n is the number of columns in each pseudo-table.
4754 ** For a reference to any other column in the new.* pseudo-table, p1
4755 ** is set to (n+2+i), where n and i are as defined previously. For
4756 ** example, if the table on which triggers are being fired is
4757 ** declared as:
4758 **
4759 ** CREATE TABLE t1(a, b);
4760 **
4761 ** Then p1 is interpreted as follows:
4762 **
4763 ** p1==0 -> old.rowid p1==3 -> new.rowid
4764 ** p1==1 -> old.a p1==4 -> new.a
4765 ** p1==2 -> old.b p1==5 -> new.b
4766 */
drh477572b2021-10-07 20:46:29 +00004767 Table *pTab;
4768 int iCol;
4769 int p1;
4770
4771 assert( ExprUseYTab(pExpr) );
4772 pTab = pExpr->y.pTab;
4773 iCol = pExpr->iColumn;
4774 p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004775 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004776
4777 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004778 assert( iCol>=-1 && iCol<pTab->nCol );
4779 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004780 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4781
4782 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004783 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004784 (pExpr->iTable ? "new" : "old"),
drhcf9d36d2021-08-02 18:03:43 +00004785 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
dan165921a2009-08-28 18:53:45 +00004786 ));
dan65a7cd12009-09-01 12:16:01 +00004787
drh44dbca82010-01-13 04:22:20 +00004788#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004789 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004790 ** integer. Use OP_RealAffinity to make sure it is really real.
4791 **
4792 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4793 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004794 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004795 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4796 }
drh44dbca82010-01-13 04:22:20 +00004797#endif
dan165921a2009-08-28 18:53:45 +00004798 break;
4799 }
4800
dan71c57db2016-07-09 20:23:55 +00004801 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004802 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004803 break;
4804 }
4805
drh9e9a67a2019-08-17 17:07:15 +00004806 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4807 ** that derive from the right-hand table of a LEFT JOIN. The
4808 ** Expr.iTable value is the table number for the right-hand table.
4809 ** The expression is only evaluated if that table is not currently
4810 ** on a LEFT JOIN NULL row.
4811 */
drh31d6fd52017-04-14 19:03:10 +00004812 case TK_IF_NULL_ROW: {
4813 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004814 u8 okConstFactor = pParse->okConstFactor;
drhee373022022-07-25 15:54:23 +00004815 AggInfo *pAggInfo = pExpr->pAggInfo;
4816 if( pAggInfo ){
4817 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4818 if( !pAggInfo->directMode ){
drh3c8e4382022-11-22 15:43:16 +00004819 inReg = AggInfoColumnReg(pAggInfo, pExpr->iAgg);
drhee373022022-07-25 15:54:23 +00004820 break;
4821 }
4822 if( pExpr->pAggInfo->useSortingIdx ){
4823 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4824 pAggInfo->aCol[pExpr->iAgg].iSorterColumn,
4825 target);
4826 inReg = target;
4827 break;
4828 }
drh6b6d6c62022-07-25 14:05:11 +00004829 }
drh31d6fd52017-04-14 19:03:10 +00004830 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004831 /* Temporarily disable factoring of constant expressions, since
4832 ** even though expressions may appear to be constant, they are not
4833 ** really constant because they originate from the right-hand side
4834 ** of a LEFT JOIN. */
4835 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004836 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004837 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004838 sqlite3VdbeJumpHere(v, addrINR);
4839 sqlite3VdbeChangeP3(v, addrINR, inReg);
4840 break;
4841 }
4842
drh2dcef112008-01-12 19:03:48 +00004843 /*
4844 ** Form A:
4845 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4846 **
4847 ** Form B:
4848 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4849 **
4850 ** Form A is can be transformed into the equivalent form B as follows:
4851 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4852 ** WHEN x=eN THEN rN ELSE y END
4853 **
4854 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004855 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4856 ** odd. The Y is also optional. If the number of elements in x.pList
4857 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004858 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4859 **
4860 ** The result of the expression is the Ri for the first matching Ei,
4861 ** or if there is no matching Ei, the ELSE term Y, or if there is
4862 ** no ELSE term, NULL.
4863 */
drhaac30f92019-12-14 15:01:55 +00004864 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004865 int endLabel; /* GOTO label for end of CASE stmt */
4866 int nextCase; /* GOTO label for next WHEN clause */
4867 int nExpr; /* 2x number of WHEN terms */
4868 int i; /* Loop counter */
4869 ExprList *pEList; /* List of WHEN terms */
4870 struct ExprList_item *aListelem; /* Array of WHEN terms */
4871 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004872 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004873 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004874 Expr *pDel = 0;
4875 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004876
drha4eeccd2021-10-07 17:43:30 +00004877 assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00004878 assert(pExpr->x.pList->nExpr > 0);
4879 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004880 aListelem = pEList->a;
4881 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004882 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004883 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004884 pDel = sqlite3ExprDup(db, pX, 0);
4885 if( db->mallocFailed ){
4886 sqlite3ExprDelete(db, pDel);
4887 break;
4888 }
drh33cd4902009-05-30 20:49:20 +00004889 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004890 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004891 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004892 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004893 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004894 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004895 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004896 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4897 ** The value in regFree1 might get SCopy-ed into the file result.
4898 ** So make sure that the regFree1 register is not reused for other
4899 ** purposes and possibly overwritten. */
4900 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004901 }
drhc5cd1242013-09-12 16:50:49 +00004902 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004903 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004904 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004905 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004906 }else{
drh2dcef112008-01-12 19:03:48 +00004907 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004908 }
drhec4ccdb2018-12-29 02:26:59 +00004909 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004910 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004911 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004912 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004913 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004914 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004915 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004916 }
drhc5cd1242013-09-12 16:50:49 +00004917 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004918 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004919 }else{
drh9de221d2008-01-05 06:51:30 +00004920 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004921 }
dan8b65e592019-07-17 14:34:17 +00004922 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004923 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004924 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004925 break;
4926 }
danielk19775338a5f2005-01-20 13:03:10 +00004927#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004928 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004929 assert( pExpr->affExpr==OE_Rollback
4930 || pExpr->affExpr==OE_Abort
4931 || pExpr->affExpr==OE_Fail
4932 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004933 );
drh9e5fdc42020-05-08 19:02:21 +00004934 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004935 sqlite3ErrorMsg(pParse,
4936 "RAISE() may only be used within a trigger-program");
4937 return 0;
4938 }
drh11949042019-08-05 18:01:42 +00004939 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004940 sqlite3MayAbort(pParse);
4941 }
dan165921a2009-08-28 18:53:45 +00004942 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004943 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004944 sqlite3VdbeAddOp4(
4945 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004946 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004947 }else{
drh9e5fdc42020-05-08 19:02:21 +00004948 sqlite3HaltConstraint(pParse,
4949 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4950 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004951 }
4952
drhffe07b22005-11-03 00:41:17 +00004953 break;
drh17a7f8d2002-03-24 13:13:27 +00004954 }
danielk19775338a5f2005-01-20 13:03:10 +00004955#endif
drhffe07b22005-11-03 00:41:17 +00004956 }
drh2dcef112008-01-12 19:03:48 +00004957 sqlite3ReleaseTempReg(pParse, regFree1);
4958 sqlite3ReleaseTempReg(pParse, regFree2);
4959 return inReg;
4960}
4961
4962/*
drh9b258c52020-03-11 19:41:49 +00004963** Generate code that will evaluate expression pExpr just one time
4964** per prepared statement execution.
4965**
4966** If the expression uses functions (that might throw an exception) then
4967** guard them with an OP_Once opcode to ensure that the code is only executed
4968** once. If no functions are involved, then factor the code out and put it at
4969** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004970**
drhad879ff2017-01-04 04:10:02 +00004971** If regDest>=0 then the result is always stored in that register and the
4972** result is not reusable. If regDest<0 then this routine is free to
4973** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004974** is stored is returned. When regDest<0, two identical expressions might
4975** code to the same register, if they do not contain function calls and hence
4976** are factored out into the initialization section at the end of the
4977** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004978*/
drh9b258c52020-03-11 19:41:49 +00004979int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004980 Parse *pParse, /* Parsing context */
4981 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004982 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004983){
drhd1a01ed2013-11-21 16:08:52 +00004984 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004985 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004986 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004987 if( regDest<0 && p ){
4988 struct ExprList_item *pItem;
4989 int i;
4990 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
drhd88fd532022-05-02 20:49:30 +00004991 if( pItem->fg.reusable
4992 && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0
4993 ){
drhad879ff2017-01-04 04:10:02 +00004994 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004995 }
4996 }
drh1e9b53f2017-01-04 01:07:24 +00004997 }
drhd1a01ed2013-11-21 16:08:52 +00004998 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004999 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
5000 Vdbe *v = pParse->pVdbe;
5001 int addr;
5002 assert( v );
5003 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
5004 pParse->okConstFactor = 0;
5005 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00005006 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00005007 sqlite3ExprCode(pParse, pExpr, regDest);
5008 }
5009 pParse->okConstFactor = 1;
5010 sqlite3ExprDelete(pParse->db, pExpr);
5011 sqlite3VdbeJumpHere(v, addr);
5012 }else{
5013 p = sqlite3ExprListAppend(pParse, p, pExpr);
5014 if( p ){
5015 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhd88fd532022-05-02 20:49:30 +00005016 pItem->fg.reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00005017 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00005018 pItem->u.iConstExprReg = regDest;
5019 }
5020 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00005021 }
drh1e9b53f2017-01-04 01:07:24 +00005022 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00005023}
5024
5025/*
drh2dcef112008-01-12 19:03:48 +00005026** Generate code to evaluate an expression and store the results
5027** into a register. Return the register number where the results
5028** are stored.
5029**
5030** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00005031** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00005032** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00005033**
5034** If pExpr is a constant, then this routine might generate this
5035** code to fill the register in the initialization section of the
5036** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00005037*/
5038int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00005039 int r2;
drh0d950af2019-08-22 16:38:42 +00005040 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00005041 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00005042 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00005043 && pExpr->op!=TK_REGISTER
5044 && sqlite3ExprIsConstantNotJoin(pExpr)
5045 ){
drhf30a9692013-11-15 01:10:18 +00005046 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00005047 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00005048 }else{
drhf30a9692013-11-15 01:10:18 +00005049 int r1 = sqlite3GetTempReg(pParse);
5050 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
5051 if( r2==r1 ){
5052 *pReg = r1;
5053 }else{
5054 sqlite3ReleaseTempReg(pParse, r1);
5055 *pReg = 0;
5056 }
drh2dcef112008-01-12 19:03:48 +00005057 }
5058 return r2;
5059}
5060
5061/*
5062** Generate code that will evaluate expression pExpr and store the
5063** results in register target. The results are guaranteed to appear
5064** in register target.
5065*/
drh05a86c52014-02-16 01:55:49 +00005066void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00005067 int inReg;
5068
drhe7375bf2020-03-10 19:24:38 +00005069 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00005070 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00005071 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00005072 if( pParse->pVdbe==0 ) return;
5073 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
5074 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00005075 u8 op;
drh952f35b2021-10-02 17:46:24 +00005076 if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
drh629b88c2020-01-02 02:50:45 +00005077 op = OP_Copy;
5078 }else{
5079 op = OP_SCopy;
5080 }
5081 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00005082 }
drhcce7d172000-05-31 15:34:51 +00005083}
5084
5085/*
drh1c75c9d2015-12-21 15:22:13 +00005086** Make a transient copy of expression pExpr and then code it using
5087** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
5088** except that the input expression is guaranteed to be unchanged.
5089*/
5090void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
5091 sqlite3 *db = pParse->db;
5092 pExpr = sqlite3ExprDup(db, pExpr, 0);
5093 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
5094 sqlite3ExprDelete(db, pExpr);
5095}
5096
5097/*
drh05a86c52014-02-16 01:55:49 +00005098** Generate code that will evaluate expression pExpr and store the
5099** results in register target. The results are guaranteed to appear
5100** in register target. If the expression is constant, then this routine
5101** might choose to code the expression at initialization time.
5102*/
5103void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00005104 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00005105 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00005106 }else{
drh088489e2020-03-10 02:57:37 +00005107 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00005108 }
drhcce7d172000-05-31 15:34:51 +00005109}
5110
5111/*
drh268380c2004-02-25 13:47:31 +00005112** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00005113** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00005114**
drh3df6c3b2017-09-15 15:38:01 +00005115** Return the number of elements evaluated. The number returned will
5116** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
5117** is defined.
drhd1a01ed2013-11-21 16:08:52 +00005118**
5119** The SQLITE_ECEL_DUP flag prevents the arguments from being
5120** filled using OP_SCopy. OP_Copy must be used instead.
5121**
5122** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
5123** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00005124**
5125** The SQLITE_ECEL_REF flag means that expressions in the list with
5126** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
5127** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00005128** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
5129** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00005130*/
danielk19774adee202004-05-08 08:23:19 +00005131int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00005132 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00005133 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00005134 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00005135 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00005136 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00005137){
5138 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00005139 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00005140 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00005141 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00005142 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00005143 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00005144 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00005145 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00005146 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00005147 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00005148 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00005149#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00005150 if( pItem->fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00005151 i--;
5152 n--;
5153 }else
5154#endif
dan257c13f2016-11-10 20:14:06 +00005155 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
5156 if( flags & SQLITE_ECEL_OMITREF ){
5157 i--;
5158 n--;
5159 }else{
5160 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
5161 }
drhb8b06692018-08-04 15:16:20 +00005162 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
5163 && sqlite3ExprIsConstantNotJoin(pExpr)
5164 ){
drh9b258c52020-03-11 19:41:49 +00005165 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00005166 }else{
5167 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
5168 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00005169 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00005170 if( copyOp==OP_Copy
drh058e9952022-07-25 19:05:24 +00005171 && (pOp=sqlite3VdbeGetLastOp(v))->opcode==OP_Copy
drh4eded602013-12-20 15:59:20 +00005172 && pOp->p1+pOp->p3+1==inReg
5173 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00005174 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00005175 ){
5176 pOp->p3++;
5177 }else{
5178 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
5179 }
drhd1a01ed2013-11-21 16:08:52 +00005180 }
drhd1766112008-09-17 00:13:12 +00005181 }
drh268380c2004-02-25 13:47:31 +00005182 }
drhf9b596e2004-05-26 16:54:42 +00005183 return n;
drh268380c2004-02-25 13:47:31 +00005184}
5185
5186/*
drh36c563a2009-11-12 13:32:22 +00005187** Generate code for a BETWEEN operator.
5188**
5189** x BETWEEN y AND z
5190**
5191** The above is equivalent to
5192**
5193** x>=y AND x<=z
5194**
5195** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00005196** elimination of x.
drh84b19a32016-08-20 22:49:28 +00005197**
5198** The xJumpIf parameter determines details:
5199**
5200** NULL: Store the boolean result in reg[dest]
5201** sqlite3ExprIfTrue: Jump to dest if true
5202** sqlite3ExprIfFalse: Jump to dest if false
5203**
5204** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00005205*/
5206static void exprCodeBetween(
5207 Parse *pParse, /* Parsing and code generating context */
5208 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00005209 int dest, /* Jump destination or storage location */
5210 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00005211 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
5212){
dan8b65e592019-07-17 14:34:17 +00005213 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00005214 Expr compLeft; /* The x>=y term */
5215 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00005216 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00005217 Expr *pDel = 0;
5218 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00005219
dan71c57db2016-07-09 20:23:55 +00005220 memset(&compLeft, 0, sizeof(Expr));
5221 memset(&compRight, 0, sizeof(Expr));
5222 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00005223
drha4eeccd2021-10-07 17:43:30 +00005224 assert( ExprUseXList(pExpr) );
dan8b65e592019-07-17 14:34:17 +00005225 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
5226 if( db->mallocFailed==0 ){
5227 exprAnd.op = TK_AND;
5228 exprAnd.pLeft = &compLeft;
5229 exprAnd.pRight = &compRight;
5230 compLeft.op = TK_GE;
5231 compLeft.pLeft = pDel;
5232 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
5233 compRight.op = TK_LE;
5234 compRight.pLeft = pDel;
5235 compRight.pRight = pExpr->x.pList->a[1].pExpr;
5236 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
5237 if( xJump ){
5238 xJump(pParse, &exprAnd, dest, jumpIfNull);
5239 }else{
5240 /* Mark the expression is being from the ON or USING clause of a join
5241 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
5242 ** it into the Parse.pConstExpr list. We should use a new bit for this,
5243 ** for clarity, but we are out of bits in the Expr.flags field so we
drh67a99db2022-05-13 14:52:04 +00005244 ** have to reuse the EP_OuterON bit. Bummer. */
5245 pDel->flags |= EP_OuterON;
dan8b65e592019-07-17 14:34:17 +00005246 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
5247 }
5248 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00005249 }
dan8b65e592019-07-17 14:34:17 +00005250 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00005251
5252 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00005253 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
5254 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
5255 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
5256 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
5257 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5258 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5259 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5260 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00005261 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00005262}
5263
5264/*
drhcce7d172000-05-31 15:34:51 +00005265** Generate code for a boolean expression such that a jump is made
5266** to the label "dest" if the expression is true but execution
5267** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00005268**
5269** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00005270** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00005271**
5272** This code depends on the fact that certain token values (ex: TK_EQ)
5273** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5274** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
5275** the make process cause these values to align. Assert()s in the code
5276** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00005277*/
danielk19774adee202004-05-08 08:23:19 +00005278void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005279 Vdbe *v = pParse->pVdbe;
5280 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005281 int regFree1 = 0;
5282 int regFree2 = 0;
5283 int r1, r2;
5284
drh35573352008-01-08 23:54:25 +00005285 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005286 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005287 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00005288 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005289 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00005290 switch( op ){
drh17180fc2019-04-19 17:26:19 +00005291 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005292 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005293 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5294 if( pAlt!=pExpr ){
5295 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
5296 }else if( op==TK_AND ){
5297 int d2 = sqlite3VdbeMakeLabel(pParse);
5298 testcase( jumpIfNull==0 );
5299 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
5300 jumpIfNull^SQLITE_JUMPIFNULL);
5301 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5302 sqlite3VdbeResolveLabel(v, d2);
5303 }else{
5304 testcase( jumpIfNull==0 );
5305 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5306 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
5307 }
drhcce7d172000-05-31 15:34:51 +00005308 break;
5309 }
5310 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00005311 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005312 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005313 break;
5314 }
drh8abed7b2018-02-26 18:49:05 +00005315 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005316 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5317 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00005318 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005319 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005320 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005321 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005322 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005323 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005324 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
5325 isNot ? SQLITE_JUMPIFNULL : 0);
5326 }else{
5327 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5328 isNot ? SQLITE_JUMPIFNULL : 0);
5329 }
drh007c8432018-02-26 03:20:18 +00005330 break;
5331 }
drhde845c22016-03-17 19:07:52 +00005332 case TK_IS:
5333 case TK_ISNOT:
5334 testcase( op==TK_IS );
5335 testcase( op==TK_ISNOT );
5336 op = (op==TK_IS) ? TK_EQ : TK_NE;
5337 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005338 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005339 case TK_LT:
5340 case TK_LE:
5341 case TK_GT:
5342 case TK_GE:
5343 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00005344 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005345 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005346 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005347 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5348 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005349 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005350 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005351 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5352 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5353 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5354 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005355 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5356 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5357 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5358 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5359 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5360 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005361 testcase( regFree1==0 );
5362 testcase( regFree2==0 );
5363 break;
5364 }
drhcce7d172000-05-31 15:34:51 +00005365 case TK_ISNULL:
5366 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005367 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5368 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005369 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhe995d2c2022-10-13 12:47:33 +00005370 sqlite3VdbeTypeofColumn(v, r1);
drh2dcef112008-01-12 19:03:48 +00005371 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005372 VdbeCoverageIf(v, op==TK_ISNULL);
5373 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005374 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005375 break;
5376 }
drhfef52082000-06-06 01:50:43 +00005377 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005378 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005379 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005380 break;
5381 }
drh84e30ca2011-02-10 17:46:14 +00005382#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005383 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005384 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005385 int destIfNull = jumpIfNull ? dest : destIfFalse;
5386 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005387 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005388 sqlite3VdbeResolveLabel(v, destIfFalse);
5389 break;
5390 }
shanehbb201342011-02-09 19:55:20 +00005391#endif
drhcce7d172000-05-31 15:34:51 +00005392 default: {
dan7b35a772016-07-28 19:47:15 +00005393 default_expr:
drhad317272019-04-19 16:21:51 +00005394 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005395 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005396 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005397 /* No-op */
5398 }else{
5399 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5400 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005401 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005402 testcase( regFree1==0 );
5403 testcase( jumpIfNull==0 );
5404 }
drhcce7d172000-05-31 15:34:51 +00005405 break;
5406 }
5407 }
drh2dcef112008-01-12 19:03:48 +00005408 sqlite3ReleaseTempReg(pParse, regFree1);
5409 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005410}
5411
5412/*
drh66b89c82000-11-28 20:47:17 +00005413** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005414** to the label "dest" if the expression is false but execution
5415** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005416**
5417** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005418** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5419** is 0.
drhcce7d172000-05-31 15:34:51 +00005420*/
danielk19774adee202004-05-08 08:23:19 +00005421void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005422 Vdbe *v = pParse->pVdbe;
5423 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005424 int regFree1 = 0;
5425 int regFree2 = 0;
5426 int r1, r2;
5427
drh35573352008-01-08 23:54:25 +00005428 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005429 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005430 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005431 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005432
5433 /* The value of pExpr->op and op are related as follows:
5434 **
5435 ** pExpr->op op
5436 ** --------- ----------
5437 ** TK_ISNULL OP_NotNull
5438 ** TK_NOTNULL OP_IsNull
5439 ** TK_NE OP_Eq
5440 ** TK_EQ OP_Ne
5441 ** TK_GT OP_Le
5442 ** TK_LE OP_Gt
5443 ** TK_GE OP_Lt
5444 ** TK_LT OP_Ge
5445 **
5446 ** For other values of pExpr->op, op is undefined and unused.
5447 ** The value of TK_ and OP_ constants are arranged such that we
5448 ** can compute the mapping above using the following expression.
5449 ** Assert()s verify that the computation is correct.
5450 */
5451 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5452
5453 /* Verify correct alignment of TK_ and OP_ constants
5454 */
5455 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5456 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5457 assert( pExpr->op!=TK_NE || op==OP_Eq );
5458 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5459 assert( pExpr->op!=TK_LT || op==OP_Ge );
5460 assert( pExpr->op!=TK_LE || op==OP_Gt );
5461 assert( pExpr->op!=TK_GT || op==OP_Le );
5462 assert( pExpr->op!=TK_GE || op==OP_Lt );
5463
danba00e302016-07-23 20:24:06 +00005464 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005465 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005466 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005467 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5468 if( pAlt!=pExpr ){
5469 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5470 }else if( pExpr->op==TK_AND ){
5471 testcase( jumpIfNull==0 );
5472 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5473 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5474 }else{
5475 int d2 = sqlite3VdbeMakeLabel(pParse);
5476 testcase( jumpIfNull==0 );
5477 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5478 jumpIfNull^SQLITE_JUMPIFNULL);
5479 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5480 sqlite3VdbeResolveLabel(v, d2);
5481 }
drhcce7d172000-05-31 15:34:51 +00005482 break;
5483 }
5484 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005485 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005486 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005487 break;
5488 }
drh8abed7b2018-02-26 18:49:05 +00005489 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005490 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5491 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005492 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005493 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005494 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005495 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005496 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005497 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005498 /* IS TRUE and IS NOT FALSE */
5499 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5500 isNot ? 0 : SQLITE_JUMPIFNULL);
5501
5502 }else{
5503 /* IS FALSE and IS NOT TRUE */
5504 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005505 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005506 }
drh007c8432018-02-26 03:20:18 +00005507 break;
5508 }
drhde845c22016-03-17 19:07:52 +00005509 case TK_IS:
5510 case TK_ISNOT:
5511 testcase( pExpr->op==TK_IS );
5512 testcase( pExpr->op==TK_ISNOT );
5513 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5514 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005515 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005516 case TK_LT:
5517 case TK_LE:
5518 case TK_GT:
5519 case TK_GE:
5520 case TK_NE:
5521 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005522 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005523 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005524 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5525 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005526 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005527 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005528 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5529 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5530 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5531 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005532 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5533 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5534 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5535 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5536 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5537 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005538 testcase( regFree1==0 );
5539 testcase( regFree2==0 );
5540 break;
5541 }
drhcce7d172000-05-31 15:34:51 +00005542 case TK_ISNULL:
5543 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005544 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhe995d2c2022-10-13 12:47:33 +00005545 sqlite3VdbeTypeofColumn(v, r1);
drh2dcef112008-01-12 19:03:48 +00005546 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005547 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5548 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005549 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005550 break;
5551 }
drhfef52082000-06-06 01:50:43 +00005552 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005553 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005554 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005555 break;
5556 }
drh84e30ca2011-02-10 17:46:14 +00005557#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005558 case TK_IN: {
5559 if( jumpIfNull ){
5560 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5561 }else{
drhec4ccdb2018-12-29 02:26:59 +00005562 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005563 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5564 sqlite3VdbeResolveLabel(v, destIfNull);
5565 }
5566 break;
5567 }
shanehbb201342011-02-09 19:55:20 +00005568#endif
drhcce7d172000-05-31 15:34:51 +00005569 default: {
danba00e302016-07-23 20:24:06 +00005570 default_expr:
drhad317272019-04-19 16:21:51 +00005571 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005572 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005573 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005574 /* no-op */
5575 }else{
5576 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5577 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005578 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005579 testcase( regFree1==0 );
5580 testcase( jumpIfNull==0 );
5581 }
drhcce7d172000-05-31 15:34:51 +00005582 break;
5583 }
5584 }
drh2dcef112008-01-12 19:03:48 +00005585 sqlite3ReleaseTempReg(pParse, regFree1);
5586 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005587}
drh22827922000-06-06 17:27:05 +00005588
5589/*
drh72bc8202015-06-11 13:58:35 +00005590** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5591** code generation, and that copy is deleted after code generation. This
5592** ensures that the original pExpr is unchanged.
5593*/
5594void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5595 sqlite3 *db = pParse->db;
5596 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5597 if( db->mallocFailed==0 ){
5598 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5599 }
5600 sqlite3ExprDelete(db, pCopy);
5601}
5602
dan5aa550c2017-06-24 18:10:29 +00005603/*
5604** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5605** type of expression.
5606**
5607** If pExpr is a simple SQL value - an integer, real, string, blob
5608** or NULL value - then the VDBE currently being prepared is configured
5609** to re-prepare each time a new value is bound to variable pVar.
5610**
5611** Additionally, if pExpr is a simple SQL value and the value is the
5612** same as that currently bound to variable pVar, non-zero is returned.
5613** Otherwise, if the values are not the same or if pExpr is not a simple
5614** SQL value, zero is returned.
5615*/
drh1580d502021-09-25 17:07:57 +00005616static int exprCompareVariable(
5617 const Parse *pParse,
5618 const Expr *pVar,
5619 const Expr *pExpr
5620){
dan5aa550c2017-06-24 18:10:29 +00005621 int res = 0;
drhc0804222017-06-28 21:47:16 +00005622 int iVar;
5623 sqlite3_value *pL, *pR = 0;
5624
5625 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5626 if( pR ){
5627 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005628 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005629 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005630 if( pL ){
5631 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5632 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5633 }
5634 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005635 }
drhc0804222017-06-28 21:47:16 +00005636 sqlite3ValueFree(pR);
5637 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005638 }
5639
5640 return res;
5641}
drh72bc8202015-06-11 13:58:35 +00005642
5643/*
drh1d9da702010-01-07 15:17:02 +00005644** Do a deep comparison of two expression trees. Return 0 if the two
5645** expressions are completely identical. Return 1 if they differ only
5646** by a COLLATE operator at the top level. Return 2 if there are differences
5647** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005648**
drh619a1302013-08-01 13:04:46 +00005649** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5650** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5651**
drh66518ca2013-08-01 15:09:57 +00005652** The pA side might be using TK_REGISTER. If that is the case and pB is
5653** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5654**
drh1d9da702010-01-07 15:17:02 +00005655** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005656** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005657** identical, we return 2 just to be safe. So if this routine
5658** returns 2, then you do not really know for certain if the two
5659** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005660** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005661** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005662** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005663** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005664**
drhc0804222017-06-28 21:47:16 +00005665** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5666** pParse->pReprepare can be matched against literals in pB. The
5667** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5668** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5669** Argument pParse should normally be NULL. If it is not NULL and pA or
5670** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005671*/
drh1580d502021-09-25 17:07:57 +00005672int sqlite3ExprCompare(
5673 const Parse *pParse,
5674 const Expr *pA,
5675 const Expr *pB,
5676 int iTab
5677){
drh10d1edf2013-11-15 15:52:39 +00005678 u32 combinedFlags;
5679 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005680 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005681 }
dan5aa550c2017-06-24 18:10:29 +00005682 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5683 return 0;
5684 }
drh10d1edf2013-11-15 15:52:39 +00005685 combinedFlags = pA->flags | pB->flags;
5686 if( combinedFlags & EP_IntValue ){
5687 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5688 return 0;
5689 }
drh1d9da702010-01-07 15:17:02 +00005690 return 2;
drh22827922000-06-06 17:27:05 +00005691 }
dan16dd3982018-12-20 15:04:38 +00005692 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005693 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005694 return 1;
5695 }
dan5aa550c2017-06-24 18:10:29 +00005696 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005697 return 1;
5698 }
drhf3adb7c2022-10-15 12:01:40 +00005699 if( pA->op==TK_AGG_COLUMN && pB->op==TK_COLUMN
5700 && pB->iTable<0 && pA->iTable==iTab
5701 ){
5702 /* fall through */
5703 }else{
5704 return 2;
5705 }
drhae80dde2012-12-06 21:16:43 +00005706 }
drha51e6002021-11-19 19:11:58 +00005707 assert( !ExprHasProperty(pA, EP_IntValue) );
5708 assert( !ExprHasProperty(pB, EP_IntValue) );
5709 if( pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005710 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005711 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005712#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005713 assert( pA->op==pB->op );
5714 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5715 return 2;
5716 }
drheda079c2018-09-20 19:02:15 +00005717 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005718 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5719 return 2;
5720 }
drheda079c2018-09-20 19:02:15 +00005721 }
5722#endif
drhf20bbc52019-01-17 01:06:00 +00005723 }else if( pA->op==TK_NULL ){
5724 return 0;
drhd5af5422018-04-13 14:27:01 +00005725 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005726 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drha51e6002021-11-19 19:11:58 +00005727 }else
5728 if( pB->u.zToken!=0
5729 && pA->op!=TK_COLUMN
5730 && pA->op!=TK_AGG_COLUMN
5731 && strcmp(pA->u.zToken,pB->u.zToken)!=0
5732 ){
drhd5af5422018-04-13 14:27:01 +00005733 return 2;
drh2646da72005-12-09 20:02:05 +00005734 }
drh22827922000-06-06 17:27:05 +00005735 }
drh898c5272019-10-22 00:03:41 +00005736 if( (pA->flags & (EP_Distinct|EP_Commuted))
5737 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005738 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005739 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005740 if( (combinedFlags & EP_FixedCol)==0
5741 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005742 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005743 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005744 if( pA->op!=TK_STRING
5745 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005746 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005747 ){
drh10d1edf2013-11-15 15:52:39 +00005748 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005749 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005750 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5751 return 2;
5752 }
drh10d1edf2013-11-15 15:52:39 +00005753 }
5754 }
drh1d9da702010-01-07 15:17:02 +00005755 return 0;
drh22827922000-06-06 17:27:05 +00005756}
5757
drh8c6f6662010-04-26 19:17:26 +00005758/*
danfbb6e9f2020-01-09 20:11:29 +00005759** Compare two ExprList objects. Return 0 if they are identical, 1
5760** if they are certainly different, or 2 if it is not possible to
5761** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005762**
drh619a1302013-08-01 13:04:46 +00005763** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5764** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5765**
drh8c6f6662010-04-26 19:17:26 +00005766** This routine might return non-zero for equivalent ExprLists. The
5767** only consequence will be disabled optimizations. But this routine
5768** must never return 0 if the two ExprList objects are different, or
5769** a malfunction will result.
5770**
5771** Two NULL pointers are considered to be the same. But a NULL pointer
5772** always differs from a non-NULL pointer.
5773*/
drh1580d502021-09-25 17:07:57 +00005774int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005775 int i;
5776 if( pA==0 && pB==0 ) return 0;
5777 if( pA==0 || pB==0 ) return 1;
5778 if( pA->nExpr!=pB->nExpr ) return 1;
5779 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005780 int res;
drh8c6f6662010-04-26 19:17:26 +00005781 Expr *pExprA = pA->a[i].pExpr;
5782 Expr *pExprB = pB->a[i].pExpr;
drhd88fd532022-05-02 20:49:30 +00005783 if( pA->a[i].fg.sortFlags!=pB->a[i].fg.sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005784 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005785 }
5786 return 0;
5787}
drh13449892005-09-07 21:22:45 +00005788
drh22827922000-06-06 17:27:05 +00005789/*
drhf9463df2017-02-11 14:59:58 +00005790** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5791** are ignored.
5792*/
drh1580d502021-09-25 17:07:57 +00005793int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005794 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005795 sqlite3ExprSkipCollateAndLikely(pA),
5796 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005797 iTab);
5798}
5799
5800/*
drhc51cf862019-05-11 19:36:03 +00005801** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005802**
5803** Or if seenNot is true, return non-zero if Expr p can only be
5804** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005805*/
5806static int exprImpliesNotNull(
drh1580d502021-09-25 17:07:57 +00005807 const Parse *pParse,/* Parsing context */
5808 const Expr *p, /* The expression to be checked */
5809 const Expr *pNN, /* The expression that is NOT NULL */
drhc51cf862019-05-11 19:36:03 +00005810 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005811 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005812){
5813 assert( p );
5814 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005815 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5816 return pNN->op!=TK_NULL;
5817 }
drhc51cf862019-05-11 19:36:03 +00005818 switch( p->op ){
5819 case TK_IN: {
5820 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
drha4eeccd2021-10-07 17:43:30 +00005821 assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005822 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005823 }
5824 case TK_BETWEEN: {
drha4eeccd2021-10-07 17:43:30 +00005825 ExprList *pList;
5826 assert( ExprUseXList(p) );
5827 pList = p->x.pList;
drhc51cf862019-05-11 19:36:03 +00005828 assert( pList!=0 );
5829 assert( pList->nExpr==2 );
5830 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005831 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5832 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005833 ){
5834 return 1;
5835 }
drh7a231b42019-08-30 15:11:08 +00005836 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005837 }
5838 case TK_EQ:
5839 case TK_NE:
5840 case TK_LT:
5841 case TK_LE:
5842 case TK_GT:
5843 case TK_GE:
5844 case TK_PLUS:
5845 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005846 case TK_BITOR:
5847 case TK_LSHIFT:
5848 case TK_RSHIFT:
5849 case TK_CONCAT:
5850 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005851 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005852 case TK_STAR:
5853 case TK_REM:
5854 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005855 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005856 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005857 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005858 }
5859 case TK_SPAN:
5860 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005861 case TK_UPLUS:
5862 case TK_UMINUS: {
5863 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5864 }
5865 case TK_TRUTH: {
5866 if( seenNot ) return 0;
5867 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005868 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005869 }
dan1cd382e2019-08-29 15:06:35 +00005870 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005871 case TK_NOT: {
5872 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5873 }
5874 }
5875 return 0;
5876}
5877
5878/*
drh4bd5f732013-07-31 23:22:39 +00005879** Return true if we can prove the pE2 will always be true if pE1 is
5880** true. Return false if we cannot complete the proof or if pE2 might
5881** be false. Examples:
5882**
drh619a1302013-08-01 13:04:46 +00005883** pE1: x==5 pE2: x==5 Result: true
5884** pE1: x>0 pE2: x==5 Result: false
5885** pE1: x=21 pE2: x=21 OR y=43 Result: true
5886** pE1: x!=123 pE2: x IS NOT NULL Result: true
5887** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5888** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5889** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005890**
5891** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5892** Expr.iTable<0 then assume a table number given by iTab.
5893**
drhc0804222017-06-28 21:47:16 +00005894** If pParse is not NULL, then the values of bound variables in pE1 are
5895** compared against literal values in pE2 and pParse->pVdbe->expmask is
5896** modified to record which bound variables are referenced. If pParse
5897** is NULL, then false will be returned if pE1 contains any bound variables.
5898**
drh4bd5f732013-07-31 23:22:39 +00005899** When in doubt, return false. Returning true might give a performance
5900** improvement. Returning false might cause a performance reduction, but
5901** it will always give the correct answer and is hence always safe.
5902*/
drh1580d502021-09-25 17:07:57 +00005903int sqlite3ExprImpliesExpr(
5904 const Parse *pParse,
5905 const Expr *pE1,
5906 const Expr *pE2,
5907 int iTab
5908){
dan5aa550c2017-06-24 18:10:29 +00005909 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005910 return 1;
5911 }
5912 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005913 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5914 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005915 ){
5916 return 1;
5917 }
drh664d6d12019-05-04 17:32:07 +00005918 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005919 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005920 ){
drhc51cf862019-05-11 19:36:03 +00005921 return 1;
drh619a1302013-08-01 13:04:46 +00005922 }
5923 return 0;
drh4bd5f732013-07-31 23:22:39 +00005924}
5925
5926/*
drh6c68d752019-11-04 02:05:52 +00005927** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005928** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005929** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5930**
5931** This routine controls an optimization. False positives (setting
5932** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5933** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005934*/
5935static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005936 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005937 testcase( pExpr->op==TK_AGG_FUNCTION );
drh67a99db2022-05-13 14:52:04 +00005938 if( ExprHasProperty(pExpr, EP_OuterON) ) return WRC_Prune;
drh25897872018-03-20 21:16:15 +00005939 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005940 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005941 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005942 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005943 case TK_IS:
5944 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005945 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005946 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005947 case TK_IN:
drh25897872018-03-20 21:16:15 +00005948 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005949 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005950 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005951 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005952 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005953 testcase( pExpr->op==TK_IS );
5954 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005955 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005956 testcase( pExpr->op==TK_CASE );
5957 testcase( pExpr->op==TK_IN );
5958 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005959 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005960 return WRC_Prune;
5961 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005962 if( pWalker->u.iCur==pExpr->iTable ){
5963 pWalker->eCode = 1;
5964 return WRC_Abort;
5965 }
5966 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005967
dan9d23ea72019-08-29 19:34:29 +00005968 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005969 if( pWalker->eCode==0 ){
5970 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5971 if( pWalker->eCode ){
5972 pWalker->eCode = 0;
5973 sqlite3WalkExpr(pWalker, pExpr->pRight);
5974 }
dan9d23ea72019-08-29 19:34:29 +00005975 }
5976 return WRC_Prune;
5977
5978 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005979 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5980 assert( pWalker->eCode );
5981 return WRC_Abort;
5982 }
dan9d23ea72019-08-29 19:34:29 +00005983 return WRC_Prune;
5984
drh98811552018-04-03 14:04:48 +00005985 /* Virtual tables are allowed to use constraints like x=NULL. So
5986 ** a term of the form x=y does not prove that y is not null if x
5987 ** is the column of a virtual table */
5988 case TK_EQ:
5989 case TK_NE:
5990 case TK_LT:
5991 case TK_LE:
5992 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005993 case TK_GE: {
5994 Expr *pLeft = pExpr->pLeft;
5995 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005996 testcase( pExpr->op==TK_EQ );
5997 testcase( pExpr->op==TK_NE );
5998 testcase( pExpr->op==TK_LT );
5999 testcase( pExpr->op==TK_LE );
6000 testcase( pExpr->op==TK_GT );
6001 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00006002 /* The y.pTab=0 assignment in wherecode.c always happens after the
6003 ** impliesNotNullRow() test */
drh477572b2021-10-07 20:46:29 +00006004 assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
6005 assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
6006 if( (pLeft->op==TK_COLUMN
drh63b3a642022-10-20 13:36:32 +00006007 && ALWAYS(pLeft->y.pTab!=0)
drh477572b2021-10-07 20:46:29 +00006008 && IsVirtual(pLeft->y.pTab))
6009 || (pRight->op==TK_COLUMN
drh63b3a642022-10-20 13:36:32 +00006010 && ALWAYS(pRight->y.pTab!=0)
drh477572b2021-10-07 20:46:29 +00006011 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00006012 ){
drh78d1d222020-02-17 19:25:07 +00006013 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00006014 }
drh08b92082020-08-10 14:18:00 +00006015 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00006016 }
drh25897872018-03-20 21:16:15 +00006017 default:
6018 return WRC_Continue;
6019 }
6020}
6021
6022/*
6023** Return true (non-zero) if expression p can only be true if at least
6024** one column of table iTab is non-null. In other words, return true
6025** if expression p will always be NULL or false if every column of iTab
6026** is NULL.
6027**
drh821b6102018-03-24 18:01:51 +00006028** False negatives are acceptable. In other words, it is ok to return
6029** zero even if expression p will never be true of every column of iTab
6030** is NULL. A false negative is merely a missed optimization opportunity.
6031**
6032** False positives are not allowed, however. A false positive may result
6033** in an incorrect answer.
6034**
drh67a99db2022-05-13 14:52:04 +00006035** Terms of p that are marked with EP_OuterON (and hence that come from
drhb77c07a2022-04-11 11:59:25 +00006036** the ON or USING clauses of OUTER JOINS) are excluded from the analysis.
drh25897872018-03-20 21:16:15 +00006037**
6038** This routine is used to check if a LEFT JOIN can be converted into
6039** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
6040** clause requires that some column of the right table of the LEFT JOIN
6041** be non-NULL, then the LEFT JOIN can be safely converted into an
6042** ordinary join.
6043*/
6044int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
6045 Walker w;
drh0d950af2019-08-22 16:38:42 +00006046 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00006047 if( p==0 ) return 0;
6048 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00006049 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00006050 }else{
6051 while( p->op==TK_AND ){
6052 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
6053 p = p->pRight;
6054 }
drhd6db6592019-04-01 19:42:42 +00006055 }
drh25897872018-03-20 21:16:15 +00006056 w.xExprCallback = impliesNotNullRow;
6057 w.xSelectCallback = 0;
6058 w.xSelectCallback2 = 0;
6059 w.eCode = 0;
6060 w.u.iCur = iTab;
6061 sqlite3WalkExpr(&w, p);
6062 return w.eCode;
6063}
6064
6065/*
drh030796d2012-08-23 16:18:10 +00006066** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00006067** to determine if an expression can be evaluated by reference to the
6068** index only, without having to do a search for the corresponding
6069** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
6070** is the cursor for the table.
6071*/
6072struct IdxCover {
6073 Index *pIdx; /* The index to be tested for coverage */
6074 int iCur; /* Cursor number for the table corresponding to the index */
6075};
6076
6077/*
6078** Check to see if there are references to columns in table
6079** pWalker->u.pIdxCover->iCur can be satisfied using the index
6080** pWalker->u.pIdxCover->pIdx.
6081*/
6082static int exprIdxCover(Walker *pWalker, Expr *pExpr){
6083 if( pExpr->op==TK_COLUMN
6084 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00006085 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00006086 ){
6087 pWalker->eCode = 1;
6088 return WRC_Abort;
6089 }
6090 return WRC_Continue;
6091}
6092
6093/*
drhe604ec02016-07-27 19:20:58 +00006094** Determine if an index pIdx on table with cursor iCur contains will
6095** the expression pExpr. Return true if the index does cover the
6096** expression and false if the pExpr expression references table columns
6097** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00006098**
6099** An index covering an expression means that the expression can be
6100** evaluated using only the index and without having to lookup the
6101** corresponding table entry.
6102*/
6103int sqlite3ExprCoveredByIndex(
6104 Expr *pExpr, /* The index to be tested */
6105 int iCur, /* The cursor number for the corresponding table */
6106 Index *pIdx /* The index that might be used for coverage */
6107){
6108 Walker w;
6109 struct IdxCover xcov;
6110 memset(&w, 0, sizeof(w));
6111 xcov.iCur = iCur;
6112 xcov.pIdx = pIdx;
6113 w.xExprCallback = exprIdxCover;
6114 w.u.pIdxCover = &xcov;
6115 sqlite3WalkExpr(&w, pExpr);
6116 return !w.eCode;
6117}
6118
6119
drh90cf38b2021-11-08 23:24:00 +00006120/* Structure used to pass information throught the Walker in order to
6121** implement sqlite3ReferencesSrcList().
drh374fdce2012-04-17 16:38:53 +00006122*/
drh90cf38b2021-11-08 23:24:00 +00006123struct RefSrcList {
6124 sqlite3 *db; /* Database connection used for sqlite3DbRealloc() */
6125 SrcList *pRef; /* Looking for references to these tables */
drh913306a2021-11-26 17:10:18 +00006126 i64 nExclude; /* Number of tables to exclude from the search */
drh90cf38b2021-11-08 23:24:00 +00006127 int *aiExclude; /* Cursor IDs for tables to exclude from the search */
drh030796d2012-08-23 16:18:10 +00006128};
6129
6130/*
drh90cf38b2021-11-08 23:24:00 +00006131** Walker SELECT callbacks for sqlite3ReferencesSrcList().
6132**
6133** When entering a new subquery on the pExpr argument, add all FROM clause
6134** entries for that subquery to the exclude list.
6135**
6136** When leaving the subquery, remove those entries from the exclude list.
daned41a962020-06-09 17:45:48 +00006137*/
drh90cf38b2021-11-08 23:24:00 +00006138static int selectRefEnter(Walker *pWalker, Select *pSelect){
6139 struct RefSrcList *p = pWalker->u.pRefSrcList;
6140 SrcList *pSrc = pSelect->pSrc;
drh913306a2021-11-26 17:10:18 +00006141 i64 i, j;
6142 int *piNew;
drh90cf38b2021-11-08 23:24:00 +00006143 if( pSrc->nSrc==0 ) return WRC_Continue;
6144 j = p->nExclude;
6145 p->nExclude += pSrc->nSrc;
6146 piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
6147 if( piNew==0 ){
6148 p->nExclude = 0;
6149 return WRC_Abort;
6150 }else{
6151 p->aiExclude = piNew;
6152 }
6153 for(i=0; i<pSrc->nSrc; i++, j++){
6154 p->aiExclude[j] = pSrc->a[i].iCursor;
daned41a962020-06-09 17:45:48 +00006155 }
6156 return WRC_Continue;
6157}
drh90cf38b2021-11-08 23:24:00 +00006158static void selectRefLeave(Walker *pWalker, Select *pSelect){
6159 struct RefSrcList *p = pWalker->u.pRefSrcList;
6160 SrcList *pSrc = pSelect->pSrc;
6161 if( p->nExclude ){
6162 assert( p->nExclude>=pSrc->nSrc );
6163 p->nExclude -= pSrc->nSrc;
6164 }
6165}
daned41a962020-06-09 17:45:48 +00006166
drh90cf38b2021-11-08 23:24:00 +00006167/* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
6168**
6169** Set the 0x01 bit of pWalker->eCode if there is a reference to any
6170** of the tables shown in RefSrcList.pRef.
6171**
6172** Set the 0x02 bit of pWalker->eCode if there is a reference to a
6173** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
drh030796d2012-08-23 16:18:10 +00006174*/
drh90cf38b2021-11-08 23:24:00 +00006175static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
6176 if( pExpr->op==TK_COLUMN
6177 || pExpr->op==TK_AGG_COLUMN
6178 ){
drh374fdce2012-04-17 16:38:53 +00006179 int i;
drh90cf38b2021-11-08 23:24:00 +00006180 struct RefSrcList *p = pWalker->u.pRefSrcList;
6181 SrcList *pSrc = p->pRef;
drh655814d2015-01-09 01:27:29 +00006182 int nSrc = pSrc ? pSrc->nSrc : 0;
6183 for(i=0; i<nSrc; i++){
drh90cf38b2021-11-08 23:24:00 +00006184 if( pExpr->iTable==pSrc->a[i].iCursor ){
6185 pWalker->eCode |= 1;
6186 return WRC_Continue;
6187 }
drh374fdce2012-04-17 16:38:53 +00006188 }
drh90cf38b2021-11-08 23:24:00 +00006189 for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
6190 if( i>=p->nExclude ){
6191 pWalker->eCode |= 2;
drh030796d2012-08-23 16:18:10 +00006192 }
drh374fdce2012-04-17 16:38:53 +00006193 }
drh030796d2012-08-23 16:18:10 +00006194 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00006195}
6196
6197/*
drh90cf38b2021-11-08 23:24:00 +00006198** Check to see if pExpr references any tables in pSrcList.
6199** Possible return values:
6200**
6201** 1 pExpr does references a table in pSrcList.
6202**
6203** 0 pExpr references some table that is not defined in either
6204** pSrcList or in subqueries of pExpr itself.
6205**
6206** -1 pExpr only references no tables at all, or it only
6207** references tables defined in subqueries of pExpr itself.
6208**
6209** As currently used, pExpr is always an aggregate function call. That
6210** fact is exploited for efficiency.
drh374fdce2012-04-17 16:38:53 +00006211*/
drh90cf38b2021-11-08 23:24:00 +00006212int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00006213 Walker w;
drh90cf38b2021-11-08 23:24:00 +00006214 struct RefSrcList x;
drh41ce47c2022-08-22 02:00:26 +00006215 assert( pParse->db!=0 );
drh80f6bfc2019-08-31 20:13:30 +00006216 memset(&w, 0, sizeof(w));
drh90cf38b2021-11-08 23:24:00 +00006217 memset(&x, 0, sizeof(x));
6218 w.xExprCallback = exprRefToSrcList;
6219 w.xSelectCallback = selectRefEnter;
6220 w.xSelectCallback2 = selectRefLeave;
6221 w.u.pRefSrcList = &x;
6222 x.db = pParse->db;
6223 x.pRef = pSrcList;
6224 assert( pExpr->op==TK_AGG_FUNCTION );
drha4eeccd2021-10-07 17:43:30 +00006225 assert( ExprUseXList(pExpr) );
drh030796d2012-08-23 16:18:10 +00006226 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00006227#ifndef SQLITE_OMIT_WINDOWFUNC
6228 if( ExprHasProperty(pExpr, EP_WinFunc) ){
6229 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
6230 }
6231#endif
drh41ce47c2022-08-22 02:00:26 +00006232 if( x.aiExclude ) sqlite3DbNNFreeNN(pParse->db, x.aiExclude);
drh90cf38b2021-11-08 23:24:00 +00006233 if( w.eCode & 0x01 ){
6234 return 1;
6235 }else if( w.eCode ){
6236 return 0;
6237 }else{
6238 return -1;
6239 }
drh374fdce2012-04-17 16:38:53 +00006240}
6241
6242/*
drh89636622020-06-07 17:33:18 +00006243** This is a Walker expression node callback.
6244**
6245** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
6246** object that is referenced does not refer directly to the Expr. If
6247** it does, make a copy. This is done because the pExpr argument is
6248** subject to change.
6249**
6250** The copy is stored on pParse->pConstExpr with a register number of 0.
6251** This will cause the expression to be deleted automatically when the
6252** Parse object is destroyed, but the zero register number means that it
6253** will not generate any code in the preamble.
6254*/
6255static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00006256 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00006257 && pExpr->pAggInfo!=0
6258 ){
6259 AggInfo *pAggInfo = pExpr->pAggInfo;
6260 int iAgg = pExpr->iAgg;
6261 Parse *pParse = pWalker->pParse;
6262 sqlite3 *db = pParse->db;
drhfe888bc2022-07-25 23:34:14 +00006263 if( pExpr->op!=TK_AGG_FUNCTION ){
6264 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_IF_NULL_ROW );
drh89636622020-06-07 17:33:18 +00006265 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00006266 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006267 pExpr = sqlite3ExprDup(db, pExpr, 0);
6268 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006269 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006270 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006271 }
6272 }
6273 }else{
drhfe888bc2022-07-25 23:34:14 +00006274 assert( pExpr->op==TK_AGG_FUNCTION );
drh89636622020-06-07 17:33:18 +00006275 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00006276 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00006277 pExpr = sqlite3ExprDup(db, pExpr, 0);
6278 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00006279 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00006280 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00006281 }
6282 }
6283 }
6284 }
6285 return WRC_Continue;
6286}
6287
6288/*
6289** Initialize a Walker object so that will persist AggInfo entries referenced
6290** by the tree that is walked.
6291*/
6292void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
6293 memset(pWalker, 0, sizeof(*pWalker));
6294 pWalker->pParse = pParse;
6295 pWalker->xExprCallback = agginfoPersistExprCb;
6296 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
6297}
6298
6299/*
drh13449892005-09-07 21:22:45 +00006300** Add a new element to the pAggInfo->aCol[] array. Return the index of
6301** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00006302*/
drh17435752007-08-16 04:30:38 +00006303static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006304 int i;
drhcf643722007-03-27 13:36:37 +00006305 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006306 db,
drhcf643722007-03-27 13:36:37 +00006307 pInfo->aCol,
6308 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00006309 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00006310 &i
6311 );
drh13449892005-09-07 21:22:45 +00006312 return i;
6313}
6314
6315/*
6316** Add a new element to the pAggInfo->aFunc[] array. Return the index of
6317** the new element. Return a negative number if malloc fails.
6318*/
drh17435752007-08-16 04:30:38 +00006319static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00006320 int i;
drhcf643722007-03-27 13:36:37 +00006321 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00006322 db,
drhcf643722007-03-27 13:36:37 +00006323 pInfo->aFunc,
6324 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00006325 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00006326 &i
6327 );
drh13449892005-09-07 21:22:45 +00006328 return i;
drh89636622020-06-07 17:33:18 +00006329}
drh22827922000-06-06 17:27:05 +00006330
6331/*
drh590f0132022-11-23 17:56:00 +00006332** Search the AggInfo object for an aCol[] entry that has iTable and iColumn.
6333** Return the index in aCol[] of the entry that describes that column.
6334**
6335** If no prior entry is found, create a new one and return -1. The
6336** new column will have an idex of pAggInfo->nColumn-1.
6337*/
6338static void findOrCreateAggInfoColumn(
6339 Parse *pParse, /* Parsing context */
6340 AggInfo *pAggInfo, /* The AggInfo object to search and/or modify */
6341 Expr *pExpr /* Expr describing the column to find or insert */
6342){
6343 struct AggInfo_col *pCol;
6344 int k;
6345
drh7960da02022-11-25 13:08:20 +00006346 assert( pAggInfo->iFirstReg==0 );
drh590f0132022-11-23 17:56:00 +00006347 pCol = pAggInfo->aCol;
6348 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
6349 if( pCol->iTable==pExpr->iTable
6350 && pCol->iColumn==pExpr->iColumn
6351 && pExpr->op!=TK_IF_NULL_ROW
6352 ){
6353 goto fix_up_expr;
6354 }
6355 }
6356 k = addAggInfoColumn(pParse->db, pAggInfo);
6357 if( k<0 ){
6358 /* OOM on resize */
6359 assert( pParse->db->mallocFailed );
6360 return;
6361 }
6362 pCol = &pAggInfo->aCol[k];
6363 assert( ExprUseYTab(pExpr) );
6364 pCol->pTab = pExpr->y.pTab;
6365 pCol->iTable = pExpr->iTable;
6366 pCol->iColumn = pExpr->iColumn;
6367 pCol->iSorterColumn = -1;
6368 pCol->pCExpr = pExpr;
6369 if( pAggInfo->pGroupBy && pExpr->op!=TK_IF_NULL_ROW ){
6370 int j, n;
6371 ExprList *pGB = pAggInfo->pGroupBy;
6372 struct ExprList_item *pTerm = pGB->a;
6373 n = pGB->nExpr;
6374 for(j=0; j<n; j++, pTerm++){
6375 Expr *pE = pTerm->pExpr;
6376 if( pE->op==TK_COLUMN
6377 && pE->iTable==pExpr->iTable
6378 && pE->iColumn==pExpr->iColumn
6379 ){
6380 pCol->iSorterColumn = j;
6381 break;
6382 }
6383 }
6384 }
6385 if( pCol->iSorterColumn<0 ){
6386 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
6387 }
6388fix_up_expr:
6389 ExprSetVVAProperty(pExpr, EP_NoReduce);
6390 pExpr->pAggInfo = pAggInfo;
6391 if( pExpr->op==TK_COLUMN ){
6392 pExpr->op = TK_AGG_COLUMN;
6393 }
6394 pExpr->iAgg = (i16)k;
6395}
6396
6397/*
drh7d10d5a2008-08-20 16:35:10 +00006398** This is the xExprCallback for a tree walker. It is used to
6399** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00006400** for additional information.
drh22827922000-06-06 17:27:05 +00006401*/
drh7d10d5a2008-08-20 16:35:10 +00006402static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00006403 int i;
drh7d10d5a2008-08-20 16:35:10 +00006404 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00006405 Parse *pParse = pNC->pParse;
6406 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00006407 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00006408
drh25c3b8c2018-04-16 10:34:13 +00006409 assert( pNC->ncFlags & NC_UAggInfo );
drh7960da02022-11-25 13:08:20 +00006410 assert( pAggInfo->iFirstReg==0 );
drh22827922000-06-06 17:27:05 +00006411 switch( pExpr->op ){
drh590f0132022-11-23 17:56:00 +00006412 default: {
6413 IndexedExpr *pIEpr;
6414 Expr tmp;
drh594357f2022-11-24 18:45:56 +00006415 assert( pParse->iSelfTab==0 );
drh590f0132022-11-23 17:56:00 +00006416 if( (pNC->ncFlags & NC_InAggFunc)==0 ) break;
6417 if( pParse->pIdxEpr==0 ) break;
6418 for(pIEpr=pParse->pIdxEpr; pIEpr; pIEpr=pIEpr->pIENext){
6419 int iDataCur = pIEpr->iDataCur;
6420 if( iDataCur<0 ) continue;
drh590f0132022-11-23 17:56:00 +00006421 if( sqlite3ExprCompare(0, pExpr, pIEpr->pExpr, iDataCur)==0 ) break;
6422 }
6423 if( pIEpr==0 ) break;
drhc25f5ea2022-11-24 15:04:23 +00006424 if( NEVER(!ExprUseYTab(pExpr)) ) break;
drh590f0132022-11-23 17:56:00 +00006425
6426 /* If we reach this point, it means that expression pExpr can be
6427 ** translated into a reference to an index column as described by
6428 ** pIEpr.
6429 */
6430 memset(&tmp, 0, sizeof(tmp));
6431 tmp.op = TK_AGG_COLUMN;
6432 tmp.iTable = pIEpr->iIdxCur;
6433 tmp.iColumn = pIEpr->iIdxCol;
6434 findOrCreateAggInfoColumn(pParse, pAggInfo, &tmp);
6435 pAggInfo->aCol[tmp.iAgg].pCExpr = pExpr;
6436 pExpr->pAggInfo = pAggInfo;
6437 pExpr->iAgg = tmp.iAgg;
6438 return WRC_Prune;
6439 }
drh6b6d6c62022-07-25 14:05:11 +00006440 case TK_IF_NULL_ROW:
drh89c69d02007-01-04 01:20:28 +00006441 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00006442 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00006443 testcase( pExpr->op==TK_AGG_COLUMN );
6444 testcase( pExpr->op==TK_COLUMN );
drhee373022022-07-25 15:54:23 +00006445 testcase( pExpr->op==TK_IF_NULL_ROW );
drh13449892005-09-07 21:22:45 +00006446 /* Check to see if the column is in one of the tables in the FROM
6447 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00006448 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00006449 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00006450 for(i=0; i<pSrcList->nSrc; i++, pItem++){
drhc5cd1242013-09-12 16:50:49 +00006451 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00006452 if( pExpr->iTable==pItem->iCursor ){
drh590f0132022-11-23 17:56:00 +00006453 findOrCreateAggInfoColumn(pParse, pAggInfo, pExpr);
drh13449892005-09-07 21:22:45 +00006454 break;
6455 } /* endif pExpr->iTable==pItem->iCursor */
6456 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00006457 }
drh7d10d5a2008-08-20 16:35:10 +00006458 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00006459 }
6460 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00006461 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00006462 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00006463 ){
drh13449892005-09-07 21:22:45 +00006464 /* Check to see if pExpr is a duplicate of another aggregate
6465 ** function that is already in the pAggInfo structure
6466 */
6467 struct AggInfo_func *pItem = pAggInfo->aFunc;
6468 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan19e4eef2021-06-03 18:56:42 +00006469 if( pItem->pFExpr==pExpr ) break;
drh81185a52020-06-09 13:38:12 +00006470 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00006471 break;
6472 }
drh22827922000-06-06 17:27:05 +00006473 }
drh13449892005-09-07 21:22:45 +00006474 if( i>=pAggInfo->nFunc ){
6475 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
6476 */
danielk197714db2662006-01-09 16:12:04 +00006477 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006478 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006479 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006480 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006481 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006482 pItem->pFExpr = pExpr;
drha4eeccd2021-10-07 17:43:30 +00006483 assert( ExprUseUToken(pExpr) );
drh13449892005-09-07 21:22:45 +00006484 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006485 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006486 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006487 if( pExpr->flags & EP_Distinct ){
6488 pItem->iDistinct = pParse->nTab++;
6489 }else{
6490 pItem->iDistinct = -1;
6491 }
drh13449892005-09-07 21:22:45 +00006492 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006493 }
drh13449892005-09-07 21:22:45 +00006494 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6495 */
drhc5cd1242013-09-12 16:50:49 +00006496 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006497 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006498 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006499 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006500 return WRC_Prune;
6501 }else{
6502 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006503 }
drh22827922000-06-06 17:27:05 +00006504 }
6505 }
drh7d10d5a2008-08-20 16:35:10 +00006506 return WRC_Continue;
6507}
drh626a8792005-01-17 22:08:19 +00006508
6509/*
drhe8abb4c2012-11-02 18:24:57 +00006510** Analyze the pExpr expression looking for aggregate functions and
6511** for variables that need to be added to AggInfo object that pNC->pAggInfo
6512** points to. Additional entries are made on the AggInfo object as
6513** necessary.
drh626a8792005-01-17 22:08:19 +00006514**
6515** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006516** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006517*/
drhd2b3e232008-01-23 14:51:49 +00006518void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006519 Walker w;
6520 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006521 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6522 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006523 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006524 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006525 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006526 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006527 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006528}
drh5d9a4af2005-08-30 00:54:01 +00006529
6530/*
6531** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6532** expression list. Return the number of errors.
6533**
6534** If an error is found, the analysis is cut short.
6535*/
drhd2b3e232008-01-23 14:51:49 +00006536void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006537 struct ExprList_item *pItem;
6538 int i;
drh5d9a4af2005-08-30 00:54:01 +00006539 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006540 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6541 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006542 }
6543 }
drh5d9a4af2005-08-30 00:54:01 +00006544}
drh892d3172008-01-10 03:46:36 +00006545
6546/*
drhceea3322009-04-23 13:22:42 +00006547** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006548*/
6549int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006550 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006551 return ++pParse->nMem;
6552 }
danielk19772f425f62008-07-04 09:41:39 +00006553 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006554}
drhceea3322009-04-23 13:22:42 +00006555
6556/*
6557** Deallocate a register, making available for reuse for some other
6558** purpose.
drhceea3322009-04-23 13:22:42 +00006559*/
drh892d3172008-01-10 03:46:36 +00006560void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006561 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006562 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006563 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6564 pParse->aTempReg[pParse->nTempReg++] = iReg;
6565 }
drh892d3172008-01-10 03:46:36 +00006566 }
6567}
6568
6569/*
drhed24da42016-09-06 14:37:05 +00006570** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006571*/
6572int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006573 int i, n;
drhed24da42016-09-06 14:37:05 +00006574 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006575 i = pParse->iRangeReg;
6576 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006577 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006578 pParse->iRangeReg += nReg;
6579 pParse->nRangeReg -= nReg;
6580 }else{
6581 i = pParse->nMem+1;
6582 pParse->nMem += nReg;
6583 }
6584 return i;
6585}
6586void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006587 if( nReg==1 ){
6588 sqlite3ReleaseTempReg(pParse, iReg);
6589 return;
6590 }
drh3aef2fb2020-01-02 17:46:02 +00006591 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006592 if( nReg>pParse->nRangeReg ){
6593 pParse->nRangeReg = nReg;
6594 pParse->iRangeReg = iReg;
6595 }
6596}
drhcdc69552011-12-06 13:24:59 +00006597
6598/*
6599** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006600**
6601** Always invoke this procedure after coding a subroutine or co-routine
6602** that might be invoked from other parts of the code, to ensure that
6603** the sub/co-routine does not use registers in common with the code that
6604** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006605*/
6606void sqlite3ClearTempRegCache(Parse *pParse){
6607 pParse->nTempReg = 0;
6608 pParse->nRangeReg = 0;
6609}
drhbb9b5f22016-03-19 00:35:02 +00006610
6611/*
6612** Validate that no temporary register falls within the range of
6613** iFirst..iLast, inclusive. This routine is only call from within assert()
6614** statements.
6615*/
6616#ifdef SQLITE_DEBUG
6617int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6618 int i;
6619 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006620 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6621 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006622 ){
6623 return 0;
6624 }
6625 for(i=0; i<pParse->nTempReg; i++){
6626 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6627 return 0;
6628 }
6629 }
6630 return 1;
6631}
6632#endif /* SQLITE_DEBUG */