blob: 0eb7af7f403c790675385ea5cf2296603425a778 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
48 assert( pExpr->op==TK_COLLATE );
49 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
drhdb36e252019-10-22 19:51:29 +000073 if( op==TK_VECTOR ){
74 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75 }
drh11949042019-08-05 18:01:42 +000076 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000077}
78
drh53db1452004-05-20 13:54:53 +000079/*
drh8b4c40d2007-02-01 23:02:45 +000080** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000081** sequence named by pToken. Return a pointer to a new Expr node that
82** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000083**
84** If a memory allocation error occurs, that fact is recorded in pParse->db
85** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000086*/
drh4ef7efa2014-03-20 15:14:08 +000087Expr *sqlite3ExprAddCollateToken(
88 Parse *pParse, /* Parsing context */
89 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000090 const Token *pCollName, /* Name of collating sequence */
91 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000092){
drh0a8a4062012-12-07 18:38:16 +000093 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000094 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000095 if( pNew ){
96 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000097 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000098 pExpr = pNew;
99 }
drhae80dde2012-12-06 21:16:43 +0000100 }
drh0a8a4062012-12-07 18:38:16 +0000101 return pExpr;
102}
103Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000104 Token s;
105 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000106 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000107 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000108}
109
110/*
drh0d950af2019-08-22 16:38:42 +0000111** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000112*/
113Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000114 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
115 assert( pExpr->op==TK_COLLATE );
116 pExpr = pExpr->pLeft;
117 }
118 return pExpr;
119}
120
121/*
122** Skip over any TK_COLLATE operators and/or any unlikely()
123** or likelihood() or likely() functions at the root of an
124** expression.
125*/
126Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000127 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000128 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000129 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000131 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000132 pExpr = pExpr->x.pList->a[0].pExpr;
133 }else{
drh0b8d2552015-09-05 22:36:07 +0000134 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000135 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000136 }
drha4c3c872013-09-12 17:29:25 +0000137 }
drh0a8a4062012-12-07 18:38:16 +0000138 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000139}
140
141/*
drhae80dde2012-12-06 21:16:43 +0000142** Return the collation sequence for the expression pExpr. If
143** there is no defined collating sequence, return NULL.
144**
drh70efa842017-09-28 01:58:23 +0000145** See also: sqlite3ExprNNCollSeq()
146**
147** The sqlite3ExprNNCollSeq() works the same exact that it returns the
148** default collation if pExpr has no defined collation.
149**
drhae80dde2012-12-06 21:16:43 +0000150** The collating sequence might be determined by a COLLATE operator
151** or by the presence of a column with a defined collating sequence.
152** COLLATE operators take first precedence. Left operands take
153** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000154*/
danielk19777cedc8d2004-06-10 10:50:08 +0000155CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000156 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000157 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000158 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000159 while( p ){
drhae80dde2012-12-06 21:16:43 +0000160 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_REGISTER ) op = p->op2;
162 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000163 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000164 ){
drheda079c2018-09-20 19:02:15 +0000165 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000166 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000167 int j = p->iColumn;
168 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000169 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000170 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000171 }
172 break;
danielk19770202b292004-06-09 09:55:16 +0000173 }
drhe081d732018-07-27 18:19:12 +0000174 if( op==TK_CAST || op==TK_UPLUS ){
175 p = p->pLeft;
176 continue;
177 }
drhcb0e04f2018-12-12 21:34:17 +0000178 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000179 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
180 break;
181 }
drhae80dde2012-12-06 21:16:43 +0000182 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000183 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000184 p = p->pLeft;
185 }else{
drh2308ed32015-02-09 16:09:34 +0000186 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000187 /* The Expr.x union is never used at the same time as Expr.pRight */
188 assert( p->x.pList==0 || p->pRight==0 );
189 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
190 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
191 ** least one EP_Collate. Thus the following two ALWAYS. */
drh92a28242019-10-09 15:37:58 +0000192 if( p->x.pList!=0
193 && !db->mallocFailed
194 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
195 ){
drh2308ed32015-02-09 16:09:34 +0000196 int i;
drh6728cd92015-02-09 18:28:03 +0000197 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000198 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
199 pNext = p->x.pList->a[i].pExpr;
200 break;
201 }
202 }
203 }
204 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000205 }
206 }else{
drh7d10d5a2008-08-20 16:35:10 +0000207 break;
208 }
danielk19770202b292004-06-09 09:55:16 +0000209 }
danielk19777cedc8d2004-06-10 10:50:08 +0000210 if( sqlite3CheckCollSeq(pParse, pColl) ){
211 pColl = 0;
212 }
213 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000214}
215
216/*
drh70efa842017-09-28 01:58:23 +0000217** Return the collation sequence for the expression pExpr. If
218** there is no defined collating sequence, return a pointer to the
219** defautl collation sequence.
220**
221** See also: sqlite3ExprCollSeq()
222**
223** The sqlite3ExprCollSeq() routine works the same except that it
224** returns NULL if there is no defined collation.
225*/
226CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
227 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
228 if( p==0 ) p = pParse->db->pDfltColl;
229 assert( p!=0 );
230 return p;
231}
232
233/*
234** Return TRUE if the two expressions have equivalent collating sequences.
235*/
236int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
237 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
238 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
239 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
240}
241
242/*
drh626a8792005-01-17 22:08:19 +0000243** pExpr is an operand of a comparison operator. aff2 is the
244** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000245** type affinity that should be used for the comparison operator.
246*/
danielk1977e014a832004-05-17 10:48:57 +0000247char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000248 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000249 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000250 /* Both sides of the comparison are columns. If one has numeric
251 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000252 */
drh8a512562005-11-14 22:29:05 +0000253 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000254 return SQLITE_AFF_NUMERIC;
255 }else{
drh05883a32015-06-02 15:32:08 +0000256 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000257 }
danielk1977e014a832004-05-17 10:48:57 +0000258 }else{
259 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000260 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
261 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000262 }
263}
264
drh53db1452004-05-20 13:54:53 +0000265/*
266** pExpr is a comparison operator. Return the type affinity that should
267** be applied to both operands prior to doing the comparison.
268*/
danielk1977e014a832004-05-17 10:48:57 +0000269static char comparisonAffinity(Expr *pExpr){
270 char aff;
271 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
272 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000273 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000274 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000275 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000276 if( pExpr->pRight ){
277 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000278 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
279 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000280 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000281 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000282 }
283 return aff;
284}
285
286/*
287** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
288** idx_affinity is the affinity of an indexed column. Return true
289** if the index with affinity idx_affinity may be used to implement
290** the comparison in pExpr.
291*/
292int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
293 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000294 if( aff<SQLITE_AFF_TEXT ){
295 return 1;
drh8a512562005-11-14 22:29:05 +0000296 }
drh915e4342019-08-06 15:18:15 +0000297 if( aff==SQLITE_AFF_TEXT ){
298 return idx_affinity==SQLITE_AFF_TEXT;
299 }
300 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000301}
302
danielk1977a37cdde2004-05-16 11:15:36 +0000303/*
drh35573352008-01-08 23:54:25 +0000304** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000305** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000306*/
drh35573352008-01-08 23:54:25 +0000307static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
308 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000309 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000310 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000311}
312
drha2e00042002-01-22 03:13:42 +0000313/*
danielk19770202b292004-06-09 09:55:16 +0000314** Return a pointer to the collation sequence that should be used by
315** a binary comparison operator comparing pLeft and pRight.
316**
317** If the left hand expression has a collating sequence type, then it is
318** used. Otherwise the collation sequence for the right hand expression
319** is used, or the default (BINARY) if neither expression has a collating
320** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000321**
322** Argument pRight (but not pLeft) may be a null pointer. In this case,
323** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000324*/
drh0a0e1312007-08-07 17:04:59 +0000325CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000326 Parse *pParse,
327 Expr *pLeft,
328 Expr *pRight
329){
drhec41dda2007-02-07 13:09:45 +0000330 CollSeq *pColl;
331 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000332 if( pLeft->flags & EP_Collate ){
333 pColl = sqlite3ExprCollSeq(pParse, pLeft);
334 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
335 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000336 }else{
337 pColl = sqlite3ExprCollSeq(pParse, pLeft);
338 if( !pColl ){
339 pColl = sqlite3ExprCollSeq(pParse, pRight);
340 }
danielk19770202b292004-06-09 09:55:16 +0000341 }
342 return pColl;
343}
344
drh898c5272019-10-22 00:03:41 +0000345/* Expresssion p is a comparison operator. Return a collation sequence
346** appropriate for the comparison operator.
347**
348** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
349** However, if the OP_Commuted flag is set, then the order of the operands
350** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
351** correct collating sequence is found.
352*/
353CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
354 if( ExprHasProperty(p, EP_Commuted) ){
355 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
356 }else{
357 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
358 }
359}
360
danielk19770202b292004-06-09 09:55:16 +0000361/*
drhbe5c89a2004-07-26 00:31:09 +0000362** Generate code for a comparison operator.
363*/
364static int codeCompare(
365 Parse *pParse, /* The parsing (and code generating) context */
366 Expr *pLeft, /* The left operand */
367 Expr *pRight, /* The right operand */
368 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000369 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000370 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000371 int jumpIfNull, /* If true, jump if either operand is NULL */
372 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000373){
drh35573352008-01-08 23:54:25 +0000374 int p5;
375 int addr;
376 CollSeq *p4;
377
drh898c5272019-10-22 00:03:41 +0000378 if( isCommuted ){
379 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
380 }else{
381 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
382 }
drh35573352008-01-08 23:54:25 +0000383 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
384 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
385 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000386 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000387 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000388}
389
dancfbb5e82016-07-13 19:48:13 +0000390/*
dan870a0702016-08-01 16:37:43 +0000391** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000392**
393** A vector is defined as any expression that results in two or more
394** columns of result. Every TK_VECTOR node is an vector because the
395** parser will not generate a TK_VECTOR with fewer than two entries.
396** But a TK_SELECT might be either a vector or a scalar. It is only
397** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000398*/
399int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000400 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000401}
402
403/*
dancfbb5e82016-07-13 19:48:13 +0000404** If the expression passed as the only argument is of type TK_VECTOR
405** return the number of expressions in the vector. Or, if the expression
406** is a sub-select, return the number of columns in the sub-select. For
407** any other type of expression, return 1.
408*/
dan71c57db2016-07-09 20:23:55 +0000409int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000410 u8 op = pExpr->op;
411 if( op==TK_REGISTER ) op = pExpr->op2;
412 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000413 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000414 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000415 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000416 }else{
417 return 1;
dan71c57db2016-07-09 20:23:55 +0000418 }
dan71c57db2016-07-09 20:23:55 +0000419}
420
danba00e302016-07-23 20:24:06 +0000421/*
drhfc7f27b2016-08-20 00:07:01 +0000422** Return a pointer to a subexpression of pVector that is the i-th
423** column of the vector (numbered starting with 0). The caller must
424** ensure that i is within range.
425**
drh76dbe7a2016-08-20 21:02:38 +0000426** If pVector is really a scalar (and "scalar" here includes subqueries
427** that return a single column!) then return pVector unmodified.
428**
drhfc7f27b2016-08-20 00:07:01 +0000429** pVector retains ownership of the returned subexpression.
430**
431** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000432** just the expression for the i-th term of the result set, and may
433** not be ready for evaluation because the table cursor has not yet
434** been positioned.
danba00e302016-07-23 20:24:06 +0000435*/
drhfc7f27b2016-08-20 00:07:01 +0000436Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000437 assert( i<sqlite3ExprVectorSize(pVector) );
438 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000439 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
440 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000441 return pVector->x.pSelect->pEList->a[i].pExpr;
442 }else{
443 return pVector->x.pList->a[i].pExpr;
444 }
dan71c57db2016-07-09 20:23:55 +0000445 }
dan870a0702016-08-01 16:37:43 +0000446 return pVector;
dan71c57db2016-07-09 20:23:55 +0000447}
drhfc7f27b2016-08-20 00:07:01 +0000448
drhfc7f27b2016-08-20 00:07:01 +0000449/*
450** Compute and return a new Expr object which when passed to
451** sqlite3ExprCode() will generate all necessary code to compute
452** the iField-th column of the vector expression pVector.
453**
drh8762ec12016-08-20 01:06:22 +0000454** It is ok for pVector to be a scalar (as long as iField==0).
455** In that case, this routine works like sqlite3ExprDup().
456**
drhfc7f27b2016-08-20 00:07:01 +0000457** The caller owns the returned Expr object and is responsible for
458** ensuring that the returned value eventually gets freed.
459**
drh8762ec12016-08-20 01:06:22 +0000460** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000461** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000462** valid for the life of the returned object. If pVector is a TK_VECTOR
463** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000464** returns.
drh8762ec12016-08-20 01:06:22 +0000465**
466** A trick to cause a TK_SELECT pVector to be deleted together with
467** the returned Expr object is to attach the pVector to the pRight field
468** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000469*/
470Expr *sqlite3ExprForVectorField(
471 Parse *pParse, /* Parsing context */
472 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000473 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000474){
475 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000476 if( pVector->op==TK_SELECT ){
477 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000478 /* The TK_SELECT_COLUMN Expr node:
479 **
drh966e2912017-01-03 02:58:01 +0000480 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000481 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000482 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000483 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000484 ** pLeft->iTable: First in an array of register holding result, or 0
485 ** if the result is not yet computed.
486 **
487 ** sqlite3ExprDelete() specifically skips the recursive delete of
488 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000489 ** can be attached to pRight to cause this node to take ownership of
490 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
491 ** with the same pLeft pointer to the pVector, but only one of them
492 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000493 */
drhabfd35e2016-12-06 22:47:23 +0000494 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000495 if( pRet ){
496 pRet->iColumn = iField;
497 pRet->pLeft = pVector;
498 }
drhfc7f27b2016-08-20 00:07:01 +0000499 assert( pRet==0 || pRet->iTable==0 );
500 }else{
drha1251bc2016-08-20 00:51:37 +0000501 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
502 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000503 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000504 }
505 return pRet;
506}
dan71c57db2016-07-09 20:23:55 +0000507
dan5c288b92016-07-30 21:02:33 +0000508/*
509** If expression pExpr is of type TK_SELECT, generate code to evaluate
510** it. Return the register in which the result is stored (or, if the
511** sub-select returns more than one column, the first in an array
512** of registers in which the result is stored).
513**
514** If pExpr is not a TK_SELECT expression, return 0.
515*/
516static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000517 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000518#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000519 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000520 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000521 }
danf9b2e052016-08-02 17:45:00 +0000522#endif
dan8da209b2016-07-26 18:06:08 +0000523 return reg;
524}
525
dan5c288b92016-07-30 21:02:33 +0000526/*
527** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000528** or TK_SELECT that returns more than one column. This function returns
529** the register number of a register that contains the value of
530** element iField of the vector.
531**
532** If pVector is a TK_SELECT expression, then code for it must have
533** already been generated using the exprCodeSubselect() routine. In this
534** case parameter regSelect should be the first in an array of registers
535** containing the results of the sub-select.
536**
537** If pVector is of type TK_VECTOR, then code for the requested field
538** is generated. In this case (*pRegFree) may be set to the number of
539** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000540**
541** Before returning, output parameter (*ppExpr) is set to point to the
542** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000543*/
544static int exprVectorRegister(
545 Parse *pParse, /* Parse context */
546 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000547 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000548 int regSelect, /* First in array of registers */
549 Expr **ppExpr, /* OUT: Expression element */
550 int *pRegFree /* OUT: Temp register to free */
551){
drh12abf402016-08-22 14:30:05 +0000552 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000553 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000554 if( op==TK_REGISTER ){
555 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
556 return pVector->iTable+iField;
557 }
558 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000559 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
560 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000561 }
dan870a0702016-08-01 16:37:43 +0000562 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000563 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
564}
565
566/*
567** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000568** the result of the comparison (1, 0, or NULL) and write that
569** result into register dest.
570**
571** The caller must satisfy the following preconditions:
572**
573** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
574** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
575** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000576*/
drh79752b62016-08-13 10:02:17 +0000577static void codeVectorCompare(
578 Parse *pParse, /* Code generator context */
579 Expr *pExpr, /* The comparison operation */
580 int dest, /* Write results into this register */
581 u8 op, /* Comparison operator */
582 u8 p5 /* SQLITE_NULLEQ or zero */
583){
dan71c57db2016-07-09 20:23:55 +0000584 Vdbe *v = pParse->pVdbe;
585 Expr *pLeft = pExpr->pLeft;
586 Expr *pRight = pExpr->pRight;
587 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000588 int i;
589 int regLeft = 0;
590 int regRight = 0;
591 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000592 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000593 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000594
drh245ce622017-01-01 12:44:07 +0000595 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
596 sqlite3ErrorMsg(pParse, "row value misused");
597 return;
598 }
drhb29e60c2016-09-05 12:02:34 +0000599 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
600 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
601 || pExpr->op==TK_LT || pExpr->op==TK_GT
602 || pExpr->op==TK_LE || pExpr->op==TK_GE
603 );
604 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
605 || (pExpr->op==TK_ISNOT && op==TK_NE) );
606 assert( p5==0 || pExpr->op!=op );
607 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000608
drhb29e60c2016-09-05 12:02:34 +0000609 p5 |= SQLITE_STOREP2;
610 if( opx==TK_LE ) opx = TK_LT;
611 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000612
drhb29e60c2016-09-05 12:02:34 +0000613 regLeft = exprCodeSubselect(pParse, pLeft);
614 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000615
drhb29e60c2016-09-05 12:02:34 +0000616 for(i=0; 1 /*Loop exits by "break"*/; i++){
617 int regFree1 = 0, regFree2 = 0;
618 Expr *pL, *pR;
619 int r1, r2;
620 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000621 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
622 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000623 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000624 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
625 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
626 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
627 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
628 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
629 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
630 sqlite3ReleaseTempReg(pParse, regFree1);
631 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000632 if( i==nLeft-1 ){
633 break;
dan71c57db2016-07-09 20:23:55 +0000634 }
drhb29e60c2016-09-05 12:02:34 +0000635 if( opx==TK_EQ ){
636 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
637 p5 |= SQLITE_KEEPNULL;
638 }else if( opx==TK_NE ){
639 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
640 p5 |= SQLITE_KEEPNULL;
641 }else{
642 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
643 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
644 VdbeCoverageIf(v, op==TK_LT);
645 VdbeCoverageIf(v, op==TK_GT);
646 VdbeCoverageIf(v, op==TK_LE);
647 VdbeCoverageIf(v, op==TK_GE);
648 if( i==nLeft-2 ) opx = op;
649 }
dan71c57db2016-07-09 20:23:55 +0000650 }
drhb29e60c2016-09-05 12:02:34 +0000651 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000652}
653
danielk19774b5255a2008-06-05 16:47:39 +0000654#if SQLITE_MAX_EXPR_DEPTH>0
655/*
656** Check that argument nHeight is less than or equal to the maximum
657** expression depth allowed. If it is not, leave an error message in
658** pParse.
659*/
drh7d10d5a2008-08-20 16:35:10 +0000660int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000661 int rc = SQLITE_OK;
662 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
663 if( nHeight>mxHeight ){
664 sqlite3ErrorMsg(pParse,
665 "Expression tree is too large (maximum depth %d)", mxHeight
666 );
667 rc = SQLITE_ERROR;
668 }
669 return rc;
670}
671
672/* The following three functions, heightOfExpr(), heightOfExprList()
673** and heightOfSelect(), are used to determine the maximum height
674** of any expression tree referenced by the structure passed as the
675** first argument.
676**
677** If this maximum height is greater than the current value pointed
678** to by pnHeight, the second parameter, then set *pnHeight to that
679** value.
680*/
681static void heightOfExpr(Expr *p, int *pnHeight){
682 if( p ){
683 if( p->nHeight>*pnHeight ){
684 *pnHeight = p->nHeight;
685 }
686 }
687}
688static void heightOfExprList(ExprList *p, int *pnHeight){
689 if( p ){
690 int i;
691 for(i=0; i<p->nExpr; i++){
692 heightOfExpr(p->a[i].pExpr, pnHeight);
693 }
694 }
695}
dan1a3a3082018-01-18 19:00:54 +0000696static void heightOfSelect(Select *pSelect, int *pnHeight){
697 Select *p;
698 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000699 heightOfExpr(p->pWhere, pnHeight);
700 heightOfExpr(p->pHaving, pnHeight);
701 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000702 heightOfExprList(p->pEList, pnHeight);
703 heightOfExprList(p->pGroupBy, pnHeight);
704 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000705 }
706}
707
708/*
709** Set the Expr.nHeight variable in the structure passed as an
710** argument. An expression with no children, Expr.pList or
711** Expr.pSelect member has a height of 1. Any other expression
712** has a height equal to the maximum height of any other
713** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000714**
715** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
716** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000717*/
718static void exprSetHeight(Expr *p){
719 int nHeight = 0;
720 heightOfExpr(p->pLeft, &nHeight);
721 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000722 if( ExprHasProperty(p, EP_xIsSelect) ){
723 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000724 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000725 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000726 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000727 }
danielk19774b5255a2008-06-05 16:47:39 +0000728 p->nHeight = nHeight + 1;
729}
730
731/*
732** Set the Expr.nHeight variable using the exprSetHeight() function. If
733** the height is greater than the maximum allowed expression depth,
734** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000735**
736** Also propagate all EP_Propagate flags from the Expr.x.pList into
737** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000738*/
drh2308ed32015-02-09 16:09:34 +0000739void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000740 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000741 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000742 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000743}
744
745/*
746** Return the maximum height of any expression tree referenced
747** by the select statement passed as an argument.
748*/
749int sqlite3SelectExprHeight(Select *p){
750 int nHeight = 0;
751 heightOfSelect(p, &nHeight);
752 return nHeight;
753}
drh2308ed32015-02-09 16:09:34 +0000754#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
755/*
756** Propagate all EP_Propagate flags from the Expr.x.pList into
757** Expr.flags.
758*/
759void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
760 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
761 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
762 }
763}
764#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000765#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
766
drhbe5c89a2004-07-26 00:31:09 +0000767/*
drhb7916a72009-05-27 10:31:29 +0000768** This routine is the core allocator for Expr nodes.
769**
drha76b5df2002-02-23 02:32:10 +0000770** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000771** for this node and for the pToken argument is a single allocation
772** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000773** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000774**
775** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000776** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000777** parameter is ignored if pToken is NULL or if the token does not
778** appear to be quoted. If the quotes were of the form "..." (double-quotes)
779** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000780**
781** Special case: If op==TK_INTEGER and pToken points to a string that
782** can be translated into a 32-bit integer, then the token is not
783** stored in u.zToken. Instead, the integer values is written
784** into u.iValue and the EP_IntValue flag is set. No extra storage
785** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000786*/
drhb7916a72009-05-27 10:31:29 +0000787Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000788 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000789 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000790 const Token *pToken, /* Token argument. Might be NULL */
791 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000792){
drha76b5df2002-02-23 02:32:10 +0000793 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000794 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000795 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000796
drh575fad62016-02-05 13:38:36 +0000797 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000798 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000799 if( op!=TK_INTEGER || pToken->z==0
800 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
801 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000802 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000803 }
drhb7916a72009-05-27 10:31:29 +0000804 }
drh575fad62016-02-05 13:38:36 +0000805 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000806 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000807 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000808 pNew->op = (u8)op;
809 pNew->iAgg = -1;
810 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000811 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000812 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000813 pNew->u.iValue = iValue;
814 }else{
drh33e619f2009-05-28 01:00:55 +0000815 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000816 assert( pToken->z!=0 || pToken->n==0 );
817 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000818 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000819 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000820 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000821 }
drhb7916a72009-05-27 10:31:29 +0000822 }
823 }
824#if SQLITE_MAX_EXPR_DEPTH>0
825 pNew->nHeight = 1;
826#endif
827 }
drha76b5df2002-02-23 02:32:10 +0000828 return pNew;
829}
830
831/*
drhb7916a72009-05-27 10:31:29 +0000832** Allocate a new expression node from a zero-terminated token that has
833** already been dequoted.
834*/
835Expr *sqlite3Expr(
836 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
837 int op, /* Expression opcode */
838 const char *zToken /* Token argument. Might be NULL */
839){
840 Token x;
841 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000842 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000843 return sqlite3ExprAlloc(db, op, &x, 0);
844}
845
846/*
847** Attach subtrees pLeft and pRight to the Expr node pRoot.
848**
849** If pRoot==NULL that means that a memory allocation error has occurred.
850** In that case, delete the subtrees pLeft and pRight.
851*/
852void sqlite3ExprAttachSubtrees(
853 sqlite3 *db,
854 Expr *pRoot,
855 Expr *pLeft,
856 Expr *pRight
857){
858 if( pRoot==0 ){
859 assert( db->mallocFailed );
860 sqlite3ExprDelete(db, pLeft);
861 sqlite3ExprDelete(db, pRight);
862 }else{
863 if( pRight ){
864 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000865 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000866 }
867 if( pLeft ){
868 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000869 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000870 }
871 exprSetHeight(pRoot);
872 }
873}
874
875/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000876** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000877**
drhbf664462009-06-19 18:32:54 +0000878** One or both of the subtrees can be NULL. Return a pointer to the new
879** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
880** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000881*/
drh17435752007-08-16 04:30:38 +0000882Expr *sqlite3PExpr(
883 Parse *pParse, /* Parsing context */
884 int op, /* Expression opcode */
885 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000886 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000887){
drh5fb52ca2012-03-31 02:34:35 +0000888 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000889 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
890 if( p ){
891 memset(p, 0, sizeof(Expr));
892 p->op = op & 0xff;
893 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000894 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000895 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000896 }else{
897 sqlite3ExprDelete(pParse->db, pLeft);
898 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000899 }
drh4e0cff62004-11-05 05:10:28 +0000900 return p;
901}
902
903/*
drh08de4f72016-04-11 01:06:47 +0000904** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
905** do a memory allocation failure) then delete the pSelect object.
906*/
907void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
908 if( pExpr ){
909 pExpr->x.pSelect = pSelect;
910 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
911 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
912 }else{
913 assert( pParse->db->mallocFailed );
914 sqlite3SelectDelete(pParse->db, pSelect);
915 }
916}
917
918
919/*
drh91bb0ee2004-09-01 03:06:34 +0000920** Join two expressions using an AND operator. If either expression is
921** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000922**
923** If one side or the other of the AND is known to be false, then instead
924** of returning an AND expression, just return a constant expression with
925** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000926*/
drhd5c851c2019-04-19 13:38:34 +0000927Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
928 sqlite3 *db = pParse->db;
929 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000930 return pRight;
931 }else if( pRight==0 ){
932 return pLeft;
drhad317272019-04-19 16:21:51 +0000933 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000934 sqlite3ExprUnmapAndDelete(pParse, pLeft);
935 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000936 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000937 }else{
drhd5c851c2019-04-19 13:38:34 +0000938 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000939 }
940}
941
942/*
943** Construct a new expression node for a function with multiple
944** arguments.
945*/
drh954733b2018-07-27 23:33:16 +0000946Expr *sqlite3ExprFunction(
947 Parse *pParse, /* Parsing context */
948 ExprList *pList, /* Argument list */
949 Token *pToken, /* Name of the function */
950 int eDistinct /* SF_Distinct or SF_ALL or 0 */
951){
drha76b5df2002-02-23 02:32:10 +0000952 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000953 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000954 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000955 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000956 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000957 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000958 return 0;
959 }
drh954733b2018-07-27 23:33:16 +0000960 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
961 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
962 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000963 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000964 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000965 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000966 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000967 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000968 return pNew;
969}
970
971/*
drhfa6bc002004-09-07 16:19:52 +0000972** Assign a variable number to an expression that encodes a wildcard
973** in the original SQL statement.
974**
975** Wildcards consisting of a single "?" are assigned the next sequential
976** variable number.
977**
978** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000979** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000980** the SQL statement comes from an external source.
981**
drh51f49f12009-05-21 20:41:32 +0000982** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000983** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000984** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000985** assigned.
986*/
drhde25a882016-10-03 15:28:24 +0000987void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000988 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000989 const char *z;
drhf326d662016-12-23 13:30:53 +0000990 ynVar x;
drh17435752007-08-16 04:30:38 +0000991
drhfa6bc002004-09-07 16:19:52 +0000992 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000993 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000994 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000995 assert( z!=0 );
996 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000997 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000998 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000999 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001000 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001001 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001002 }else{
drhf326d662016-12-23 13:30:53 +00001003 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001004 if( z[0]=='?' ){
1005 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1006 ** use it as the variable number */
1007 i64 i;
drh18814df2017-01-31 03:52:34 +00001008 int bOk;
1009 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1010 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1011 bOk = 1;
1012 }else{
1013 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1014 }
drh124c0b42011-06-01 18:15:55 +00001015 testcase( i==0 );
1016 testcase( i==1 );
1017 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1018 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1019 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1020 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1021 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001022 return;
drhfa6bc002004-09-07 16:19:52 +00001023 }
drh8e74e7b2017-01-31 12:41:48 +00001024 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001025 if( x>pParse->nVar ){
1026 pParse->nVar = (int)x;
1027 doAdd = 1;
1028 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1029 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001030 }
1031 }else{
1032 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1033 ** number as the prior appearance of the same name, or if the name
1034 ** has never appeared before, reuse the same variable number
1035 */
drh9bf755c2016-12-23 03:59:31 +00001036 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1037 if( x==0 ){
1038 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001039 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001040 }
drhfa6bc002004-09-07 16:19:52 +00001041 }
drhf326d662016-12-23 13:30:53 +00001042 if( doAdd ){
1043 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1044 }
1045 }
1046 pExpr->iColumn = x;
1047 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001048 sqlite3ErrorMsg(pParse, "too many SQL variables");
1049 }
drhfa6bc002004-09-07 16:19:52 +00001050}
1051
1052/*
danf6963f92009-11-23 14:39:14 +00001053** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001054*/
drh4f0010b2016-04-11 14:49:39 +00001055static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1056 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001057 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1058 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001059
1060 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1061 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001062 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001063#ifdef SQLITE_DEBUG
1064 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1065 assert( p->pLeft==0 );
1066 assert( p->pRight==0 );
1067 assert( p->x.pSelect==0 );
1068 }
1069#endif
1070 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001071 /* The Expr.x union is never used at the same time as Expr.pRight */
1072 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001073 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001074 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001075 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001076 sqlite3ExprDeleteNN(db, p->pRight);
1077 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001078 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001079 sqlite3SelectDelete(db, p->x.pSelect);
1080 }else{
1081 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001082#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001083 if( ExprHasProperty(p, EP_WinFunc) ){
1084 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001085 }
dan6ba7ab02019-07-02 11:56:47 +00001086#endif
dan8117f112019-07-10 20:16:53 +00001087 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001088 }
drh209bc522016-09-23 21:36:24 +00001089 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001090 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001091 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001092 }
drha2e00042002-01-22 03:13:42 +00001093}
drh4f0010b2016-04-11 14:49:39 +00001094void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1095 if( p ) sqlite3ExprDeleteNN(db, p);
1096}
drha2e00042002-01-22 03:13:42 +00001097
drh8e34e402019-06-11 10:43:56 +00001098/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1099** expression.
1100*/
1101void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1102 if( p ){
1103 if( IN_RENAME_OBJECT ){
1104 sqlite3RenameExprUnmap(pParse, p);
1105 }
1106 sqlite3ExprDeleteNN(pParse->db, p);
1107 }
1108}
1109
drhd2687b72005-08-12 22:56:09 +00001110/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001111** Return the number of bytes allocated for the expression structure
1112** passed as the first argument. This is always one of EXPR_FULLSIZE,
1113** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1114*/
1115static int exprStructSize(Expr *p){
1116 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001117 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1118 return EXPR_FULLSIZE;
1119}
1120
1121/*
drh33e619f2009-05-28 01:00:55 +00001122** The dupedExpr*Size() routines each return the number of bytes required
1123** to store a copy of an expression or expression tree. They differ in
1124** how much of the tree is measured.
1125**
1126** dupedExprStructSize() Size of only the Expr structure
1127** dupedExprNodeSize() Size of Expr + space for token
1128** dupedExprSize() Expr + token + subtree components
1129**
1130***************************************************************************
1131**
1132** The dupedExprStructSize() function returns two values OR-ed together:
1133** (1) the space required for a copy of the Expr structure only and
1134** (2) the EP_xxx flags that indicate what the structure size should be.
1135** The return values is always one of:
1136**
1137** EXPR_FULLSIZE
1138** EXPR_REDUCEDSIZE | EP_Reduced
1139** EXPR_TOKENONLYSIZE | EP_TokenOnly
1140**
1141** The size of the structure can be found by masking the return value
1142** of this routine with 0xfff. The flags can be found by masking the
1143** return value with EP_Reduced|EP_TokenOnly.
1144**
1145** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1146** (unreduced) Expr objects as they or originally constructed by the parser.
1147** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001148** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001149** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001150** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001151** to reduce a pristine expression tree from the parser. The implementation
1152** of dupedExprStructSize() contain multiple assert() statements that attempt
1153** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001154*/
1155static int dupedExprStructSize(Expr *p, int flags){
1156 int nSize;
drh33e619f2009-05-28 01:00:55 +00001157 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001158 assert( EXPR_FULLSIZE<=0xfff );
1159 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001160 if( 0==flags || p->op==TK_SELECT_COLUMN
1161#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001162 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001163#endif
1164 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001165 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001166 }else{
drhc5cd1242013-09-12 16:50:49 +00001167 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001168 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001169 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001170 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001171 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001172 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1173 }else{
drhaecd8022013-09-13 18:15:15 +00001174 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001175 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1176 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001177 }
1178 return nSize;
1179}
1180
1181/*
drh33e619f2009-05-28 01:00:55 +00001182** This function returns the space in bytes required to store the copy
1183** of the Expr structure and a copy of the Expr.u.zToken string (if that
1184** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001185*/
1186static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001187 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1188 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001189 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001190 }
danielk1977bc739712009-03-23 04:33:32 +00001191 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001192}
1193
1194/*
1195** Return the number of bytes required to create a duplicate of the
1196** expression passed as the first argument. The second argument is a
1197** mask containing EXPRDUP_XXX flags.
1198**
1199** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001200** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001201**
1202** If the EXPRDUP_REDUCE flag is set, then the return value includes
1203** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1204** and Expr.pRight variables (but not for any structures pointed to or
1205** descended from the Expr.x.pList or Expr.x.pSelect variables).
1206*/
1207static int dupedExprSize(Expr *p, int flags){
1208 int nByte = 0;
1209 if( p ){
1210 nByte = dupedExprNodeSize(p, flags);
1211 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001212 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001213 }
1214 }
1215 return nByte;
1216}
1217
1218/*
1219** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1220** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001221** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001222** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001223** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001224** portion of the buffer copied into by this function.
1225*/
drh3c194692016-04-11 16:43:43 +00001226static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1227 Expr *pNew; /* Value to return */
1228 u8 *zAlloc; /* Memory space from which to build Expr object */
1229 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1230
drh575fad62016-02-05 13:38:36 +00001231 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001232 assert( p );
1233 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1234 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001235
drh3c194692016-04-11 16:43:43 +00001236 /* Figure out where to write the new Expr structure. */
1237 if( pzBuffer ){
1238 zAlloc = *pzBuffer;
1239 staticFlag = EP_Static;
1240 }else{
1241 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1242 staticFlag = 0;
1243 }
1244 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001245
drh3c194692016-04-11 16:43:43 +00001246 if( pNew ){
1247 /* Set nNewSize to the size allocated for the structure pointed to
1248 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1249 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1250 ** by the copy of the p->u.zToken string (if any).
1251 */
1252 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1253 const int nNewSize = nStructSize & 0xfff;
1254 int nToken;
1255 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1256 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001257 }else{
drh3c194692016-04-11 16:43:43 +00001258 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001259 }
drh3c194692016-04-11 16:43:43 +00001260 if( dupFlags ){
1261 assert( ExprHasProperty(p, EP_Reduced)==0 );
1262 memcpy(zAlloc, p, nNewSize);
1263 }else{
1264 u32 nSize = (u32)exprStructSize(p);
1265 memcpy(zAlloc, p, nSize);
1266 if( nSize<EXPR_FULLSIZE ){
1267 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1268 }
1269 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001270
drh3c194692016-04-11 16:43:43 +00001271 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1272 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1273 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1274 pNew->flags |= staticFlag;
1275
1276 /* Copy the p->u.zToken string, if any. */
1277 if( nToken ){
1278 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1279 memcpy(zToken, p->u.zToken, nToken);
1280 }
1281
drh209bc522016-09-23 21:36:24 +00001282 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001283 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1284 if( ExprHasProperty(p, EP_xIsSelect) ){
1285 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001286 }else{
drh3c194692016-04-11 16:43:43 +00001287 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001288 }
drh3c194692016-04-11 16:43:43 +00001289 }
1290
1291 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001292 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001293 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001294 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001295 pNew->pLeft = p->pLeft ?
1296 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1297 pNew->pRight = p->pRight ?
1298 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001299 }
dan67a9b8e2018-06-22 20:51:35 +00001300#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001301 if( ExprHasProperty(p, EP_WinFunc) ){
1302 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1303 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001304 }
dan67a9b8e2018-06-22 20:51:35 +00001305#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001306 if( pzBuffer ){
1307 *pzBuffer = zAlloc;
1308 }
1309 }else{
drh209bc522016-09-23 21:36:24 +00001310 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001311 if( pNew->op==TK_SELECT_COLUMN ){
1312 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001313 assert( p->iColumn==0 || p->pRight==0 );
1314 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001315 }else{
1316 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1317 }
drh3c194692016-04-11 16:43:43 +00001318 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001319 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001320 }
1321 }
1322 return pNew;
1323}
1324
1325/*
danbfe31e72014-01-15 14:17:31 +00001326** Create and return a deep copy of the object passed as the second
1327** argument. If an OOM condition is encountered, NULL is returned
1328** and the db->mallocFailed flag set.
1329*/
daneede6a52014-01-15 19:42:23 +00001330#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001331static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001332 With *pRet = 0;
1333 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001334 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001335 pRet = sqlite3DbMallocZero(db, nByte);
1336 if( pRet ){
1337 int i;
1338 pRet->nCte = p->nCte;
1339 for(i=0; i<p->nCte; i++){
1340 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1341 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1342 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1343 }
1344 }
1345 }
1346 return pRet;
1347}
daneede6a52014-01-15 19:42:23 +00001348#else
1349# define withDup(x,y) 0
1350#endif
dan4e9119d2014-01-13 15:12:23 +00001351
drha8389972018-12-06 22:04:19 +00001352#ifndef SQLITE_OMIT_WINDOWFUNC
1353/*
1354** The gatherSelectWindows() procedure and its helper routine
1355** gatherSelectWindowsCallback() are used to scan all the expressions
1356** an a newly duplicated SELECT statement and gather all of the Window
1357** objects found there, assembling them onto the linked list at Select->pWin.
1358*/
1359static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001360 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001361 Select *pSelect = pWalker->u.pSelect;
1362 Window *pWin = pExpr->y.pWin;
1363 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001364 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001365 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001366 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001367 }
1368 return WRC_Continue;
1369}
drha37b6a52018-12-06 22:12:18 +00001370static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1371 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1372}
drha8389972018-12-06 22:04:19 +00001373static void gatherSelectWindows(Select *p){
1374 Walker w;
1375 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001376 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1377 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001378 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001379 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001380 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001381}
1382#endif
1383
1384
drha76b5df2002-02-23 02:32:10 +00001385/*
drhff78bd22002-02-27 01:47:11 +00001386** The following group of routines make deep copies of expressions,
1387** expression lists, ID lists, and select statements. The copies can
1388** be deleted (by being passed to their respective ...Delete() routines)
1389** without effecting the originals.
1390**
danielk19774adee202004-05-08 08:23:19 +00001391** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1392** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001393** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001394**
drhad3cab52002-05-24 02:04:32 +00001395** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001396**
drhb7916a72009-05-27 10:31:29 +00001397** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001398** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1399** truncated version of the usual Expr structure that will be stored as
1400** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001401*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001402Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001403 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001404 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001405}
danielk19776ab3a2e2009-02-19 14:39:25 +00001406ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001407 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001408 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001409 int i;
drhb1637482017-01-03 00:27:16 +00001410 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001411 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001412 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001413 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001414 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001415 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001416 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001417 pOldItem = p->a;
1418 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001419 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001420 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001421 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001422 if( pOldExpr
1423 && pOldExpr->op==TK_SELECT_COLUMN
1424 && (pNewExpr = pItem->pExpr)!=0
1425 ){
1426 assert( pNewExpr->iColumn==0 || i>0 );
1427 if( pNewExpr->iColumn==0 ){
1428 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001429 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1430 }else{
1431 assert( i>0 );
1432 assert( pItem[-1].pExpr!=0 );
1433 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1434 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1435 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001436 }
1437 }
drh17435752007-08-16 04:30:38 +00001438 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001439 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
dan6e118922019-08-12 16:36:38 +00001440 pItem->sortFlags = pOldItem->sortFlags;
drh3e7bc9c2004-02-21 19:17:17 +00001441 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001442 pItem->bNulls = pOldItem->bNulls;
drh2c036cf2013-06-26 00:34:13 +00001443 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001444 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001445 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001446 }
1447 return pNew;
1448}
danielk197793758c82005-01-21 08:13:14 +00001449
1450/*
1451** If cursors, triggers, views and subqueries are all omitted from
1452** the build, then none of the following routines, except for
1453** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1454** called with a NULL argument.
1455*/
danielk19776a67fe82005-02-04 04:07:16 +00001456#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1457 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001458SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001459 SrcList *pNew;
1460 int i;
drh113088e2003-03-20 01:16:58 +00001461 int nByte;
drh575fad62016-02-05 13:38:36 +00001462 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001463 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001464 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001465 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001466 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001467 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001468 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001469 struct SrcList_item *pNewItem = &pNew->a[i];
1470 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001471 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001472 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001473 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1474 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1475 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001476 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001477 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001478 pNewItem->addrFillSub = pOldItem->addrFillSub;
1479 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001480 if( pNewItem->fg.isIndexedBy ){
1481 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1482 }
1483 pNewItem->pIBIndex = pOldItem->pIBIndex;
1484 if( pNewItem->fg.isTabFunc ){
1485 pNewItem->u1.pFuncArg =
1486 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1487 }
drhed8a3bb2005-06-06 21:19:56 +00001488 pTab = pNewItem->pTab = pOldItem->pTab;
1489 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001490 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001491 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001492 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1493 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001494 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001495 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001496 }
1497 return pNew;
1498}
drh17435752007-08-16 04:30:38 +00001499IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001500 IdList *pNew;
1501 int i;
drh575fad62016-02-05 13:38:36 +00001502 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001503 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001504 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001505 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001506 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001507 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001508 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001509 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001510 return 0;
1511 }
drh6c535152012-02-02 03:38:30 +00001512 /* Note that because the size of the allocation for p->a[] is not
1513 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1514 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001515 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001516 struct IdList_item *pNewItem = &pNew->a[i];
1517 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001518 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001519 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001520 }
1521 return pNew;
1522}
dana7466202017-02-03 14:44:52 +00001523Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1524 Select *pRet = 0;
1525 Select *pNext = 0;
1526 Select **pp = &pRet;
1527 Select *p;
1528
drh575fad62016-02-05 13:38:36 +00001529 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001530 for(p=pDup; p; p=p->pPrior){
1531 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1532 if( pNew==0 ) break;
1533 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1534 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1535 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1536 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1537 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1538 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1539 pNew->op = p->op;
1540 pNew->pNext = pNext;
1541 pNew->pPrior = 0;
1542 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001543 pNew->iLimit = 0;
1544 pNew->iOffset = 0;
1545 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1546 pNew->addrOpenEphm[0] = -1;
1547 pNew->addrOpenEphm[1] = -1;
1548 pNew->nSelectRow = p->nSelectRow;
1549 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001550#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001551 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001552 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001553 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001554#endif
drhfef37762018-07-10 19:48:35 +00001555 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001556 *pp = pNew;
1557 pp = &pNew->pPrior;
1558 pNext = pNew;
1559 }
1560
1561 return pRet;
drhff78bd22002-02-27 01:47:11 +00001562}
danielk197793758c82005-01-21 08:13:14 +00001563#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001564Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001565 assert( p==0 );
1566 return 0;
1567}
1568#endif
drhff78bd22002-02-27 01:47:11 +00001569
1570
1571/*
drha76b5df2002-02-23 02:32:10 +00001572** Add a new element to the end of an expression list. If pList is
1573** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001574**
drha19543f2017-09-15 15:17:48 +00001575** The pList argument must be either NULL or a pointer to an ExprList
1576** obtained from a prior call to sqlite3ExprListAppend(). This routine
1577** may not be used with an ExprList obtained from sqlite3ExprListDup().
1578** Reason: This routine assumes that the number of slots in pList->a[]
1579** is a power of two. That is true for sqlite3ExprListAppend() returns
1580** but is not necessarily true from the return value of sqlite3ExprListDup().
1581**
drhb7916a72009-05-27 10:31:29 +00001582** If a memory allocation error occurs, the entire list is freed and
1583** NULL is returned. If non-NULL is returned, then it is guaranteed
1584** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001585*/
drh17435752007-08-16 04:30:38 +00001586ExprList *sqlite3ExprListAppend(
1587 Parse *pParse, /* Parsing context */
1588 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001589 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001590){
drh43606172017-04-05 11:32:13 +00001591 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001592 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001593 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001594 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001595 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001596 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001597 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001598 }
drhc263f7c2016-01-18 13:18:54 +00001599 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001600 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001601 ExprList *pNew;
1602 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001603 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001604 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001605 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001606 }
drh43606172017-04-05 11:32:13 +00001607 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001608 }
drh43606172017-04-05 11:32:13 +00001609 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001610 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1611 assert( offsetof(struct ExprList_item,pExpr)==0 );
1612 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001613 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001614 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001615
1616no_mem:
1617 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001618 sqlite3ExprDelete(db, pExpr);
1619 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001620 return 0;
drha76b5df2002-02-23 02:32:10 +00001621}
1622
1623/*
drh8762ec12016-08-20 01:06:22 +00001624** pColumns and pExpr form a vector assignment which is part of the SET
1625** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001626**
1627** (a,b,c) = (expr1,expr2,expr3)
1628** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1629**
1630** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001631** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001632** TK_SELECT_COLUMN expressions.
1633*/
1634ExprList *sqlite3ExprListAppendVector(
1635 Parse *pParse, /* Parsing context */
1636 ExprList *pList, /* List to which to append. Might be NULL */
1637 IdList *pColumns, /* List of names of LHS of the assignment */
1638 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1639){
1640 sqlite3 *db = pParse->db;
1641 int n;
1642 int i;
drh66860af2016-08-23 18:30:10 +00001643 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001644 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1645 ** exit prior to this routine being invoked */
1646 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001647 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001648
1649 /* If the RHS is a vector, then we can immediately check to see that
1650 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1651 ** wildcards ("*") in the result set of the SELECT must be expanded before
1652 ** we can do the size check, so defer the size check until code generation.
1653 */
1654 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001655 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1656 pColumns->nId, n);
1657 goto vector_append_error;
1658 }
drh966e2912017-01-03 02:58:01 +00001659
1660 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001661 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001662 assert( pSubExpr!=0 || db->mallocFailed );
1663 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1664 if( pSubExpr==0 ) continue;
1665 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001666 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1667 if( pList ){
drh66860af2016-08-23 18:30:10 +00001668 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001669 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1670 pColumns->a[i].zName = 0;
1671 }
1672 }
drh966e2912017-01-03 02:58:01 +00001673
drhffe28052017-05-06 18:09:36 +00001674 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001675 Expr *pFirst = pList->a[iFirst].pExpr;
1676 assert( pFirst!=0 );
1677 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001678
drhf4dd26c2017-04-05 11:49:06 +00001679 /* Store the SELECT statement in pRight so it will be deleted when
1680 ** sqlite3ExprListDelete() is called */
1681 pFirst->pRight = pExpr;
1682 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001683
drhf4dd26c2017-04-05 11:49:06 +00001684 /* Remember the size of the LHS in iTable so that we can check that
1685 ** the RHS and LHS sizes match during code generation. */
1686 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001687 }
1688
1689vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001690 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001691 sqlite3IdListDelete(db, pColumns);
1692 return pList;
1693}
1694
1695/*
drhbc622bc2015-08-24 15:39:42 +00001696** Set the sort order for the last element on the given ExprList.
1697*/
dan6e118922019-08-12 16:36:38 +00001698void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001699 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001700 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001701 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001702
1703 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1704 assert( iSortOrder==SQLITE_SO_UNDEFINED
1705 || iSortOrder==SQLITE_SO_ASC
1706 || iSortOrder==SQLITE_SO_DESC
1707 );
1708 assert( eNulls==SQLITE_SO_UNDEFINED
1709 || eNulls==SQLITE_SO_ASC
1710 || eNulls==SQLITE_SO_DESC
1711 );
1712
dan9105fd52019-08-19 17:26:32 +00001713 pItem = &p->a[p->nExpr-1];
1714 assert( pItem->bNulls==0 );
1715 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1716 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001717 }
dan9105fd52019-08-19 17:26:32 +00001718 pItem->sortFlags = (u8)iSortOrder;
1719
1720 if( eNulls!=SQLITE_SO_UNDEFINED ){
1721 pItem->bNulls = 1;
1722 if( iSortOrder!=eNulls ){
1723 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1724 }
drhbc622bc2015-08-24 15:39:42 +00001725 }
drhbc622bc2015-08-24 15:39:42 +00001726}
1727
1728/*
drhb7916a72009-05-27 10:31:29 +00001729** Set the ExprList.a[].zName element of the most recently added item
1730** on the expression list.
1731**
1732** pList might be NULL following an OOM error. But pName should never be
1733** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1734** is set.
1735*/
1736void sqlite3ExprListSetName(
1737 Parse *pParse, /* Parsing context */
1738 ExprList *pList, /* List to which to add the span. */
1739 Token *pName, /* Name to be added */
1740 int dequote /* True to cause the name to be dequoted */
1741){
1742 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1743 if( pList ){
1744 struct ExprList_item *pItem;
1745 assert( pList->nExpr>0 );
1746 pItem = &pList->a[pList->nExpr-1];
1747 assert( pItem->zName==0 );
1748 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001749 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001750 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001751 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001752 }
drhb7916a72009-05-27 10:31:29 +00001753 }
1754}
1755
1756/*
1757** Set the ExprList.a[].zSpan element of the most recently added item
1758** on the expression list.
1759**
1760** pList might be NULL following an OOM error. But pSpan should never be
1761** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1762** is set.
1763*/
1764void sqlite3ExprListSetSpan(
1765 Parse *pParse, /* Parsing context */
1766 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001767 const char *zStart, /* Start of the span */
1768 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001769){
1770 sqlite3 *db = pParse->db;
1771 assert( pList!=0 || db->mallocFailed!=0 );
1772 if( pList ){
1773 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1774 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001775 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001776 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001777 }
1778}
1779
1780/*
danielk19777a15a4b2007-05-08 17:54:43 +00001781** If the expression list pEList contains more than iLimit elements,
1782** leave an error message in pParse.
1783*/
1784void sqlite3ExprListCheckLength(
1785 Parse *pParse,
1786 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001787 const char *zObject
1788){
drhb1a6c3c2008-03-20 16:30:17 +00001789 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001790 testcase( pEList && pEList->nExpr==mx );
1791 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001792 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001793 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1794 }
1795}
1796
1797/*
drha76b5df2002-02-23 02:32:10 +00001798** Delete an entire expression list.
1799*/
drhaffa8552016-04-11 18:25:05 +00001800static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001801 int i = pList->nExpr;
1802 struct ExprList_item *pItem = pList->a;
1803 assert( pList->nExpr>0 );
1804 do{
drh633e6d52008-07-28 19:34:53 +00001805 sqlite3ExprDelete(db, pItem->pExpr);
1806 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001807 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001808 pItem++;
1809 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001810 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001811}
drhaffa8552016-04-11 18:25:05 +00001812void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1813 if( pList ) exprListDeleteNN(db, pList);
1814}
drha76b5df2002-02-23 02:32:10 +00001815
1816/*
drh2308ed32015-02-09 16:09:34 +00001817** Return the bitwise-OR of all Expr.flags fields in the given
1818** ExprList.
drh885a5b02015-02-09 15:21:36 +00001819*/
drh2308ed32015-02-09 16:09:34 +00001820u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001821 int i;
drh2308ed32015-02-09 16:09:34 +00001822 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001823 assert( pList!=0 );
1824 for(i=0; i<pList->nExpr; i++){
1825 Expr *pExpr = pList->a[i].pExpr;
1826 assert( pExpr!=0 );
1827 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001828 }
drh2308ed32015-02-09 16:09:34 +00001829 return m;
drh885a5b02015-02-09 15:21:36 +00001830}
1831
1832/*
drh7e6f9802017-09-04 00:33:04 +00001833** This is a SELECT-node callback for the expression walker that
1834** always "fails". By "fail" in this case, we mean set
1835** pWalker->eCode to zero and abort.
1836**
1837** This callback is used by multiple expression walkers.
1838*/
1839int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1840 UNUSED_PARAMETER(NotUsed);
1841 pWalker->eCode = 0;
1842 return WRC_Abort;
1843}
1844
1845/*
drh171d16b2018-02-26 20:15:54 +00001846** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001847** then convert it into an TK_TRUEFALSE term. Return non-zero if
1848** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001849*/
1850int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1851 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001852 if( !ExprHasProperty(pExpr, EP_Quoted)
1853 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1854 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001855 ){
1856 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001857 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001858 return 1;
1859 }
1860 return 0;
1861}
1862
drh43c4ac82018-02-26 21:26:27 +00001863/*
drh96acafb2018-02-27 14:49:25 +00001864** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001865** and 0 if it is FALSE.
1866*/
drh96acafb2018-02-27 14:49:25 +00001867int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001868 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001869 assert( pExpr->op==TK_TRUEFALSE );
1870 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1871 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1872 return pExpr->u.zToken[4]==0;
1873}
1874
drh17180fc2019-04-19 17:26:19 +00001875/*
1876** If pExpr is an AND or OR expression, try to simplify it by eliminating
1877** terms that are always true or false. Return the simplified expression.
1878** Or return the original expression if no simplification is possible.
1879**
1880** Examples:
1881**
1882** (x<10) AND true => (x<10)
1883** (x<10) AND false => false
1884** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1885** (x<10) AND (y=22 OR true) => (x<10)
1886** (y=22) OR true => true
1887*/
1888Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1889 assert( pExpr!=0 );
1890 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1891 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1892 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1893 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1894 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1895 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1896 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1897 }
1898 }
1899 return pExpr;
1900}
1901
drh171d16b2018-02-26 20:15:54 +00001902
1903/*
drh059b2d52014-10-24 19:28:09 +00001904** These routines are Walker callbacks used to check expressions to
1905** see if they are "constant" for some definition of constant. The
1906** Walker.eCode value determines the type of "constant" we are looking
1907** for.
drh73b211a2005-01-18 04:00:42 +00001908**
drh7d10d5a2008-08-20 16:35:10 +00001909** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001910**
drh059b2d52014-10-24 19:28:09 +00001911** sqlite3ExprIsConstant() pWalker->eCode==1
1912** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001913** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001914** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001915**
drh059b2d52014-10-24 19:28:09 +00001916** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1917** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001918**
drhfeada2d2014-09-24 13:20:22 +00001919** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001920** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1921** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001922** parameter raises an error for new statements, but is silently converted
1923** to NULL for existing schemas. This allows sqlite_master tables that
1924** contain a bound parameter because they were generated by older versions
1925** of SQLite to be parsed by newer versions of SQLite without raising a
1926** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001927*/
drh7d10d5a2008-08-20 16:35:10 +00001928static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001929
drh059b2d52014-10-24 19:28:09 +00001930 /* If pWalker->eCode is 2 then any term of the expression that comes from
1931 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001932 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001933 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1934 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001935 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001936 }
1937
drh626a8792005-01-17 22:08:19 +00001938 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001939 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001940 ** and either pWalker->eCode==4 or 5 or the function has the
1941 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001942 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001943 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001944 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001945 }else{
1946 pWalker->eCode = 0;
1947 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001948 }
drh626a8792005-01-17 22:08:19 +00001949 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001950 /* Convert "true" or "false" in a DEFAULT clause into the
1951 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001952 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001953 return WRC_Prune;
1954 }
1955 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001956 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001957 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001958 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001959 testcase( pExpr->op==TK_ID );
1960 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001961 testcase( pExpr->op==TK_AGG_FUNCTION );
1962 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001963 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001964 return WRC_Continue;
1965 }
drh059b2d52014-10-24 19:28:09 +00001966 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1967 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001968 }
drhf43ce0b2017-05-25 00:08:48 +00001969 /* Fall through */
1970 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001971 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001972 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001973 testcase( pExpr->op==TK_IF_NULL_ROW );
1974 pWalker->eCode = 0;
1975 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001976 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001977 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001978 /* Silently convert bound parameters that appear inside of CREATE
1979 ** statements into a NULL when parsing the CREATE statement text out
1980 ** of the sqlite_master table */
1981 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001982 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001983 /* A bound parameter in a CREATE statement that originates from
1984 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001985 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001986 return WRC_Abort;
1987 }
1988 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001989 default:
drh6e341b92018-04-17 18:50:40 +00001990 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1991 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001992 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001993 }
1994}
drh059b2d52014-10-24 19:28:09 +00001995static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001996 Walker w;
drh059b2d52014-10-24 19:28:09 +00001997 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001998 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001999 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002000#ifdef SQLITE_DEBUG
2001 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2002#endif
drh059b2d52014-10-24 19:28:09 +00002003 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002004 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002005 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002006}
drh626a8792005-01-17 22:08:19 +00002007
2008/*
drh059b2d52014-10-24 19:28:09 +00002009** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002010** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002011**
2012** For the purposes of this function, a double-quoted string (ex: "abc")
2013** is considered a variable but a single-quoted string (ex: 'abc') is
2014** a constant.
drhfef52082000-06-06 01:50:43 +00002015*/
danielk19774adee202004-05-08 08:23:19 +00002016int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002017 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002018}
2019
2020/*
drh07aded62018-07-28 16:24:08 +00002021** Walk an expression tree. Return non-zero if
2022**
2023** (1) the expression is constant, and
2024** (2) the expression does originate in the ON or USING clause
2025** of a LEFT JOIN, and
2026** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2027** operands created by the constant propagation optimization.
2028**
2029** When this routine returns true, it indicates that the expression
2030** can be added to the pParse->pConstExpr list and evaluated once when
2031** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002032*/
2033int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002034 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002035}
2036
2037/*
drhfcb9f4f2015-06-01 18:13:16 +00002038** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002039** for any single row of the table with cursor iCur. In other words, the
2040** expression must not refer to any non-deterministic function nor any
2041** table other than iCur.
2042*/
2043int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2044 return exprIsConst(p, 3, iCur);
2045}
2046
danab31a842017-04-29 20:53:09 +00002047
2048/*
2049** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2050*/
2051static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2052 ExprList *pGroupBy = pWalker->u.pGroupBy;
2053 int i;
2054
2055 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2056 ** it constant. */
2057 for(i=0; i<pGroupBy->nExpr; i++){
2058 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002059 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002060 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002061 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002062 return WRC_Prune;
2063 }
2064 }
2065 }
2066
2067 /* Check if pExpr is a sub-select. If so, consider it variable. */
2068 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2069 pWalker->eCode = 0;
2070 return WRC_Abort;
2071 }
2072
2073 return exprNodeIsConstant(pWalker, pExpr);
2074}
2075
2076/*
2077** Walk the expression tree passed as the first argument. Return non-zero
2078** if the expression consists entirely of constants or copies of terms
2079** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002080**
2081** This routine is used to determine if a term of the HAVING clause can
2082** be promoted into the WHERE clause. In order for such a promotion to work,
2083** the value of the HAVING clause term must be the same for all members of
2084** a "group". The requirement that the GROUP BY term must be BINARY
2085** assumes that no other collating sequence will have a finer-grained
2086** grouping than binary. In other words (A=B COLLATE binary) implies
2087** A=B in every other collating sequence. The requirement that the
2088** GROUP BY be BINARY is stricter than necessary. It would also work
2089** to promote HAVING clauses that use the same alternative collating
2090** sequence as the GROUP BY term, but that is much harder to check,
2091** alternative collating sequences are uncommon, and this is only an
2092** optimization, so we take the easy way out and simply require the
2093** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002094*/
2095int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2096 Walker w;
danab31a842017-04-29 20:53:09 +00002097 w.eCode = 1;
2098 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002099 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002100 w.u.pGroupBy = pGroupBy;
2101 w.pParse = pParse;
2102 sqlite3WalkExpr(&w, p);
2103 return w.eCode;
2104}
2105
drh059b2d52014-10-24 19:28:09 +00002106/*
2107** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002108** or a function call with constant arguments. Return and 0 if there
2109** are any variables.
2110**
2111** For the purposes of this function, a double-quoted string (ex: "abc")
2112** is considered a variable but a single-quoted string (ex: 'abc') is
2113** a constant.
2114*/
drhfeada2d2014-09-24 13:20:22 +00002115int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2116 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002117 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002118}
2119
drh5b88bc42013-12-07 23:35:21 +00002120#ifdef SQLITE_ENABLE_CURSOR_HINTS
2121/*
2122** Walk an expression tree. Return 1 if the expression contains a
2123** subquery of some kind. Return 0 if there are no subqueries.
2124*/
2125int sqlite3ExprContainsSubquery(Expr *p){
2126 Walker w;
drhbec24762015-08-13 20:07:13 +00002127 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002128 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002129 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002130#ifdef SQLITE_DEBUG
2131 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2132#endif
drh5b88bc42013-12-07 23:35:21 +00002133 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002134 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002135}
2136#endif
2137
drheb55bd22005-06-30 17:04:21 +00002138/*
drh73b211a2005-01-18 04:00:42 +00002139** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002140** to fit in a 32-bit integer, return 1 and put the value of the integer
2141** in *pValue. If the expression is not an integer or if it is too big
2142** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002143*/
danielk19774adee202004-05-08 08:23:19 +00002144int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002145 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002146 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002147
2148 /* If an expression is an integer literal that fits in a signed 32-bit
2149 ** integer, then the EP_IntValue flag will have already been set */
2150 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2151 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2152
drh92b01d52008-06-24 00:32:35 +00002153 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002154 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002155 return 1;
2156 }
drhe4de1fe2002-06-02 16:09:01 +00002157 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002158 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002159 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002160 break;
drh4b59ab52002-08-24 18:24:51 +00002161 }
drhe4de1fe2002-06-02 16:09:01 +00002162 case TK_UMINUS: {
2163 int v;
danielk19774adee202004-05-08 08:23:19 +00002164 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002165 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002166 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002167 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002168 }
2169 break;
2170 }
2171 default: break;
2172 }
drh92b01d52008-06-24 00:32:35 +00002173 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002174}
2175
2176/*
drh039fc322009-11-17 18:31:47 +00002177** Return FALSE if there is no chance that the expression can be NULL.
2178**
2179** If the expression might be NULL or if the expression is too complex
2180** to tell return TRUE.
2181**
2182** This routine is used as an optimization, to skip OP_IsNull opcodes
2183** when we know that a value cannot be NULL. Hence, a false positive
2184** (returning TRUE when in fact the expression can never be NULL) might
2185** be a small performance hit but is otherwise harmless. On the other
2186** hand, a false negative (returning FALSE when the result could be NULL)
2187** will likely result in an incorrect answer. So when in doubt, return
2188** TRUE.
2189*/
2190int sqlite3ExprCanBeNull(const Expr *p){
2191 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002192 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2193 p = p->pLeft;
2194 }
drh039fc322009-11-17 18:31:47 +00002195 op = p->op;
2196 if( op==TK_REGISTER ) op = p->op2;
2197 switch( op ){
2198 case TK_INTEGER:
2199 case TK_STRING:
2200 case TK_FLOAT:
2201 case TK_BLOB:
2202 return 0;
drh7248a8b2014-08-04 18:50:54 +00002203 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002204 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002205 p->y.pTab==0 || /* Reference to column of index on expression */
2206 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002207 default:
2208 return 1;
2209 }
2210}
2211
2212/*
2213** Return TRUE if the given expression is a constant which would be
2214** unchanged by OP_Affinity with the affinity given in the second
2215** argument.
2216**
2217** This routine is used to determine if the OP_Affinity operation
2218** can be omitted. When in doubt return FALSE. A false negative
2219** is harmless. A false positive, however, can result in the wrong
2220** answer.
2221*/
2222int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2223 u8 op;
drhaf866402019-08-22 11:11:28 +00002224 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002225 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002226 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2227 if( p->op==TK_UMINUS ) unaryMinus = 1;
2228 p = p->pLeft;
2229 }
drh039fc322009-11-17 18:31:47 +00002230 op = p->op;
2231 if( op==TK_REGISTER ) op = p->op2;
2232 switch( op ){
2233 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002234 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002235 }
2236 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002237 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002238 }
2239 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002240 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002241 }
2242 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002243 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002244 }
drh2f2855b2009-11-18 01:25:26 +00002245 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002246 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002247 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002248 }
drh039fc322009-11-17 18:31:47 +00002249 default: {
2250 return 0;
2251 }
2252 }
2253}
2254
2255/*
drhc4a3c772001-04-04 11:48:57 +00002256** Return TRUE if the given string is a row-id column name.
2257*/
danielk19774adee202004-05-08 08:23:19 +00002258int sqlite3IsRowid(const char *z){
2259 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2260 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2261 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002262 return 0;
2263}
2264
danielk19779a96b662007-11-29 17:05:18 +00002265/*
drh69c355b2016-03-09 15:34:51 +00002266** pX is the RHS of an IN operator. If pX is a SELECT statement
2267** that can be simplified to a direct table access, then return
2268** a pointer to the SELECT statement. If pX is not a SELECT statement,
2269** or if the SELECT statement needs to be manifested into a transient
2270** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002271*/
2272#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002273static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002274 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002275 SrcList *pSrc;
2276 ExprList *pEList;
2277 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002278 int i;
drh69c355b2016-03-09 15:34:51 +00002279 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2280 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2281 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002282 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002283 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002284 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2285 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2286 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002287 }
drhb74b1012009-05-28 21:04:37 +00002288 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002289 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002290 if( p->pWhere ) return 0; /* Has no WHERE clause */
2291 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002292 assert( pSrc!=0 );
2293 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002294 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002295 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002296 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002297 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002298 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2299 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002300 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002301 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002302 for(i=0; i<pEList->nExpr; i++){
2303 Expr *pRes = pEList->a[i].pExpr;
2304 if( pRes->op!=TK_COLUMN ) return 0;
2305 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002306 }
drh69c355b2016-03-09 15:34:51 +00002307 return p;
drhb287f4b2008-04-25 00:08:38 +00002308}
2309#endif /* SQLITE_OMIT_SUBQUERY */
2310
danf9b2e052016-08-02 17:45:00 +00002311#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002312/*
drh4c259e92014-08-01 21:12:35 +00002313** Generate code that checks the left-most column of index table iCur to see if
2314** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002315** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2316** to be set to NULL if iCur contains one or more NULL values.
2317*/
2318static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002319 int addr1;
drh6be515e2014-08-01 21:00:53 +00002320 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002321 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002322 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2323 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002324 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002325 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002326}
danf9b2e052016-08-02 17:45:00 +00002327#endif
drh6be515e2014-08-01 21:00:53 +00002328
drhbb53ecb2014-08-02 21:03:33 +00002329
2330#ifndef SQLITE_OMIT_SUBQUERY
2331/*
2332** The argument is an IN operator with a list (not a subquery) on the
2333** right-hand side. Return TRUE if that list is constant.
2334*/
2335static int sqlite3InRhsIsConstant(Expr *pIn){
2336 Expr *pLHS;
2337 int res;
2338 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2339 pLHS = pIn->pLeft;
2340 pIn->pLeft = 0;
2341 res = sqlite3ExprIsConstant(pIn);
2342 pIn->pLeft = pLHS;
2343 return res;
2344}
2345#endif
2346
drh6be515e2014-08-01 21:00:53 +00002347/*
danielk19779a96b662007-11-29 17:05:18 +00002348** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002349** The pX parameter is the expression on the RHS of the IN operator, which
2350** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002351**
drhd4305ca2012-09-18 17:08:33 +00002352** The job of this routine is to find or create a b-tree object that can
2353** be used either to test for membership in the RHS set or to iterate through
2354** all members of the RHS set, skipping duplicates.
2355**
drh3a856252014-08-01 14:46:57 +00002356** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002357** and pX->iTable is set to the index of that cursor.
2358**
drhb74b1012009-05-28 21:04:37 +00002359** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002360**
drh1ccce442013-03-12 20:38:51 +00002361** IN_INDEX_ROWID - The cursor was opened on a database table.
2362** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2363** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2364** IN_INDEX_EPH - The cursor was opened on a specially created and
2365** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002366** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2367** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002368**
drhd4305ca2012-09-18 17:08:33 +00002369** An existing b-tree might be used if the RHS expression pX is a simple
2370** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002371**
dan553168c2016-08-01 20:14:31 +00002372** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002373**
drhd4305ca2012-09-18 17:08:33 +00002374** If the RHS of the IN operator is a list or a more complex subquery, then
2375** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002376** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002377** existing table.
drhd4305ca2012-09-18 17:08:33 +00002378**
drh7fc0ba02017-11-17 15:02:00 +00002379** The inFlags parameter must contain, at a minimum, one of the bits
2380** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2381** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2382** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2383** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002384**
2385** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2386** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002387** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002388** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2389** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002390**
drh3a856252014-08-01 14:46:57 +00002391** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2392** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002393** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2394** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002395**
drhbb53ecb2014-08-02 21:03:33 +00002396** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2397** if the RHS of the IN operator is a list (not a subquery) then this
2398** routine might decide that creating an ephemeral b-tree for membership
2399** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2400** calling routine should implement the IN operator using a sequence
2401** of Eq or Ne comparison operations.
2402**
drhb74b1012009-05-28 21:04:37 +00002403** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002404** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002405** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002406** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002407** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002408** to *prRhsHasNull. If there is no chance that the (...) contains a
2409** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002410**
drhe21a6e12014-08-01 18:00:24 +00002411** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002412** the value in that register will be NULL if the b-tree contains one or more
2413** NULL values, and it will be some non-NULL value if the b-tree contains no
2414** NULL values.
dan553168c2016-08-01 20:14:31 +00002415**
2416** If the aiMap parameter is not NULL, it must point to an array containing
2417** one element for each column returned by the SELECT statement on the RHS
2418** of the IN(...) operator. The i'th entry of the array is populated with the
2419** offset of the index column that matches the i'th column returned by the
2420** SELECT. For example, if the expression and selected index are:
2421**
2422** (?,?,?) IN (SELECT a, b, c FROM t1)
2423** CREATE INDEX i1 ON t1(b, c, a);
2424**
2425** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002426*/
danielk1977284f4ac2007-12-10 05:03:46 +00002427#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002428int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002429 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002430 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002431 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2432 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002433 int *aiMap, /* Mapping from Index fields to RHS fields */
2434 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002435){
drhb74b1012009-05-28 21:04:37 +00002436 Select *p; /* SELECT to the right of IN operator */
2437 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2438 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002439 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002440 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002441
drh1450bc62009-10-30 13:25:56 +00002442 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002443 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002444
dan7b35a772016-07-28 19:47:15 +00002445 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2446 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002447 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002448 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002449 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002450 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2451 int i;
2452 ExprList *pEList = pX->x.pSelect->pEList;
2453 for(i=0; i<pEList->nExpr; i++){
2454 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2455 }
2456 if( i==pEList->nExpr ){
2457 prRhsHasNull = 0;
2458 }
2459 }
2460
drhb74b1012009-05-28 21:04:37 +00002461 /* Check to see if an existing table or index can be used to
2462 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002463 ** ephemeral table. */
2464 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002465 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002466 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002467 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002468 ExprList *pEList = p->pEList;
2469 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002470
drhb07028f2011-10-14 21:49:18 +00002471 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2472 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2473 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2474 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002475
drhb22f7c82014-02-06 23:56:27 +00002476 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002477 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2478 sqlite3CodeVerifySchema(pParse, iDb);
2479 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002480
drha84a2832016-08-26 21:15:35 +00002481 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002482 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002483 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002484 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002485 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002486
2487 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2488 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002489 ExplainQueryPlan((pParse, 0,
2490 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002491 sqlite3VdbeJumpHere(v, iAddr);
2492 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002493 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002494 int affinity_ok = 1;
2495 int i;
2496
2497 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002498 ** comparison is the same as the affinity of each column in table
2499 ** on the RHS of the IN operator. If it not, it is not possible to
2500 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002501 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002502 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002503 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002504 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002505 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002506 testcase( cmpaff==SQLITE_AFF_BLOB );
2507 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002508 switch( cmpaff ){
2509 case SQLITE_AFF_BLOB:
2510 break;
2511 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002512 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2513 ** other has no affinity and the other side is TEXT. Hence,
2514 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2515 ** and for the term on the LHS of the IN to have no affinity. */
2516 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002517 break;
2518 default:
2519 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2520 }
2521 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002522
drha84a2832016-08-26 21:15:35 +00002523 if( affinity_ok ){
2524 /* Search for an existing index that will work for this IN operator */
2525 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2526 Bitmask colUsed; /* Columns of the index used */
2527 Bitmask mCol; /* Mask for the current column */
2528 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002529 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002530 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2531 ** BITMASK(nExpr) without overflowing */
2532 testcase( pIdx->nColumn==BMS-2 );
2533 testcase( pIdx->nColumn==BMS-1 );
2534 if( pIdx->nColumn>=BMS-1 ) continue;
2535 if( mustBeUnique ){
2536 if( pIdx->nKeyCol>nExpr
2537 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2538 ){
2539 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002540 }
danielk19770cdc0222008-06-26 18:04:03 +00002541 }
drha84a2832016-08-26 21:15:35 +00002542
2543 colUsed = 0; /* Columns of index used so far */
2544 for(i=0; i<nExpr; i++){
2545 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2546 Expr *pRhs = pEList->a[i].pExpr;
2547 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2548 int j;
2549
2550 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2551 for(j=0; j<nExpr; j++){
2552 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2553 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002554 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2555 continue;
2556 }
drha84a2832016-08-26 21:15:35 +00002557 break;
2558 }
2559 if( j==nExpr ) break;
2560 mCol = MASKBIT(j);
2561 if( mCol & colUsed ) break; /* Each column used only once */
2562 colUsed |= mCol;
2563 if( aiMap ) aiMap[i] = j;
2564 }
2565
2566 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2567 if( colUsed==(MASKBIT(nExpr)-1) ){
2568 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002569 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002570 ExplainQueryPlan((pParse, 0,
2571 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002572 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2573 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2574 VdbeComment((v, "%s", pIdx->zName));
2575 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2576 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2577
2578 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002579#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002580 i64 mask = (1<<nExpr)-1;
2581 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2582 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002583#endif
2584 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002585 if( nExpr==1 ){
2586 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2587 }
2588 }
2589 sqlite3VdbeJumpHere(v, iAddr);
2590 }
2591 } /* End loop over indexes */
2592 } /* End if( affinity_ok ) */
2593 } /* End if not an rowid index */
2594 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002595
drhbb53ecb2014-08-02 21:03:33 +00002596 /* If no preexisting index is available for the IN clause
2597 ** and IN_INDEX_NOOP is an allowed reply
2598 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002599 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002600 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002601 ** the IN operator so return IN_INDEX_NOOP.
2602 */
2603 if( eType==0
2604 && (inFlags & IN_INDEX_NOOP_OK)
2605 && !ExprHasProperty(pX, EP_xIsSelect)
2606 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2607 ){
2608 eType = IN_INDEX_NOOP;
2609 }
drhbb53ecb2014-08-02 21:03:33 +00002610
danielk19779a96b662007-11-29 17:05:18 +00002611 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002612 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002613 ** We will have to generate an ephemeral table to do the job.
2614 */
drh8e23daf2013-06-11 13:30:04 +00002615 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002616 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002617 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002618 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002619 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002620 }else if( prRhsHasNull ){
2621 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002622 }
drh85bcdce2018-12-23 21:27:29 +00002623 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002624 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002625 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002626 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002627 }
drhcf4d38a2010-07-28 02:53:36 +00002628 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002629 }
danba00e302016-07-23 20:24:06 +00002630
2631 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2632 int i, n;
2633 n = sqlite3ExprVectorSize(pX->pLeft);
2634 for(i=0; i<n; i++) aiMap[i] = i;
2635 }
drh2c041312018-12-24 02:34:49 +00002636 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002637 return eType;
2638}
danielk1977284f4ac2007-12-10 05:03:46 +00002639#endif
drh626a8792005-01-17 22:08:19 +00002640
danf9b2e052016-08-02 17:45:00 +00002641#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002642/*
2643** Argument pExpr is an (?, ?...) IN(...) expression. This
2644** function allocates and returns a nul-terminated string containing
2645** the affinities to be used for each column of the comparison.
2646**
2647** It is the responsibility of the caller to ensure that the returned
2648** string is eventually freed using sqlite3DbFree().
2649*/
dan71c57db2016-07-09 20:23:55 +00002650static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2651 Expr *pLeft = pExpr->pLeft;
2652 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002653 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002654 char *zRet;
2655
dan553168c2016-08-01 20:14:31 +00002656 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002657 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002658 if( zRet ){
2659 int i;
2660 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002661 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002662 char a = sqlite3ExprAffinity(pA);
2663 if( pSelect ){
2664 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2665 }else{
2666 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002667 }
dan71c57db2016-07-09 20:23:55 +00002668 }
2669 zRet[nVal] = '\0';
2670 }
2671 return zRet;
2672}
danf9b2e052016-08-02 17:45:00 +00002673#endif
dan71c57db2016-07-09 20:23:55 +00002674
dan8da209b2016-07-26 18:06:08 +00002675#ifndef SQLITE_OMIT_SUBQUERY
2676/*
2677** Load the Parse object passed as the first argument with an error
2678** message of the form:
2679**
2680** "sub-select returns N columns - expected M"
2681*/
2682void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2683 const char *zFmt = "sub-select returns %d columns - expected %d";
2684 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2685}
2686#endif
2687
drh626a8792005-01-17 22:08:19 +00002688/*
dan44c56042016-12-07 15:38:37 +00002689** Expression pExpr is a vector that has been used in a context where
2690** it is not permitted. If pExpr is a sub-select vector, this routine
2691** loads the Parse object with a message of the form:
2692**
2693** "sub-select returns N columns - expected 1"
2694**
2695** Or, if it is a regular scalar vector:
2696**
2697** "row value misused"
2698*/
2699void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2700#ifndef SQLITE_OMIT_SUBQUERY
2701 if( pExpr->flags & EP_xIsSelect ){
2702 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2703 }else
2704#endif
2705 {
2706 sqlite3ErrorMsg(pParse, "row value misused");
2707 }
2708}
2709
drh85bcdce2018-12-23 21:27:29 +00002710#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002711/*
drh85bcdce2018-12-23 21:27:29 +00002712** Generate code that will construct an ephemeral table containing all terms
2713** in the RHS of an IN operator. The IN operator can be in either of two
2714** forms:
drh626a8792005-01-17 22:08:19 +00002715**
drh9cbe6352005-11-29 03:13:21 +00002716** x IN (4,5,11) -- IN operator with list on right-hand side
2717** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002718**
drh2c041312018-12-24 02:34:49 +00002719** The pExpr parameter is the IN operator. The cursor number for the
2720** constructed ephermeral table is returned. The first time the ephemeral
2721** table is computed, the cursor number is also stored in pExpr->iTable,
2722** however the cursor number returned might not be the same, as it might
2723** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002724**
drh85bcdce2018-12-23 21:27:29 +00002725** If the LHS expression ("x" in the examples) is a column value, or
2726** the SELECT statement returns a column value, then the affinity of that
2727** column is used to build the index keys. If both 'x' and the
2728** SELECT... statement are columns, then numeric affinity is used
2729** if either column has NUMERIC or INTEGER affinity. If neither
2730** 'x' nor the SELECT... statement are columns, then numeric affinity
2731** is used.
drhcce7d172000-05-31 15:34:51 +00002732*/
drh85bcdce2018-12-23 21:27:29 +00002733void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002734 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002735 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002736 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002737){
drh2c041312018-12-24 02:34:49 +00002738 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002739 int addr; /* Address of OP_OpenEphemeral instruction */
2740 Expr *pLeft; /* the LHS of the IN operator */
2741 KeyInfo *pKeyInfo = 0; /* Key information */
2742 int nVal; /* Size of vector pLeft */
2743 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002744
drh2c041312018-12-24 02:34:49 +00002745 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002746 assert( v!=0 );
2747
drh2c041312018-12-24 02:34:49 +00002748 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002749 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002750 **
2751 ** * The right-hand side is a correlated subquery
2752 ** * The right-hand side is an expression list containing variables
2753 ** * We are inside a trigger
2754 **
drh2c041312018-12-24 02:34:49 +00002755 ** If all of the above are false, then we can compute the RHS just once
2756 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002757 */
drhefb699f2018-12-24 11:55:44 +00002758 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002759 /* Reuse of the RHS is allowed */
2760 /* If this routine has already been coded, but the previous code
2761 ** might not have been invoked yet, so invoke it now as a subroutine.
2762 */
2763 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002764 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002765 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2766 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2767 pExpr->x.pSelect->selId));
2768 }
drh2c041312018-12-24 02:34:49 +00002769 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2770 pExpr->y.sub.iAddr);
2771 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002772 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002773 return;
2774 }
2775
2776 /* Begin coding the subroutine */
2777 ExprSetProperty(pExpr, EP_Subrtn);
2778 pExpr->y.sub.regReturn = ++pParse->nMem;
2779 pExpr->y.sub.iAddr =
2780 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2781 VdbeComment((v, "return address"));
2782
2783 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002784 }
2785
drh85bcdce2018-12-23 21:27:29 +00002786 /* Check to see if this is a vector IN operator */
2787 pLeft = pExpr->pLeft;
2788 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002789
drh85bcdce2018-12-23 21:27:29 +00002790 /* Construct the ephemeral table that will contain the content of
2791 ** RHS of the IN operator.
2792 */
drh2c041312018-12-24 02:34:49 +00002793 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002794 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002795#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2796 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2797 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2798 }else{
2799 VdbeComment((v, "RHS of IN operator"));
2800 }
2801#endif
drh50ef6712019-02-22 23:29:56 +00002802 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002803
drh85bcdce2018-12-23 21:27:29 +00002804 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2805 /* Case 1: expr IN (SELECT ...)
2806 **
2807 ** Generate code to write the results of the select into the temporary
2808 ** table allocated and opened above.
2809 */
2810 Select *pSelect = pExpr->x.pSelect;
2811 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002812
drh2c041312018-12-24 02:34:49 +00002813 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2814 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002815 ));
drh85bcdce2018-12-23 21:27:29 +00002816 /* If the LHS and RHS of the IN operator do not match, that
2817 ** error will have been caught long before we reach this point. */
2818 if( ALWAYS(pEList->nExpr==nVal) ){
2819 SelectDest dest;
2820 int i;
drhbd462bc2018-12-24 20:21:06 +00002821 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002822 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2823 pSelect->iLimit = 0;
2824 testcase( pSelect->selFlags & SF_Distinct );
2825 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2826 if( sqlite3Select(pParse, pSelect, &dest) ){
2827 sqlite3DbFree(pParse->db, dest.zAffSdst);
2828 sqlite3KeyInfoUnref(pKeyInfo);
2829 return;
drhfef52082000-06-06 01:50:43 +00002830 }
drh85bcdce2018-12-23 21:27:29 +00002831 sqlite3DbFree(pParse->db, dest.zAffSdst);
2832 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2833 assert( pEList!=0 );
2834 assert( pEList->nExpr>0 );
2835 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2836 for(i=0; i<nVal; i++){
2837 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2838 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2839 pParse, p, pEList->a[i].pExpr
2840 );
danielk197741a05b72008-10-02 13:50:55 +00002841 }
drh85bcdce2018-12-23 21:27:29 +00002842 }
2843 }else if( ALWAYS(pExpr->x.pList!=0) ){
2844 /* Case 2: expr IN (exprlist)
2845 **
2846 ** For each expression, build an index key from the evaluation and
2847 ** store it in the temporary table. If <expr> is a column, then use
2848 ** that columns affinity when building index keys. If <expr> is not
2849 ** a column, use numeric affinity.
2850 */
2851 char affinity; /* Affinity of the LHS of the IN */
2852 int i;
2853 ExprList *pList = pExpr->x.pList;
2854 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002855 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002856 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002857 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002858 affinity = SQLITE_AFF_BLOB;
2859 }
2860 if( pKeyInfo ){
2861 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2862 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002863 }
2864
drh85bcdce2018-12-23 21:27:29 +00002865 /* Loop through each expression in <exprlist>. */
2866 r1 = sqlite3GetTempReg(pParse);
2867 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002868 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2869 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002870
2871 /* If the expression is not constant then we will need to
2872 ** disable the test that was generated above that makes sure
2873 ** this code only executes once. Because for a non-constant
2874 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002875 */
drh2c041312018-12-24 02:34:49 +00002876 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2877 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002878 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002879 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002880 }
drh1398ad32005-01-19 23:24:50 +00002881
drh85bcdce2018-12-23 21:27:29 +00002882 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002883 sqlite3ExprCode(pParse, pE2, r1);
2884 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2885 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002886 }
drh85bcdce2018-12-23 21:27:29 +00002887 sqlite3ReleaseTempReg(pParse, r1);
2888 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002889 }
drh85bcdce2018-12-23 21:27:29 +00002890 if( pKeyInfo ){
2891 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2892 }
drh2c041312018-12-24 02:34:49 +00002893 if( addrOnce ){
2894 sqlite3VdbeJumpHere(v, addrOnce);
2895 /* Subroutine return */
2896 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2897 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002898 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002899 }
2900}
2901#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002902
drh85bcdce2018-12-23 21:27:29 +00002903/*
2904** Generate code for scalar subqueries used as a subquery expression
2905** or EXISTS operator:
2906**
2907** (SELECT a FROM b) -- subquery
2908** EXISTS (SELECT a FROM b) -- EXISTS subquery
2909**
2910** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2911**
drhd86fe442019-08-26 13:45:49 +00002912** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002913** the result is stored in a contiguous array of registers and the
2914** return value is the register of the left-most result column.
2915** Return 0 if an error occurs.
2916*/
2917#ifndef SQLITE_OMIT_SUBQUERY
2918int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002919 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002920 int rReg = 0; /* Register storing resulting */
2921 Select *pSel; /* SELECT statement to encode */
2922 SelectDest dest; /* How to deal with SELECT result */
2923 int nReg; /* Registers to allocate */
2924 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002925
2926 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002927 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002928 testcase( pExpr->op==TK_EXISTS );
2929 testcase( pExpr->op==TK_SELECT );
2930 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2931 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2932 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002933
drh5198ff52018-12-24 12:09:47 +00002934 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002935 ** is encountered if any of the following is true:
2936 **
2937 ** * The right-hand side is a correlated subquery
2938 ** * The right-hand side is an expression list containing variables
2939 ** * We are inside a trigger
2940 **
2941 ** If all of the above are false, then we can run this code just once
2942 ** save the results, and reuse the same result on subsequent invocations.
2943 */
2944 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002945 /* If this routine has already been coded, then invoke it as a
2946 ** subroutine. */
2947 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002948 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002949 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2950 pExpr->y.sub.iAddr);
2951 return pExpr->iTable;
2952 }
2953
2954 /* Begin coding the subroutine */
2955 ExprSetProperty(pExpr, EP_Subrtn);
2956 pExpr->y.sub.regReturn = ++pParse->nMem;
2957 pExpr->y.sub.iAddr =
2958 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2959 VdbeComment((v, "return address"));
2960
drh2c041312018-12-24 02:34:49 +00002961 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002962 }
drh85bcdce2018-12-23 21:27:29 +00002963
2964 /* For a SELECT, generate code to put the values for all columns of
2965 ** the first row into an array of registers and return the index of
2966 ** the first register.
2967 **
2968 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2969 ** into a register and return that register number.
2970 **
2971 ** In both cases, the query is augmented with "LIMIT 1". Any
2972 ** preexisting limit is discarded in place of the new LIMIT 1.
2973 */
drhbd462bc2018-12-24 20:21:06 +00002974 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2975 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002976 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2977 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2978 pParse->nMem += nReg;
2979 if( pExpr->op==TK_SELECT ){
2980 dest.eDest = SRT_Mem;
2981 dest.iSdst = dest.iSDParm;
2982 dest.nSdst = nReg;
2983 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2984 VdbeComment((v, "Init subquery result"));
2985 }else{
2986 dest.eDest = SRT_Exists;
2987 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2988 VdbeComment((v, "Init EXISTS result"));
2989 }
drh85bcdce2018-12-23 21:27:29 +00002990 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00002991 /* The subquery already has a limit. If the pre-existing limit is X
2992 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
2993 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00002994 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00002995 if( pLimit ){
2996 pLimit->affExpr = SQLITE_AFF_NUMERIC;
2997 pLimit = sqlite3PExpr(pParse, TK_NE,
2998 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
2999 }
3000 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003001 pSel->pLimit->pLeft = pLimit;
3002 }else{
drh7ca13472019-09-23 11:55:22 +00003003 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003004 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003005 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3006 }
3007 pSel->iLimit = 0;
3008 if( sqlite3Select(pParse, pSel, &dest) ){
3009 return 0;
3010 }
drh2c041312018-12-24 02:34:49 +00003011 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003012 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003013 if( addrOnce ){
3014 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003015
drh5198ff52018-12-24 12:09:47 +00003016 /* Subroutine return */
3017 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3018 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003019 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003020 }
drh2c041312018-12-24 02:34:49 +00003021
drh1450bc62009-10-30 13:25:56 +00003022 return rReg;
drhcce7d172000-05-31 15:34:51 +00003023}
drh51522cd2005-01-20 13:36:19 +00003024#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003025
drhe3365e62009-11-12 17:52:24 +00003026#ifndef SQLITE_OMIT_SUBQUERY
3027/*
dan7b35a772016-07-28 19:47:15 +00003028** Expr pIn is an IN(...) expression. This function checks that the
3029** sub-select on the RHS of the IN() operator has the same number of
3030** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3031** a sub-query, that the LHS is a vector of size 1.
3032*/
3033int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3034 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3035 if( (pIn->flags & EP_xIsSelect) ){
3036 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3037 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3038 return 1;
3039 }
3040 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003041 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003042 return 1;
3043 }
3044 return 0;
3045}
3046#endif
3047
3048#ifndef SQLITE_OMIT_SUBQUERY
3049/*
drhe3365e62009-11-12 17:52:24 +00003050** Generate code for an IN expression.
3051**
3052** x IN (SELECT ...)
3053** x IN (value, value, ...)
3054**
drhecb87ac2016-08-25 15:46:25 +00003055** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003056** right-hand side (RHS) is an array of zero or more scalar values, or a
3057** subquery. If the RHS is a subquery, the number of result columns must
3058** match the number of columns in the vector on the LHS. If the RHS is
3059** a list of values, the LHS must be a scalar.
3060**
3061** The IN operator is true if the LHS value is contained within the RHS.
3062** The result is false if the LHS is definitely not in the RHS. The
3063** result is NULL if the presence of the LHS in the RHS cannot be
3064** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003065**
drh6be515e2014-08-01 21:00:53 +00003066** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003067** contained within the RHS. If due to NULLs we cannot determine if the LHS
3068** is contained in the RHS then jump to destIfNull. If the LHS is contained
3069** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003070**
3071** See the separate in-operator.md documentation file in the canonical
3072** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003073*/
3074static void sqlite3ExprCodeIN(
3075 Parse *pParse, /* Parsing and code generating context */
3076 Expr *pExpr, /* The IN expression */
3077 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3078 int destIfNull /* Jump here if the results are unknown due to NULLs */
3079){
3080 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003081 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003082 int rLhs; /* Register(s) holding the LHS values */
3083 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003084 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003085 int *aiMap = 0; /* Map from vector field to index column */
3086 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003087 int nVector; /* Size of vectors for this IN operator */
3088 int iDummy; /* Dummy parameter to exprCodeVector() */
3089 Expr *pLeft; /* The LHS of the IN operator */
3090 int i; /* loop counter */
3091 int destStep2; /* Where to jump when NULLs seen in step 2 */
3092 int destStep6 = 0; /* Start of code for Step 6 */
3093 int addrTruthOp; /* Address of opcode that determines the IN is true */
3094 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3095 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003096 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003097
drhe347d3e2016-08-25 21:14:34 +00003098 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003099 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003100 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003101 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3102 aiMap = (int*)sqlite3DbMallocZero(
3103 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3104 );
drhe347d3e2016-08-25 21:14:34 +00003105 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003106
danba00e302016-07-23 20:24:06 +00003107 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003108 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003109 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3110 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003111 v = pParse->pVdbe;
3112 assert( v!=0 ); /* OOM detected prior to this routine */
3113 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003114 eType = sqlite3FindInIndex(pParse, pExpr,
3115 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003116 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3117 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003118
danba00e302016-07-23 20:24:06 +00003119 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3120 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3121 );
drhecb87ac2016-08-25 15:46:25 +00003122#ifdef SQLITE_DEBUG
3123 /* Confirm that aiMap[] contains nVector integer values between 0 and
3124 ** nVector-1. */
3125 for(i=0; i<nVector; i++){
3126 int j, cnt;
3127 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3128 assert( cnt==1 );
3129 }
3130#endif
drhe3365e62009-11-12 17:52:24 +00003131
danba00e302016-07-23 20:24:06 +00003132 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3133 ** vector, then it is stored in an array of nVector registers starting
3134 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003135 **
3136 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3137 ** so that the fields are in the same order as an existing index. The
3138 ** aiMap[] array contains a mapping from the original LHS field order to
3139 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003140 */
drhe347d3e2016-08-25 21:14:34 +00003141 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3142 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003143 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003144 /* LHS fields are not reordered */
3145 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003146 }else{
3147 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003148 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003149 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003150 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003151 }
danba00e302016-07-23 20:24:06 +00003152 }
drhe3365e62009-11-12 17:52:24 +00003153
drhbb53ecb2014-08-02 21:03:33 +00003154 /* If sqlite3FindInIndex() did not find or create an index that is
3155 ** suitable for evaluating the IN operator, then evaluate using a
3156 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003157 **
3158 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003159 */
drhbb53ecb2014-08-02 21:03:33 +00003160 if( eType==IN_INDEX_NOOP ){
3161 ExprList *pList = pExpr->x.pList;
3162 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003163 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003164 int r2, regToFree;
3165 int regCkNull = 0;
3166 int ii;
drhdd668c22019-09-02 02:21:58 +00003167 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003168 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003169 if( destIfNull!=destIfFalse ){
3170 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003171 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003172 }
drhdd668c22019-09-02 02:21:58 +00003173 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003174 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003175 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003176 r2 = regToFree = sqlite3GetTempReg(pParse);
3177 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003178 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003179 }else{
3180 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003181 }
drha9769792014-08-04 16:39:39 +00003182 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003183 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3184 }
3185 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003186 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003187 (void*)pColl, P4_COLLSEQ);
3188 VdbeCoverageIf(v, ii<pList->nExpr-1);
3189 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003190 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003191 }else{
3192 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003193 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003194 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003195 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003196 }
3197 sqlite3ReleaseTempReg(pParse, regToFree);
3198 }
3199 if( regCkNull ){
3200 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003201 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003202 }
3203 sqlite3VdbeResolveLabel(v, labelOk);
3204 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003205 goto sqlite3ExprCodeIN_finished;
3206 }
3207
3208 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3209 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3210 ** We will then skip the binary search of the RHS.
3211 */
3212 if( destIfNull==destIfFalse ){
3213 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003214 }else{
drhec4ccdb2018-12-29 02:26:59 +00003215 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003216 }
3217 for(i=0; i<nVector; i++){
3218 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3219 if( sqlite3ExprCanBeNull(p) ){
3220 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003221 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003222 }
drhe3365e62009-11-12 17:52:24 +00003223 }
drhe347d3e2016-08-25 21:14:34 +00003224
3225 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3226 ** of the RHS using the LHS as a probe. If found, the result is
3227 ** true.
3228 */
3229 if( eType==IN_INDEX_ROWID ){
3230 /* In this case, the RHS is the ROWID of table b-tree and so we also
3231 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3232 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003233 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003234 VdbeCoverage(v);
3235 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3236 }else{
3237 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3238 if( destIfFalse==destIfNull ){
3239 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003240 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003241 rLhs, nVector); VdbeCoverage(v);
3242 goto sqlite3ExprCodeIN_finished;
3243 }
3244 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003245 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003246 rLhs, nVector); VdbeCoverage(v);
3247 }
3248
3249 /* Step 4. If the RHS is known to be non-NULL and we did not find
3250 ** an match on the search above, then the result must be FALSE.
3251 */
3252 if( rRhsHasNull && nVector==1 ){
3253 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3254 VdbeCoverage(v);
3255 }
3256
3257 /* Step 5. If we do not care about the difference between NULL and
3258 ** FALSE, then just return false.
3259 */
3260 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3261
3262 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3263 ** If any comparison is NULL, then the result is NULL. If all
3264 ** comparisons are FALSE then the final result is FALSE.
3265 **
3266 ** For a scalar LHS, it is sufficient to check just the first row
3267 ** of the RHS.
3268 */
3269 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003270 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003271 VdbeCoverage(v);
3272 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003273 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003274 }else{
3275 /* For nVector==1, combine steps 6 and 7 by immediately returning
3276 ** FALSE if the first comparison is not NULL */
3277 destNotNull = destIfFalse;
3278 }
3279 for(i=0; i<nVector; i++){
3280 Expr *p;
3281 CollSeq *pColl;
3282 int r3 = sqlite3GetTempReg(pParse);
3283 p = sqlite3VectorFieldSubexpr(pLeft, i);
3284 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003285 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003286 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3287 (void*)pColl, P4_COLLSEQ);
3288 VdbeCoverage(v);
3289 sqlite3ReleaseTempReg(pParse, r3);
3290 }
3291 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3292 if( nVector>1 ){
3293 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003294 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003295 VdbeCoverage(v);
3296
3297 /* Step 7: If we reach this point, we know that the result must
3298 ** be false. */
3299 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3300 }
3301
3302 /* Jumps here in order to return true. */
3303 sqlite3VdbeJumpHere(v, addrTruthOp);
3304
3305sqlite3ExprCodeIN_finished:
3306 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003307 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003308sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003309 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003310 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003311}
3312#endif /* SQLITE_OMIT_SUBQUERY */
3313
drh13573c72010-01-12 17:04:07 +00003314#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003315/*
3316** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003317** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003318**
3319** The z[] string will probably not be zero-terminated. But the
3320** z[n] character is guaranteed to be something that does not look
3321** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003322*/
drhb7916a72009-05-27 10:31:29 +00003323static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003324 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003325 double value;
drh9339da12010-09-30 00:50:49 +00003326 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003327 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3328 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003329 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003330 }
3331}
drh13573c72010-01-12 17:04:07 +00003332#endif
drh598f1342007-10-23 15:39:45 +00003333
3334
3335/*
drhfec19aa2004-05-19 20:41:03 +00003336** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003337** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003338**
shaneh5f1d6b62010-09-30 16:51:25 +00003339** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003340*/
drh13573c72010-01-12 17:04:07 +00003341static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3342 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003343 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003344 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003345 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003346 if( negFlag ) i = -i;
3347 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003348 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003349 int c;
3350 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003351 const char *z = pExpr->u.zToken;
3352 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003353 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003354 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003355#ifdef SQLITE_OMIT_FLOATING_POINT
3356 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3357#else
drh1b7ddc52014-07-23 14:52:05 +00003358#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003359 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003360 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003361 }else
3362#endif
3363 {
drh9296c182014-07-23 13:40:49 +00003364 codeReal(v, z, negFlag, iMem);
3365 }
drh13573c72010-01-12 17:04:07 +00003366#endif
drh77320ea2016-11-30 14:47:37 +00003367 }else{
drh84d4f1a2017-09-20 10:47:10 +00003368 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003369 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003370 }
drhfec19aa2004-05-19 20:41:03 +00003371 }
3372}
3373
drh5cd79232009-05-25 11:46:29 +00003374
drh1f9ca2c2015-08-25 16:57:52 +00003375/* Generate code that will load into register regOut a value that is
3376** appropriate for the iIdxCol-th column of index pIdx.
3377*/
3378void sqlite3ExprCodeLoadIndexColumn(
3379 Parse *pParse, /* The parsing context */
3380 Index *pIdx, /* The index whose column is to be loaded */
3381 int iTabCur, /* Cursor pointing to a table row */
3382 int iIdxCol, /* The column of the index to be loaded */
3383 int regOut /* Store the index column value in this register */
3384){
3385 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003386 if( iTabCol==XN_EXPR ){
3387 assert( pIdx->aColExpr );
3388 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003389 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003390 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003391 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003392 }else{
drh6df9c4b2019-10-18 12:52:08 +00003393 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003394 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003395 }
drh1f9ca2c2015-08-25 16:57:52 +00003396}
3397
drhe70fa7f2019-10-22 21:01:34 +00003398#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3399/*
3400** Generate code that will compute the value of generated column pCol
3401** and store the result in register regOut
3402*/
3403void sqlite3ExprCodeGeneratedColumn(
3404 Parse *pParse,
3405 Column *pCol,
3406 int regOut
3407){
3408 sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3409 if( pCol->affinity>=SQLITE_AFF_TEXT ){
3410 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Affinity, regOut, 1, 0,
3411 &pCol->affinity, 1);
3412 }
3413}
3414#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3415
drh5cd79232009-05-25 11:46:29 +00003416/*
drh5c092e82010-05-14 19:24:02 +00003417** Generate code to extract the value of the iCol-th column of a table.
3418*/
3419void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003420 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003421 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003422 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003423 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003424 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003425){
drhab45fc02019-10-16 22:01:56 +00003426 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003427 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003428 if( pTab==0 ){
3429 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3430 return;
3431 }
drh5c092e82010-05-14 19:24:02 +00003432 if( iCol<0 || iCol==pTab->iPKey ){
3433 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3434 }else{
drh81f7b372019-10-16 12:18:59 +00003435 int op;
3436 int x;
3437 if( IsVirtual(pTab) ){
3438 op = OP_VColumn;
3439 x = iCol;
3440#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003441 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003442 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003443 if( pCol->colFlags & COLFLAG_BUSY ){
3444 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3445 }else{
3446 int savedSelfTab = pParse->iSelfTab;
3447 pCol->colFlags |= COLFLAG_BUSY;
3448 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003449 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003450 pParse->iSelfTab = savedSelfTab;
3451 pCol->colFlags &= ~COLFLAG_BUSY;
3452 }
drh81f7b372019-10-16 12:18:59 +00003453 return;
3454#endif
3455 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003456 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003457 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003458 op = OP_Column;
3459 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003460 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003461 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003462 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003463 }
3464 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003465 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3466 }
3467}
3468
3469/*
drh945498f2007-02-24 11:52:52 +00003470** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003471** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003472**
3473** There must be an open cursor to pTab in iTable when this routine
3474** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003475*/
drhe55cbd72008-03-31 23:48:03 +00003476int sqlite3ExprCodeGetColumn(
3477 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003478 Table *pTab, /* Description of the table we are reading from */
3479 int iColumn, /* Index of the table column */
3480 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003481 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003482 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003483){
drh81f7b372019-10-16 12:18:59 +00003484 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003485 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003486 if( p5 ){
drh81f7b372019-10-16 12:18:59 +00003487 sqlite3VdbeChangeP5(pParse->pVdbe, p5);
drha748fdc2012-03-28 01:34:47 +00003488 }
drhe55cbd72008-03-31 23:48:03 +00003489 return iReg;
3490}
drhe55cbd72008-03-31 23:48:03 +00003491
3492/*
drhb21e7c72008-06-22 12:37:57 +00003493** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003494** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003495*/
drhb21e7c72008-06-22 12:37:57 +00003496void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003497 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003498 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003499}
3500
drh652fbf52008-04-01 01:42:41 +00003501/*
drh12abf402016-08-22 14:30:05 +00003502** Convert a scalar expression node to a TK_REGISTER referencing
3503** register iReg. The caller must ensure that iReg already contains
3504** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003505*/
dan069d1b12019-06-16 08:58:14 +00003506static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003507 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003508 p->op2 = p->op;
3509 p->op = TK_REGISTER;
3510 p->iTable = iReg;
3511 ExprClearProperty(p, EP_Skip);
3512}
3513
drh12abf402016-08-22 14:30:05 +00003514/*
3515** Evaluate an expression (either a vector or a scalar expression) and store
3516** the result in continguous temporary registers. Return the index of
3517** the first register used to store the result.
3518**
3519** If the returned result register is a temporary scalar, then also write
3520** that register number into *piFreeable. If the returned result register
3521** is not a temporary or if the expression is a vector set *piFreeable
3522** to 0.
3523*/
3524static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3525 int iResult;
3526 int nResult = sqlite3ExprVectorSize(p);
3527 if( nResult==1 ){
3528 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3529 }else{
3530 *piFreeable = 0;
3531 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003532#if SQLITE_OMIT_SUBQUERY
3533 iResult = 0;
3534#else
drh85bcdce2018-12-23 21:27:29 +00003535 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003536#endif
drh12abf402016-08-22 14:30:05 +00003537 }else{
3538 int i;
3539 iResult = pParse->nMem+1;
3540 pParse->nMem += nResult;
3541 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003542 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003543 }
3544 }
3545 }
3546 return iResult;
3547}
3548
dan71c57db2016-07-09 20:23:55 +00003549
drha4c3c872013-09-12 17:29:25 +00003550/*
drhcce7d172000-05-31 15:34:51 +00003551** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003552** expression. Attempt to store the results in register "target".
3553** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003554**
drh8b213892008-08-29 02:14:02 +00003555** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003556** be stored in target. The result might be stored in some other
3557** register if it is convenient to do so. The calling function
3558** must check the return code and move the results to the desired
3559** register.
drhcce7d172000-05-31 15:34:51 +00003560*/
drh678ccce2008-03-31 18:19:54 +00003561int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003562 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3563 int op; /* The opcode being coded */
3564 int inReg = target; /* Results stored in register inReg */
3565 int regFree1 = 0; /* If non-zero free this temporary register */
3566 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003567 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003568 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003569 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003570
drh9cbf3422008-01-17 16:22:13 +00003571 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003572 if( v==0 ){
3573 assert( pParse->db->mallocFailed );
3574 return 0;
3575 }
drh389a1ad2008-01-03 23:44:53 +00003576
drh1efa8022018-04-28 04:16:43 +00003577expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003578 if( pExpr==0 ){
3579 op = TK_NULL;
3580 }else{
3581 op = pExpr->op;
3582 }
drhf2bc0132004-10-04 13:19:23 +00003583 switch( op ){
drh13449892005-09-07 21:22:45 +00003584 case TK_AGG_COLUMN: {
3585 AggInfo *pAggInfo = pExpr->pAggInfo;
3586 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3587 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003588 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003589 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003590 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003591 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003592 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003593 return target;
drh13449892005-09-07 21:22:45 +00003594 }
3595 /* Otherwise, fall thru into the TK_COLUMN case */
3596 }
drh967e8b72000-06-21 13:59:10 +00003597 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003598 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003599 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003600 /* This COLUMN expression is really a constant due to WHERE clause
3601 ** constraints, and that constant is coded by the pExpr->pLeft
3602 ** expresssion. However, make sure the constant has the correct
3603 ** datatype by applying the Affinity of the table column to the
3604 ** constant.
3605 */
3606 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003607 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00003608 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003609 static const char zAff[] = "B\000C\000D\000E";
3610 assert( SQLITE_AFF_BLOB=='A' );
3611 assert( SQLITE_AFF_TEXT=='B' );
3612 if( iReg!=target ){
3613 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3614 iReg = target;
3615 }
3616 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3617 &zAff[(aff-'B')*2], P4_STATIC);
3618 }
3619 return iReg;
drhefad2e22018-07-27 16:57:11 +00003620 }
drhb2b9d3d2013-08-01 01:14:43 +00003621 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003622 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003623 /* Other columns in the same row for CHECK constraints or
3624 ** generated columns or for inserting into partial index.
3625 ** The row is unpacked into registers beginning at
3626 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3627 ** immediately prior to the first column.
3628 */
3629 Column *pCol;
3630 Table *pTab = pExpr->y.pTab;
3631 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003632 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003633 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003634 assert( iCol>=XN_ROWID );
3635 assert( iCol<pExpr->y.pTab->nCol );
3636 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003637 return -1-pParse->iSelfTab;
3638 }
drhc5f808d2019-10-19 15:01:52 +00003639 pCol = pTab->aCol + iCol;
3640 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3641 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003642#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3643 if( pCol->colFlags & COLFLAG_GENERATED ){
3644 if( pCol->colFlags & COLFLAG_BUSY ){
3645 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3646 pCol->zName);
3647 return 0;
3648 }
3649 pCol->colFlags |= COLFLAG_BUSY;
drhdd6cc9b2019-10-19 18:47:27 +00003650 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
drhe70fa7f2019-10-22 21:01:34 +00003651 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
drh9942ef02019-10-18 02:19:18 +00003652 }
3653 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003654 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003655 }else
3656#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3657 if( pCol->affinity==SQLITE_AFF_REAL ){
3658 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003659 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3660 return target;
3661 }else{
drh9942ef02019-10-18 02:19:18 +00003662 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003663 }
drhb2b9d3d2013-08-01 01:14:43 +00003664 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003665 /* Coding an expression that is part of an index where column names
3666 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003667 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003668 }
drh22827922000-06-06 17:27:05 +00003669 }
drheda079c2018-09-20 19:02:15 +00003670 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003671 pExpr->iColumn, iTab, target,
3672 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003673 }
3674 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003675 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003676 return target;
drhfec19aa2004-05-19 20:41:03 +00003677 }
drh8abed7b2018-02-26 18:49:05 +00003678 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003679 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003680 return target;
3681 }
drh13573c72010-01-12 17:04:07 +00003682#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003683 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003684 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3685 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003686 return target;
drh598f1342007-10-23 15:39:45 +00003687 }
drh13573c72010-01-12 17:04:07 +00003688#endif
drhfec19aa2004-05-19 20:41:03 +00003689 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003690 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003691 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003692 return target;
drhcce7d172000-05-31 15:34:51 +00003693 }
drhf0863fe2005-06-12 21:35:51 +00003694 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003695 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003696 return target;
drhf0863fe2005-06-12 21:35:51 +00003697 }
danielk19775338a5f2005-01-20 13:03:10 +00003698#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003699 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003700 int n;
3701 const char *z;
drhca48c902008-01-18 14:08:24 +00003702 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003703 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3704 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3705 assert( pExpr->u.zToken[1]=='\'' );
3706 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003707 n = sqlite3Strlen30(z) - 1;
3708 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003709 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3710 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003711 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003712 }
danielk19775338a5f2005-01-20 13:03:10 +00003713#endif
drh50457892003-09-06 01:10:47 +00003714 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003715 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3716 assert( pExpr->u.zToken!=0 );
3717 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003718 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3719 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003720 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003721 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003722 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003723 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003724 }
drhc332cc32016-09-19 10:24:19 +00003725 return target;
drh50457892003-09-06 01:10:47 +00003726 }
drh4e0cff62004-11-05 05:10:28 +00003727 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003728 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003729 }
drh487e2622005-06-25 18:42:14 +00003730#ifndef SQLITE_OMIT_CAST
3731 case TK_CAST: {
3732 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003733 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003734 if( inReg!=target ){
3735 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3736 inReg = target;
3737 }
drh4169e432014-08-25 20:11:52 +00003738 sqlite3VdbeAddOp2(v, OP_Cast, target,
3739 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003740 return inReg;
drh487e2622005-06-25 18:42:14 +00003741 }
3742#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003743 case TK_IS:
3744 case TK_ISNOT:
3745 op = (op==TK_IS) ? TK_EQ : TK_NE;
3746 p5 = SQLITE_NULLEQ;
3747 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003748 case TK_LT:
3749 case TK_LE:
3750 case TK_GT:
3751 case TK_GE:
3752 case TK_NE:
3753 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003754 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003755 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003756 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003757 }else{
3758 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3759 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3760 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00003761 r1, r2, inReg, SQLITE_STOREP2 | p5,
3762 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00003763 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3764 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3765 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3766 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3767 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3768 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3769 testcase( regFree1==0 );
3770 testcase( regFree2==0 );
3771 }
drh6a2fe092009-09-23 02:29:36 +00003772 break;
3773 }
drhcce7d172000-05-31 15:34:51 +00003774 case TK_AND:
3775 case TK_OR:
3776 case TK_PLUS:
3777 case TK_STAR:
3778 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003779 case TK_REM:
3780 case TK_BITAND:
3781 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003782 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003783 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003784 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003785 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003786 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3787 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3788 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3789 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3790 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3791 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3792 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3793 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3794 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3795 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3796 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003797 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3798 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003799 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003800 testcase( regFree1==0 );
3801 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003802 break;
3803 }
drhcce7d172000-05-31 15:34:51 +00003804 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003805 Expr *pLeft = pExpr->pLeft;
3806 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003807 if( pLeft->op==TK_INTEGER ){
3808 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003809 return target;
drh13573c72010-01-12 17:04:07 +00003810#ifndef SQLITE_OMIT_FLOATING_POINT
3811 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003812 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3813 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003814 return target;
drh13573c72010-01-12 17:04:07 +00003815#endif
drh3c84ddf2008-01-09 02:15:38 +00003816 }else{
drh10d1edf2013-11-15 15:52:39 +00003817 tempX.op = TK_INTEGER;
3818 tempX.flags = EP_IntValue|EP_TokenOnly;
3819 tempX.u.iValue = 0;
3820 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003821 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003822 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003823 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003824 }
drh3c84ddf2008-01-09 02:15:38 +00003825 break;
drh6e142f52000-06-08 13:36:40 +00003826 }
drhbf4133c2001-10-13 02:59:08 +00003827 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003828 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003829 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3830 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003831 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3832 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003833 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003834 break;
3835 }
drh8abed7b2018-02-26 18:49:05 +00003836 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003837 int isTrue; /* IS TRUE or IS NOT TRUE */
3838 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003839 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3840 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003841 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3842 bNormal = pExpr->op2==TK_IS;
3843 testcase( isTrue && bNormal);
3844 testcase( !isTrue && bNormal);
3845 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003846 break;
3847 }
drhcce7d172000-05-31 15:34:51 +00003848 case TK_ISNULL:
3849 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003850 int addr;
drh7d176102014-02-18 03:07:12 +00003851 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3852 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003853 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003854 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003855 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003856 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003857 VdbeCoverageIf(v, op==TK_ISNULL);
3858 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003859 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003860 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003861 break;
drhcce7d172000-05-31 15:34:51 +00003862 }
drh22827922000-06-06 17:27:05 +00003863 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003864 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003865 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003866 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3867 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003868 }else{
drhc332cc32016-09-19 10:24:19 +00003869 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003870 }
drh22827922000-06-06 17:27:05 +00003871 break;
3872 }
drhcce7d172000-05-31 15:34:51 +00003873 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003874 ExprList *pFarg; /* List of function arguments */
3875 int nFarg; /* Number of function arguments */
3876 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003877 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003878 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003879 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003880 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003881 u8 enc = ENC(db); /* The text encoding used by this database */
3882 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003883
dan67a9b8e2018-06-22 20:51:35 +00003884#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003885 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3886 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003887 }
dan67a9b8e2018-06-22 20:51:35 +00003888#endif
dan86fb6e12018-05-16 20:58:07 +00003889
drh1e9b53f2017-01-04 01:07:24 +00003890 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003891 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003892 ** out of the inner loop, even if that means an extra OP_Copy. */
3893 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003894 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003895 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003896 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003897 pFarg = 0;
3898 }else{
3899 pFarg = pExpr->x.pList;
3900 }
3901 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003902 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3903 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003904 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003905#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3906 if( pDef==0 && pParse->explain ){
3907 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3908 }
3909#endif
danb6e9f7a2018-05-19 14:15:29 +00003910 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003911 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003912 break;
3913 }
drhae6bb952009-11-11 00:24:31 +00003914
3915 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003916 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003917 ** arguments past the first non-NULL argument.
3918 */
drhd36e1042013-09-06 13:10:12 +00003919 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003920 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003921 assert( nFarg>=2 );
3922 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3923 for(i=1; i<nFarg; i++){
3924 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003925 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003926 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003927 }
3928 sqlite3VdbeResolveLabel(v, endCoalesce);
3929 break;
3930 }
3931
drhcca9f3d2013-09-06 15:23:29 +00003932 /* The UNLIKELY() function is a no-op. The result is the value
3933 ** of the first argument.
3934 */
3935 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3936 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003937 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003938 }
drhae6bb952009-11-11 00:24:31 +00003939
drh54240752017-01-03 14:39:30 +00003940#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003941 /* The AFFINITY() function evaluates to a string that describes
3942 ** the type affinity of the argument. This is used for testing of
3943 ** the SQLite type logic.
3944 */
3945 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3946 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3947 char aff;
3948 assert( nFarg==1 );
3949 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3950 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003951 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003952 return target;
3953 }
drh54240752017-01-03 14:39:30 +00003954#endif
drha1a523a2016-12-26 00:18:36 +00003955
drhd1a01ed2013-11-21 16:08:52 +00003956 for(i=0; i<nFarg; i++){
3957 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003958 testcase( i==31 );
3959 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003960 }
3961 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3962 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3963 }
3964 }
drh12ffee82009-04-08 13:51:51 +00003965 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003966 if( constMask ){
3967 r1 = pParse->nMem+1;
3968 pParse->nMem += nFarg;
3969 }else{
3970 r1 = sqlite3GetTempRange(pParse, nFarg);
3971 }
drha748fdc2012-03-28 01:34:47 +00003972
3973 /* For length() and typeof() functions with a column argument,
3974 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3975 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3976 ** loading.
3977 */
drhd36e1042013-09-06 13:10:12 +00003978 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003979 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003980 assert( nFarg==1 );
3981 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003982 exprOp = pFarg->a[0].pExpr->op;
3983 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003984 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3985 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003986 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3987 pFarg->a[0].pExpr->op2 =
3988 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003989 }
3990 }
3991
drh5579d592015-08-26 14:01:41 +00003992 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003993 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003994 }else{
drh12ffee82009-04-08 13:51:51 +00003995 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003996 }
drhb7f6f682006-07-08 17:06:43 +00003997#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003998 /* Possibly overload the function if the first argument is
3999 ** a virtual table column.
4000 **
4001 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4002 ** second argument, not the first, as the argument to test to
4003 ** see if it is a column in a virtual table. This is done because
4004 ** the left operand of infix functions (the operand we want to
4005 ** control overloading) ends up as the second argument to the
4006 ** function. The expression "A glob B" is equivalent to
4007 ** "glob(B,A). We want to use the A in "A glob B" to test
4008 ** for function overloading. But we use the B term in "glob(B,A)".
4009 */
drh59155062018-05-26 18:03:48 +00004010 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004011 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4012 }else if( nFarg>0 ){
4013 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004014 }
4015#endif
drhd36e1042013-09-06 13:10:12 +00004016 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004017 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004018 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004019 }
drh092457b2017-12-29 15:04:49 +00004020#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4021 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004022 Expr *pArg = pFarg->a[0].pExpr;
4023 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004024 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004025 }else{
4026 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4027 }
drh092457b2017-12-29 15:04:49 +00004028 }else
4029#endif
4030 {
drh2fc865c2017-12-16 20:20:37 +00004031 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
4032 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
4033 sqlite3VdbeChangeP5(v, (u8)nFarg);
4034 }
drhd1a01ed2013-11-21 16:08:52 +00004035 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00004036 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00004037 }
drhc332cc32016-09-19 10:24:19 +00004038 return target;
drhcce7d172000-05-31 15:34:51 +00004039 }
drhfe2093d2005-01-20 22:48:47 +00004040#ifndef SQLITE_OMIT_SUBQUERY
4041 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004042 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004043 int nCol;
drhc5499be2008-04-01 15:06:33 +00004044 testcase( op==TK_EXISTS );
4045 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004046 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4047 sqlite3SubselectError(pParse, nCol, 1);
4048 }else{
drh85bcdce2018-12-23 21:27:29 +00004049 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004050 }
drh19a775c2000-06-05 18:54:46 +00004051 break;
4052 }
drhfc7f27b2016-08-20 00:07:01 +00004053 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004054 int n;
drhfc7f27b2016-08-20 00:07:01 +00004055 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004056 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004057 }
drh966e2912017-01-03 02:58:01 +00004058 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004059 if( pExpr->iTable!=0
4060 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004061 ){
4062 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4063 pExpr->iTable, n);
4064 }
drhc332cc32016-09-19 10:24:19 +00004065 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004066 }
drhfef52082000-06-06 01:50:43 +00004067 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004068 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4069 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004070 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4071 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4072 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4073 sqlite3VdbeResolveLabel(v, destIfFalse);
4074 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4075 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004076 return target;
drhfef52082000-06-06 01:50:43 +00004077 }
drhe3365e62009-11-12 17:52:24 +00004078#endif /* SQLITE_OMIT_SUBQUERY */
4079
4080
drh2dcef112008-01-12 19:03:48 +00004081 /*
4082 ** x BETWEEN y AND z
4083 **
4084 ** This is equivalent to
4085 **
4086 ** x>=y AND x<=z
4087 **
4088 ** X is stored in pExpr->pLeft.
4089 ** Y is stored in pExpr->pList->a[0].pExpr.
4090 ** Z is stored in pExpr->pList->a[1].pExpr.
4091 */
drhfef52082000-06-06 01:50:43 +00004092 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004093 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004094 return target;
drhfef52082000-06-06 01:50:43 +00004095 }
drh94fa9c42016-02-27 21:16:04 +00004096 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004097 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004098 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004099 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004100 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004101 }
drh2dcef112008-01-12 19:03:48 +00004102
dan165921a2009-08-28 18:53:45 +00004103 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004104 /* If the opcode is TK_TRIGGER, then the expression is a reference
4105 ** to a column in the new.* or old.* pseudo-tables available to
4106 ** trigger programs. In this case Expr.iTable is set to 1 for the
4107 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4108 ** is set to the column of the pseudo-table to read, or to -1 to
4109 ** read the rowid field.
4110 **
4111 ** The expression is implemented using an OP_Param opcode. The p1
4112 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4113 ** to reference another column of the old.* pseudo-table, where
4114 ** i is the index of the column. For a new.rowid reference, p1 is
4115 ** set to (n+1), where n is the number of columns in each pseudo-table.
4116 ** For a reference to any other column in the new.* pseudo-table, p1
4117 ** is set to (n+2+i), where n and i are as defined previously. For
4118 ** example, if the table on which triggers are being fired is
4119 ** declared as:
4120 **
4121 ** CREATE TABLE t1(a, b);
4122 **
4123 ** Then p1 is interpreted as follows:
4124 **
4125 ** p1==0 -> old.rowid p1==3 -> new.rowid
4126 ** p1==1 -> old.a p1==4 -> new.a
4127 ** p1==2 -> old.b p1==5 -> new.b
4128 */
drheda079c2018-09-20 19:02:15 +00004129 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004130 int iCol = pExpr->iColumn;
4131 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
4132 + (iCol>=0 ? sqlite3TableColumnToStorage(pTab, iCol) : -1);
dan65a7cd12009-09-01 12:16:01 +00004133
4134 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004135 assert( iCol>=-1 && iCol<pTab->nCol );
4136 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004137 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4138
4139 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004140 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004141 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004142 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004143 ));
dan65a7cd12009-09-01 12:16:01 +00004144
drh44dbca82010-01-13 04:22:20 +00004145#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004146 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004147 ** integer. Use OP_RealAffinity to make sure it is really real.
4148 **
4149 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4150 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004151 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004152 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4153 }
drh44dbca82010-01-13 04:22:20 +00004154#endif
dan165921a2009-08-28 18:53:45 +00004155 break;
4156 }
4157
dan71c57db2016-07-09 20:23:55 +00004158 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004159 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004160 break;
4161 }
4162
drh9e9a67a2019-08-17 17:07:15 +00004163 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4164 ** that derive from the right-hand table of a LEFT JOIN. The
4165 ** Expr.iTable value is the table number for the right-hand table.
4166 ** The expression is only evaluated if that table is not currently
4167 ** on a LEFT JOIN NULL row.
4168 */
drh31d6fd52017-04-14 19:03:10 +00004169 case TK_IF_NULL_ROW: {
4170 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004171 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004172 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004173 /* Temporarily disable factoring of constant expressions, since
4174 ** even though expressions may appear to be constant, they are not
4175 ** really constant because they originate from the right-hand side
4176 ** of a LEFT JOIN. */
4177 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004178 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004179 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004180 sqlite3VdbeJumpHere(v, addrINR);
4181 sqlite3VdbeChangeP3(v, addrINR, inReg);
4182 break;
4183 }
4184
drh2dcef112008-01-12 19:03:48 +00004185 /*
4186 ** Form A:
4187 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4188 **
4189 ** Form B:
4190 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4191 **
4192 ** Form A is can be transformed into the equivalent form B as follows:
4193 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4194 ** WHEN x=eN THEN rN ELSE y END
4195 **
4196 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004197 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4198 ** odd. The Y is also optional. If the number of elements in x.pList
4199 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004200 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4201 **
4202 ** The result of the expression is the Ri for the first matching Ei,
4203 ** or if there is no matching Ei, the ELSE term Y, or if there is
4204 ** no ELSE term, NULL.
4205 */
drh33cd4902009-05-30 20:49:20 +00004206 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004207 int endLabel; /* GOTO label for end of CASE stmt */
4208 int nextCase; /* GOTO label for next WHEN clause */
4209 int nExpr; /* 2x number of WHEN terms */
4210 int i; /* Loop counter */
4211 ExprList *pEList; /* List of WHEN terms */
4212 struct ExprList_item *aListelem; /* Array of WHEN terms */
4213 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004214 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004215 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004216 Expr *pDel = 0;
4217 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004218
danielk19776ab3a2e2009-02-19 14:39:25 +00004219 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004220 assert(pExpr->x.pList->nExpr > 0);
4221 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004222 aListelem = pEList->a;
4223 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004224 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004225 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004226 pDel = sqlite3ExprDup(db, pX, 0);
4227 if( db->mallocFailed ){
4228 sqlite3ExprDelete(db, pDel);
4229 break;
4230 }
drh33cd4902009-05-30 20:49:20 +00004231 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004232 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004233 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004234 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004235 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004236 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004237 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004238 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4239 ** The value in regFree1 might get SCopy-ed into the file result.
4240 ** So make sure that the regFree1 register is not reused for other
4241 ** purposes and possibly overwritten. */
4242 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004243 }
drhc5cd1242013-09-12 16:50:49 +00004244 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004245 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004246 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004247 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004248 }else{
drh2dcef112008-01-12 19:03:48 +00004249 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004250 }
drhec4ccdb2018-12-29 02:26:59 +00004251 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004252 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004253 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004254 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004255 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004256 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004257 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004258 }
drhc5cd1242013-09-12 16:50:49 +00004259 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004260 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004261 }else{
drh9de221d2008-01-05 06:51:30 +00004262 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004263 }
dan8b65e592019-07-17 14:34:17 +00004264 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004265 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004266 break;
4267 }
danielk19775338a5f2005-01-20 13:03:10 +00004268#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004269 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004270 assert( pExpr->affExpr==OE_Rollback
4271 || pExpr->affExpr==OE_Abort
4272 || pExpr->affExpr==OE_Fail
4273 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004274 );
dane0af83a2009-09-08 19:15:01 +00004275 if( !pParse->pTriggerTab ){
4276 sqlite3ErrorMsg(pParse,
4277 "RAISE() may only be used within a trigger-program");
4278 return 0;
4279 }
drh11949042019-08-05 18:01:42 +00004280 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004281 sqlite3MayAbort(pParse);
4282 }
dan165921a2009-08-28 18:53:45 +00004283 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004284 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004285 sqlite3VdbeAddOp4(
4286 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004287 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004288 }else{
drh433dccf2013-02-09 15:37:11 +00004289 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004290 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004291 }
4292
drhffe07b22005-11-03 00:41:17 +00004293 break;
drh17a7f8d2002-03-24 13:13:27 +00004294 }
danielk19775338a5f2005-01-20 13:03:10 +00004295#endif
drhffe07b22005-11-03 00:41:17 +00004296 }
drh2dcef112008-01-12 19:03:48 +00004297 sqlite3ReleaseTempReg(pParse, regFree1);
4298 sqlite3ReleaseTempReg(pParse, regFree2);
4299 return inReg;
4300}
4301
4302/*
drhd1a01ed2013-11-21 16:08:52 +00004303** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004304**
drhad879ff2017-01-04 04:10:02 +00004305** If regDest>=0 then the result is always stored in that register and the
4306** result is not reusable. If regDest<0 then this routine is free to
4307** store the value whereever it wants. The register where the expression
4308** is stored is returned. When regDest<0, two identical expressions will
4309** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004310*/
drh1e9b53f2017-01-04 01:07:24 +00004311int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004312 Parse *pParse, /* Parsing context */
4313 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004314 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004315){
drhd1a01ed2013-11-21 16:08:52 +00004316 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004317 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004318 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004319 if( regDest<0 && p ){
4320 struct ExprList_item *pItem;
4321 int i;
4322 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004323 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004324 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004325 }
4326 }
drh1e9b53f2017-01-04 01:07:24 +00004327 }
drhd1a01ed2013-11-21 16:08:52 +00004328 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4329 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004330 if( p ){
4331 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004332 pItem->reusable = regDest<0;
4333 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004334 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004335 }
drhd1a01ed2013-11-21 16:08:52 +00004336 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004337 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004338}
4339
4340/*
drh2dcef112008-01-12 19:03:48 +00004341** Generate code to evaluate an expression and store the results
4342** into a register. Return the register number where the results
4343** are stored.
4344**
4345** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004346** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004347** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004348**
4349** If pExpr is a constant, then this routine might generate this
4350** code to fill the register in the initialization section of the
4351** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004352*/
4353int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004354 int r2;
drh0d950af2019-08-22 16:38:42 +00004355 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004356 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004357 && pExpr->op!=TK_REGISTER
4358 && sqlite3ExprIsConstantNotJoin(pExpr)
4359 ){
drhf30a9692013-11-15 01:10:18 +00004360 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004361 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004362 }else{
drhf30a9692013-11-15 01:10:18 +00004363 int r1 = sqlite3GetTempReg(pParse);
4364 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4365 if( r2==r1 ){
4366 *pReg = r1;
4367 }else{
4368 sqlite3ReleaseTempReg(pParse, r1);
4369 *pReg = 0;
4370 }
drh2dcef112008-01-12 19:03:48 +00004371 }
4372 return r2;
4373}
4374
4375/*
4376** Generate code that will evaluate expression pExpr and store the
4377** results in register target. The results are guaranteed to appear
4378** in register target.
4379*/
drh05a86c52014-02-16 01:55:49 +00004380void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004381 int inReg;
4382
4383 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004384 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4385 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4386 if( inReg!=target && pParse->pVdbe ){
4387 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004388 }
drhcce7d172000-05-31 15:34:51 +00004389}
4390
4391/*
drh1c75c9d2015-12-21 15:22:13 +00004392** Make a transient copy of expression pExpr and then code it using
4393** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4394** except that the input expression is guaranteed to be unchanged.
4395*/
4396void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4397 sqlite3 *db = pParse->db;
4398 pExpr = sqlite3ExprDup(db, pExpr, 0);
4399 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4400 sqlite3ExprDelete(db, pExpr);
4401}
4402
4403/*
drh05a86c52014-02-16 01:55:49 +00004404** Generate code that will evaluate expression pExpr and store the
4405** results in register target. The results are guaranteed to appear
4406** in register target. If the expression is constant, then this routine
4407** might choose to code the expression at initialization time.
4408*/
4409void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004410 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004411 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004412 }else{
4413 sqlite3ExprCode(pParse, pExpr, target);
4414 }
drhcce7d172000-05-31 15:34:51 +00004415}
4416
4417/*
drh268380c2004-02-25 13:47:31 +00004418** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004419** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004420**
drh3df6c3b2017-09-15 15:38:01 +00004421** Return the number of elements evaluated. The number returned will
4422** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4423** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004424**
4425** The SQLITE_ECEL_DUP flag prevents the arguments from being
4426** filled using OP_SCopy. OP_Copy must be used instead.
4427**
4428** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4429** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004430**
4431** The SQLITE_ECEL_REF flag means that expressions in the list with
4432** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4433** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004434** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4435** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004436*/
danielk19774adee202004-05-08 08:23:19 +00004437int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004438 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004439 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004440 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004441 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004442 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004443){
4444 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004445 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004446 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004447 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004448 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004449 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004450 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004451 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004452 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004453 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004454 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004455#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4456 if( pItem->bSorterRef ){
4457 i--;
4458 n--;
4459 }else
4460#endif
dan257c13f2016-11-10 20:14:06 +00004461 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4462 if( flags & SQLITE_ECEL_OMITREF ){
4463 i--;
4464 n--;
4465 }else{
4466 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4467 }
drhb8b06692018-08-04 15:16:20 +00004468 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4469 && sqlite3ExprIsConstantNotJoin(pExpr)
4470 ){
drhad879ff2017-01-04 04:10:02 +00004471 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004472 }else{
4473 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4474 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004475 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004476 if( copyOp==OP_Copy
4477 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4478 && pOp->p1+pOp->p3+1==inReg
4479 && pOp->p2+pOp->p3+1==target+i
4480 ){
4481 pOp->p3++;
4482 }else{
4483 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4484 }
drhd1a01ed2013-11-21 16:08:52 +00004485 }
drhd1766112008-09-17 00:13:12 +00004486 }
drh268380c2004-02-25 13:47:31 +00004487 }
drhf9b596e2004-05-26 16:54:42 +00004488 return n;
drh268380c2004-02-25 13:47:31 +00004489}
4490
4491/*
drh36c563a2009-11-12 13:32:22 +00004492** Generate code for a BETWEEN operator.
4493**
4494** x BETWEEN y AND z
4495**
4496** The above is equivalent to
4497**
4498** x>=y AND x<=z
4499**
4500** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004501** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004502**
4503** The xJumpIf parameter determines details:
4504**
4505** NULL: Store the boolean result in reg[dest]
4506** sqlite3ExprIfTrue: Jump to dest if true
4507** sqlite3ExprIfFalse: Jump to dest if false
4508**
4509** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004510*/
4511static void exprCodeBetween(
4512 Parse *pParse, /* Parsing and code generating context */
4513 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004514 int dest, /* Jump destination or storage location */
4515 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004516 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4517){
dan8b65e592019-07-17 14:34:17 +00004518 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004519 Expr compLeft; /* The x>=y term */
4520 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004521 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004522 Expr *pDel = 0;
4523 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004524
dan71c57db2016-07-09 20:23:55 +00004525 memset(&compLeft, 0, sizeof(Expr));
4526 memset(&compRight, 0, sizeof(Expr));
4527 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004528
4529 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004530 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4531 if( db->mallocFailed==0 ){
4532 exprAnd.op = TK_AND;
4533 exprAnd.pLeft = &compLeft;
4534 exprAnd.pRight = &compRight;
4535 compLeft.op = TK_GE;
4536 compLeft.pLeft = pDel;
4537 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4538 compRight.op = TK_LE;
4539 compRight.pLeft = pDel;
4540 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4541 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4542 if( xJump ){
4543 xJump(pParse, &exprAnd, dest, jumpIfNull);
4544 }else{
4545 /* Mark the expression is being from the ON or USING clause of a join
4546 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4547 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4548 ** for clarity, but we are out of bits in the Expr.flags field so we
4549 ** have to reuse the EP_FromJoin bit. Bummer. */
4550 pDel->flags |= EP_FromJoin;
4551 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4552 }
4553 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004554 }
dan8b65e592019-07-17 14:34:17 +00004555 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004556
4557 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004558 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4559 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4560 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4561 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4562 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4563 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4564 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4565 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004566 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004567}
4568
4569/*
drhcce7d172000-05-31 15:34:51 +00004570** Generate code for a boolean expression such that a jump is made
4571** to the label "dest" if the expression is true but execution
4572** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004573**
4574** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004575** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004576**
4577** This code depends on the fact that certain token values (ex: TK_EQ)
4578** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4579** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4580** the make process cause these values to align. Assert()s in the code
4581** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004582*/
danielk19774adee202004-05-08 08:23:19 +00004583void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004584 Vdbe *v = pParse->pVdbe;
4585 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004586 int regFree1 = 0;
4587 int regFree2 = 0;
4588 int r1, r2;
4589
drh35573352008-01-08 23:54:25 +00004590 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004591 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004592 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004593 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004594 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004595 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004596 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004597 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4598 if( pAlt!=pExpr ){
4599 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4600 }else if( op==TK_AND ){
4601 int d2 = sqlite3VdbeMakeLabel(pParse);
4602 testcase( jumpIfNull==0 );
4603 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4604 jumpIfNull^SQLITE_JUMPIFNULL);
4605 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4606 sqlite3VdbeResolveLabel(v, d2);
4607 }else{
4608 testcase( jumpIfNull==0 );
4609 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4610 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4611 }
drhcce7d172000-05-31 15:34:51 +00004612 break;
4613 }
4614 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004615 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004616 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004617 break;
4618 }
drh8abed7b2018-02-26 18:49:05 +00004619 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004620 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4621 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004622 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004623 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004624 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004625 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004626 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004627 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004628 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4629 isNot ? SQLITE_JUMPIFNULL : 0);
4630 }else{
4631 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4632 isNot ? SQLITE_JUMPIFNULL : 0);
4633 }
drh007c8432018-02-26 03:20:18 +00004634 break;
4635 }
drhde845c22016-03-17 19:07:52 +00004636 case TK_IS:
4637 case TK_ISNOT:
4638 testcase( op==TK_IS );
4639 testcase( op==TK_ISNOT );
4640 op = (op==TK_IS) ? TK_EQ : TK_NE;
4641 jumpIfNull = SQLITE_NULLEQ;
4642 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004643 case TK_LT:
4644 case TK_LE:
4645 case TK_GT:
4646 case TK_GE:
4647 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004648 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004649 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004650 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004651 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4652 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004653 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004654 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004655 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4656 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4657 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4658 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004659 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4660 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4661 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4662 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4663 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4664 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004665 testcase( regFree1==0 );
4666 testcase( regFree2==0 );
4667 break;
4668 }
drhcce7d172000-05-31 15:34:51 +00004669 case TK_ISNULL:
4670 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004671 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4672 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004673 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4674 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004675 VdbeCoverageIf(v, op==TK_ISNULL);
4676 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004677 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004678 break;
4679 }
drhfef52082000-06-06 01:50:43 +00004680 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004681 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004682 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004683 break;
4684 }
drh84e30ca2011-02-10 17:46:14 +00004685#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004686 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004687 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004688 int destIfNull = jumpIfNull ? dest : destIfFalse;
4689 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004690 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004691 sqlite3VdbeResolveLabel(v, destIfFalse);
4692 break;
4693 }
shanehbb201342011-02-09 19:55:20 +00004694#endif
drhcce7d172000-05-31 15:34:51 +00004695 default: {
dan7b35a772016-07-28 19:47:15 +00004696 default_expr:
drhad317272019-04-19 16:21:51 +00004697 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004698 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004699 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004700 /* No-op */
4701 }else{
4702 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4703 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004704 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004705 testcase( regFree1==0 );
4706 testcase( jumpIfNull==0 );
4707 }
drhcce7d172000-05-31 15:34:51 +00004708 break;
4709 }
4710 }
drh2dcef112008-01-12 19:03:48 +00004711 sqlite3ReleaseTempReg(pParse, regFree1);
4712 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004713}
4714
4715/*
drh66b89c82000-11-28 20:47:17 +00004716** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004717** to the label "dest" if the expression is false but execution
4718** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004719**
4720** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004721** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4722** is 0.
drhcce7d172000-05-31 15:34:51 +00004723*/
danielk19774adee202004-05-08 08:23:19 +00004724void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004725 Vdbe *v = pParse->pVdbe;
4726 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004727 int regFree1 = 0;
4728 int regFree2 = 0;
4729 int r1, r2;
4730
drh35573352008-01-08 23:54:25 +00004731 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004732 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004733 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004734
4735 /* The value of pExpr->op and op are related as follows:
4736 **
4737 ** pExpr->op op
4738 ** --------- ----------
4739 ** TK_ISNULL OP_NotNull
4740 ** TK_NOTNULL OP_IsNull
4741 ** TK_NE OP_Eq
4742 ** TK_EQ OP_Ne
4743 ** TK_GT OP_Le
4744 ** TK_LE OP_Gt
4745 ** TK_GE OP_Lt
4746 ** TK_LT OP_Ge
4747 **
4748 ** For other values of pExpr->op, op is undefined and unused.
4749 ** The value of TK_ and OP_ constants are arranged such that we
4750 ** can compute the mapping above using the following expression.
4751 ** Assert()s verify that the computation is correct.
4752 */
4753 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4754
4755 /* Verify correct alignment of TK_ and OP_ constants
4756 */
4757 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4758 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4759 assert( pExpr->op!=TK_NE || op==OP_Eq );
4760 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4761 assert( pExpr->op!=TK_LT || op==OP_Ge );
4762 assert( pExpr->op!=TK_LE || op==OP_Gt );
4763 assert( pExpr->op!=TK_GT || op==OP_Le );
4764 assert( pExpr->op!=TK_GE || op==OP_Lt );
4765
danba00e302016-07-23 20:24:06 +00004766 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004767 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004768 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004769 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4770 if( pAlt!=pExpr ){
4771 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4772 }else if( pExpr->op==TK_AND ){
4773 testcase( jumpIfNull==0 );
4774 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4775 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4776 }else{
4777 int d2 = sqlite3VdbeMakeLabel(pParse);
4778 testcase( jumpIfNull==0 );
4779 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4780 jumpIfNull^SQLITE_JUMPIFNULL);
4781 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4782 sqlite3VdbeResolveLabel(v, d2);
4783 }
drhcce7d172000-05-31 15:34:51 +00004784 break;
4785 }
4786 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004787 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004788 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004789 break;
4790 }
drh8abed7b2018-02-26 18:49:05 +00004791 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004792 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4793 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004794 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004795 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004796 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004797 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004798 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004799 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004800 /* IS TRUE and IS NOT FALSE */
4801 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4802 isNot ? 0 : SQLITE_JUMPIFNULL);
4803
4804 }else{
4805 /* IS FALSE and IS NOT TRUE */
4806 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004807 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004808 }
drh007c8432018-02-26 03:20:18 +00004809 break;
4810 }
drhde845c22016-03-17 19:07:52 +00004811 case TK_IS:
4812 case TK_ISNOT:
4813 testcase( pExpr->op==TK_IS );
4814 testcase( pExpr->op==TK_ISNOT );
4815 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4816 jumpIfNull = SQLITE_NULLEQ;
4817 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004818 case TK_LT:
4819 case TK_LE:
4820 case TK_GT:
4821 case TK_GE:
4822 case TK_NE:
4823 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004824 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004825 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004826 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4827 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004828 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004829 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004830 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4831 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4832 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4833 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004834 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4835 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4836 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4837 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4838 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4839 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004840 testcase( regFree1==0 );
4841 testcase( regFree2==0 );
4842 break;
4843 }
drhcce7d172000-05-31 15:34:51 +00004844 case TK_ISNULL:
4845 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004846 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4847 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004848 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4849 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004850 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004851 break;
4852 }
drhfef52082000-06-06 01:50:43 +00004853 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004854 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004855 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004856 break;
4857 }
drh84e30ca2011-02-10 17:46:14 +00004858#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004859 case TK_IN: {
4860 if( jumpIfNull ){
4861 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4862 }else{
drhec4ccdb2018-12-29 02:26:59 +00004863 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004864 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4865 sqlite3VdbeResolveLabel(v, destIfNull);
4866 }
4867 break;
4868 }
shanehbb201342011-02-09 19:55:20 +00004869#endif
drhcce7d172000-05-31 15:34:51 +00004870 default: {
danba00e302016-07-23 20:24:06 +00004871 default_expr:
drhad317272019-04-19 16:21:51 +00004872 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004873 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004874 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004875 /* no-op */
4876 }else{
4877 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4878 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004879 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004880 testcase( regFree1==0 );
4881 testcase( jumpIfNull==0 );
4882 }
drhcce7d172000-05-31 15:34:51 +00004883 break;
4884 }
4885 }
drh2dcef112008-01-12 19:03:48 +00004886 sqlite3ReleaseTempReg(pParse, regFree1);
4887 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004888}
drh22827922000-06-06 17:27:05 +00004889
4890/*
drh72bc8202015-06-11 13:58:35 +00004891** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4892** code generation, and that copy is deleted after code generation. This
4893** ensures that the original pExpr is unchanged.
4894*/
4895void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4896 sqlite3 *db = pParse->db;
4897 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4898 if( db->mallocFailed==0 ){
4899 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4900 }
4901 sqlite3ExprDelete(db, pCopy);
4902}
4903
dan5aa550c2017-06-24 18:10:29 +00004904/*
4905** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4906** type of expression.
4907**
4908** If pExpr is a simple SQL value - an integer, real, string, blob
4909** or NULL value - then the VDBE currently being prepared is configured
4910** to re-prepare each time a new value is bound to variable pVar.
4911**
4912** Additionally, if pExpr is a simple SQL value and the value is the
4913** same as that currently bound to variable pVar, non-zero is returned.
4914** Otherwise, if the values are not the same or if pExpr is not a simple
4915** SQL value, zero is returned.
4916*/
4917static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4918 int res = 0;
drhc0804222017-06-28 21:47:16 +00004919 int iVar;
4920 sqlite3_value *pL, *pR = 0;
4921
4922 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4923 if( pR ){
4924 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004925 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004926 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004927 if( pL ){
4928 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4929 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4930 }
4931 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004932 }
drhc0804222017-06-28 21:47:16 +00004933 sqlite3ValueFree(pR);
4934 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004935 }
4936
4937 return res;
4938}
drh72bc8202015-06-11 13:58:35 +00004939
4940/*
drh1d9da702010-01-07 15:17:02 +00004941** Do a deep comparison of two expression trees. Return 0 if the two
4942** expressions are completely identical. Return 1 if they differ only
4943** by a COLLATE operator at the top level. Return 2 if there are differences
4944** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004945**
drh619a1302013-08-01 13:04:46 +00004946** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4947** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4948**
drh66518ca2013-08-01 15:09:57 +00004949** The pA side might be using TK_REGISTER. If that is the case and pB is
4950** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4951**
drh1d9da702010-01-07 15:17:02 +00004952** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004953** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004954** identical, we return 2 just to be safe. So if this routine
4955** returns 2, then you do not really know for certain if the two
4956** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004957** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004958** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004959** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004960** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004961**
drhc0804222017-06-28 21:47:16 +00004962** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4963** pParse->pReprepare can be matched against literals in pB. The
4964** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4965** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4966** Argument pParse should normally be NULL. If it is not NULL and pA or
4967** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004968*/
dan5aa550c2017-06-24 18:10:29 +00004969int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004970 u32 combinedFlags;
4971 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004972 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004973 }
dan5aa550c2017-06-24 18:10:29 +00004974 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4975 return 0;
4976 }
drh10d1edf2013-11-15 15:52:39 +00004977 combinedFlags = pA->flags | pB->flags;
4978 if( combinedFlags & EP_IntValue ){
4979 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4980 return 0;
4981 }
drh1d9da702010-01-07 15:17:02 +00004982 return 2;
drh22827922000-06-06 17:27:05 +00004983 }
dan16dd3982018-12-20 15:04:38 +00004984 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004985 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004986 return 1;
4987 }
dan5aa550c2017-06-24 18:10:29 +00004988 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004989 return 1;
4990 }
4991 return 2;
4992 }
drh2edc5fd2015-11-24 02:10:52 +00004993 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00004994 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00004995 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004996#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00004997 assert( pA->op==pB->op );
4998 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4999 return 2;
5000 }
drheda079c2018-09-20 19:02:15 +00005001 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005002 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5003 return 2;
5004 }
drheda079c2018-09-20 19:02:15 +00005005 }
5006#endif
drhf20bbc52019-01-17 01:06:00 +00005007 }else if( pA->op==TK_NULL ){
5008 return 0;
drhd5af5422018-04-13 14:27:01 +00005009 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005010 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005011 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005012 return 2;
drh2646da72005-12-09 20:02:05 +00005013 }
drh22827922000-06-06 17:27:05 +00005014 }
drh898c5272019-10-22 00:03:41 +00005015 if( (pA->flags & (EP_Distinct|EP_Commuted))
5016 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drh89b6de02018-12-12 20:11:23 +00005017 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00005018 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005019 if( (combinedFlags & EP_FixedCol)==0
5020 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005021 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005022 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005023 if( pA->op!=TK_STRING
5024 && pA->op!=TK_TRUEFALSE
5025 && (combinedFlags & EP_Reduced)==0
5026 ){
drh10d1edf2013-11-15 15:52:39 +00005027 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00005028 if( pA->op2!=pB->op2 ) return 2;
drhebc64082019-09-27 15:15:38 +00005029 if( pA->op!=TK_IN
5030 && pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00005031 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005032 }
5033 }
drh1d9da702010-01-07 15:17:02 +00005034 return 0;
drh22827922000-06-06 17:27:05 +00005035}
5036
drh8c6f6662010-04-26 19:17:26 +00005037/*
5038** Compare two ExprList objects. Return 0 if they are identical and
5039** non-zero if they differ in any way.
5040**
drh619a1302013-08-01 13:04:46 +00005041** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5042** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5043**
drh8c6f6662010-04-26 19:17:26 +00005044** This routine might return non-zero for equivalent ExprLists. The
5045** only consequence will be disabled optimizations. But this routine
5046** must never return 0 if the two ExprList objects are different, or
5047** a malfunction will result.
5048**
5049** Two NULL pointers are considered to be the same. But a NULL pointer
5050** always differs from a non-NULL pointer.
5051*/
drh619a1302013-08-01 13:04:46 +00005052int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005053 int i;
5054 if( pA==0 && pB==0 ) return 0;
5055 if( pA==0 || pB==0 ) return 1;
5056 if( pA->nExpr!=pB->nExpr ) return 1;
5057 for(i=0; i<pA->nExpr; i++){
5058 Expr *pExprA = pA->a[i].pExpr;
5059 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005060 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00005061 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00005062 }
5063 return 0;
5064}
drh13449892005-09-07 21:22:45 +00005065
drh22827922000-06-06 17:27:05 +00005066/*
drhf9463df2017-02-11 14:59:58 +00005067** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5068** are ignored.
5069*/
5070int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005071 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005072 sqlite3ExprSkipCollateAndLikely(pA),
5073 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005074 iTab);
5075}
5076
5077/*
drhc51cf862019-05-11 19:36:03 +00005078** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005079**
5080** Or if seenNot is true, return non-zero if Expr p can only be
5081** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005082*/
5083static int exprImpliesNotNull(
5084 Parse *pParse, /* Parsing context */
5085 Expr *p, /* The expression to be checked */
5086 Expr *pNN, /* The expression that is NOT NULL */
5087 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005088 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005089){
5090 assert( p );
5091 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005092 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5093 return pNN->op!=TK_NULL;
5094 }
drhc51cf862019-05-11 19:36:03 +00005095 switch( p->op ){
5096 case TK_IN: {
5097 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5098 assert( ExprHasProperty(p,EP_xIsSelect)
5099 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005100 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005101 }
5102 case TK_BETWEEN: {
5103 ExprList *pList = p->x.pList;
5104 assert( pList!=0 );
5105 assert( pList->nExpr==2 );
5106 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005107 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5108 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005109 ){
5110 return 1;
5111 }
drh7a231b42019-08-30 15:11:08 +00005112 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005113 }
5114 case TK_EQ:
5115 case TK_NE:
5116 case TK_LT:
5117 case TK_LE:
5118 case TK_GT:
5119 case TK_GE:
5120 case TK_PLUS:
5121 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005122 case TK_BITOR:
5123 case TK_LSHIFT:
5124 case TK_RSHIFT:
5125 case TK_CONCAT:
5126 seenNot = 1;
5127 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005128 case TK_STAR:
5129 case TK_REM:
5130 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005131 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005132 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5133 /* Fall thru into the next case */
5134 }
5135 case TK_SPAN:
5136 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005137 case TK_UPLUS:
5138 case TK_UMINUS: {
5139 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5140 }
5141 case TK_TRUTH: {
5142 if( seenNot ) return 0;
5143 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005144 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005145 }
dan1cd382e2019-08-29 15:06:35 +00005146 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005147 case TK_NOT: {
5148 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5149 }
5150 }
5151 return 0;
5152}
5153
5154/*
drh4bd5f732013-07-31 23:22:39 +00005155** Return true if we can prove the pE2 will always be true if pE1 is
5156** true. Return false if we cannot complete the proof or if pE2 might
5157** be false. Examples:
5158**
drh619a1302013-08-01 13:04:46 +00005159** pE1: x==5 pE2: x==5 Result: true
5160** pE1: x>0 pE2: x==5 Result: false
5161** pE1: x=21 pE2: x=21 OR y=43 Result: true
5162** pE1: x!=123 pE2: x IS NOT NULL Result: true
5163** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5164** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5165** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005166**
5167** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5168** Expr.iTable<0 then assume a table number given by iTab.
5169**
drhc0804222017-06-28 21:47:16 +00005170** If pParse is not NULL, then the values of bound variables in pE1 are
5171** compared against literal values in pE2 and pParse->pVdbe->expmask is
5172** modified to record which bound variables are referenced. If pParse
5173** is NULL, then false will be returned if pE1 contains any bound variables.
5174**
drh4bd5f732013-07-31 23:22:39 +00005175** When in doubt, return false. Returning true might give a performance
5176** improvement. Returning false might cause a performance reduction, but
5177** it will always give the correct answer and is hence always safe.
5178*/
dan5aa550c2017-06-24 18:10:29 +00005179int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5180 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005181 return 1;
5182 }
5183 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005184 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5185 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005186 ){
5187 return 1;
5188 }
drh664d6d12019-05-04 17:32:07 +00005189 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005190 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005191 ){
drhc51cf862019-05-11 19:36:03 +00005192 return 1;
drh619a1302013-08-01 13:04:46 +00005193 }
5194 return 0;
drh4bd5f732013-07-31 23:22:39 +00005195}
5196
5197/*
drh25897872018-03-20 21:16:15 +00005198** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5199** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005200** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5201**
5202** This routine controls an optimization. False positives (setting
5203** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5204** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005205*/
5206static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005207 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005208 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005209 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5210 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005211 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005212 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005213 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005214 case TK_IS:
5215 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005216 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005217 case TK_IN:
drh25897872018-03-20 21:16:15 +00005218 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005219 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005220 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005221 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005222 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005223 testcase( pExpr->op==TK_IS );
5224 testcase( pExpr->op==TK_OR );
5225 testcase( pExpr->op==TK_CASE );
5226 testcase( pExpr->op==TK_IN );
5227 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005228 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005229 return WRC_Prune;
5230 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005231 if( pWalker->u.iCur==pExpr->iTable ){
5232 pWalker->eCode = 1;
5233 return WRC_Abort;
5234 }
5235 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005236
dan9d23ea72019-08-29 19:34:29 +00005237 case TK_AND:
dan0287c952019-10-10 17:09:44 +00005238 assert( pWalker->eCode==0 );
5239 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5240 if( pWalker->eCode ){
5241 pWalker->eCode = 0;
5242 sqlite3WalkExpr(pWalker, pExpr->pRight);
dan9d23ea72019-08-29 19:34:29 +00005243 }
5244 return WRC_Prune;
5245
5246 case TK_BETWEEN:
5247 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5248 return WRC_Prune;
5249
drh98811552018-04-03 14:04:48 +00005250 /* Virtual tables are allowed to use constraints like x=NULL. So
5251 ** a term of the form x=y does not prove that y is not null if x
5252 ** is the column of a virtual table */
5253 case TK_EQ:
5254 case TK_NE:
5255 case TK_LT:
5256 case TK_LE:
5257 case TK_GT:
5258 case TK_GE:
5259 testcase( pExpr->op==TK_EQ );
5260 testcase( pExpr->op==TK_NE );
5261 testcase( pExpr->op==TK_LT );
5262 testcase( pExpr->op==TK_LE );
5263 testcase( pExpr->op==TK_GT );
5264 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005265 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5266 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005267 ){
5268 return WRC_Prune;
5269 }
dan9d23ea72019-08-29 19:34:29 +00005270
drh25897872018-03-20 21:16:15 +00005271 default:
5272 return WRC_Continue;
5273 }
5274}
5275
5276/*
5277** Return true (non-zero) if expression p can only be true if at least
5278** one column of table iTab is non-null. In other words, return true
5279** if expression p will always be NULL or false if every column of iTab
5280** is NULL.
5281**
drh821b6102018-03-24 18:01:51 +00005282** False negatives are acceptable. In other words, it is ok to return
5283** zero even if expression p will never be true of every column of iTab
5284** is NULL. A false negative is merely a missed optimization opportunity.
5285**
5286** False positives are not allowed, however. A false positive may result
5287** in an incorrect answer.
5288**
drh25897872018-03-20 21:16:15 +00005289** Terms of p that are marked with EP_FromJoin (and hence that come from
5290** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5291**
5292** This routine is used to check if a LEFT JOIN can be converted into
5293** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5294** clause requires that some column of the right table of the LEFT JOIN
5295** be non-NULL, then the LEFT JOIN can be safely converted into an
5296** ordinary join.
5297*/
5298int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5299 Walker w;
drh0d950af2019-08-22 16:38:42 +00005300 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005301 if( p==0 ) return 0;
5302 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005303 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005304 }else{
5305 while( p->op==TK_AND ){
5306 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5307 p = p->pRight;
5308 }
drhd6db6592019-04-01 19:42:42 +00005309 }
drh25897872018-03-20 21:16:15 +00005310 w.xExprCallback = impliesNotNullRow;
5311 w.xSelectCallback = 0;
5312 w.xSelectCallback2 = 0;
5313 w.eCode = 0;
5314 w.u.iCur = iTab;
5315 sqlite3WalkExpr(&w, p);
5316 return w.eCode;
5317}
5318
5319/*
drh030796d2012-08-23 16:18:10 +00005320** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005321** to determine if an expression can be evaluated by reference to the
5322** index only, without having to do a search for the corresponding
5323** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5324** is the cursor for the table.
5325*/
5326struct IdxCover {
5327 Index *pIdx; /* The index to be tested for coverage */
5328 int iCur; /* Cursor number for the table corresponding to the index */
5329};
5330
5331/*
5332** Check to see if there are references to columns in table
5333** pWalker->u.pIdxCover->iCur can be satisfied using the index
5334** pWalker->u.pIdxCover->pIdx.
5335*/
5336static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5337 if( pExpr->op==TK_COLUMN
5338 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005339 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005340 ){
5341 pWalker->eCode = 1;
5342 return WRC_Abort;
5343 }
5344 return WRC_Continue;
5345}
5346
5347/*
drhe604ec02016-07-27 19:20:58 +00005348** Determine if an index pIdx on table with cursor iCur contains will
5349** the expression pExpr. Return true if the index does cover the
5350** expression and false if the pExpr expression references table columns
5351** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005352**
5353** An index covering an expression means that the expression can be
5354** evaluated using only the index and without having to lookup the
5355** corresponding table entry.
5356*/
5357int sqlite3ExprCoveredByIndex(
5358 Expr *pExpr, /* The index to be tested */
5359 int iCur, /* The cursor number for the corresponding table */
5360 Index *pIdx /* The index that might be used for coverage */
5361){
5362 Walker w;
5363 struct IdxCover xcov;
5364 memset(&w, 0, sizeof(w));
5365 xcov.iCur = iCur;
5366 xcov.pIdx = pIdx;
5367 w.xExprCallback = exprIdxCover;
5368 w.u.pIdxCover = &xcov;
5369 sqlite3WalkExpr(&w, pExpr);
5370 return !w.eCode;
5371}
5372
5373
5374/*
5375** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005376** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005377** aggregate function, in order to implement the
5378** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005379*/
drh030796d2012-08-23 16:18:10 +00005380struct SrcCount {
5381 SrcList *pSrc; /* One particular FROM clause in a nested query */
5382 int nThis; /* Number of references to columns in pSrcList */
5383 int nOther; /* Number of references to columns in other FROM clauses */
5384};
5385
5386/*
5387** Count the number of references to columns.
5388*/
5389static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005390 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5391 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5392 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5393 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5394 ** NEVER() will need to be removed. */
5395 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005396 int i;
drh030796d2012-08-23 16:18:10 +00005397 struct SrcCount *p = pWalker->u.pSrcCount;
5398 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005399 int nSrc = pSrc ? pSrc->nSrc : 0;
5400 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005401 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005402 }
drh655814d2015-01-09 01:27:29 +00005403 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005404 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005405 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5406 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005407 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005408 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005409 p->nOther++;
5410 }
drh374fdce2012-04-17 16:38:53 +00005411 }
drh030796d2012-08-23 16:18:10 +00005412 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005413}
5414
5415/*
drh030796d2012-08-23 16:18:10 +00005416** Determine if any of the arguments to the pExpr Function reference
5417** pSrcList. Return true if they do. Also return true if the function
5418** has no arguments or has only constant arguments. Return false if pExpr
5419** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005420*/
drh030796d2012-08-23 16:18:10 +00005421int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005422 Walker w;
drh030796d2012-08-23 16:18:10 +00005423 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005424 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005425 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005426 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005427 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005428 w.u.pSrcCount = &cnt;
5429 cnt.pSrc = pSrcList;
5430 cnt.nThis = 0;
5431 cnt.nOther = 0;
5432 sqlite3WalkExprList(&w, pExpr->x.pList);
5433 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005434}
5435
5436/*
drh13449892005-09-07 21:22:45 +00005437** Add a new element to the pAggInfo->aCol[] array. Return the index of
5438** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005439*/
drh17435752007-08-16 04:30:38 +00005440static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005441 int i;
drhcf643722007-03-27 13:36:37 +00005442 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005443 db,
drhcf643722007-03-27 13:36:37 +00005444 pInfo->aCol,
5445 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005446 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005447 &i
5448 );
drh13449892005-09-07 21:22:45 +00005449 return i;
5450}
5451
5452/*
5453** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5454** the new element. Return a negative number if malloc fails.
5455*/
drh17435752007-08-16 04:30:38 +00005456static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005457 int i;
drhcf643722007-03-27 13:36:37 +00005458 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005459 db,
drhcf643722007-03-27 13:36:37 +00005460 pInfo->aFunc,
5461 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005462 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005463 &i
5464 );
drh13449892005-09-07 21:22:45 +00005465 return i;
5466}
drh22827922000-06-06 17:27:05 +00005467
5468/*
drh7d10d5a2008-08-20 16:35:10 +00005469** This is the xExprCallback for a tree walker. It is used to
5470** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005471** for additional information.
drh22827922000-06-06 17:27:05 +00005472*/
drh7d10d5a2008-08-20 16:35:10 +00005473static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005474 int i;
drh7d10d5a2008-08-20 16:35:10 +00005475 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005476 Parse *pParse = pNC->pParse;
5477 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005478 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005479
drh25c3b8c2018-04-16 10:34:13 +00005480 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005481 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005482 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005483 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005484 testcase( pExpr->op==TK_AGG_COLUMN );
5485 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005486 /* Check to see if the column is in one of the tables in the FROM
5487 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005488 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005489 struct SrcList_item *pItem = pSrcList->a;
5490 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5491 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005492 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005493 if( pExpr->iTable==pItem->iCursor ){
5494 /* If we reach this point, it means that pExpr refers to a table
5495 ** that is in the FROM clause of the aggregate query.
5496 **
5497 ** Make an entry for the column in pAggInfo->aCol[] if there
5498 ** is not an entry there already.
5499 */
drh7f906d62007-03-12 23:48:52 +00005500 int k;
drh13449892005-09-07 21:22:45 +00005501 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005502 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005503 if( pCol->iTable==pExpr->iTable &&
5504 pCol->iColumn==pExpr->iColumn ){
5505 break;
5506 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005507 }
danielk19771e536952007-08-16 10:09:01 +00005508 if( (k>=pAggInfo->nColumn)
5509 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5510 ){
drh7f906d62007-03-12 23:48:52 +00005511 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005512 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005513 pCol->iTable = pExpr->iTable;
5514 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005515 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005516 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005517 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005518 if( pAggInfo->pGroupBy ){
5519 int j, n;
5520 ExprList *pGB = pAggInfo->pGroupBy;
5521 struct ExprList_item *pTerm = pGB->a;
5522 n = pGB->nExpr;
5523 for(j=0; j<n; j++, pTerm++){
5524 Expr *pE = pTerm->pExpr;
5525 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5526 pE->iColumn==pExpr->iColumn ){
5527 pCol->iSorterColumn = j;
5528 break;
5529 }
5530 }
5531 }
5532 if( pCol->iSorterColumn<0 ){
5533 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5534 }
5535 }
5536 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5537 ** because it was there before or because we just created it).
5538 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5539 ** pAggInfo->aCol[] entry.
5540 */
drhebb6a652013-09-12 23:42:22 +00005541 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005542 pExpr->pAggInfo = pAggInfo;
5543 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005544 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005545 break;
5546 } /* endif pExpr->iTable==pItem->iCursor */
5547 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005548 }
drh7d10d5a2008-08-20 16:35:10 +00005549 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005550 }
5551 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005552 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005553 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005554 ){
drh13449892005-09-07 21:22:45 +00005555 /* Check to see if pExpr is a duplicate of another aggregate
5556 ** function that is already in the pAggInfo structure
5557 */
5558 struct AggInfo_func *pItem = pAggInfo->aFunc;
5559 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005560 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005561 break;
5562 }
drh22827922000-06-06 17:27:05 +00005563 }
drh13449892005-09-07 21:22:45 +00005564 if( i>=pAggInfo->nFunc ){
5565 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5566 */
danielk197714db2662006-01-09 16:12:04 +00005567 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005568 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005569 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005570 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005571 pItem = &pAggInfo->aFunc[i];
5572 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005573 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005574 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005575 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005576 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005577 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005578 if( pExpr->flags & EP_Distinct ){
5579 pItem->iDistinct = pParse->nTab++;
5580 }else{
5581 pItem->iDistinct = -1;
5582 }
drh13449892005-09-07 21:22:45 +00005583 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005584 }
drh13449892005-09-07 21:22:45 +00005585 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5586 */
drhc5cd1242013-09-12 16:50:49 +00005587 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005588 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005589 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005590 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005591 return WRC_Prune;
5592 }else{
5593 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005594 }
drh22827922000-06-06 17:27:05 +00005595 }
5596 }
drh7d10d5a2008-08-20 16:35:10 +00005597 return WRC_Continue;
5598}
5599static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005600 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005601 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005602 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005603}
drh979dd1b2017-05-29 14:26:07 +00005604static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5605 UNUSED_PARAMETER(pSelect);
5606 pWalker->walkerDepth--;
5607}
drh626a8792005-01-17 22:08:19 +00005608
5609/*
drhe8abb4c2012-11-02 18:24:57 +00005610** Analyze the pExpr expression looking for aggregate functions and
5611** for variables that need to be added to AggInfo object that pNC->pAggInfo
5612** points to. Additional entries are made on the AggInfo object as
5613** necessary.
drh626a8792005-01-17 22:08:19 +00005614**
5615** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005616** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005617*/
drhd2b3e232008-01-23 14:51:49 +00005618void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005619 Walker w;
5620 w.xExprCallback = analyzeAggregate;
5621 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005622 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5623 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005624 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005625 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005626 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005627 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005628}
drh5d9a4af2005-08-30 00:54:01 +00005629
5630/*
5631** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5632** expression list. Return the number of errors.
5633**
5634** If an error is found, the analysis is cut short.
5635*/
drhd2b3e232008-01-23 14:51:49 +00005636void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005637 struct ExprList_item *pItem;
5638 int i;
drh5d9a4af2005-08-30 00:54:01 +00005639 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005640 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5641 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005642 }
5643 }
drh5d9a4af2005-08-30 00:54:01 +00005644}
drh892d3172008-01-10 03:46:36 +00005645
5646/*
drhceea3322009-04-23 13:22:42 +00005647** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005648*/
5649int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005650 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005651 return ++pParse->nMem;
5652 }
danielk19772f425f62008-07-04 09:41:39 +00005653 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005654}
drhceea3322009-04-23 13:22:42 +00005655
5656/*
5657** Deallocate a register, making available for reuse for some other
5658** purpose.
drhceea3322009-04-23 13:22:42 +00005659*/
drh892d3172008-01-10 03:46:36 +00005660void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005661 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005662 pParse->aTempReg[pParse->nTempReg++] = iReg;
5663 }
5664}
5665
5666/*
drhed24da42016-09-06 14:37:05 +00005667** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005668*/
5669int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005670 int i, n;
drhed24da42016-09-06 14:37:05 +00005671 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005672 i = pParse->iRangeReg;
5673 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005674 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005675 pParse->iRangeReg += nReg;
5676 pParse->nRangeReg -= nReg;
5677 }else{
5678 i = pParse->nMem+1;
5679 pParse->nMem += nReg;
5680 }
5681 return i;
5682}
5683void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005684 if( nReg==1 ){
5685 sqlite3ReleaseTempReg(pParse, iReg);
5686 return;
5687 }
drh892d3172008-01-10 03:46:36 +00005688 if( nReg>pParse->nRangeReg ){
5689 pParse->nRangeReg = nReg;
5690 pParse->iRangeReg = iReg;
5691 }
5692}
drhcdc69552011-12-06 13:24:59 +00005693
5694/*
5695** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005696**
5697** Always invoke this procedure after coding a subroutine or co-routine
5698** that might be invoked from other parts of the code, to ensure that
5699** the sub/co-routine does not use registers in common with the code that
5700** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005701*/
5702void sqlite3ClearTempRegCache(Parse *pParse){
5703 pParse->nTempReg = 0;
5704 pParse->nRangeReg = 0;
5705}
drhbb9b5f22016-03-19 00:35:02 +00005706
5707/*
5708** Validate that no temporary register falls within the range of
5709** iFirst..iLast, inclusive. This routine is only call from within assert()
5710** statements.
5711*/
5712#ifdef SQLITE_DEBUG
5713int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5714 int i;
5715 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005716 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5717 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005718 ){
5719 return 0;
5720 }
5721 for(i=0; i<pParse->nTempReg; i++){
5722 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5723 return 0;
5724 }
5725 }
5726 return 1;
5727}
5728#endif /* SQLITE_DEBUG */