xref: /sqlite-3.40.0/src/expr.c (revision db45bd5e)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
17e014a838Sdanielk1977 /*
18e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
19e014a838Sdanielk1977 **
20e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
21e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
22e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
23e014a838Sdanielk1977 ** indicating no affinity for the expression.
24e014a838Sdanielk1977 **
2560ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
26e014a838Sdanielk1977 ** have an affinity:
27e014a838Sdanielk1977 **
28e014a838Sdanielk1977 ** CREATE TABLE t1(a);
29e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
30e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
32e014a838Sdanielk1977 */
33bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
34580c8c18Sdrh   int op;
35580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
369bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
37580c8c18Sdrh   op = pExpr->op;
38487e262fSdrh   if( op==TK_SELECT ){
396ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
406ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
41a37cdde0Sdanielk1977   }
42*db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
43487e262fSdrh #ifndef SQLITE_OMIT_CAST
44487e262fSdrh   if( op==TK_CAST ){
4533e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
46fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
47487e262fSdrh   }
48487e262fSdrh #endif
49*db45bd5eSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab!=0 ){
507d10d5a6Sdrh     int j = pExpr->iColumn;
517d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
527d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
537d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
547d10d5a6Sdrh   }
55a37cdde0Sdanielk1977   return pExpr->affinity;
56a37cdde0Sdanielk1977 }
57a37cdde0Sdanielk1977 
5853db1458Sdrh /*
598b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
60ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
61ae80ddeaSdrh ** implements the COLLATE operator.
620a8a406eSdrh **
630a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
640a8a406eSdrh ** and the pExpr parameter is returned unchanged.
658b4c40d8Sdrh */
664ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
674ef7efadSdrh   Parse *pParse,           /* Parsing context */
684ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
6980103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
7080103fc6Sdan   int dequote              /* True to dequote pCollName */
714ef7efadSdrh ){
720a8a406eSdrh   if( pCollName->n>0 ){
7380103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
74ae80ddeaSdrh     if( pNew ){
75ae80ddeaSdrh       pNew->pLeft = pExpr;
76a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
770a8a406eSdrh       pExpr = pNew;
78ae80ddeaSdrh     }
790a8a406eSdrh   }
800a8a406eSdrh   return pExpr;
810a8a406eSdrh }
820a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
830a8a406eSdrh   Token s;
84261d8a51Sdrh   assert( zC!=0 );
8540aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
8680103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
870a8a406eSdrh }
880a8a406eSdrh 
890a8a406eSdrh /*
900b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
91a4c3c87eSdrh ** or likelihood() function at the root of an expression.
920a8a406eSdrh */
930a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
94a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
95a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
96cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
97cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
98a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
99cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
100cca9f3d2Sdrh     }else{
1010b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
102d91eba96Sdrh       pExpr = pExpr->pLeft;
103cca9f3d2Sdrh     }
104d91eba96Sdrh   }
1050a8a406eSdrh   return pExpr;
1068b4c40d8Sdrh }
1078b4c40d8Sdrh 
1088b4c40d8Sdrh /*
109ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
110ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
111ae80ddeaSdrh **
112ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
113ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
114ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
115ae80ddeaSdrh ** precedence over right operands.
1160202b29eSdanielk1977 */
1177cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
118ae80ddeaSdrh   sqlite3 *db = pParse->db;
1197cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1207d10d5a6Sdrh   Expr *p = pExpr;
121261d8a51Sdrh   while( p ){
122ae80ddeaSdrh     int op = p->op;
123fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
124ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
125ae80ddeaSdrh       p = p->pLeft;
126ae80ddeaSdrh       continue;
127ae80ddeaSdrh     }
12836e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1297a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
130ae80ddeaSdrh       break;
131ae80ddeaSdrh     }
132a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
133ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
134a58d4a96Sdrh      && p->pTab!=0
135ae80ddeaSdrh     ){
1367d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1377d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1387d10d5a6Sdrh       int j = p->iColumn;
1397d10d5a6Sdrh       if( j>=0 ){
140ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
141c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1420202b29eSdanielk1977       }
1437d10d5a6Sdrh       break;
1447d10d5a6Sdrh     }
145ae80ddeaSdrh     if( p->flags & EP_Collate ){
1462308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1477d10d5a6Sdrh         p = p->pLeft;
148ae80ddeaSdrh       }else{
1492308ed38Sdrh         Expr *pNext  = p->pRight;
1506728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1516728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1526728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1536728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1546728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1556728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1562308ed38Sdrh           int i;
1576728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1582308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1592308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1602308ed38Sdrh               break;
1612308ed38Sdrh             }
1622308ed38Sdrh           }
1632308ed38Sdrh         }
1642308ed38Sdrh         p = pNext;
165ae80ddeaSdrh       }
166ae80ddeaSdrh     }else{
167ae80ddeaSdrh       break;
168ae80ddeaSdrh     }
1690202b29eSdanielk1977   }
1707cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1717cedc8d4Sdanielk1977     pColl = 0;
1727cedc8d4Sdanielk1977   }
1737cedc8d4Sdanielk1977   return pColl;
1740202b29eSdanielk1977 }
1750202b29eSdanielk1977 
1760202b29eSdanielk1977 /*
177626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
178626a879aSdrh ** type affinity of the other operand.  This routine returns the
17953db1458Sdrh ** type affinity that should be used for the comparison operator.
18053db1458Sdrh */
181e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
182bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
183e014a838Sdanielk1977   if( aff1 && aff2 ){
1848df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1858df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
186e014a838Sdanielk1977     */
1878a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
188e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
189e014a838Sdanielk1977     }else{
19005883a34Sdrh       return SQLITE_AFF_BLOB;
191e014a838Sdanielk1977     }
192e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1935f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1945f6a87b3Sdrh     ** results directly.
195e014a838Sdanielk1977     */
19605883a34Sdrh     return SQLITE_AFF_BLOB;
197e014a838Sdanielk1977   }else{
198e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
199fe05af87Sdrh     assert( aff1==0 || aff2==0 );
200e014a838Sdanielk1977     return (aff1 + aff2);
201e014a838Sdanielk1977   }
202e014a838Sdanielk1977 }
203e014a838Sdanielk1977 
20453db1458Sdrh /*
20553db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
20653db1458Sdrh ** be applied to both operands prior to doing the comparison.
20753db1458Sdrh */
208e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
209e014a838Sdanielk1977   char aff;
210e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
211e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2126a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
213e014a838Sdanielk1977   assert( pExpr->pLeft );
214bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
215e014a838Sdanielk1977   if( pExpr->pRight ){
216e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2176ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2186ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2196ab3a2ecSdanielk1977   }else if( !aff ){
22005883a34Sdrh     aff = SQLITE_AFF_BLOB;
221e014a838Sdanielk1977   }
222e014a838Sdanielk1977   return aff;
223e014a838Sdanielk1977 }
224e014a838Sdanielk1977 
225e014a838Sdanielk1977 /*
226e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
227e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
228e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
229e014a838Sdanielk1977 ** the comparison in pExpr.
230e014a838Sdanielk1977 */
231e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
232e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2338a51256cSdrh   switch( aff ){
23405883a34Sdrh     case SQLITE_AFF_BLOB:
2358a51256cSdrh       return 1;
2368a51256cSdrh     case SQLITE_AFF_TEXT:
2378a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2388a51256cSdrh     default:
2398a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2408a51256cSdrh   }
241e014a838Sdanielk1977 }
242e014a838Sdanielk1977 
243a37cdde0Sdanielk1977 /*
24435573356Sdrh ** Return the P5 value that should be used for a binary comparison
245a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
246a37cdde0Sdanielk1977 */
24735573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
24835573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2491bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
25035573356Sdrh   return aff;
251a37cdde0Sdanielk1977 }
252a37cdde0Sdanielk1977 
253a2e00042Sdrh /*
2540202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2550202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2560202b29eSdanielk1977 **
2570202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2580202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2590202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2600202b29eSdanielk1977 ** type.
261bcbb04e5Sdanielk1977 **
262bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
263bcbb04e5Sdanielk1977 ** it is not considered.
2640202b29eSdanielk1977 */
265bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
266bcbb04e5Sdanielk1977   Parse *pParse,
267bcbb04e5Sdanielk1977   Expr *pLeft,
268bcbb04e5Sdanielk1977   Expr *pRight
269bcbb04e5Sdanielk1977 ){
270ec41ddacSdrh   CollSeq *pColl;
271ec41ddacSdrh   assert( pLeft );
272ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
273ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
274ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
275ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
276ec41ddacSdrh   }else{
277ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2780202b29eSdanielk1977     if( !pColl ){
2797cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2800202b29eSdanielk1977     }
281ec41ddacSdrh   }
2820202b29eSdanielk1977   return pColl;
2830202b29eSdanielk1977 }
2840202b29eSdanielk1977 
2850202b29eSdanielk1977 /*
286be5c89acSdrh ** Generate code for a comparison operator.
287be5c89acSdrh */
288be5c89acSdrh static int codeCompare(
289be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
290be5c89acSdrh   Expr *pLeft,      /* The left operand */
291be5c89acSdrh   Expr *pRight,     /* The right operand */
292be5c89acSdrh   int opcode,       /* The comparison opcode */
29335573356Sdrh   int in1, int in2, /* Register holding operands */
294be5c89acSdrh   int dest,         /* Jump here if true.  */
295be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
296be5c89acSdrh ){
29735573356Sdrh   int p5;
29835573356Sdrh   int addr;
29935573356Sdrh   CollSeq *p4;
30035573356Sdrh 
30135573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
30235573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
30335573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
30435573356Sdrh                            (void*)p4, P4_COLLSEQ);
3051bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
30635573356Sdrh   return addr;
307be5c89acSdrh }
308be5c89acSdrh 
309cfbb5e82Sdan /*
310870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
311d832da7fSdrh **
312d832da7fSdrh ** A vector is defined as any expression that results in two or more
313d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
314d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
315d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
316d832da7fSdrh ** considered a vector if it has two or more result columns.
317870a0705Sdan */
318870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
31976dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
320870a0705Sdan }
321870a0705Sdan 
322870a0705Sdan /*
323cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
324cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
325cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
326cfbb5e82Sdan ** any other type of expression, return 1.
327cfbb5e82Sdan */
32871c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
32976dbe7a8Sdrh   if( pExpr->op==TK_VECTOR ){
33071c57db0Sdan     return pExpr->x.pList->nExpr;
33176dbe7a8Sdrh   }else if( pExpr->op==TK_SELECT ){
33276dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
33376dbe7a8Sdrh   }else{
33476dbe7a8Sdrh     return 1;
33576dbe7a8Sdrh   }
33671c57db0Sdan }
33771c57db0Sdan 
338f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
339ba00e30aSdan /*
340fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
341fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
342fc7f27b9Sdrh ** ensure that i is within range.
343fc7f27b9Sdrh **
34476dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
34576dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
34676dbe7a8Sdrh **
347fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
348fc7f27b9Sdrh **
349fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
35076dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
35176dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
35276dbe7a8Sdrh ** been positioned.
353ba00e30aSdan */
354fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
355870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
356870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
357870a0705Sdan     if( pVector->op==TK_SELECT ){
35871c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
359870a0705Sdan     }else{
36071c57db0Sdan       return pVector->x.pList->a[i].pExpr;
36171c57db0Sdan     }
362870a0705Sdan   }
363870a0705Sdan   return pVector;
364870a0705Sdan }
365fc7f27b9Sdrh #endif /* !defined(SQLITE_OMIT_SUBQUERY) */
366fc7f27b9Sdrh 
367fc7f27b9Sdrh #ifndef SQLITE_OMIT_SUBQUERY
368fc7f27b9Sdrh /*
369fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
370fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
371fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
372fc7f27b9Sdrh **
3738762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
3748762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
3758762ec19Sdrh **
376fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
377fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
378fc7f27b9Sdrh **
3798762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
38076dbe7a8Sdrh ** then the returne object will reference pVector and so pVector must remain
3818762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
3828762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
38376dbe7a8Sdrh ** returns.
3848762ec19Sdrh **
3858762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
3868762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
3878762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
388fc7f27b9Sdrh */
389fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
390fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
391fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
392a1251bc4Sdrh   int iField           /* Which column of the vector to return */
393fc7f27b9Sdrh ){
394fc7f27b9Sdrh   Expr *pRet;
395a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
396a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
397fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
398fc7f27b9Sdrh     **
399fc7f27b9Sdrh     ** pLeft:           pVector containing TK_SELECT
4008762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
401fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
402fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
403fc7f27b9Sdrh     **                  if the result is not yet computed.
404fc7f27b9Sdrh     **
405fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
406fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4078762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4088762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4098762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4108762ec19Sdrh     ** will own the pVector.
411fc7f27b9Sdrh     */
4128bd0d58eSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0, 0);
4138bd0d58eSdrh     if( pRet ){
4148bd0d58eSdrh       pRet->iColumn = iField;
4158bd0d58eSdrh       pRet->pLeft = pVector;
4168bd0d58eSdrh     }
417fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
418fc7f27b9Sdrh   }else{
419a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
420a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
421fc7f27b9Sdrh   }
422fc7f27b9Sdrh   return pRet;
423fc7f27b9Sdrh }
424fc7f27b9Sdrh #endif /* !define(SQLITE_OMIT_SUBQUERY) */
42571c57db0Sdan 
4265c288b92Sdan /*
4275c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4285c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4295c288b92Sdan ** sub-select returns more than one column, the first in an array
4305c288b92Sdan ** of registers in which the result is stored).
4315c288b92Sdan **
4325c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4335c288b92Sdan */
4345c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4358da209b1Sdan   int reg = 0;
436f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4375c288b92Sdan   if( pExpr->op==TK_SELECT ){
4388da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4398da209b1Sdan   }
440f9b2e05cSdan #endif
4418da209b1Sdan   return reg;
4428da209b1Sdan }
4438da209b1Sdan 
4445c288b92Sdan /*
4455c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
446870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
447870a0705Sdan ** the register number of a register that contains the value of
448870a0705Sdan ** element iField of the vector.
449870a0705Sdan **
450870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
451870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
452870a0705Sdan ** case parameter regSelect should be the first in an array of registers
453870a0705Sdan ** containing the results of the sub-select.
454870a0705Sdan **
455870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
456870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
457870a0705Sdan ** a temporary register to be freed by the caller before returning.
4585c288b92Sdan **
4595c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
4605c288b92Sdan ** Expr object corresponding to element iElem of the vector.
4615c288b92Sdan */
4625c288b92Sdan static int exprVectorRegister(
4635c288b92Sdan   Parse *pParse,                  /* Parse context */
4645c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
465870a0705Sdan   int iField,                     /* Field to extract from pVector */
4665c288b92Sdan   int regSelect,                  /* First in array of registers */
4675c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
4685c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
4695c288b92Sdan ){
470870a0705Sdan   assert( pVector->op==TK_VECTOR || pVector->op==TK_SELECT );
4718bd0d58eSdrh   assert( pParse->nErr || pParse->db->mallocFailed
4728bd0d58eSdrh           || (pVector->op==TK_VECTOR)==(regSelect==0) );
473f358009aSdan   if( pVector->op==TK_SELECT ){
474870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
475870a0705Sdan      return regSelect+iField;
4765c288b92Sdan   }
477870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
4785c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
4795c288b92Sdan }
4805c288b92Sdan 
4815c288b92Sdan /*
4825c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
48379752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
48479752b6eSdrh ** result into register dest.
48579752b6eSdrh **
48679752b6eSdrh ** The caller must satisfy the following preconditions:
48779752b6eSdrh **
48879752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
48979752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
49079752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
4915c288b92Sdan */
49279752b6eSdrh static void codeVectorCompare(
49379752b6eSdrh   Parse *pParse,        /* Code generator context */
49479752b6eSdrh   Expr *pExpr,          /* The comparison operation */
49579752b6eSdrh   int dest,             /* Write results into this register */
49679752b6eSdrh   u8 op,                /* Comparison operator */
49779752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
49879752b6eSdrh ){
49971c57db0Sdan   Vdbe *v = pParse->pVdbe;
50071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
50171c57db0Sdan   Expr *pRight = pExpr->pRight;
50271c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
50371c57db0Sdan   int nRight = sqlite3ExprVectorSize(pRight);
50471c57db0Sdan 
50571c57db0Sdan   /* Check that both sides of the comparison are vectors, and that
50671c57db0Sdan   ** both are the same length.  */
50771c57db0Sdan   if( nLeft!=nRight ){
50871c57db0Sdan     sqlite3ErrorMsg(pParse, "invalid use of row value");
50971c57db0Sdan   }else{
51071c57db0Sdan     int i;
51171c57db0Sdan     int regLeft = 0;
51271c57db0Sdan     int regRight = 0;
51379752b6eSdrh     u8 opx = op;
51479752b6eSdrh     int addrDone = sqlite3VdbeMakeLabel(v);
51571c57db0Sdan 
51671c57db0Sdan     assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
51771c57db0Sdan          || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
51871c57db0Sdan          || pExpr->op==TK_LT || pExpr->op==TK_GT
51971c57db0Sdan          || pExpr->op==TK_LE || pExpr->op==TK_GE
52071c57db0Sdan     );
52179752b6eSdrh     assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
52279752b6eSdrh               || (pExpr->op==TK_ISNOT && op==TK_NE) );
52379752b6eSdrh     assert( p5==0 || pExpr->op!=op );
52479752b6eSdrh     assert( p5==SQLITE_NULLEQ || pExpr->op==op );
52571c57db0Sdan 
52679752b6eSdrh     p5 |= SQLITE_STOREP2;
52779752b6eSdrh     if( opx==TK_LE ) opx = TK_LT;
52879752b6eSdrh     if( opx==TK_GE ) opx = TK_GT;
5295c288b92Sdan 
5305c288b92Sdan     regLeft = exprCodeSubselect(pParse, pLeft);
5315c288b92Sdan     regRight = exprCodeSubselect(pParse, pRight);
5325c288b92Sdan 
5335c288b92Sdan     for(i=0; i<nLeft; i++){
5345c288b92Sdan       int regFree1 = 0, regFree2 = 0;
5355c288b92Sdan       Expr *pL, *pR;
5365c288b92Sdan       int r1, r2;
53779752b6eSdrh       if( i>0 ) sqlite3ExprCachePush(pParse);
5385c288b92Sdan       r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5395c288b92Sdan       r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
54079752b6eSdrh       codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
54179752b6eSdrh       testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
54279752b6eSdrh       testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
54379752b6eSdrh       testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
54479752b6eSdrh       testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
54579752b6eSdrh       testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
54679752b6eSdrh       testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
54771c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree1);
54871c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree2);
54979752b6eSdrh       if( i>0 ) sqlite3ExprCachePop(pParse);
55079752b6eSdrh       if( i==nLeft-1 ){
55179752b6eSdrh         break;
55271c57db0Sdan       }
55379752b6eSdrh       if( opx==TK_EQ ){
55479752b6eSdrh         sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
55579752b6eSdrh         p5 |= SQLITE_KEEPNULL;
55679752b6eSdrh       }else if( opx==TK_NE ){
55779752b6eSdrh         sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
55879752b6eSdrh         p5 |= SQLITE_KEEPNULL;
559a2f62925Sdrh       }else{
560a2f62925Sdrh         assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
561a2f62925Sdrh         sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
56279752b6eSdrh         VdbeCoverageIf(v, op==TK_LT);
56379752b6eSdrh         VdbeCoverageIf(v, op==TK_GT);
56479752b6eSdrh         VdbeCoverageIf(v, op==TK_LE);
56579752b6eSdrh         VdbeCoverageIf(v, op==TK_GE);
56679752b6eSdrh         if( i==nLeft-2 ) opx = op;
56771c57db0Sdan       }
56879752b6eSdrh     }
56979752b6eSdrh     sqlite3VdbeResolveLabel(v, addrDone);
57079752b6eSdrh   }
57171c57db0Sdan }
57271c57db0Sdan 
5734b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
5744b5255acSdanielk1977 /*
5754b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
5764b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
5774b5255acSdanielk1977 ** pParse.
5784b5255acSdanielk1977 */
5797d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
5804b5255acSdanielk1977   int rc = SQLITE_OK;
5814b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
5824b5255acSdanielk1977   if( nHeight>mxHeight ){
5834b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
5844b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
5854b5255acSdanielk1977     );
5864b5255acSdanielk1977     rc = SQLITE_ERROR;
5874b5255acSdanielk1977   }
5884b5255acSdanielk1977   return rc;
5894b5255acSdanielk1977 }
5904b5255acSdanielk1977 
5914b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
5924b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
5934b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
5944b5255acSdanielk1977 ** first argument.
5954b5255acSdanielk1977 **
5964b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
5974b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
5984b5255acSdanielk1977 ** value.
5994b5255acSdanielk1977 */
6004b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6014b5255acSdanielk1977   if( p ){
6024b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6034b5255acSdanielk1977       *pnHeight = p->nHeight;
6044b5255acSdanielk1977     }
6054b5255acSdanielk1977   }
6064b5255acSdanielk1977 }
6074b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6084b5255acSdanielk1977   if( p ){
6094b5255acSdanielk1977     int i;
6104b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6114b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6124b5255acSdanielk1977     }
6134b5255acSdanielk1977   }
6144b5255acSdanielk1977 }
6154b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
6164b5255acSdanielk1977   if( p ){
6174b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6184b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6194b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6204b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
6214b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6224b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6234b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6244b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
6254b5255acSdanielk1977   }
6264b5255acSdanielk1977 }
6274b5255acSdanielk1977 
6284b5255acSdanielk1977 /*
6294b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6304b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6314b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6324b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6334b5255acSdanielk1977 ** referenced Expr plus one.
6342308ed38Sdrh **
6352308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6362308ed38Sdrh ** if appropriate.
6374b5255acSdanielk1977 */
6384b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6394b5255acSdanielk1977   int nHeight = 0;
6404b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6414b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6426ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6436ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6442308ed38Sdrh   }else if( p->x.pList ){
6456ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6462308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6476ab3a2ecSdanielk1977   }
6484b5255acSdanielk1977   p->nHeight = nHeight + 1;
6494b5255acSdanielk1977 }
6504b5255acSdanielk1977 
6514b5255acSdanielk1977 /*
6524b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6534b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6544b5255acSdanielk1977 ** leave an error in pParse.
6552308ed38Sdrh **
6562308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
6572308ed38Sdrh ** Expr.flags.
6584b5255acSdanielk1977 */
6592308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
66074893a4cSdrh   if( pParse->nErr ) return;
6614b5255acSdanielk1977   exprSetHeight(p);
6627d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
6634b5255acSdanielk1977 }
6644b5255acSdanielk1977 
6654b5255acSdanielk1977 /*
6664b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
6674b5255acSdanielk1977 ** by the select statement passed as an argument.
6684b5255acSdanielk1977 */
6694b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
6704b5255acSdanielk1977   int nHeight = 0;
6714b5255acSdanielk1977   heightOfSelect(p, &nHeight);
6724b5255acSdanielk1977   return nHeight;
6734b5255acSdanielk1977 }
6742308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
6752308ed38Sdrh /*
6762308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
6772308ed38Sdrh ** Expr.flags.
6782308ed38Sdrh */
6792308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
6802308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
6812308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6822308ed38Sdrh   }
6832308ed38Sdrh }
6844b5255acSdanielk1977 #define exprSetHeight(y)
6854b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
6864b5255acSdanielk1977 
687be5c89acSdrh /*
688b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
689b7916a78Sdrh **
690a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
691b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
692b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
693a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
694b7916a78Sdrh **
695b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
696e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
697b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
698b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
699b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
70033e619fcSdrh **
70133e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
70233e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
70333e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
70433e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
70533e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
706a76b5dfcSdrh */
707b7916a78Sdrh Expr *sqlite3ExprAlloc(
708a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
70917435752Sdrh   int op,                 /* Expression opcode */
710b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
711b7916a78Sdrh   int dequote             /* True to dequote */
71217435752Sdrh ){
713a76b5dfcSdrh   Expr *pNew;
71433e619fcSdrh   int nExtra = 0;
715cf697396Sshane   int iValue = 0;
716b7916a78Sdrh 
717575fad65Sdrh   assert( db!=0 );
718b7916a78Sdrh   if( pToken ){
71933e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
72033e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
721b7916a78Sdrh       nExtra = pToken->n+1;
722d50ffc41Sdrh       assert( iValue>=0 );
72333e619fcSdrh     }
724a76b5dfcSdrh   }
725575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
726b7916a78Sdrh   if( pNew ){
727ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7281bd10f8aSdrh     pNew->op = (u8)op;
729a58fdfb1Sdanielk1977     pNew->iAgg = -1;
730a76b5dfcSdrh     if( pToken ){
73133e619fcSdrh       if( nExtra==0 ){
73233e619fcSdrh         pNew->flags |= EP_IntValue;
73333e619fcSdrh         pNew->u.iValue = iValue;
73433e619fcSdrh       }else{
73533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
736b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
737b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
73833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
739244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
740244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
74133e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
742a34001c9Sdrh         }
743a34001c9Sdrh       }
74433e619fcSdrh     }
745b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
746b7916a78Sdrh     pNew->nHeight = 1;
747b7916a78Sdrh #endif
748a34001c9Sdrh   }
749a76b5dfcSdrh   return pNew;
750a76b5dfcSdrh }
751a76b5dfcSdrh 
752a76b5dfcSdrh /*
753b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
754b7916a78Sdrh ** already been dequoted.
755b7916a78Sdrh */
756b7916a78Sdrh Expr *sqlite3Expr(
757b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
758b7916a78Sdrh   int op,                 /* Expression opcode */
759b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
760b7916a78Sdrh ){
761b7916a78Sdrh   Token x;
762b7916a78Sdrh   x.z = zToken;
763b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
764b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
765b7916a78Sdrh }
766b7916a78Sdrh 
767b7916a78Sdrh /*
768b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
769b7916a78Sdrh **
770b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
771b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
772b7916a78Sdrh */
773b7916a78Sdrh void sqlite3ExprAttachSubtrees(
774b7916a78Sdrh   sqlite3 *db,
775b7916a78Sdrh   Expr *pRoot,
776b7916a78Sdrh   Expr *pLeft,
777b7916a78Sdrh   Expr *pRight
778b7916a78Sdrh ){
779b7916a78Sdrh   if( pRoot==0 ){
780b7916a78Sdrh     assert( db->mallocFailed );
781b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
782b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
783b7916a78Sdrh   }else{
784b7916a78Sdrh     if( pRight ){
785b7916a78Sdrh       pRoot->pRight = pRight;
786885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
787b7916a78Sdrh     }
788b7916a78Sdrh     if( pLeft ){
789b7916a78Sdrh       pRoot->pLeft = pLeft;
790885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
791b7916a78Sdrh     }
792b7916a78Sdrh     exprSetHeight(pRoot);
793b7916a78Sdrh   }
794b7916a78Sdrh }
795b7916a78Sdrh 
796b7916a78Sdrh /*
79760ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
798b7916a78Sdrh **
799bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
800bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
801bf664469Sdrh ** free the subtrees and return NULL.
802206f3d96Sdrh */
80317435752Sdrh Expr *sqlite3PExpr(
80417435752Sdrh   Parse *pParse,          /* Parsing context */
80517435752Sdrh   int op,                 /* Expression opcode */
80617435752Sdrh   Expr *pLeft,            /* Left operand */
80717435752Sdrh   Expr *pRight,           /* Right operand */
80817435752Sdrh   const Token *pToken     /* Argument token */
80917435752Sdrh ){
8105fb52caaSdrh   Expr *p;
8111167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8125fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8135fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8145fb52caaSdrh   }else{
8151167d327Sdrh     p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
816b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8175fb52caaSdrh   }
8182b359bdbSdan   if( p ) {
8192b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8202b359bdbSdan   }
8214e0cff60Sdrh   return p;
8224e0cff60Sdrh }
8234e0cff60Sdrh 
8244e0cff60Sdrh /*
82508de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
82608de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
82708de4f79Sdrh */
82808de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
82908de4f79Sdrh   if( pExpr ){
83008de4f79Sdrh     pExpr->x.pSelect = pSelect;
83108de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
83208de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
83308de4f79Sdrh   }else{
83408de4f79Sdrh     assert( pParse->db->mallocFailed );
83508de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
83608de4f79Sdrh   }
83708de4f79Sdrh }
83808de4f79Sdrh 
83908de4f79Sdrh 
84008de4f79Sdrh /*
841991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
842991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
843991a1985Sdrh ** expression at compile-time return 0.
844991a1985Sdrh **
845991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
846991a1985Sdrh ** the expression really is always false or false (a false negative).
847991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
848991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8495fb52caaSdrh **
8505fb52caaSdrh ** Note that if the expression is part of conditional for a
8515fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8525fb52caaSdrh ** is it true or false, so always return 0.
8535fb52caaSdrh */
854991a1985Sdrh static int exprAlwaysTrue(Expr *p){
855991a1985Sdrh   int v = 0;
856991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
857991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
858991a1985Sdrh   return v!=0;
859991a1985Sdrh }
8605fb52caaSdrh static int exprAlwaysFalse(Expr *p){
8615fb52caaSdrh   int v = 0;
8625fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
8635fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
8645fb52caaSdrh   return v==0;
8655fb52caaSdrh }
8665fb52caaSdrh 
8675fb52caaSdrh /*
86891bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
86991bb0eedSdrh ** NULL, then just return the other expression.
8705fb52caaSdrh **
8715fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8725fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8735fb52caaSdrh ** a value of false.
87491bb0eedSdrh */
8751e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
87691bb0eedSdrh   if( pLeft==0 ){
87791bb0eedSdrh     return pRight;
87891bb0eedSdrh   }else if( pRight==0 ){
87991bb0eedSdrh     return pLeft;
8805fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
8815fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
8825fb52caaSdrh     sqlite3ExprDelete(db, pRight);
8835fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
88491bb0eedSdrh   }else{
885b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
886b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
887b7916a78Sdrh     return pNew;
888a76b5dfcSdrh   }
889a76b5dfcSdrh }
890a76b5dfcSdrh 
891a76b5dfcSdrh /*
892a76b5dfcSdrh ** Construct a new expression node for a function with multiple
893a76b5dfcSdrh ** arguments.
894a76b5dfcSdrh */
89517435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
896a76b5dfcSdrh   Expr *pNew;
897633e6d57Sdrh   sqlite3 *db = pParse->db;
8984b202ae2Sdanielk1977   assert( pToken );
899b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
900a76b5dfcSdrh   if( pNew==0 ){
901d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
902a76b5dfcSdrh     return 0;
903a76b5dfcSdrh   }
9046ab3a2ecSdanielk1977   pNew->x.pList = pList;
9056ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9062308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
907a76b5dfcSdrh   return pNew;
908a76b5dfcSdrh }
909a76b5dfcSdrh 
910a76b5dfcSdrh /*
911fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
912fa6bc000Sdrh ** in the original SQL statement.
913fa6bc000Sdrh **
914fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
915fa6bc000Sdrh ** variable number.
916fa6bc000Sdrh **
917fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
918fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
919fa6bc000Sdrh ** the SQL statement comes from an external source.
920fa6bc000Sdrh **
92151f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
922fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
92360ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
924fa6bc000Sdrh ** assigned.
925fa6bc000Sdrh */
926fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
92717435752Sdrh   sqlite3 *db = pParse->db;
928b7916a78Sdrh   const char *z;
92917435752Sdrh 
930fa6bc000Sdrh   if( pExpr==0 ) return;
931c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
93233e619fcSdrh   z = pExpr->u.zToken;
933b7916a78Sdrh   assert( z!=0 );
934b7916a78Sdrh   assert( z[0]!=0 );
935b7916a78Sdrh   if( z[1]==0 ){
936fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
937b7916a78Sdrh     assert( z[0]=='?' );
9388677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
939124c0b49Sdrh   }else{
940124c0b49Sdrh     ynVar x = 0;
941124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
942124c0b49Sdrh     if( z[0]=='?' ){
943fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
944fa6bc000Sdrh       ** use it as the variable number */
945c8d735aeSdan       i64 i;
946124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
947124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
948c5499befSdrh       testcase( i==0 );
949c5499befSdrh       testcase( i==1 );
950c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
951c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
952c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
953fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
954bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
955124c0b49Sdrh         x = 0;
956fa6bc000Sdrh       }
957fa6bc000Sdrh       if( i>pParse->nVar ){
9581df2db7fSshaneh         pParse->nVar = (int)i;
959fa6bc000Sdrh       }
960fa6bc000Sdrh     }else{
96151f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
962fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
963fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
964fa6bc000Sdrh       */
965124c0b49Sdrh       ynVar i;
966124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
967503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
968124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
969fa6bc000Sdrh           break;
970fa6bc000Sdrh         }
971fa6bc000Sdrh       }
972124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
973fa6bc000Sdrh     }
974124c0b49Sdrh     if( x>0 ){
975124c0b49Sdrh       if( x>pParse->nzVar ){
976124c0b49Sdrh         char **a;
977124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
9784a642b60Sdrh         if( a==0 ){
9794a642b60Sdrh           assert( db->mallocFailed ); /* Error reported through mallocFailed */
9804a642b60Sdrh           return;
9814a642b60Sdrh         }
982124c0b49Sdrh         pParse->azVar = a;
983124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
984124c0b49Sdrh         pParse->nzVar = x;
985124c0b49Sdrh       }
986124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
987124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
988124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
989fa6bc000Sdrh       }
990fa6bc000Sdrh     }
991fa6bc000Sdrh   }
992bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
993832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
994832b2664Sdanielk1977   }
995fa6bc000Sdrh }
996fa6bc000Sdrh 
997fa6bc000Sdrh /*
998f6963f99Sdan ** Recursively delete an expression tree.
999a2e00042Sdrh */
10004f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10014f0010b1Sdrh   assert( p!=0 );
1002d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1003d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1004c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
1005c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1006c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
100771c57db0Sdan     if( p->op!=TK_SELECT_COLUMN ) sqlite3ExprDelete(db, p->pLeft);
1008633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
1009c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
10106ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
10116ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10126ab3a2ecSdanielk1977     }else{
10136ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10146ab3a2ecSdanielk1977     }
10156ab3a2ecSdanielk1977   }
101633e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1017633e6d57Sdrh     sqlite3DbFree(db, p);
1018a2e00042Sdrh   }
101933e619fcSdrh }
10204f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10214f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10224f0010b1Sdrh }
1023a2e00042Sdrh 
1024d2687b77Sdrh /*
10256ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10266ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10276ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10286ab3a2ecSdanielk1977 */
10296ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10306ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10316ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10326ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10336ab3a2ecSdanielk1977 }
10346ab3a2ecSdanielk1977 
10356ab3a2ecSdanielk1977 /*
103633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
103733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
103833e619fcSdrh ** how much of the tree is measured.
103933e619fcSdrh **
104033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
104133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
104233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
104333e619fcSdrh **
104433e619fcSdrh ***************************************************************************
104533e619fcSdrh **
104633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
104733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
104833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
104933e619fcSdrh ** The return values is always one of:
105033e619fcSdrh **
105133e619fcSdrh **      EXPR_FULLSIZE
105233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
105333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
105433e619fcSdrh **
105533e619fcSdrh ** The size of the structure can be found by masking the return value
105633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
105733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
105833e619fcSdrh **
105933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
106033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
106133e619fcSdrh ** During expression analysis, extra information is computed and moved into
106233e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
106333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
106460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
106533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
106633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
106733e619fcSdrh ** to enforce this constraint.
10686ab3a2ecSdanielk1977 */
10696ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
10706ab3a2ecSdanielk1977   int nSize;
107133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1072aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1073aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
10743c19469cSdrh   if( 0==flags ){
10756ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
10766ab3a2ecSdanielk1977   }else{
1077c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
107833e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1079c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1080ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1081aecd8021Sdrh     if( p->pLeft || p->x.pList ){
108233e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
108333e619fcSdrh     }else{
1084aecd8021Sdrh       assert( p->pRight==0 );
108533e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
108633e619fcSdrh     }
10876ab3a2ecSdanielk1977   }
10886ab3a2ecSdanielk1977   return nSize;
10896ab3a2ecSdanielk1977 }
10906ab3a2ecSdanielk1977 
10916ab3a2ecSdanielk1977 /*
109233e619fcSdrh ** This function returns the space in bytes required to store the copy
109333e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
109433e619fcSdrh ** string is defined.)
10956ab3a2ecSdanielk1977 */
10966ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
109733e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
109833e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
109933e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11006ab3a2ecSdanielk1977   }
1101bc73971dSdanielk1977   return ROUND8(nByte);
11026ab3a2ecSdanielk1977 }
11036ab3a2ecSdanielk1977 
11046ab3a2ecSdanielk1977 /*
11056ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11066ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11076ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11086ab3a2ecSdanielk1977 **
11096ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
111033e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11116ab3a2ecSdanielk1977 **
11126ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11136ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11146ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11156ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11166ab3a2ecSdanielk1977 */
11176ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11186ab3a2ecSdanielk1977   int nByte = 0;
11196ab3a2ecSdanielk1977   if( p ){
11206ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11216ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1122b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11236ab3a2ecSdanielk1977     }
11246ab3a2ecSdanielk1977   }
11256ab3a2ecSdanielk1977   return nByte;
11266ab3a2ecSdanielk1977 }
11276ab3a2ecSdanielk1977 
11286ab3a2ecSdanielk1977 /*
11296ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11306ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
113133e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11326ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
113360ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11346ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11356ab3a2ecSdanielk1977 */
11363c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11373c19469cSdrh   Expr *pNew;           /* Value to return */
11383c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11393c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11406ab3a2ecSdanielk1977 
11413c19469cSdrh   assert( db!=0 );
11423c19469cSdrh   assert( p );
11433c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11443c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11456ab3a2ecSdanielk1977 
11466ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11476ab3a2ecSdanielk1977   if( pzBuffer ){
11486ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
114933e619fcSdrh     staticFlag = EP_Static;
11506ab3a2ecSdanielk1977   }else{
11513c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
11523c19469cSdrh     staticFlag = 0;
11536ab3a2ecSdanielk1977   }
11546ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
11556ab3a2ecSdanielk1977 
11566ab3a2ecSdanielk1977   if( pNew ){
11576ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
11586ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
11596ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
116033e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
11616ab3a2ecSdanielk1977     */
11623c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
116333e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
116433e619fcSdrh     int nToken;
116533e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
116633e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
116733e619fcSdrh     }else{
116833e619fcSdrh       nToken = 0;
116933e619fcSdrh     }
11703c19469cSdrh     if( dupFlags ){
11716ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11726ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11736ab3a2ecSdanielk1977     }else{
11743e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11756ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
117672ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
11776ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
11786ab3a2ecSdanielk1977       }
117972ea29d7Sdrh     }
11806ab3a2ecSdanielk1977 
118133e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1182c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
118333e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
118433e619fcSdrh     pNew->flags |= staticFlag;
11856ab3a2ecSdanielk1977 
118633e619fcSdrh     /* Copy the p->u.zToken string, if any. */
11876ab3a2ecSdanielk1977     if( nToken ){
118833e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
118933e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
11906ab3a2ecSdanielk1977     }
11916ab3a2ecSdanielk1977 
11926ab3a2ecSdanielk1977     if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
11936ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
11946ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
11953c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
11966ab3a2ecSdanielk1977       }else{
11973c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
11986ab3a2ecSdanielk1977       }
11996ab3a2ecSdanielk1977     }
12006ab3a2ecSdanielk1977 
12016ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1202c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12033c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
12046ab3a2ecSdanielk1977       if( ExprHasProperty(pNew, EP_Reduced) ){
12053c19469cSdrh         pNew->pLeft = p->pLeft ?
12063c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12073c19469cSdrh         pNew->pRight = p->pRight ?
12083c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12096ab3a2ecSdanielk1977       }
12106ab3a2ecSdanielk1977       if( pzBuffer ){
12116ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12126ab3a2ecSdanielk1977       }
1213b7916a78Sdrh     }else{
1214c5cd1249Sdrh       if( !ExprHasProperty(p, EP_TokenOnly) ){
12159854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12169854260bSdrh           pNew->pLeft = p->pLeft;
12179854260bSdrh         }else{
12186ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12199854260bSdrh         }
12206ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12216ab3a2ecSdanielk1977       }
12226ab3a2ecSdanielk1977     }
12236ab3a2ecSdanielk1977   }
12246ab3a2ecSdanielk1977   return pNew;
12256ab3a2ecSdanielk1977 }
12266ab3a2ecSdanielk1977 
12276ab3a2ecSdanielk1977 /*
1228bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1229bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1230bfe31e7fSdan ** and the db->mallocFailed flag set.
1231bfe31e7fSdan */
1232eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1233bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12344e9119d9Sdan   With *pRet = 0;
12354e9119d9Sdan   if( p ){
12364e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12374e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12384e9119d9Sdan     if( pRet ){
12394e9119d9Sdan       int i;
12404e9119d9Sdan       pRet->nCte = p->nCte;
12414e9119d9Sdan       for(i=0; i<p->nCte; i++){
12424e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
12434e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
12444e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
12454e9119d9Sdan       }
12464e9119d9Sdan     }
12474e9119d9Sdan   }
12484e9119d9Sdan   return pRet;
12494e9119d9Sdan }
1250eede6a53Sdan #else
1251eede6a53Sdan # define withDup(x,y) 0
1252eede6a53Sdan #endif
12534e9119d9Sdan 
1254a76b5dfcSdrh /*
1255ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1256ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1257ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1258ff78bd2fSdrh ** without effecting the originals.
1259ff78bd2fSdrh **
12604adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
12614adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1262ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1263ff78bd2fSdrh **
1264ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
12656ab3a2ecSdanielk1977 **
1266b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
12676ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
12686ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
12696ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1270ff78bd2fSdrh */
12716ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
127272ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
12733c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1274ff78bd2fSdrh }
12756ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1276ff78bd2fSdrh   ExprList *pNew;
1277145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1278ff78bd2fSdrh   int i;
1279575fad65Sdrh   assert( db!=0 );
1280ff78bd2fSdrh   if( p==0 ) return 0;
1281575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1282ff78bd2fSdrh   if( pNew==0 ) return 0;
1283d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
1284d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1285575fad65Sdrh   pNew->a = pItem = sqlite3DbMallocRawNN(db,  i*sizeof(p->a[0]) );
1286e0048400Sdanielk1977   if( pItem==0 ){
1287633e6d57Sdrh     sqlite3DbFree(db, pNew);
1288e0048400Sdanielk1977     return 0;
1289e0048400Sdanielk1977   }
1290145716b3Sdrh   pOldItem = p->a;
1291145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
12926ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1293b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
129417435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1295b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1296145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
12973e7bc9caSdrh     pItem->done = 0;
12982c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1299c2acc4e4Sdrh     pItem->u = pOldItem->u;
1300ff78bd2fSdrh   }
1301ff78bd2fSdrh   return pNew;
1302ff78bd2fSdrh }
130393758c8dSdanielk1977 
130493758c8dSdanielk1977 /*
130593758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
130693758c8dSdanielk1977 ** the build, then none of the following routines, except for
130793758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
130893758c8dSdanielk1977 ** called with a NULL argument.
130993758c8dSdanielk1977 */
13106a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13116a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13126ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1313ad3cab52Sdrh   SrcList *pNew;
1314ad3cab52Sdrh   int i;
1315113088ecSdrh   int nByte;
1316575fad65Sdrh   assert( db!=0 );
1317ad3cab52Sdrh   if( p==0 ) return 0;
1318113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1319575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1320ad3cab52Sdrh   if( pNew==0 ) return 0;
13214305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1322ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13234efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13244efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1325ed8a3bb1Sdrh     Table *pTab;
132641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
132717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
132817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
132917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13308a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13314efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13325b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
13335b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
13348a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
13358a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
13368a48b9c0Sdrh     }
13378a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
13388a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
13398a48b9c0Sdrh       pNewItem->u1.pFuncArg =
13408a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
13418a48b9c0Sdrh     }
1342ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1343ed8a3bb1Sdrh     if( pTab ){
1344ed8a3bb1Sdrh       pTab->nRef++;
1345a1cb183dSdanielk1977     }
13466ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
13476ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
134817435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
13496c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1350ad3cab52Sdrh   }
1351ad3cab52Sdrh   return pNew;
1352ad3cab52Sdrh }
135317435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1354ff78bd2fSdrh   IdList *pNew;
1355ff78bd2fSdrh   int i;
1356575fad65Sdrh   assert( db!=0 );
1357ff78bd2fSdrh   if( p==0 ) return 0;
1358575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1359ff78bd2fSdrh   if( pNew==0 ) return 0;
13606c535158Sdrh   pNew->nId = p->nId;
1361575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1362d5d56523Sdanielk1977   if( pNew->a==0 ){
1363633e6d57Sdrh     sqlite3DbFree(db, pNew);
1364d5d56523Sdanielk1977     return 0;
1365d5d56523Sdanielk1977   }
13666c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
13676c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
13686c535158Sdrh   ** on the duplicate created by this function. */
1369ff78bd2fSdrh   for(i=0; i<p->nId; i++){
13704efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
13714efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
137217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
13734efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1374ff78bd2fSdrh   }
1375ff78bd2fSdrh   return pNew;
1376ff78bd2fSdrh }
13776ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
137823b1b372Sdrh   Select *pNew, *pPrior;
1379575fad65Sdrh   assert( db!=0 );
1380ff78bd2fSdrh   if( p==0 ) return 0;
1381575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1382ff78bd2fSdrh   if( pNew==0 ) return 0;
1383b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
13846ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
13856ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
13866ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
13876ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
13886ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1389ff78bd2fSdrh   pNew->op = p->op;
139023b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
139123b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
139223b1b372Sdrh   pNew->pNext = 0;
13936ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
13946ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
139592b01d53Sdrh   pNew->iLimit = 0;
139692b01d53Sdrh   pNew->iOffset = 0;
13977d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1398b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1399b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1400ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
14014e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1402eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1403ff78bd2fSdrh   return pNew;
1404ff78bd2fSdrh }
140593758c8dSdanielk1977 #else
14066ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
140793758c8dSdanielk1977   assert( p==0 );
140893758c8dSdanielk1977   return 0;
140993758c8dSdanielk1977 }
141093758c8dSdanielk1977 #endif
1411ff78bd2fSdrh 
1412ff78bd2fSdrh 
1413ff78bd2fSdrh /*
1414a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1415a76b5dfcSdrh ** initially NULL, then create a new expression list.
1416b7916a78Sdrh **
1417b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1418b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1419b7916a78Sdrh ** that the new entry was successfully appended.
1420a76b5dfcSdrh */
142117435752Sdrh ExprList *sqlite3ExprListAppend(
142217435752Sdrh   Parse *pParse,          /* Parsing context */
142317435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1424b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
142517435752Sdrh ){
142617435752Sdrh   sqlite3 *db = pParse->db;
1427575fad65Sdrh   assert( db!=0 );
1428a76b5dfcSdrh   if( pList==0 ){
1429575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1430a76b5dfcSdrh     if( pList==0 ){
1431d5d56523Sdanielk1977       goto no_mem;
1432a76b5dfcSdrh     }
1433c263f7c4Sdrh     pList->nExpr = 0;
1434575fad65Sdrh     pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
1435d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1436d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1437d5d56523Sdanielk1977     struct ExprList_item *a;
1438d872bb18Sdrh     assert( pList->nExpr>0 );
1439d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1440d5d56523Sdanielk1977     if( a==0 ){
1441d5d56523Sdanielk1977       goto no_mem;
1442a76b5dfcSdrh     }
1443d5d56523Sdanielk1977     pList->a = a;
1444a76b5dfcSdrh   }
14454efc4754Sdrh   assert( pList->a!=0 );
1446b7916a78Sdrh   if( 1 ){
14474efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
14484efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1449e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1450a76b5dfcSdrh   }
1451a76b5dfcSdrh   return pList;
1452d5d56523Sdanielk1977 
1453d5d56523Sdanielk1977 no_mem:
1454d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1455633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1456633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1457d5d56523Sdanielk1977   return 0;
1458a76b5dfcSdrh }
1459a76b5dfcSdrh 
1460a76b5dfcSdrh /*
14618762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
14628762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1463a1251bc4Sdrh **
1464a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1465a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1466a1251bc4Sdrh **
1467a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
14688762ec19Sdrh ** expression list pList.  In the case of a subquery on the LHS, append
1469a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1470a1251bc4Sdrh */
1471a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1472a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1473a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1474a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1475a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1476a1251bc4Sdrh ){
1477a1251bc4Sdrh   sqlite3 *db = pParse->db;
1478a1251bc4Sdrh   int n;
1479a1251bc4Sdrh   int i;
1480a1251bc4Sdrh   if( pColumns==0 ) goto vector_append_error;
1481a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1482a1251bc4Sdrh   n = sqlite3ExprVectorSize(pExpr);
1483a1251bc4Sdrh   if( pColumns->nId!=n ){
1484a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1485a1251bc4Sdrh                     pColumns->nId, n);
1486a1251bc4Sdrh     goto vector_append_error;
1487a1251bc4Sdrh   }
1488a1251bc4Sdrh   for(i=0; i<n; i++){
1489a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1490a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1491a1251bc4Sdrh     if( pList ){
1492a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1493a1251bc4Sdrh       pColumns->a[i].zName = 0;
1494a1251bc4Sdrh     }
1495a1251bc4Sdrh   }
1496a1251bc4Sdrh   if( pExpr->op==TK_SELECT ){
1497a1251bc4Sdrh     if( pList && pList->a[0].pExpr ){
1498a1251bc4Sdrh       assert( pList->a[0].pExpr->op==TK_SELECT_COLUMN );
1499a1251bc4Sdrh       pList->a[0].pExpr->pRight = pExpr;
1500a1251bc4Sdrh       pExpr = 0;
1501a1251bc4Sdrh     }
1502a1251bc4Sdrh   }
1503a1251bc4Sdrh 
1504a1251bc4Sdrh vector_append_error:
1505a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1506a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1507a1251bc4Sdrh   return pList;
1508a1251bc4Sdrh }
1509a1251bc4Sdrh 
1510a1251bc4Sdrh /*
1511bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1512bc622bc0Sdrh */
1513bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1514bc622bc0Sdrh   if( p==0 ) return;
1515bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1516bc622bc0Sdrh   assert( p->nExpr>0 );
1517bc622bc0Sdrh   if( iSortOrder<0 ){
1518bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1519bc622bc0Sdrh     return;
1520bc622bc0Sdrh   }
1521bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1522bc622bc0Sdrh }
1523bc622bc0Sdrh 
1524bc622bc0Sdrh /*
1525b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1526b7916a78Sdrh ** on the expression list.
1527b7916a78Sdrh **
1528b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1529b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1530b7916a78Sdrh ** is set.
1531b7916a78Sdrh */
1532b7916a78Sdrh void sqlite3ExprListSetName(
1533b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1534b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1535b7916a78Sdrh   Token *pName,           /* Name to be added */
1536b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1537b7916a78Sdrh ){
1538b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1539b7916a78Sdrh   if( pList ){
1540b7916a78Sdrh     struct ExprList_item *pItem;
1541b7916a78Sdrh     assert( pList->nExpr>0 );
1542b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1543b7916a78Sdrh     assert( pItem->zName==0 );
1544b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1545244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1546b7916a78Sdrh   }
1547b7916a78Sdrh }
1548b7916a78Sdrh 
1549b7916a78Sdrh /*
1550b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1551b7916a78Sdrh ** on the expression list.
1552b7916a78Sdrh **
1553b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1554b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1555b7916a78Sdrh ** is set.
1556b7916a78Sdrh */
1557b7916a78Sdrh void sqlite3ExprListSetSpan(
1558b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1559b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1560b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1561b7916a78Sdrh ){
1562b7916a78Sdrh   sqlite3 *db = pParse->db;
1563b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1564b7916a78Sdrh   if( pList ){
1565b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1566b7916a78Sdrh     assert( pList->nExpr>0 );
1567b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1568b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1569b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1570cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1571b7916a78Sdrh   }
1572b7916a78Sdrh }
1573b7916a78Sdrh 
1574b7916a78Sdrh /*
15757a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
15767a15a4beSdanielk1977 ** leave an error message in pParse.
15777a15a4beSdanielk1977 */
15787a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
15797a15a4beSdanielk1977   Parse *pParse,
15807a15a4beSdanielk1977   ExprList *pEList,
15817a15a4beSdanielk1977   const char *zObject
15827a15a4beSdanielk1977 ){
1583b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1584c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1585c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1586b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
15877a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
15887a15a4beSdanielk1977   }
15897a15a4beSdanielk1977 }
15907a15a4beSdanielk1977 
15917a15a4beSdanielk1977 /*
1592a76b5dfcSdrh ** Delete an entire expression list.
1593a76b5dfcSdrh */
1594affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1595a76b5dfcSdrh   int i;
1596be5c89acSdrh   struct ExprList_item *pItem;
1597d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1598be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1599633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1600633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1601b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1602a76b5dfcSdrh   }
1603633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1604633e6d57Sdrh   sqlite3DbFree(db, pList);
1605a76b5dfcSdrh }
1606affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1607affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1608affa855cSdrh }
1609a76b5dfcSdrh 
1610a76b5dfcSdrh /*
16112308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
16122308ed38Sdrh ** ExprList.
1613885a5b03Sdrh */
16142308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1615885a5b03Sdrh   int i;
16162308ed38Sdrh   u32 m = 0;
16172308ed38Sdrh   if( pList ){
1618885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1619d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1620de845c2fSdrh        assert( pExpr!=0 );
1621de845c2fSdrh        m |= pExpr->flags;
1622885a5b03Sdrh     }
16232308ed38Sdrh   }
16242308ed38Sdrh   return m;
1625885a5b03Sdrh }
1626885a5b03Sdrh 
1627885a5b03Sdrh /*
1628059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1629059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1630059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1631059b2d50Sdrh ** for.
163273b211abSdrh **
16337d10d5a6Sdrh ** These callback routines are used to implement the following:
1634626a879aSdrh **
1635059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1636059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1637fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1638059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
163987abf5c0Sdrh **
1640059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1641059b2d50Sdrh ** is found to not be a constant.
164287abf5c0Sdrh **
1643feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1644059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1645059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1646feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1647feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1648feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1649feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1650feada2dfSdrh ** malformed schema error.
1651626a879aSdrh */
16527d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1653626a879aSdrh 
1654059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1655059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
16560a168377Sdrh   ** from being considered constant. */
1657059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1658059b2d50Sdrh     pWalker->eCode = 0;
16597d10d5a6Sdrh     return WRC_Abort;
16600a168377Sdrh   }
16610a168377Sdrh 
1662626a879aSdrh   switch( pExpr->op ){
1663eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1664059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1665059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1666eb55bd2fSdrh     case TK_FUNCTION:
166763f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1668b1fba286Sdrh         return WRC_Continue;
1669059b2d50Sdrh       }else{
1670059b2d50Sdrh         pWalker->eCode = 0;
1671059b2d50Sdrh         return WRC_Abort;
1672b1fba286Sdrh       }
1673626a879aSdrh     case TK_ID:
1674626a879aSdrh     case TK_COLUMN:
1675626a879aSdrh     case TK_AGG_FUNCTION:
167613449892Sdrh     case TK_AGG_COLUMN:
1677c5499befSdrh       testcase( pExpr->op==TK_ID );
1678c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1679c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1680c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1681059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1682059b2d50Sdrh         return WRC_Continue;
1683059b2d50Sdrh       }else{
1684059b2d50Sdrh         pWalker->eCode = 0;
16857d10d5a6Sdrh         return WRC_Abort;
1686059b2d50Sdrh       }
1687feada2dfSdrh     case TK_VARIABLE:
1688059b2d50Sdrh       if( pWalker->eCode==5 ){
1689feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1690feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1691feada2dfSdrh         ** of the sqlite_master table */
1692feada2dfSdrh         pExpr->op = TK_NULL;
1693059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1694feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1695feada2dfSdrh         ** sqlite3_prepare() causes an error */
1696059b2d50Sdrh         pWalker->eCode = 0;
1697feada2dfSdrh         return WRC_Abort;
1698feada2dfSdrh       }
1699feada2dfSdrh       /* Fall through */
1700626a879aSdrh     default:
1701b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1702b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
17037d10d5a6Sdrh       return WRC_Continue;
1704626a879aSdrh   }
1705626a879aSdrh }
170662c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
170762c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1708059b2d50Sdrh   pWalker->eCode = 0;
17097d10d5a6Sdrh   return WRC_Abort;
17107d10d5a6Sdrh }
1711059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
17127d10d5a6Sdrh   Walker w;
1713aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1714059b2d50Sdrh   w.eCode = initFlag;
17157d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
17167d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1717059b2d50Sdrh   w.u.iCur = iCur;
17187d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1719059b2d50Sdrh   return w.eCode;
17207d10d5a6Sdrh }
1721626a879aSdrh 
1722626a879aSdrh /*
1723059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1724eb55bd2fSdrh ** and 0 if it involves variables or function calls.
17252398937bSdrh **
17262398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
17272398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
17282398937bSdrh ** a constant.
1729fef5208cSdrh */
17304adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1731059b2d50Sdrh   return exprIsConst(p, 1, 0);
1732fef5208cSdrh }
1733fef5208cSdrh 
1734fef5208cSdrh /*
1735059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
17360a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
17370a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
17380a168377Sdrh ** an ON or USING clause.
17390a168377Sdrh */
17400a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1741059b2d50Sdrh   return exprIsConst(p, 2, 0);
17420a168377Sdrh }
17430a168377Sdrh 
17440a168377Sdrh /*
1745fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1746059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1747059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1748059b2d50Sdrh ** table other than iCur.
1749059b2d50Sdrh */
1750059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1751059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1752059b2d50Sdrh }
1753059b2d50Sdrh 
1754059b2d50Sdrh /*
1755059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1756eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1757eb55bd2fSdrh ** are any variables.
1758eb55bd2fSdrh **
1759eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1760eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1761eb55bd2fSdrh ** a constant.
1762eb55bd2fSdrh */
1763feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1764feada2dfSdrh   assert( isInit==0 || isInit==1 );
1765059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1766eb55bd2fSdrh }
1767eb55bd2fSdrh 
17685b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
17695b88bc4bSdrh /*
17705b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
17715b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
17725b88bc4bSdrh */
17735b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
17745b88bc4bSdrh   Walker w;
17755b88bc4bSdrh   memset(&w, 0, sizeof(w));
1776bec2476aSdrh   w.eCode = 1;
17775b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
17785b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
17795b88bc4bSdrh   sqlite3WalkExpr(&w, p);
178007194bffSdrh   return w.eCode==0;
17815b88bc4bSdrh }
17825b88bc4bSdrh #endif
17835b88bc4bSdrh 
1784eb55bd2fSdrh /*
178573b211abSdrh ** If the expression p codes a constant integer that is small enough
1786202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1787202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1788202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1789e4de1febSdrh */
17904adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
179192b01d53Sdrh   int rc = 0;
1792cd92e84dSdrh 
1793cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1794cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1795cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1796cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1797cd92e84dSdrh 
179892b01d53Sdrh   if( p->flags & EP_IntValue ){
179933e619fcSdrh     *pValue = p->u.iValue;
1800e4de1febSdrh     return 1;
1801e4de1febSdrh   }
180292b01d53Sdrh   switch( p->op ){
18034b59ab5eSdrh     case TK_UPLUS: {
180492b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1805f6e369a1Sdrh       break;
18064b59ab5eSdrh     }
1807e4de1febSdrh     case TK_UMINUS: {
1808e4de1febSdrh       int v;
18094adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1810f6418891Smistachkin         assert( v!=(-2147483647-1) );
1811e4de1febSdrh         *pValue = -v;
181292b01d53Sdrh         rc = 1;
1813e4de1febSdrh       }
1814e4de1febSdrh       break;
1815e4de1febSdrh     }
1816e4de1febSdrh     default: break;
1817e4de1febSdrh   }
181892b01d53Sdrh   return rc;
1819e4de1febSdrh }
1820e4de1febSdrh 
1821e4de1febSdrh /*
1822039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1823039fc32eSdrh **
1824039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1825039fc32eSdrh ** to tell return TRUE.
1826039fc32eSdrh **
1827039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1828039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1829039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1830039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1831039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1832039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1833039fc32eSdrh ** TRUE.
1834039fc32eSdrh */
1835039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1836039fc32eSdrh   u8 op;
1837cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1838039fc32eSdrh   op = p->op;
1839039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1840039fc32eSdrh   switch( op ){
1841039fc32eSdrh     case TK_INTEGER:
1842039fc32eSdrh     case TK_STRING:
1843039fc32eSdrh     case TK_FLOAT:
1844039fc32eSdrh     case TK_BLOB:
1845039fc32eSdrh       return 0;
18467248a8b2Sdrh     case TK_COLUMN:
18477248a8b2Sdrh       assert( p->pTab!=0 );
184872673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
184972673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1850039fc32eSdrh     default:
1851039fc32eSdrh       return 1;
1852039fc32eSdrh   }
1853039fc32eSdrh }
1854039fc32eSdrh 
1855039fc32eSdrh /*
1856039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1857039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1858039fc32eSdrh ** argument.
1859039fc32eSdrh **
1860039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1861039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1862039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1863039fc32eSdrh ** answer.
1864039fc32eSdrh */
1865039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1866039fc32eSdrh   u8 op;
186705883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1868cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1869039fc32eSdrh   op = p->op;
1870039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1871039fc32eSdrh   switch( op ){
1872039fc32eSdrh     case TK_INTEGER: {
1873039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1874039fc32eSdrh     }
1875039fc32eSdrh     case TK_FLOAT: {
1876039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1877039fc32eSdrh     }
1878039fc32eSdrh     case TK_STRING: {
1879039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1880039fc32eSdrh     }
1881039fc32eSdrh     case TK_BLOB: {
1882039fc32eSdrh       return 1;
1883039fc32eSdrh     }
18842f2855b6Sdrh     case TK_COLUMN: {
188588376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
188688376ca7Sdrh       return p->iColumn<0
18872f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
18882f2855b6Sdrh     }
1889039fc32eSdrh     default: {
1890039fc32eSdrh       return 0;
1891039fc32eSdrh     }
1892039fc32eSdrh   }
1893039fc32eSdrh }
1894039fc32eSdrh 
1895039fc32eSdrh /*
1896c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1897c4a3c779Sdrh */
18984adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
18994adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
19004adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
19014adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1902c4a3c779Sdrh   return 0;
1903c4a3c779Sdrh }
1904c4a3c779Sdrh 
19059a96b668Sdanielk1977 /*
190669c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
190769c355bdSdrh ** that can be simplified to a direct table access, then return
190869c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
190969c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
191069c355bdSdrh ** table, then return NULL.
1911b287f4b6Sdrh */
1912b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
19137b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
191469c355bdSdrh   Select *p;
1915b287f4b6Sdrh   SrcList *pSrc;
1916b287f4b6Sdrh   ExprList *pEList;
1917b287f4b6Sdrh   Table *pTab;
1918cfbb5e82Sdan   int i;
191969c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
192069c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
192169c355bdSdrh   p = pX->x.pSelect;
1922b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
19237d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1924b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1925b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
19267d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
19277d10d5a6Sdrh   }
1928b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1929b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1930b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1931b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1932b287f4b6Sdrh   pSrc = p->pSrc;
1933d1fa7bcaSdrh   assert( pSrc!=0 );
1934d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1935b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1936b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
193769c355bdSdrh   assert( pTab!=0 );
1938b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1939b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1940b287f4b6Sdrh   pEList = p->pEList;
1941cfbb5e82Sdan 
19427b35a77bSdan   /* All SELECT results must be columns. */
1943cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
1944cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
1945cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
194669c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
1947cfbb5e82Sdan   }
194869c355bdSdrh   return p;
1949b287f4b6Sdrh }
1950b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1951b287f4b6Sdrh 
1952b287f4b6Sdrh /*
19531d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
19541d8cb21fSdan ** address of the new instruction.
19551d8cb21fSdan */
19561d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
19571d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
19581d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
19591d8cb21fSdan }
19601d8cb21fSdan 
1961f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
19621d8cb21fSdan /*
19634c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
19644c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
19656be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
19666be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
19676be515ebSdrh */
19686be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
1969728e0f91Sdrh   int addr1;
19706be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
1971728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
19726be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
19736be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
19744c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
1975728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
19766be515ebSdrh }
1977f9b2e05cSdan #endif
19786be515ebSdrh 
1979bb53ecb1Sdrh 
1980bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1981bb53ecb1Sdrh /*
1982bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
1983bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
1984bb53ecb1Sdrh */
1985bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
1986bb53ecb1Sdrh   Expr *pLHS;
1987bb53ecb1Sdrh   int res;
1988bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1989bb53ecb1Sdrh   pLHS = pIn->pLeft;
1990bb53ecb1Sdrh   pIn->pLeft = 0;
1991bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
1992bb53ecb1Sdrh   pIn->pLeft = pLHS;
1993bb53ecb1Sdrh   return res;
1994bb53ecb1Sdrh }
1995bb53ecb1Sdrh #endif
1996bb53ecb1Sdrh 
19976be515ebSdrh /*
19989a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1999d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2000d4305ca6Sdrh ** might be either a list of expressions or a subquery.
20019a96b668Sdanielk1977 **
2002d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2003d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2004d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2005d4305ca6Sdrh **
20063a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2007d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2008d4305ca6Sdrh **
2009b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
20109a96b668Sdanielk1977 **
20119a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
20121ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
20131ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
20149a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
20159a96b668Sdanielk1977 **                         populated epheremal table.
2016bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2017bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
20189a96b668Sdanielk1977 **
2019d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2020d4305ca6Sdrh ** subquery such as:
20219a96b668Sdanielk1977 **
2022553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
20239a96b668Sdanielk1977 **
2024d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2025d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
202660ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2027d4305ca6Sdrh ** existing table.
2028d4305ca6Sdrh **
20293a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
20303a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
20313a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
20323a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
20333a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
20343a85625dSdrh ** IN operator.
20353a85625dSdrh **
20363a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
20373a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2038553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2039553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2040553168c7Sdan ** a UNIQUE constraint or index.
20410cdc022eSdanielk1977 **
20423a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
20433a85625dSdrh ** for fast set membership tests) then an epheremal table must
2044553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2045553168c7Sdan ** index can be found with the specified <columns> as its left-most.
20460cdc022eSdanielk1977 **
2047bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2048bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2049bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2050bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2051bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2052bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2053bb53ecb1Sdrh **
2054b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
20553a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2056e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
20573a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
20580cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2059e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2060e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
20610cdc022eSdanielk1977 **
2062e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
20636be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
20646be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
20656be515ebSdrh ** NULL values.
2066553168c7Sdan **
2067553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2068553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2069553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2070553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2071553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2072553168c7Sdan **
2073553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2074553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2075553168c7Sdan **
2076553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
20779a96b668Sdanielk1977 */
2078284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2079ba00e30aSdan int sqlite3FindInIndex(
2080ba00e30aSdan   Parse *pParse,
2081ba00e30aSdan   Expr *pX,
2082ba00e30aSdan   u32 inFlags,
2083ba00e30aSdan   int *prRhsHasNull,
2084ba00e30aSdan   int *aiMap
2085ba00e30aSdan ){
2086b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2087b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2088b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
20893a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2090b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
20919a96b668Sdanielk1977 
20921450bc6eSdrh   assert( pX->op==TK_IN );
20933a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
20941450bc6eSdrh 
20957b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
20967b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2097870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
20987b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2099870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
21007b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
21017b35a77bSdan     int i;
21027b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
21037b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
21047b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
21057b35a77bSdan     }
21067b35a77bSdan     if( i==pEList->nExpr ){
21077b35a77bSdan       prRhsHasNull = 0;
21087b35a77bSdan     }
21097b35a77bSdan   }
21107b35a77bSdan 
2111b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2112b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
21137b35a77bSdan   ** ephemeral table.  */
21147b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2115e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2116b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2117ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2118cfbb5e82Sdan     ExprList *pEList = p->pEList;
2119cfbb5e82Sdan     int nExpr = pEList->nExpr;
2120e1fb65a0Sdanielk1977 
2121b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2122b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2123b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2124b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2125b07028f7Sdrh 
2126b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2127e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2128e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2129e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
21309a96b668Sdanielk1977 
21319a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
21329a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
21339a96b668Sdanielk1977     ** successful here.
21349a96b668Sdanielk1977     */
21359a96b668Sdanielk1977     assert(v);
2136cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
21377d176105Sdrh       int iAddr = sqlite3CodeOnce(pParse);
21387d176105Sdrh       VdbeCoverage(v);
21399a96b668Sdanielk1977 
21409a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
21419a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
21429a96b668Sdanielk1977 
21439a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
21449a96b668Sdanielk1977     }else{
2145e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2146cfbb5e82Sdan       int affinity_ok = 1;
2147cfbb5e82Sdan       int i;
2148cfbb5e82Sdan 
2149cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
2150cfbb5e82Sdan       ** comparison is the same as the affinity of each column. If
2151cfbb5e82Sdan       ** it not, it is not possible to use any index.  */
2152cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2153fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2154cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
2155cfbb5e82Sdan         char idxaff = pTab->aCol[iCol].affinity;
2156cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
2157cfbb5e82Sdan         switch( cmpaff ){
2158cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2159cfbb5e82Sdan             break;
2160cfbb5e82Sdan           case SQLITE_AFF_TEXT:
2161cfbb5e82Sdan             affinity_ok = (idxaff==SQLITE_AFF_TEXT);
2162cfbb5e82Sdan             break;
2163cfbb5e82Sdan           default:
2164cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2165cfbb5e82Sdan         }
2166cfbb5e82Sdan       }
2167e1fb65a0Sdanielk1977 
21689a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
21699a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
2170e1fb65a0Sdanielk1977       ** to this collation sequence.  */
21719a96b668Sdanielk1977 
21729a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
2173cfbb5e82Sdan         if( pIdx->nKeyCol<nExpr ) continue;
2174cfbb5e82Sdan         if( mustBeUnique && (pIdx->nKeyCol!=nExpr || !IsUniqueIndex(pIdx)) ){
2175cfbb5e82Sdan           continue;
2176cfbb5e82Sdan         }
2177cfbb5e82Sdan 
2178cfbb5e82Sdan         for(i=0; i<nExpr; i++){
2179fc7f27b9Sdrh           Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2180cfbb5e82Sdan           Expr *pRhs = pEList->a[i].pExpr;
2181cfbb5e82Sdan           CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2182cfbb5e82Sdan           int j;
2183cfbb5e82Sdan 
218417994e3bSdan           assert( pReq || pParse->nErr );
218517994e3bSdan           if( pReq==0 ) break;
218617994e3bSdan 
2187cfbb5e82Sdan           for(j=0; j<nExpr; j++){
2188cfbb5e82Sdan             if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2189cfbb5e82Sdan             assert( pIdx->azColl[j] );
2190cfbb5e82Sdan             if( sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ) continue;
2191cfbb5e82Sdan             break;
2192cfbb5e82Sdan           }
2193cfbb5e82Sdan           if( j==nExpr ) break;
2194ba00e30aSdan           if( aiMap ) aiMap[i] = j;
2195cfbb5e82Sdan         }
2196cfbb5e82Sdan 
2197cfbb5e82Sdan         if( i==nExpr ){
21987d176105Sdrh           int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
21992ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
22002ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2201207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
22021ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
22031ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
22049a96b668Sdanielk1977 
22057b35a77bSdan           if( prRhsHasNull ){
22067b35a77bSdan             *prRhsHasNull = ++pParse->nMem;
22073480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2208cfbb5e82Sdan             i64 mask = (1<<nExpr)-1;
22093480bfdaSdan             sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2210cfbb5e82Sdan                 iTab, 0, 0, (u8*)&mask, P4_INT64);
22113480bfdaSdan #endif
22127b35a77bSdan             if( nExpr==1 ){
22136be515ebSdrh               sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
22140cdc022eSdanielk1977             }
22157b35a77bSdan           }
2216552fd454Sdrh           sqlite3VdbeJumpHere(v, iAddr);
22179a96b668Sdanielk1977         }
22189a96b668Sdanielk1977       }
22199a96b668Sdanielk1977     }
22209a96b668Sdanielk1977   }
22219a96b668Sdanielk1977 
2222bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2223bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2224bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
222571c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
222660ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2227bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2228bb53ecb1Sdrh   */
2229bb53ecb1Sdrh   if( eType==0
2230bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2231bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2232bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2233bb53ecb1Sdrh   ){
2234bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2235bb53ecb1Sdrh   }
2236bb53ecb1Sdrh 
22379a96b668Sdanielk1977   if( eType==0 ){
22384387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2239b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2240b74b1017Sdrh     */
22418e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
22420cdc022eSdanielk1977     int rMayHaveNull = 0;
224341a05b7bSdanielk1977     eType = IN_INDEX_EPH;
22443a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
22454a5acf8eSdrh       pParse->nQueryLoop = 0;
2246c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
224741a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
22480cdc022eSdanielk1977       }
2249e21a6e1dSdrh     }else if( prRhsHasNull ){
2250e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2251cf4d38aaSdrh     }
225241a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2253cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
22549a96b668Sdanielk1977   }else{
22559a96b668Sdanielk1977     pX->iTable = iTab;
22569a96b668Sdanielk1977   }
2257ba00e30aSdan 
2258ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2259ba00e30aSdan     int i, n;
2260ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2261ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2262ba00e30aSdan   }
22639a96b668Sdanielk1977   return eType;
22649a96b668Sdanielk1977 }
2265284f4acaSdanielk1977 #endif
2266626a879aSdrh 
2267f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2268553168c7Sdan /*
2269553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2270553168c7Sdan ** function allocates and returns a nul-terminated string containing
2271553168c7Sdan ** the affinities to be used for each column of the comparison.
2272553168c7Sdan **
2273553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2274553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2275553168c7Sdan */
227671c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
227771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
227871c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2279553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
228071c57db0Sdan   char *zRet;
228171c57db0Sdan 
2282553168c7Sdan   assert( pExpr->op==TK_IN );
228371c57db0Sdan   zRet = sqlite3DbMallocZero(pParse->db, nVal+1);
228471c57db0Sdan   if( zRet ){
228571c57db0Sdan     int i;
228671c57db0Sdan     for(i=0; i<nVal; i++){
2287fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2288553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2289553168c7Sdan       if( pSelect ){
2290553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
229171c57db0Sdan       }else{
2292553168c7Sdan         zRet[i] = a;
229371c57db0Sdan       }
229471c57db0Sdan     }
229571c57db0Sdan     zRet[nVal] = '\0';
229671c57db0Sdan   }
229771c57db0Sdan   return zRet;
229871c57db0Sdan }
2299f9b2e05cSdan #endif
230071c57db0Sdan 
23018da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
23028da209b1Sdan /*
23038da209b1Sdan ** Load the Parse object passed as the first argument with an error
23048da209b1Sdan ** message of the form:
23058da209b1Sdan **
23068da209b1Sdan **   "sub-select returns N columns - expected M"
23078da209b1Sdan */
23088da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
23098da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
23108da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
23118da209b1Sdan }
23128da209b1Sdan #endif
23138da209b1Sdan 
2314626a879aSdrh /*
2315d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2316d4187c71Sdrh ** or IN operators.  Examples:
2317626a879aSdrh **
23189cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
23199cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
23209cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
23219cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2322fef5208cSdrh **
23239cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
23249cbe6352Sdrh ** operator or subquery.
232541a05b7bSdanielk1977 **
232641a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
232741a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
232841a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
232941a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
233041a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2331fd773cf9Sdrh **
2332fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2333fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
23343a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
23353a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
23363a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
23371450bc6eSdrh **
23381450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
233939a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
234039a11819Sdrh ** array of registers and the return value is the register of the left-most
234139a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2342cce7d176Sdrh */
234351522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23441450bc6eSdrh int sqlite3CodeSubselect(
2345fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2346fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
23476be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2348fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
234941a05b7bSdanielk1977 ){
23506be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
23511450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2352b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
23531450bc6eSdrh   if( NEVER(v==0) ) return 0;
2354ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2355fc976065Sdanielk1977 
235639a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
235739a11819Sdrh   ** is encountered if any of the following is true:
235857dbd7b3Sdrh   **
235957dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
236057dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
236157dbd7b3Sdrh   **    *  We are inside a trigger
236257dbd7b3Sdrh   **
236357dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
236457dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2365b3bce662Sdanielk1977   */
2366c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
23676be515ebSdrh     jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
2368b3bce662Sdanielk1977   }
2369b3bce662Sdanielk1977 
23704a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
23714a07e3dbSdan   if( pParse->explain==2 ){
237262aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
237362aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
237462aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
237562aaa6caSdrh         pParse->iNextSelectId
23764a07e3dbSdan     );
23774a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
23784a07e3dbSdan   }
23794a07e3dbSdan #endif
23804a07e3dbSdan 
2381cce7d176Sdrh   switch( pExpr->op ){
2382fef5208cSdrh     case TK_IN: {
2383b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2384d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2385323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
238671c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2387d3d39e93Sdrh 
238871c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2389553168c7Sdan       assert( !isRowid || nVal==1 );
2390e014a838Sdanielk1977 
2391e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
23928cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2393553168c7Sdan       ** filled with index keys representing the results from the
2394553168c7Sdan       ** SELECT or the <exprlist>.
2395fef5208cSdrh       **
2396e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2397e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2398e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2399e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2400e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2401e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2402e014a838Sdanielk1977       ** is used.
2403fef5208cSdrh       */
2404832508b7Sdrh       pExpr->iTable = pParse->nTab++;
240571c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
240671c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
240771c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2408e014a838Sdanielk1977 
24096ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2410e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2411e014a838Sdanielk1977         **
2412e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2413e014a838Sdanielk1977         ** table allocated and opened above.
2414e014a838Sdanielk1977         */
24154387006cSdrh         Select *pSelect = pExpr->x.pSelect;
241671c57db0Sdan         ExprList *pEList = pSelect->pEList;
24171013c932Sdrh 
241841a05b7bSdanielk1977         assert( !isRowid );
241971c57db0Sdan         if( pEList->nExpr!=nVal ){
24208da209b1Sdan           sqlite3SubselectError(pParse, pEList->nExpr, nVal);
242171c57db0Sdan         }else{
242271c57db0Sdan           SelectDest dest;
242371c57db0Sdan           int i;
24241013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
242571c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
2426e014a838Sdanielk1977           assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
24274387006cSdrh           pSelect->iLimit = 0;
24284387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2429812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
24304387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
243171c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
24322ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
24331450bc6eSdrh             return 0;
243494ccde58Sdrh           }
243571c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2436812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
24373535ec3eSdrh           assert( pEList!=0 );
24383535ec3eSdrh           assert( pEList->nExpr>0 );
24392ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
244071c57db0Sdan           for(i=0; i<nVal; i++){
2441fc7f27b9Sdrh             Expr *p = (nVal>1) ? sqlite3VectorFieldSubexpr(pLeft, i) : pLeft;
244271c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
244371c57db0Sdan                 pParse, p, pEList->a[i].pExpr
244471c57db0Sdan             );
244571c57db0Sdan           }
244671c57db0Sdan         }
2447a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2448fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2449fef5208cSdrh         **
2450e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2451e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2452e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2453e014a838Sdanielk1977         ** a column, use numeric affinity.
2454fef5208cSdrh         */
245571c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2456e014a838Sdanielk1977         int i;
24576ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
245857dbd7b3Sdrh         struct ExprList_item *pItem;
2459ecc31805Sdrh         int r1, r2, r3;
246057dbd7b3Sdrh 
246171c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2462e014a838Sdanielk1977         if( !affinity ){
246305883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2464e014a838Sdanielk1977         }
2465323df790Sdrh         if( pKeyInfo ){
24662ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2467323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2468323df790Sdrh         }
2469e014a838Sdanielk1977 
2470e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
24712d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
24722d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
247337e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
247457dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
247557dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2476e05c929bSdrh           int iValToIns;
2477e014a838Sdanielk1977 
247857dbd7b3Sdrh           /* If the expression is not constant then we will need to
247957dbd7b3Sdrh           ** disable the test that was generated above that makes sure
248057dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
248157dbd7b3Sdrh           ** expression we need to rerun this code each time.
248257dbd7b3Sdrh           */
24836be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
24846be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
24856be515ebSdrh             jmpIfDynamic = -1;
24864794b980Sdrh           }
2487e014a838Sdanielk1977 
2488e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2489e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2490e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2491e05c929bSdrh           }else{
2492ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
249341a05b7bSdanielk1977             if( isRowid ){
2494e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2495e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2496688852abSdrh               VdbeCoverage(v);
249741a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
249841a05b7bSdanielk1977             }else{
2499ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
25003c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
25012d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2502fef5208cSdrh             }
250341a05b7bSdanielk1977           }
2504e05c929bSdrh         }
25052d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
25062d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2507fef5208cSdrh       }
2508323df790Sdrh       if( pKeyInfo ){
25092ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
251041a05b7bSdanielk1977       }
2511b3bce662Sdanielk1977       break;
2512fef5208cSdrh     }
2513fef5208cSdrh 
251451522cd3Sdrh     case TK_EXISTS:
2515fd773cf9Sdrh     case TK_SELECT:
2516fd773cf9Sdrh     default: {
251739a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
251839a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
251939a11819Sdrh       **
252039a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
252139a11819Sdrh       ** the first row into an array of registers and return the index of
252239a11819Sdrh       ** the first register.
252339a11819Sdrh       **
252439a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
252539a11819Sdrh       ** into a register and return that register number.
252639a11819Sdrh       **
252739a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
252839a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2529fef5208cSdrh       */
2530fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
253139a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
253271c57db0Sdan       int nReg;                             /* Registers to allocate */
25331398ad36Sdrh 
2534cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2535cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2536cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
25376ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
253871c57db0Sdan 
25396ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
254071c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
254171c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
254271c57db0Sdan       pParse->nMem += nReg;
254351522cd3Sdrh       if( pExpr->op==TK_SELECT ){
25446c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
254553932ce8Sdrh         dest.iSdst = dest.iSDParm;
254671c57db0Sdan         dest.nSdst = nReg;
254771c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2548d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
254951522cd3Sdrh       }else{
25506c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
25512b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2552d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
255351522cd3Sdrh       }
2554633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2555094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2556094430ebSdrh                                   &sqlite3IntTokens[1]);
255748b5b041Sdrh       pSel->iLimit = 0;
2558772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
25597d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
25601450bc6eSdrh         return 0;
256194ccde58Sdrh       }
25622b596da8Sdrh       rReg = dest.iSDParm;
2563ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2564b3bce662Sdanielk1977       break;
256519a775c2Sdrh     }
2566cce7d176Sdrh   }
2567b3bce662Sdanielk1977 
25686be515ebSdrh   if( rHasNullFlag ){
25696be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2570b3bce662Sdanielk1977   }
25716be515ebSdrh 
25726be515ebSdrh   if( jmpIfDynamic>=0 ){
25736be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2574b3bce662Sdanielk1977   }
2575d2490904Sdrh   sqlite3ExprCachePop(pParse);
2576fc976065Sdanielk1977 
25771450bc6eSdrh   return rReg;
2578cce7d176Sdrh }
257951522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2580cce7d176Sdrh 
2581e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2582e3365e6cSdrh /*
25837b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
25847b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
25857b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
25867b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
25877b35a77bSdan */
25887b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
25897b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
25907b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
25917b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
25927b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
25937b35a77bSdan       return 1;
25947b35a77bSdan     }
25957b35a77bSdan   }else if( nVector!=1 ){
25967b35a77bSdan     if( (pIn->pLeft->flags & EP_xIsSelect) ){
25977b35a77bSdan       sqlite3SubselectError(pParse, nVector, 1);
25987b35a77bSdan     }else{
25997b35a77bSdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
26007b35a77bSdan     }
26017b35a77bSdan     return 1;
26027b35a77bSdan   }
26037b35a77bSdan   return 0;
26047b35a77bSdan }
26057b35a77bSdan #endif
26067b35a77bSdan 
26077b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
26087b35a77bSdan /*
2609e3365e6cSdrh ** Generate code for an IN expression.
2610e3365e6cSdrh **
2611e3365e6cSdrh **      x IN (SELECT ...)
2612e3365e6cSdrh **      x IN (value, value, ...)
2613e3365e6cSdrh **
2614e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
2615e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
2616e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
2617e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
2618e3365e6cSdrh ** RHS contains one or more NULL values.
2619e3365e6cSdrh **
26206be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2621e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2622e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2623e3365e6cSdrh ** within the RHS then fall through.
2624e3365e6cSdrh */
2625e3365e6cSdrh static void sqlite3ExprCodeIN(
2626e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2627e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2628e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2629e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2630e3365e6cSdrh ){
2631e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2632e3365e6cSdrh   int eType;            /* Type of the RHS */
2633e3365e6cSdrh   int r1;               /* Temporary use register */
2634e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2635ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2636ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2637ba00e30aSdan   int nVector;          /* Size of vectors for this IN(...) op */
2638ba00e30aSdan   Expr *pLeft = pExpr->pLeft;
2639ba00e30aSdan   int i;
2640e3365e6cSdrh 
26417b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2642553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2643a48d7e77Sdrh   if( zAff==0 ) return;
2644ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2645ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2646ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2647ba00e30aSdan   );
2648a48d7e77Sdrh   if( aiMap==0 ){
2649a48d7e77Sdrh     sqlite3DbFree(pParse->db, zAff);
2650553168c7Sdan     return;
2651553168c7Sdan   }
26527b35a77bSdan 
2653ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2654ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2655ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2656ba00e30aSdan   ** the RHS has not yet been coded.  */
2657e3365e6cSdrh   v = pParse->pVdbe;
2658e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2659e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2660bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2661bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2662ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2663e3365e6cSdrh 
2664ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2665ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2666ba00e30aSdan   );
2667e3365e6cSdrh 
2668ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2669ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2670ba00e30aSdan   ** at r1.
2671e3365e6cSdrh   */
2672ba00e30aSdan   r1 = sqlite3GetTempRange(pParse, nVector);
2673e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2674ba00e30aSdan   if( nVector>1 && (pLeft->flags & EP_xIsSelect) ){
2675553168c7Sdan     int regSelect = sqlite3CodeSubselect(pParse, pLeft, 0, 0);
2676ba00e30aSdan     for(i=0; i<nVector; i++){
2677553168c7Sdan       sqlite3VdbeAddOp3(v, OP_Copy, regSelect+i, r1+aiMap[i], 0);
2678ba00e30aSdan     }
2679553168c7Sdan   }else{
2680553168c7Sdan     for(i=0; i<nVector; i++){
2681fc7f27b9Sdrh       Expr *pLhs = sqlite3VectorFieldSubexpr(pLeft, i);
2682553168c7Sdan       sqlite3ExprCode(pParse, pLhs, r1+aiMap[i]);
2683ba00e30aSdan     }
2684ba00e30aSdan   }
2685e3365e6cSdrh 
2686bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2687bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2688bb53ecb1Sdrh   ** sequence of comparisons.
2689bb53ecb1Sdrh   */
2690bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2691bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2692bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2693bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2694bb53ecb1Sdrh     int r2, regToFree;
2695bb53ecb1Sdrh     int regCkNull = 0;
2696bb53ecb1Sdrh     int ii;
2697bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2698bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2699bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2700a976979bSdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
2701bb53ecb1Sdrh     }
2702bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2703bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2704a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2705bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2706bb53ecb1Sdrh       }
2707bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2708bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
27094336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
27104336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
27114336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2712ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2713bb53ecb1Sdrh       }else{
2714bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2715bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2716bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2717ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2718bb53ecb1Sdrh       }
2719bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2720bb53ecb1Sdrh     }
2721bb53ecb1Sdrh     if( regCkNull ){
2722bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2723076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2724bb53ecb1Sdrh     }
2725bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2726bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2727bb53ecb1Sdrh   }else{
2728bb53ecb1Sdrh 
27297b35a77bSdan     /* If any value on the LHS is NULL, the result of the IN(...) operator
27307b35a77bSdan     ** must be either false or NULL. If these two are handled identically,
27317b35a77bSdan     ** test the LHS for NULLs and jump directly to destIfNull if any are
27327b35a77bSdan     ** found.
27337b35a77bSdan     **
27347b35a77bSdan     ** Otherwise, if NULL and false are handled differently, and the
27357b35a77bSdan     ** IN(...) operation is not a vector operation, and the LHS of the
27367b35a77bSdan     ** operator is NULL, then the result is false if the index is
27377b35a77bSdan     ** completely empty, or NULL otherwise.  */
2738094430ebSdrh     if( destIfNull==destIfFalse ){
2739d49fd4e8Sdan       for(i=0; i<nVector; i++){
2740fc7f27b9Sdrh         Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2741d49fd4e8Sdan         if( sqlite3ExprCanBeNull(p) ){
2742d49fd4e8Sdan           sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
2743471b4b92Sdrh           VdbeCoverage(v);
2744d49fd4e8Sdan         }
2745d49fd4e8Sdan       }
2746d49fd4e8Sdan     }else if( nVector==1 && sqlite3ExprCanBeNull(pExpr->pLeft) ){
2747688852abSdrh       int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2748094430ebSdrh       sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2749688852abSdrh       VdbeCoverage(v);
2750076e85f5Sdrh       sqlite3VdbeGoto(v, destIfNull);
2751094430ebSdrh       sqlite3VdbeJumpHere(v, addr1);
2752094430ebSdrh     }
2753e3365e6cSdrh 
2754e3365e6cSdrh     if( eType==IN_INDEX_ROWID ){
27557b35a77bSdan       /* In this case, the RHS is the ROWID of table b-tree */
2756eeb9565aSdrh       sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, r1);
2757688852abSdrh       VdbeCoverage(v);
27587b35a77bSdan     }else{
27597b35a77bSdan       /* In this case, the RHS is an index b-tree. Apply the comparison
27607b35a77bSdan       ** affinities to each value on the LHS of the operator.  */
27617b35a77bSdan       sqlite3VdbeAddOp4(v, OP_Affinity, r1, nVector, 0, zAff, nVector);
2762ba00e30aSdan 
27637b35a77bSdan       if( nVector>1 && destIfNull!=destIfFalse ){
27647b35a77bSdan         int iIdx = pExpr->iTable;
27657b35a77bSdan         int addr;
27667b35a77bSdan         int addrNext;
27677b35a77bSdan 
27687b35a77bSdan         /* Search the index for the key. */
27697b35a77bSdan         addr = sqlite3VdbeAddOp4Int(v, OP_Found, iIdx, 0, r1, nVector);
2770471b4b92Sdrh         VdbeCoverage(v);
27717b35a77bSdan 
27727b35a77bSdan         /* At this point the specified key is not present in the index,
27737b35a77bSdan         ** so the result of the IN(..) operator must be either NULL or
27747b35a77bSdan         ** 0. The vdbe code generated below figures out which.  */
27757b35a77bSdan         addrNext = 1+sqlite3VdbeAddOp2(v, OP_Rewind, iIdx, destIfFalse);
2776471b4b92Sdrh         VdbeCoverage(v);
27777b35a77bSdan 
2778ba00e30aSdan         for(i=0; i<nVector; i++){
2779ba00e30aSdan           Expr *p;
2780ba00e30aSdan           CollSeq *pColl;
27817b35a77bSdan           int r2 = sqlite3GetTempReg(pParse);
2782fc7f27b9Sdrh           p = sqlite3VectorFieldSubexpr(pLeft, i);
2783ba00e30aSdan           pColl = sqlite3ExprCollSeq(pParse, p);
2784ba00e30aSdan 
27857b35a77bSdan           sqlite3VdbeAddOp3(v, OP_Column, iIdx, i, r2);
27867b35a77bSdan           sqlite3VdbeAddOp4(v, OP_Eq, r1+i, 0, r2, (void*)pColl,P4_COLLSEQ);
27877b35a77bSdan           sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
2788471b4b92Sdrh           VdbeCoverage(v);
27897b35a77bSdan           sqlite3VdbeAddOp2(v, OP_Next, iIdx, addrNext);
2790471b4b92Sdrh           VdbeCoverage(v);
2791ba00e30aSdan           sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
27927b35a77bSdan           sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-3);
2793ba00e30aSdan           sqlite3ReleaseTempReg(pParse, r2);
27947b35a77bSdan         }
27957b35a77bSdan         sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2796e3365e6cSdrh 
27977b35a77bSdan         /* The key was found in the index. If it contains any NULL values,
27987b35a77bSdan         ** then the result of the IN(...) operator is NULL. Otherwise, the
27997b35a77bSdan         ** result is 1.  */
28007b35a77bSdan         sqlite3VdbeJumpHere(v, addr);
28017b35a77bSdan         for(i=0; i<nVector; i++){
2802fc7f27b9Sdrh           Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
28037b35a77bSdan           if( sqlite3ExprCanBeNull(p) ){
28047b35a77bSdan             sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
2805471b4b92Sdrh             VdbeCoverage(v);
28067b35a77bSdan           }
28077b35a77bSdan         }
28087b35a77bSdan 
28097b35a77bSdan       }else if( rRhsHasNull==0 ){
2810e3365e6cSdrh         /* This branch runs if it is known at compile time that the RHS
28117b35a77bSdan         ** cannot contain NULL values. This happens as a result
28127b35a77bSdan         ** of "NOT NULL" constraints in the database schema.
2813e3365e6cSdrh         **
2814e3365e6cSdrh         ** Also run this branch if NULL is equivalent to FALSE
28157b35a77bSdan         ** for this particular IN operator.  */
2816ba00e30aSdan         sqlite3VdbeAddOp4Int(
2817ba00e30aSdan             v, OP_NotFound, pExpr->iTable, destIfFalse, r1, nVector
2818ba00e30aSdan         );
2819688852abSdrh         VdbeCoverage(v);
2820e3365e6cSdrh       }else{
2821e3365e6cSdrh         /* In this branch, the RHS of the IN might contain a NULL and
2822e3365e6cSdrh         ** the presence of a NULL on the RHS makes a difference in the
2823e3365e6cSdrh         ** outcome.
2824e3365e6cSdrh         */
2825728e0f91Sdrh         int addr1;
2826e3365e6cSdrh 
2827e3365e6cSdrh         /* First check to see if the LHS is contained in the RHS.  If so,
28286be515ebSdrh         ** then the answer is TRUE the presence of NULLs in the RHS does
28296be515ebSdrh         ** not matter.  If the LHS is not contained in the RHS, then the
28306be515ebSdrh         ** answer is NULL if the RHS contains NULLs and the answer is
28316be515ebSdrh         ** FALSE if the RHS is NULL-free.
2832e3365e6cSdrh         */
2833728e0f91Sdrh         addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2834688852abSdrh         VdbeCoverage(v);
28356be515ebSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2836552fd454Sdrh         VdbeCoverage(v);
2837076e85f5Sdrh         sqlite3VdbeGoto(v, destIfFalse);
2838728e0f91Sdrh         sqlite3VdbeJumpHere(v, addr1);
2839e3365e6cSdrh       }
2840e3365e6cSdrh     }
2841bb53ecb1Sdrh   }
2842e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2843d2490904Sdrh   sqlite3ExprCachePop(pParse);
2844ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
2845553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
2846e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2847e3365e6cSdrh }
2848e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2849e3365e6cSdrh 
285013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2851598f1340Sdrh /*
2852598f1340Sdrh ** Generate an instruction that will put the floating point
28539cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
28540cf19ed8Sdrh **
28550cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
28560cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
28570cf19ed8Sdrh ** like the continuation of the number.
2858598f1340Sdrh */
2859b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2860fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2861598f1340Sdrh     double value;
28629339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2863d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2864598f1340Sdrh     if( negateFlag ) value = -value;
286597bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2866598f1340Sdrh   }
2867598f1340Sdrh }
286813573c71Sdrh #endif
2869598f1340Sdrh 
2870598f1340Sdrh 
2871598f1340Sdrh /*
2872fec19aadSdrh ** Generate an instruction that will put the integer describe by
28739cbf3425Sdrh ** text z[0..n-1] into register iMem.
28740cf19ed8Sdrh **
28755f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2876fec19aadSdrh */
287713573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
287813573c71Sdrh   Vdbe *v = pParse->pVdbe;
287992b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
288033e619fcSdrh     int i = pExpr->u.iValue;
2881d50ffc41Sdrh     assert( i>=0 );
288292b01d53Sdrh     if( negFlag ) i = -i;
288392b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2884fd773cf9Sdrh   }else{
28855f1d6b61Sshaneh     int c;
28865f1d6b61Sshaneh     i64 value;
2887fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2888fd773cf9Sdrh     assert( z!=0 );
28899296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
28905f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2891158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
289297bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2893fec19aadSdrh     }else{
289413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
289513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
289613573c71Sdrh #else
28971b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
28989296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
28999296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
29001b7ddc59Sdrh       }else
29011b7ddc59Sdrh #endif
29021b7ddc59Sdrh       {
2903b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
29049296c18aSdrh       }
290513573c71Sdrh #endif
2906fec19aadSdrh     }
2907fec19aadSdrh   }
2908c9cf901dSdanielk1977 }
2909fec19aadSdrh 
2910bea119cdSdrh #if defined(SQLITE_DEBUG)
2911bea119cdSdrh /*
2912bea119cdSdrh ** Verify the consistency of the column cache
2913bea119cdSdrh */
2914bea119cdSdrh static int cacheIsValid(Parse *pParse){
2915bea119cdSdrh   int i, n;
2916bea119cdSdrh   for(i=n=0; i<SQLITE_N_COLCACHE; i++){
2917bea119cdSdrh     if( pParse->aColCache[i].iReg>0 ) n++;
2918bea119cdSdrh   }
2919bea119cdSdrh   return n==pParse->nColCache;
2920bea119cdSdrh }
2921bea119cdSdrh #endif
2922bea119cdSdrh 
2923ceea3321Sdrh /*
2924ceea3321Sdrh ** Clear a cache entry.
2925ceea3321Sdrh */
2926ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2927ceea3321Sdrh   if( p->tempReg ){
2928ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2929ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2930ceea3321Sdrh     }
2931ceea3321Sdrh     p->tempReg = 0;
2932ceea3321Sdrh   }
2933bea119cdSdrh   p->iReg = 0;
2934bea119cdSdrh   pParse->nColCache--;
2935ee65eea4Sdan   assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2936ceea3321Sdrh }
2937ceea3321Sdrh 
2938ceea3321Sdrh 
2939ceea3321Sdrh /*
2940ceea3321Sdrh ** Record in the column cache that a particular column from a
2941ceea3321Sdrh ** particular table is stored in a particular register.
2942ceea3321Sdrh */
2943ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2944ceea3321Sdrh   int i;
2945ceea3321Sdrh   int minLru;
2946ceea3321Sdrh   int idxLru;
2947ceea3321Sdrh   struct yColCache *p;
2948ceea3321Sdrh 
2949ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2950ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
295120411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
295220411ea7Sdrh 
2953b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2954b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2955b6da74ebSdrh   ** with and without the column cache.
2956b6da74ebSdrh   */
29577e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2958b6da74ebSdrh 
295927ee406eSdrh   /* First replace any existing entry.
296027ee406eSdrh   **
296127ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
296227ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
296327ee406eSdrh   */
296427ee406eSdrh #ifndef NDEBUG
2965ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
296627ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2967ceea3321Sdrh   }
296827ee406eSdrh #endif
2969ceea3321Sdrh 
2970ceea3321Sdrh   /* Find an empty slot and replace it */
2971ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2972ceea3321Sdrh     if( p->iReg==0 ){
2973ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2974ceea3321Sdrh       p->iTable = iTab;
2975ceea3321Sdrh       p->iColumn = iCol;
2976ceea3321Sdrh       p->iReg = iReg;
2977ceea3321Sdrh       p->tempReg = 0;
2978ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2979bea119cdSdrh       pParse->nColCache++;
2980ee65eea4Sdan       assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2981ceea3321Sdrh       return;
2982ceea3321Sdrh     }
2983ceea3321Sdrh   }
2984ceea3321Sdrh 
2985ceea3321Sdrh   /* Replace the last recently used */
2986ceea3321Sdrh   minLru = 0x7fffffff;
2987ceea3321Sdrh   idxLru = -1;
2988ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2989ceea3321Sdrh     if( p->lru<minLru ){
2990ceea3321Sdrh       idxLru = i;
2991ceea3321Sdrh       minLru = p->lru;
2992ceea3321Sdrh     }
2993ceea3321Sdrh   }
299420411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2995ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2996ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2997ceea3321Sdrh     p->iTable = iTab;
2998ceea3321Sdrh     p->iColumn = iCol;
2999ceea3321Sdrh     p->iReg = iReg;
3000ceea3321Sdrh     p->tempReg = 0;
3001ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
3002bea119cdSdrh     assert( cacheIsValid(pParse) );
3003ceea3321Sdrh     return;
3004ceea3321Sdrh   }
3005ceea3321Sdrh }
3006ceea3321Sdrh 
3007ceea3321Sdrh /*
3008f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3009f49f3523Sdrh ** Purge the range of registers from the column cache.
3010ceea3321Sdrh */
3011f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
3012ceea3321Sdrh   struct yColCache *p;
3013bea119cdSdrh   if( iReg<=0 || pParse->nColCache==0 ) return;
3014bea119cdSdrh   p = &pParse->aColCache[SQLITE_N_COLCACHE-1];
3015bea119cdSdrh   while(1){
3016bea119cdSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ) cacheEntryClear(pParse, p);
3017bea119cdSdrh     if( p==pParse->aColCache ) break;
3018bea119cdSdrh     p--;
3019ceea3321Sdrh   }
3020ceea3321Sdrh }
3021ceea3321Sdrh 
3022ceea3321Sdrh /*
3023ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3024ceea3321Sdrh ** added to the column cache after this call are removed when the
3025ceea3321Sdrh ** corresponding pop occurs.
3026ceea3321Sdrh */
3027ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3028ceea3321Sdrh   pParse->iCacheLevel++;
30299ac7962aSdrh #ifdef SQLITE_DEBUG
30309ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30319ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
30329ac7962aSdrh   }
30339ac7962aSdrh #endif
3034ceea3321Sdrh }
3035ceea3321Sdrh 
3036ceea3321Sdrh /*
3037ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3038d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3039d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3040ceea3321Sdrh */
3041d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
3042ceea3321Sdrh   int i;
3043ceea3321Sdrh   struct yColCache *p;
3044d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3045d2490904Sdrh   pParse->iCacheLevel--;
30469ac7962aSdrh #ifdef SQLITE_DEBUG
30479ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30489ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
30499ac7962aSdrh   }
30509ac7962aSdrh #endif
3051ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3052ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
3053ceea3321Sdrh       cacheEntryClear(pParse, p);
3054ceea3321Sdrh     }
3055ceea3321Sdrh   }
3056ceea3321Sdrh }
3057945498f3Sdrh 
3058945498f3Sdrh /*
30595cd79239Sdrh ** When a cached column is reused, make sure that its register is
30605cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
30615cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
30625cd79239Sdrh ** get them all.
30635cd79239Sdrh */
30645cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
30655cd79239Sdrh   int i;
30665cd79239Sdrh   struct yColCache *p;
30675cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
30685cd79239Sdrh     if( p->iReg==iReg ){
30695cd79239Sdrh       p->tempReg = 0;
30705cd79239Sdrh     }
30715cd79239Sdrh   }
30725cd79239Sdrh }
30735cd79239Sdrh 
30741f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
30751f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
30761f9ca2c8Sdrh */
30771f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
30781f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
30791f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
30801f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
30811f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
30821f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
30831f9ca2c8Sdrh ){
30841f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
30854b92f98cSdrh   if( iTabCol==XN_EXPR ){
30861f9ca2c8Sdrh     assert( pIdx->aColExpr );
30871f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
30881f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
30891c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
30904b92f98cSdrh   }else{
30914b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
30924b92f98cSdrh                                     iTabCol, regOut);
30934b92f98cSdrh   }
30941f9ca2c8Sdrh }
30951f9ca2c8Sdrh 
30965cd79239Sdrh /*
30975c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
30985c092e8aSdrh */
30995c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
31005c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
31015c092e8aSdrh   Table *pTab,    /* The table containing the value */
3102313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
31035c092e8aSdrh   int iCol,       /* Index of the column to extract */
3104313619f5Sdrh   int regOut      /* Extract the value into this register */
31055c092e8aSdrh ){
31065c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
31075c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
31085c092e8aSdrh   }else{
31095c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3110ee0ec8e1Sdrh     int x = iCol;
311135db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3112ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3113ee0ec8e1Sdrh     }
3114ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
31155c092e8aSdrh   }
31165c092e8aSdrh   if( iCol>=0 ){
31175c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
31185c092e8aSdrh   }
31195c092e8aSdrh }
31205c092e8aSdrh 
31215c092e8aSdrh /*
3122945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3123ce78bc6eSdrh ** table pTab and store the column value in a register.
3124ce78bc6eSdrh **
3125ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3126ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3127ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3128ce78bc6eSdrh ** for GetColumnToReg().
3129e55cbd72Sdrh **
3130e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3131e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3132945498f3Sdrh */
3133e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3134e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
31352133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
31362133d822Sdrh   int iColumn,     /* Index of the table column */
31372133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3138a748fdccSdrh   int iReg,        /* Store results here */
3139ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
31402133d822Sdrh ){
3141e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3142e55cbd72Sdrh   int i;
3143da250ea5Sdrh   struct yColCache *p;
3144e55cbd72Sdrh 
3145ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3146b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
3147ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
31485cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3149da250ea5Sdrh       return p->iReg;
3150e55cbd72Sdrh     }
3151e55cbd72Sdrh   }
3152e55cbd72Sdrh   assert( v!=0 );
31535c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3154a748fdccSdrh   if( p5 ){
3155a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3156a748fdccSdrh   }else{
3157ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3158a748fdccSdrh   }
3159e55cbd72Sdrh   return iReg;
3160e55cbd72Sdrh }
3161ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3162ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3163ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3164ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3165ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3166ce78bc6eSdrh   int iReg         /* Store results here */
3167ce78bc6eSdrh ){
3168ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3169ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3170ce78bc6eSdrh }
3171ce78bc6eSdrh 
3172e55cbd72Sdrh 
3173e55cbd72Sdrh /*
3174ceea3321Sdrh ** Clear all column cache entries.
3175e55cbd72Sdrh */
3176ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3177e55cbd72Sdrh   int i;
3178ceea3321Sdrh   struct yColCache *p;
3179ceea3321Sdrh 
31809ac7962aSdrh #if SQLITE_DEBUG
31819ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31829ac7962aSdrh     printf("CLEAR\n");
31839ac7962aSdrh   }
31849ac7962aSdrh #endif
3185ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3186ceea3321Sdrh     if( p->iReg ){
3187ceea3321Sdrh       cacheEntryClear(pParse, p);
3188e55cbd72Sdrh     }
3189da250ea5Sdrh   }
3190da250ea5Sdrh }
3191e55cbd72Sdrh 
3192e55cbd72Sdrh /*
3193da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3194da250ea5Sdrh ** registers starting with iStart.
3195e55cbd72Sdrh */
3196da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3197f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3198e55cbd72Sdrh }
3199e55cbd72Sdrh 
3200e55cbd72Sdrh /*
3201b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3202b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3203e55cbd72Sdrh */
3204b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3205e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3206079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3207236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3208945498f3Sdrh }
3209945498f3Sdrh 
3210f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
321192b01d53Sdrh /*
3212652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3213652fbf55Sdrh ** is used as part of the column cache.
3214f49f3523Sdrh **
3215f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3216f49f3523Sdrh ** and does not appear in a normal build.
3217652fbf55Sdrh */
3218652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3219652fbf55Sdrh   int i;
3220ceea3321Sdrh   struct yColCache *p;
3221ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3222ceea3321Sdrh     int r = p->iReg;
3223f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3224652fbf55Sdrh   }
3225652fbf55Sdrh   return 0;
3226652fbf55Sdrh }
3227f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3228652fbf55Sdrh 
3229bea119cdSdrh 
3230652fbf55Sdrh /*
3231a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
3232a4c3c87eSdrh */
3233a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3234a4c3c87eSdrh   p->op2 = p->op;
3235a4c3c87eSdrh   p->op = TK_REGISTER;
3236a4c3c87eSdrh   p->iTable = iReg;
3237a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3238a4c3c87eSdrh }
3239a4c3c87eSdrh 
324071c57db0Sdan static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
324171c57db0Sdan 
3242a4c3c87eSdrh /*
3243cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
32442dcef11bSdrh ** expression.  Attempt to store the results in register "target".
32452dcef11bSdrh ** Return the register where results are stored.
3246389a1adbSdrh **
32478b213899Sdrh ** With this routine, there is no guarantee that results will
32482dcef11bSdrh ** be stored in target.  The result might be stored in some other
32492dcef11bSdrh ** register if it is convenient to do so.  The calling function
32502dcef11bSdrh ** must check the return code and move the results to the desired
32512dcef11bSdrh ** register.
3252cce7d176Sdrh */
3253678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
32542dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
32552dcef11bSdrh   int op;                   /* The opcode being coded */
32562dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
32572dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
32582dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
32597b35a77bSdan   int r1, r2;               /* Various register numbers */
326020411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
326110d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
326271c57db0Sdan   int p5 = 0;
3263ffe07b2dSdrh 
32649cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
326520411ea7Sdrh   if( v==0 ){
326620411ea7Sdrh     assert( pParse->db->mallocFailed );
326720411ea7Sdrh     return 0;
326820411ea7Sdrh   }
3269389a1adbSdrh 
3270389a1adbSdrh   if( pExpr==0 ){
3271389a1adbSdrh     op = TK_NULL;
3272389a1adbSdrh   }else{
3273f2bc013cSdrh     op = pExpr->op;
3274389a1adbSdrh   }
3275f2bc013cSdrh   switch( op ){
327613449892Sdrh     case TK_AGG_COLUMN: {
327713449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
327813449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
327913449892Sdrh       if( !pAggInfo->directMode ){
32809de221dfSdrh         assert( pCol->iMem>0 );
32819de221dfSdrh         inReg = pCol->iMem;
328213449892Sdrh         break;
328313449892Sdrh       }else if( pAggInfo->useSortingIdx ){
32845134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3285389a1adbSdrh                               pCol->iSorterColumn, target);
328613449892Sdrh         break;
328713449892Sdrh       }
328813449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
328913449892Sdrh     }
3290967e8b73Sdrh     case TK_COLUMN: {
3291b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3292b2b9d3d7Sdrh       if( iTab<0 ){
3293b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3294b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3295aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
3296b2b9d3d7Sdrh           break;
3297c4a3c779Sdrh         }else{
32981f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
32991f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
33001f9ca2c8Sdrh           iTab = pParse->iSelfTab;
33012282792aSdrh         }
3302b2b9d3d7Sdrh       }
3303b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3304b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3305b2b9d3d7Sdrh                                pExpr->op2);
3306cce7d176Sdrh       break;
3307cce7d176Sdrh     }
3308cce7d176Sdrh     case TK_INTEGER: {
330913573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3310fec19aadSdrh       break;
331151e9a445Sdrh     }
331213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3313598f1340Sdrh     case TK_FLOAT: {
331433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
331533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3316598f1340Sdrh       break;
3317598f1340Sdrh     }
331813573c71Sdrh #endif
3319fec19aadSdrh     case TK_STRING: {
332033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3321076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3322cce7d176Sdrh       break;
3323cce7d176Sdrh     }
3324f0863fe5Sdrh     case TK_NULL: {
33259de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3326f0863fe5Sdrh       break;
3327f0863fe5Sdrh     }
33285338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3329c572ef7fSdanielk1977     case TK_BLOB: {
33306c8c6cecSdrh       int n;
33316c8c6cecSdrh       const char *z;
3332ca48c90fSdrh       char *zBlob;
333333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
333433e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
333533e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
333633e619fcSdrh       z = &pExpr->u.zToken[2];
3337b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3338b7916a78Sdrh       assert( z[n]=='\'' );
3339ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3340ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3341c572ef7fSdanielk1977       break;
3342c572ef7fSdanielk1977     }
33435338a5f7Sdanielk1977 #endif
334450457896Sdrh     case TK_VARIABLE: {
334533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
334633e619fcSdrh       assert( pExpr->u.zToken!=0 );
334733e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3348eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
334933e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
335004e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
335104e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
335204e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
3353895d7472Sdrh       }
335450457896Sdrh       break;
335550457896Sdrh     }
33564e0cff60Sdrh     case TK_REGISTER: {
33579de221dfSdrh       inReg = pExpr->iTable;
33584e0cff60Sdrh       break;
33594e0cff60Sdrh     }
3360487e262fSdrh #ifndef SQLITE_OMIT_CAST
3361487e262fSdrh     case TK_CAST: {
3362487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
33632dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
33641735fa88Sdrh       if( inReg!=target ){
33651735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
33661735fa88Sdrh         inReg = target;
33671735fa88Sdrh       }
33684169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
33694169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3370c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3371b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3372487e262fSdrh       break;
3373487e262fSdrh     }
3374487e262fSdrh #endif /* SQLITE_OMIT_CAST */
337571c57db0Sdan     case TK_IS:
337671c57db0Sdan     case TK_ISNOT:
337771c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
337871c57db0Sdan       p5 = SQLITE_NULLEQ;
337971c57db0Sdan       /* fall-through */
3380c9b84a1fSdrh     case TK_LT:
3381c9b84a1fSdrh     case TK_LE:
3382c9b84a1fSdrh     case TK_GT:
3383c9b84a1fSdrh     case TK_GE:
3384c9b84a1fSdrh     case TK_NE:
3385c9b84a1fSdrh     case TK_EQ: {
338671c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3387625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
338879752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
338971c57db0Sdan       }else{
339071c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3391b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
339271c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
339371c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
33947d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
33957d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
33967d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
33977d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
33987d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
33997d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3400c5499befSdrh         testcase( regFree1==0 );
3401c5499befSdrh         testcase( regFree2==0 );
3402c9b84a1fSdrh       }
34036a2fe093Sdrh       break;
34046a2fe093Sdrh     }
3405cce7d176Sdrh     case TK_AND:
3406cce7d176Sdrh     case TK_OR:
3407cce7d176Sdrh     case TK_PLUS:
3408cce7d176Sdrh     case TK_STAR:
3409cce7d176Sdrh     case TK_MINUS:
3410bf4133cbSdrh     case TK_REM:
3411bf4133cbSdrh     case TK_BITAND:
3412bf4133cbSdrh     case TK_BITOR:
341317c40294Sdrh     case TK_SLASH:
3414bf4133cbSdrh     case TK_LSHIFT:
3415855eb1cfSdrh     case TK_RSHIFT:
34160040077dSdrh     case TK_CONCAT: {
34177d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
34187d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
34197d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
34207d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
34217d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
34227d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
34237d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
34247d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
34257d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
34267d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
34277d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
34282dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
34292dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
34305b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3431c5499befSdrh       testcase( regFree1==0 );
3432c5499befSdrh       testcase( regFree2==0 );
34330040077dSdrh       break;
34340040077dSdrh     }
3435cce7d176Sdrh     case TK_UMINUS: {
3436fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3437fec19aadSdrh       assert( pLeft );
343813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
343913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
344013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
344113573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
344233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
344333e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
344413573c71Sdrh #endif
34453c84ddffSdrh       }else{
344610d1edf0Sdrh         tempX.op = TK_INTEGER;
344710d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
344810d1edf0Sdrh         tempX.u.iValue = 0;
344910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3450e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
34512dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3452c5499befSdrh         testcase( regFree2==0 );
34533c84ddffSdrh       }
34549de221dfSdrh       inReg = target;
34556e142f54Sdrh       break;
34566e142f54Sdrh     }
3457bf4133cbSdrh     case TK_BITNOT:
34586e142f54Sdrh     case TK_NOT: {
34597d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
34607d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3461e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3462e99fa2afSdrh       testcase( regFree1==0 );
3463e99fa2afSdrh       inReg = target;
3464e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3465cce7d176Sdrh       break;
3466cce7d176Sdrh     }
3467cce7d176Sdrh     case TK_ISNULL:
3468cce7d176Sdrh     case TK_NOTNULL: {
34696a288a33Sdrh       int addr;
34707d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
34717d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
34729de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
34732dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3474c5499befSdrh       testcase( regFree1==0 );
34752dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
34767d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
34777d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3478a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
34796a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3480a37cdde0Sdanielk1977       break;
3481f2bc013cSdrh     }
34822282792aSdrh     case TK_AGG_FUNCTION: {
348313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
34847e56e711Sdrh       if( pInfo==0 ){
348533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
348633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
34877e56e711Sdrh       }else{
34889de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
34897e56e711Sdrh       }
34902282792aSdrh       break;
34912282792aSdrh     }
3492cce7d176Sdrh     case TK_FUNCTION: {
349312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
349412ffee8cSdrh       int nFarg;             /* Number of function arguments */
349512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
349612ffee8cSdrh       const char *zId;       /* The function name */
3497693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
349812ffee8cSdrh       int i;                 /* Loop counter */
349912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
350012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
350117435752Sdrh 
35026ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3503c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
350412ffee8cSdrh         pFarg = 0;
350512ffee8cSdrh       }else{
350612ffee8cSdrh         pFarg = pExpr->x.pList;
350712ffee8cSdrh       }
350812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
350933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
351033e619fcSdrh       zId = pExpr->u.zToken;
351180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3512cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3513cc15313cSdrh       if( pDef==0 && pParse->explain ){
3514cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3515cc15313cSdrh       }
3516cc15313cSdrh #endif
35172d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
351880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3519feb306f5Sdrh         break;
3520feb306f5Sdrh       }
3521ae6bb957Sdrh 
3522ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
352360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3524ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3525ae6bb957Sdrh       */
3526d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3527ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3528ae6bb957Sdrh         assert( nFarg>=2 );
3529ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3530ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3531ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3532688852abSdrh           VdbeCoverage(v);
3533f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3534ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3535ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3536d2490904Sdrh           sqlite3ExprCachePop(pParse);
3537ae6bb957Sdrh         }
3538ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3539ae6bb957Sdrh         break;
3540ae6bb957Sdrh       }
3541ae6bb957Sdrh 
3542cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3543cca9f3d2Sdrh       ** of the first argument.
3544cca9f3d2Sdrh       */
3545cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3546cca9f3d2Sdrh         assert( nFarg>=1 );
35475f02ab09Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3548cca9f3d2Sdrh         break;
3549cca9f3d2Sdrh       }
3550ae6bb957Sdrh 
3551d1a01edaSdrh       for(i=0; i<nFarg; i++){
3552d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3553693e6719Sdrh           testcase( i==31 );
3554693e6719Sdrh           constMask |= MASKBIT32(i);
3555d1a01edaSdrh         }
3556d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3557d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3558d1a01edaSdrh         }
3559d1a01edaSdrh       }
356012ffee8cSdrh       if( pFarg ){
3561d1a01edaSdrh         if( constMask ){
3562d1a01edaSdrh           r1 = pParse->nMem+1;
3563d1a01edaSdrh           pParse->nMem += nFarg;
3564d1a01edaSdrh         }else{
356512ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3566d1a01edaSdrh         }
3567a748fdccSdrh 
3568a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3569a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3570a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3571a748fdccSdrh         ** loading.
3572a748fdccSdrh         */
3573d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
35744e245a4cSdrh           u8 exprOp;
3575a748fdccSdrh           assert( nFarg==1 );
3576a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
35774e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
35784e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3579a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3580a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3581b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3582b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3583b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3584a748fdccSdrh           }
3585a748fdccSdrh         }
3586a748fdccSdrh 
3587d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
35885579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3589d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3590d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3591892d3179Sdrh       }else{
359212ffee8cSdrh         r1 = 0;
3593892d3179Sdrh       }
3594b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3595a43fa227Sdrh       /* Possibly overload the function if the first argument is
3596a43fa227Sdrh       ** a virtual table column.
3597a43fa227Sdrh       **
3598a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3599a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3600a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3601a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3602a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3603a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3604a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3605a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3606a43fa227Sdrh       */
360712ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
360812ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
360912ffee8cSdrh       }else if( nFarg>0 ){
361012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3611b7f6f68fSdrh       }
3612b7f6f68fSdrh #endif
3613d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
36148b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
361566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3616682f68b0Sdanielk1977       }
36179c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
361866a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
361912ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3620d1a01edaSdrh       if( nFarg && constMask==0 ){
362112ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
36222dcef11bSdrh       }
36236ec2733bSdrh       break;
36246ec2733bSdrh     }
3625fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3626fe2093d7Sdrh     case TK_EXISTS:
362719a775c2Sdrh     case TK_SELECT: {
36288da209b1Sdan       int nCol;
3629c5499befSdrh       testcase( op==TK_EXISTS );
3630c5499befSdrh       testcase( op==TK_SELECT );
36318da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
36328da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
36338da209b1Sdan       }else{
36341450bc6eSdrh         inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
36358da209b1Sdan       }
363619a775c2Sdrh       break;
363719a775c2Sdrh     }
3638fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3639fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3640fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3641fc7f27b9Sdrh       }
3642fc7f27b9Sdrh       inReg = pExpr->pLeft->iTable + pExpr->iColumn;
3643fc7f27b9Sdrh       break;
3644fc7f27b9Sdrh     }
3645fef5208cSdrh     case TK_IN: {
3646e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3647e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3648e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3649e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
365066ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3651e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3652e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3653e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3654fef5208cSdrh       break;
3655fef5208cSdrh     }
3656e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3657e3365e6cSdrh 
3658e3365e6cSdrh 
36592dcef11bSdrh     /*
36602dcef11bSdrh     **    x BETWEEN y AND z
36612dcef11bSdrh     **
36622dcef11bSdrh     ** This is equivalent to
36632dcef11bSdrh     **
36642dcef11bSdrh     **    x>=y AND x<=z
36652dcef11bSdrh     **
36662dcef11bSdrh     ** X is stored in pExpr->pLeft.
36672dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
36682dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
36692dcef11bSdrh     */
3670fef5208cSdrh     case TK_BETWEEN: {
367171c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3672fef5208cSdrh       break;
3673fef5208cSdrh     }
367494fa9c41Sdrh     case TK_SPAN:
3675ae80ddeaSdrh     case TK_COLLATE:
36764f07e5fbSdrh     case TK_UPLUS: {
36772dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3678a2e00042Sdrh       break;
3679a2e00042Sdrh     }
36802dcef11bSdrh 
3681165921a7Sdan     case TK_TRIGGER: {
368265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
368365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
368465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
368565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
368665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
368765a7cd16Sdan       ** read the rowid field.
368865a7cd16Sdan       **
368965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
369065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
369165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
369265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
369365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
369465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
369565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
369665a7cd16Sdan       ** example, if the table on which triggers are being fired is
369765a7cd16Sdan       ** declared as:
369865a7cd16Sdan       **
369965a7cd16Sdan       **   CREATE TABLE t1(a, b);
370065a7cd16Sdan       **
370165a7cd16Sdan       ** Then p1 is interpreted as follows:
370265a7cd16Sdan       **
370365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
370465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
370565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
370665a7cd16Sdan       */
37072832ad42Sdan       Table *pTab = pExpr->pTab;
370865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
370965a7cd16Sdan 
371065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
371165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
371265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
371365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
371465a7cd16Sdan 
371565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
371676d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3717165921a7Sdan         (pExpr->iTable ? "new" : "old"),
371876d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
371976d462eeSdan         target
3720165921a7Sdan       ));
372165a7cd16Sdan 
372244dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
372365a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3724113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3725113762a2Sdrh       **
3726113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3727113762a2Sdrh       ** floating point when extracting it from the record.  */
37282832ad42Sdan       if( pExpr->iColumn>=0
37292832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
37302832ad42Sdan       ){
37312832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
37322832ad42Sdan       }
373344dbca83Sdrh #endif
3734165921a7Sdan       break;
3735165921a7Sdan     }
3736165921a7Sdan 
373771c57db0Sdan     case TK_VECTOR: {
3738d49fd4e8Sdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
373971c57db0Sdan       break;
374071c57db0Sdan     }
374171c57db0Sdan 
37422dcef11bSdrh     /*
37432dcef11bSdrh     ** Form A:
37442dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
37452dcef11bSdrh     **
37462dcef11bSdrh     ** Form B:
37472dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
37482dcef11bSdrh     **
37492dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
37502dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
37512dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
37522dcef11bSdrh     **
37532dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3754c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3755c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3756c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
37572dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
37582dcef11bSdrh     **
37592dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
37602dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
37612dcef11bSdrh     ** no ELSE term, NULL.
37622dcef11bSdrh     */
376333cd4909Sdrh     default: assert( op==TK_CASE ); {
37642dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
37652dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
37662dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
37672dcef11bSdrh       int i;                            /* Loop counter */
37682dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
37692dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
37702dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
37712dcef11bSdrh       Expr *pX;                         /* The X expression */
37721bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3773ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
377417a7f8ddSdrh 
37756ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
37766ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
37776ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3778be5c89acSdrh       aListelem = pEList->a;
3779be5c89acSdrh       nExpr = pEList->nExpr;
37802dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
37812dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
378210d1edf0Sdrh         tempX = *pX;
378333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
378410d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
3785c5499befSdrh         testcase( regFree1==0 );
37862dcef11bSdrh         opCompare.op = TK_EQ;
378710d1edf0Sdrh         opCompare.pLeft = &tempX;
37882dcef11bSdrh         pTest = &opCompare;
37898b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
37908b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
37918b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
37928b1db07fSdrh         ** purposes and possibly overwritten.  */
37938b1db07fSdrh         regFree1 = 0;
3794cce7d176Sdrh       }
3795c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3796ceea3321Sdrh         sqlite3ExprCachePush(pParse);
37972dcef11bSdrh         if( pX ){
37981bd10f8aSdrh           assert( pTest!=0 );
37992dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3800f5905aa7Sdrh         }else{
38012dcef11bSdrh           pTest = aListelem[i].pExpr;
380217a7f8ddSdrh         }
38032dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
380433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
38052dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3806c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
38079de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3808076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3809d2490904Sdrh         sqlite3ExprCachePop(pParse);
38102dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3811f570f011Sdrh       }
3812c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3813ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3814c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3815d2490904Sdrh         sqlite3ExprCachePop(pParse);
381617a7f8ddSdrh       }else{
38179de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
381817a7f8ddSdrh       }
3819c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
3820c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
38212dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
38226f34903eSdanielk1977       break;
38236f34903eSdanielk1977     }
38245338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
38256f34903eSdanielk1977     case TK_RAISE: {
3826165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3827165921a7Sdan            || pExpr->affinity==OE_Abort
3828165921a7Sdan            || pExpr->affinity==OE_Fail
3829165921a7Sdan            || pExpr->affinity==OE_Ignore
3830165921a7Sdan       );
3831e0af83acSdan       if( !pParse->pTriggerTab ){
3832e0af83acSdan         sqlite3ErrorMsg(pParse,
3833e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3834e0af83acSdan         return 0;
3835e0af83acSdan       }
3836e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3837e0af83acSdan         sqlite3MayAbort(pParse);
3838e0af83acSdan       }
383933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3840e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3841e0af83acSdan         sqlite3VdbeAddOp4(
3842e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3843688852abSdrh         VdbeCoverage(v);
3844e0af83acSdan       }else{
3845433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3846f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3847e0af83acSdan       }
3848e0af83acSdan 
3849ffe07b2dSdrh       break;
385017a7f8ddSdrh     }
38515338a5f7Sdanielk1977 #endif
3852ffe07b2dSdrh   }
38532dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
38542dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
38552dcef11bSdrh   return inReg;
38565b6afba9Sdrh }
38572dcef11bSdrh 
38582dcef11bSdrh /*
3859d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3860d1a01edaSdrh */
3861d673cddaSdrh void sqlite3ExprCodeAtInit(
3862d673cddaSdrh   Parse *pParse,    /* Parsing context */
3863d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3864d673cddaSdrh   int regDest,      /* Store the value in this register */
3865d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3866d673cddaSdrh ){
3867d1a01edaSdrh   ExprList *p;
3868d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3869d1a01edaSdrh   p = pParse->pConstExpr;
3870d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3871d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3872d673cddaSdrh   if( p ){
3873d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3874d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3875d673cddaSdrh      pItem->reusable = reusable;
3876d673cddaSdrh   }
3877d1a01edaSdrh   pParse->pConstExpr = p;
3878d1a01edaSdrh }
3879d1a01edaSdrh 
3880d1a01edaSdrh /*
38812dcef11bSdrh ** Generate code to evaluate an expression and store the results
38822dcef11bSdrh ** into a register.  Return the register number where the results
38832dcef11bSdrh ** are stored.
38842dcef11bSdrh **
38852dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3886678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
38872dcef11bSdrh ** a temporary, then set *pReg to zero.
3888f30a969bSdrh **
3889f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3890f30a969bSdrh ** code to fill the register in the initialization section of the
3891f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
38922dcef11bSdrh */
38932dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3894f30a969bSdrh   int r2;
3895f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3896d9f158e7Sdrh   if( ConstFactorOk(pParse)
3897f30a969bSdrh    && pExpr->op!=TK_REGISTER
3898f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3899f30a969bSdrh   ){
3900f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3901f30a969bSdrh     int i;
3902f30a969bSdrh     *pReg  = 0;
3903f30a969bSdrh     if( p ){
3904d673cddaSdrh       struct ExprList_item *pItem;
3905d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3906d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3907d673cddaSdrh           return pItem->u.iConstExprReg;
3908f30a969bSdrh         }
3909f30a969bSdrh       }
3910f30a969bSdrh     }
3911f30a969bSdrh     r2 = ++pParse->nMem;
3912d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3913f30a969bSdrh   }else{
39142dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3915f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
39162dcef11bSdrh     if( r2==r1 ){
39172dcef11bSdrh       *pReg = r1;
39182dcef11bSdrh     }else{
39192dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
39202dcef11bSdrh       *pReg = 0;
39212dcef11bSdrh     }
3922f30a969bSdrh   }
39232dcef11bSdrh   return r2;
39242dcef11bSdrh }
39252dcef11bSdrh 
39262dcef11bSdrh /*
39272dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
39282dcef11bSdrh ** results in register target.  The results are guaranteed to appear
39292dcef11bSdrh ** in register target.
39302dcef11bSdrh */
393105a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
39329cbf3425Sdrh   int inReg;
39339cbf3425Sdrh 
39349cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3935ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3936ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3937ebc16717Sdrh   }else{
39389cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
39391c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
39400e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
39419cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
394217a7f8ddSdrh     }
3943ebc16717Sdrh   }
3944cce7d176Sdrh }
3945cce7d176Sdrh 
3946cce7d176Sdrh /*
39471c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
39481c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
39491c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
39501c75c9d7Sdrh */
39511c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
39521c75c9d7Sdrh   sqlite3 *db = pParse->db;
39531c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
39541c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
39551c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
39561c75c9d7Sdrh }
39571c75c9d7Sdrh 
39581c75c9d7Sdrh /*
395905a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
396005a86c5cSdrh ** results in register target.  The results are guaranteed to appear
396105a86c5cSdrh ** in register target.  If the expression is constant, then this routine
396205a86c5cSdrh ** might choose to code the expression at initialization time.
396305a86c5cSdrh */
396405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
396505a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
396605a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
396705a86c5cSdrh   }else{
396805a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
396905a86c5cSdrh   }
3970cce7d176Sdrh }
3971cce7d176Sdrh 
3972cce7d176Sdrh /*
397360ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
3974de4fcfddSdrh ** in register target.
397525303780Sdrh **
39762dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
39772dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
39782dcef11bSdrh ** the result is a copy of the cache register.
39792dcef11bSdrh **
39802dcef11bSdrh ** This routine is used for expressions that are used multiple
39812dcef11bSdrh ** times.  They are evaluated once and the results of the expression
39822dcef11bSdrh ** are reused.
398325303780Sdrh */
398405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
398525303780Sdrh   Vdbe *v = pParse->pVdbe;
398625303780Sdrh   int iMem;
398705a86c5cSdrh 
398805a86c5cSdrh   assert( target>0 );
398905a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
399005a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
39912dcef11bSdrh   iMem = ++pParse->nMem;
399205a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3993a4c3c87eSdrh   exprToRegister(pExpr, iMem);
399425303780Sdrh }
39957e02e5e6Sdrh 
3996678ccce8Sdrh /*
3997268380caSdrh ** Generate code that pushes the value of every element of the given
39989cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3999268380caSdrh **
4000892d3179Sdrh ** Return the number of elements evaluated.
4001d1a01edaSdrh **
4002d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4003d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4004d1a01edaSdrh **
4005d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4006d1a01edaSdrh ** factored out into initialization code.
4007b0df9634Sdrh **
4008b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4009b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4010b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
4011268380caSdrh */
40124adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4013268380caSdrh   Parse *pParse,     /* Parsing context */
4014389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4015191b54cbSdrh   int target,        /* Where to write results */
40165579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4017d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4018268380caSdrh ){
4019268380caSdrh   struct ExprList_item *pItem;
40205579d59fSdrh   int i, j, n;
4021d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
40225579d59fSdrh   Vdbe *v = pParse->pVdbe;
40239d8b3072Sdrh   assert( pList!=0 );
40249cbf3425Sdrh   assert( target>0 );
4025d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4026268380caSdrh   n = pList->nExpr;
4027d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4028191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
40297445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
40305579d59fSdrh     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
40315579d59fSdrh       sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
40325579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4033d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
4034d1a01edaSdrh     }else{
40357445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4036746fd9ccSdrh       if( inReg!=target+i ){
40374eded604Sdrh         VdbeOp *pOp;
40384eded604Sdrh         if( copyOp==OP_Copy
40394eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
40404eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
40414eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
40424eded604Sdrh         ){
40434eded604Sdrh           pOp->p3++;
40444eded604Sdrh         }else{
40454eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
40464eded604Sdrh         }
4047d1a01edaSdrh       }
4048d176611bSdrh     }
4049268380caSdrh   }
4050f9b596ebSdrh   return n;
4051268380caSdrh }
4052268380caSdrh 
4053268380caSdrh /*
405436c563a2Sdrh ** Generate code for a BETWEEN operator.
405536c563a2Sdrh **
405636c563a2Sdrh **    x BETWEEN y AND z
405736c563a2Sdrh **
405836c563a2Sdrh ** The above is equivalent to
405936c563a2Sdrh **
406036c563a2Sdrh **    x>=y AND x<=z
406136c563a2Sdrh **
406236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
406360ec914cSpeter.d.reid ** elimination of x.
406484b19a3dSdrh **
406584b19a3dSdrh ** The xJumpIf parameter determines details:
406684b19a3dSdrh **
406784b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
406884b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
406984b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
407084b19a3dSdrh **
407184b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
407236c563a2Sdrh */
407336c563a2Sdrh static void exprCodeBetween(
407436c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
407536c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
407684b19a3dSdrh   int dest,         /* Jump destination or storage location */
407784b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
407836c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
407936c563a2Sdrh ){
408036c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
408136c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
408236c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4083*db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4084*db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
408584b19a3dSdrh 
408636c563a2Sdrh 
408771c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
408871c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
408971c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4090*db45bd5eSdrh 
4091*db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4092*db45bd5eSdrh   exprX = *pExpr->pLeft;
409336c563a2Sdrh   exprAnd.op = TK_AND;
409436c563a2Sdrh   exprAnd.pLeft = &compLeft;
409536c563a2Sdrh   exprAnd.pRight = &compRight;
409636c563a2Sdrh   compLeft.op = TK_GE;
4097*db45bd5eSdrh   compLeft.pLeft = &exprX;
409836c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
409936c563a2Sdrh   compRight.op = TK_LE;
4100*db45bd5eSdrh   compRight.pLeft = &exprX;
410136c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
4102*db45bd5eSdrh   if( sqlite3ExprIsVector(&exprX)==0 ){
4103*db45bd5eSdrh     exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
4104*db45bd5eSdrh   }
410584b19a3dSdrh   if( xJump ){
410684b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
410736c563a2Sdrh   }else{
4108*db45bd5eSdrh     exprX.flags |= EP_FromJoin;
410971c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
411036c563a2Sdrh   }
4111*db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
411236c563a2Sdrh 
411336c563a2Sdrh   /* Ensure adequate test coverage */
4114*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4115*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4116*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4117*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4118*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4119*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4120*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4121*db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
412284b19a3dSdrh   testcase( xJump==0 );
412336c563a2Sdrh }
412436c563a2Sdrh 
412536c563a2Sdrh /*
4126cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4127cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4128cce7d176Sdrh ** continues straight thru if the expression is false.
4129f5905aa7Sdrh **
4130f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
413135573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4132f2bc013cSdrh **
4133f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4134f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4135f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4136f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4137f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4138cce7d176Sdrh */
41394adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4140cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4141cce7d176Sdrh   int op = 0;
41422dcef11bSdrh   int regFree1 = 0;
41432dcef11bSdrh   int regFree2 = 0;
41442dcef11bSdrh   int r1, r2;
41452dcef11bSdrh 
414635573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
414748864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
414833cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4149f2bc013cSdrh   op = pExpr->op;
41507b35a77bSdan   switch( op ){
4151cce7d176Sdrh     case TK_AND: {
41524adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4153c5499befSdrh       testcase( jumpIfNull==0 );
415435573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
415554e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41564adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
41574adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4158d2490904Sdrh       sqlite3ExprCachePop(pParse);
4159cce7d176Sdrh       break;
4160cce7d176Sdrh     }
4161cce7d176Sdrh     case TK_OR: {
4162c5499befSdrh       testcase( jumpIfNull==0 );
41634adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
416454e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41654adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4166d2490904Sdrh       sqlite3ExprCachePop(pParse);
4167cce7d176Sdrh       break;
4168cce7d176Sdrh     }
4169cce7d176Sdrh     case TK_NOT: {
4170c5499befSdrh       testcase( jumpIfNull==0 );
41714adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4172cce7d176Sdrh       break;
4173cce7d176Sdrh     }
4174de845c2fSdrh     case TK_IS:
4175de845c2fSdrh     case TK_ISNOT:
4176de845c2fSdrh       testcase( op==TK_IS );
4177de845c2fSdrh       testcase( op==TK_ISNOT );
4178de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4179de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4180de845c2fSdrh       /* Fall thru */
4181cce7d176Sdrh     case TK_LT:
4182cce7d176Sdrh     case TK_LE:
4183cce7d176Sdrh     case TK_GT:
4184cce7d176Sdrh     case TK_GE:
4185cce7d176Sdrh     case TK_NE:
41860ac65892Sdrh     case TK_EQ: {
4187625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4188c5499befSdrh       testcase( jumpIfNull==0 );
4189b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4190b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
419135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
41922dcef11bSdrh                   r1, r2, dest, jumpIfNull);
41937d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41947d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41957d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41967d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4197de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4198de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4199de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4200de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4201de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4202de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
42036a2fe093Sdrh       testcase( regFree1==0 );
42046a2fe093Sdrh       testcase( regFree2==0 );
42056a2fe093Sdrh       break;
42066a2fe093Sdrh     }
4207cce7d176Sdrh     case TK_ISNULL:
4208cce7d176Sdrh     case TK_NOTNULL: {
42097d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
42107d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
42112dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42122dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
42137d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42147d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4215c5499befSdrh       testcase( regFree1==0 );
4216cce7d176Sdrh       break;
4217cce7d176Sdrh     }
4218fef5208cSdrh     case TK_BETWEEN: {
42195c03f30aSdrh       testcase( jumpIfNull==0 );
422071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4221fef5208cSdrh       break;
4222fef5208cSdrh     }
4223bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4224e3365e6cSdrh     case TK_IN: {
4225e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4226e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4227e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4228076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4229e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4230e3365e6cSdrh       break;
4231e3365e6cSdrh     }
4232bb201344Sshaneh #endif
4233cce7d176Sdrh     default: {
42347b35a77bSdan     default_expr:
4235991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4236076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4237991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4238991a1985Sdrh         /* No-op */
4239991a1985Sdrh       }else{
42402dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
42412dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4242688852abSdrh         VdbeCoverage(v);
4243c5499befSdrh         testcase( regFree1==0 );
4244c5499befSdrh         testcase( jumpIfNull==0 );
4245991a1985Sdrh       }
4246cce7d176Sdrh       break;
4247cce7d176Sdrh     }
4248cce7d176Sdrh   }
42492dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42502dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4251cce7d176Sdrh }
4252cce7d176Sdrh 
4253cce7d176Sdrh /*
425466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4255cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4256cce7d176Sdrh ** continues straight thru if the expression is true.
4257f5905aa7Sdrh **
4258f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
425935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
426035573356Sdrh ** is 0.
4261cce7d176Sdrh */
42624adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4263cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4264cce7d176Sdrh   int op = 0;
42652dcef11bSdrh   int regFree1 = 0;
42662dcef11bSdrh   int regFree2 = 0;
42672dcef11bSdrh   int r1, r2;
42682dcef11bSdrh 
426935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
427048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
427133cd4909Sdrh   if( pExpr==0 )    return;
4272f2bc013cSdrh 
4273f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4274f2bc013cSdrh   **
4275f2bc013cSdrh   **       pExpr->op            op
4276f2bc013cSdrh   **       ---------          ----------
4277f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4278f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4279f2bc013cSdrh   **       TK_NE              OP_Eq
4280f2bc013cSdrh   **       TK_EQ              OP_Ne
4281f2bc013cSdrh   **       TK_GT              OP_Le
4282f2bc013cSdrh   **       TK_LE              OP_Gt
4283f2bc013cSdrh   **       TK_GE              OP_Lt
4284f2bc013cSdrh   **       TK_LT              OP_Ge
4285f2bc013cSdrh   **
4286f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4287f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4288f2bc013cSdrh   ** can compute the mapping above using the following expression.
4289f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4290f2bc013cSdrh   */
4291f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4292f2bc013cSdrh 
4293f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4294f2bc013cSdrh   */
4295f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4296f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4297f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4298f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4299f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4300f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4301f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4302f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4303f2bc013cSdrh 
4304ba00e30aSdan   switch( pExpr->op ){
4305cce7d176Sdrh     case TK_AND: {
4306c5499befSdrh       testcase( jumpIfNull==0 );
43074adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
430854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43094adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4310d2490904Sdrh       sqlite3ExprCachePop(pParse);
4311cce7d176Sdrh       break;
4312cce7d176Sdrh     }
4313cce7d176Sdrh     case TK_OR: {
43144adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4315c5499befSdrh       testcase( jumpIfNull==0 );
431635573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
431754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43184adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
43194adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4320d2490904Sdrh       sqlite3ExprCachePop(pParse);
4321cce7d176Sdrh       break;
4322cce7d176Sdrh     }
4323cce7d176Sdrh     case TK_NOT: {
43245c03f30aSdrh       testcase( jumpIfNull==0 );
43254adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4326cce7d176Sdrh       break;
4327cce7d176Sdrh     }
4328de845c2fSdrh     case TK_IS:
4329de845c2fSdrh     case TK_ISNOT:
4330de845c2fSdrh       testcase( pExpr->op==TK_IS );
4331de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4332de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4333de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4334de845c2fSdrh       /* Fall thru */
4335cce7d176Sdrh     case TK_LT:
4336cce7d176Sdrh     case TK_LE:
4337cce7d176Sdrh     case TK_GT:
4338cce7d176Sdrh     case TK_GE:
4339cce7d176Sdrh     case TK_NE:
4340cce7d176Sdrh     case TK_EQ: {
4341625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4342c5499befSdrh       testcase( jumpIfNull==0 );
4343b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4344b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
434535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
43462dcef11bSdrh                   r1, r2, dest, jumpIfNull);
43477d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
43487d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
43497d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
43507d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4351de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4352de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4353de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4354de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4355de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4356de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
43576a2fe093Sdrh       testcase( regFree1==0 );
43586a2fe093Sdrh       testcase( regFree2==0 );
43596a2fe093Sdrh       break;
43606a2fe093Sdrh     }
4361cce7d176Sdrh     case TK_ISNULL:
4362cce7d176Sdrh     case TK_NOTNULL: {
43632dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
43642dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
43657d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
43667d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4367c5499befSdrh       testcase( regFree1==0 );
4368cce7d176Sdrh       break;
4369cce7d176Sdrh     }
4370fef5208cSdrh     case TK_BETWEEN: {
43715c03f30aSdrh       testcase( jumpIfNull==0 );
437271c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4373fef5208cSdrh       break;
4374fef5208cSdrh     }
4375bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4376e3365e6cSdrh     case TK_IN: {
4377e3365e6cSdrh       if( jumpIfNull ){
4378e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4379e3365e6cSdrh       }else{
4380e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4381e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4382e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4383e3365e6cSdrh       }
4384e3365e6cSdrh       break;
4385e3365e6cSdrh     }
4386bb201344Sshaneh #endif
4387cce7d176Sdrh     default: {
4388ba00e30aSdan     default_expr:
4389991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4390076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4391991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4392991a1985Sdrh         /* no-op */
4393991a1985Sdrh       }else{
43942dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
43952dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4396688852abSdrh         VdbeCoverage(v);
4397c5499befSdrh         testcase( regFree1==0 );
4398c5499befSdrh         testcase( jumpIfNull==0 );
4399991a1985Sdrh       }
4400cce7d176Sdrh       break;
4401cce7d176Sdrh     }
4402cce7d176Sdrh   }
44032dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44042dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4405cce7d176Sdrh }
44062282792aSdrh 
44072282792aSdrh /*
440872bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
440972bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
441072bc8208Sdrh ** ensures that the original pExpr is unchanged.
441172bc8208Sdrh */
441272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
441372bc8208Sdrh   sqlite3 *db = pParse->db;
441472bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
441572bc8208Sdrh   if( db->mallocFailed==0 ){
441672bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
441772bc8208Sdrh   }
441872bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
441972bc8208Sdrh }
442072bc8208Sdrh 
442172bc8208Sdrh 
442272bc8208Sdrh /*
44231d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
44241d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
44251d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
44261d9da70aSdrh ** other than the top-level COLLATE operator.
4427d40aab0eSdrh **
4428619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4429619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4430619a1305Sdrh **
443166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
443266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
443366518ca7Sdrh **
44341d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4435d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
44361d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
44371d9da70aSdrh ** returns 2, then you do not really know for certain if the two
44381d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4439d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
44401d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4441d40aab0eSdrh ** just might result in some slightly slower code.  But returning
44421d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
44432282792aSdrh */
4444619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
444510d1edf0Sdrh   u32 combinedFlags;
44464b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
44471d9da70aSdrh     return pB==pA ? 0 : 2;
44482282792aSdrh   }
444910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
445010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
445110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
445210d1edf0Sdrh       return 0;
445310d1edf0Sdrh     }
44541d9da70aSdrh     return 2;
44556ab3a2ecSdanielk1977   }
4456c2acc4e4Sdrh   if( pA->op!=pB->op ){
4457619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
4458ae80ddeaSdrh       return 1;
4459ae80ddeaSdrh     }
4460619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
4461ae80ddeaSdrh       return 1;
4462ae80ddeaSdrh     }
4463ae80ddeaSdrh     return 2;
4464ae80ddeaSdrh   }
44652edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4466390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4467390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4468390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
446910d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
447010d1edf0Sdrh     }
447110d1edf0Sdrh   }
447210d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
447385f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
447410d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4475619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
4476619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
4477619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
44787693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4479619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
448066518ca7Sdrh       if( pA->iTable!=pB->iTable
448185f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
44821d9da70aSdrh     }
44831d9da70aSdrh   }
44842646da7eSdrh   return 0;
44852646da7eSdrh }
44862282792aSdrh 
44878c6f666bSdrh /*
44888c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
44898c6f666bSdrh ** non-zero if they differ in any way.
44908c6f666bSdrh **
4491619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4492619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4493619a1305Sdrh **
44948c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
44958c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
44968c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
44978c6f666bSdrh ** a malfunction will result.
44988c6f666bSdrh **
44998c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
45008c6f666bSdrh ** always differs from a non-NULL pointer.
45018c6f666bSdrh */
4502619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
45038c6f666bSdrh   int i;
45048c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
45058c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
45068c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
45078c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
45088c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
45098c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
45108c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
4511619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
45128c6f666bSdrh   }
45138c6f666bSdrh   return 0;
45148c6f666bSdrh }
451513449892Sdrh 
45162282792aSdrh /*
45174bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
45184bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
45194bd5f73fSdrh ** be false.  Examples:
45204bd5f73fSdrh **
4521619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
45224bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4523619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
45244bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4525619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4526619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4527619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
45284bd5f73fSdrh **
45294bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
45304bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
45314bd5f73fSdrh **
45324bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
45334bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
45344bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
45354bd5f73fSdrh */
45364bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
4537619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
4538619a1305Sdrh     return 1;
4539619a1305Sdrh   }
4540619a1305Sdrh   if( pE2->op==TK_OR
4541619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
4542619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
4543619a1305Sdrh   ){
4544619a1305Sdrh     return 1;
4545619a1305Sdrh   }
4546619a1305Sdrh   if( pE2->op==TK_NOTNULL
4547619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
4548619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
4549619a1305Sdrh   ){
4550619a1305Sdrh     return 1;
4551619a1305Sdrh   }
4552619a1305Sdrh   return 0;
45534bd5f73fSdrh }
45544bd5f73fSdrh 
45554bd5f73fSdrh /*
4556030796dfSdrh ** An instance of the following structure is used by the tree walker
45572409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
45582409f8a1Sdrh ** index only, without having to do a search for the corresponding
45592409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
45602409f8a1Sdrh ** is the cursor for the table.
45612409f8a1Sdrh */
45622409f8a1Sdrh struct IdxCover {
45632409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
45642409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
45652409f8a1Sdrh };
45662409f8a1Sdrh 
45672409f8a1Sdrh /*
45682409f8a1Sdrh ** Check to see if there are references to columns in table
45692409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
45702409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
45712409f8a1Sdrh */
45722409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
45732409f8a1Sdrh   if( pExpr->op==TK_COLUMN
45742409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
45752409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
45762409f8a1Sdrh   ){
45772409f8a1Sdrh     pWalker->eCode = 1;
45782409f8a1Sdrh     return WRC_Abort;
45792409f8a1Sdrh   }
45802409f8a1Sdrh   return WRC_Continue;
45812409f8a1Sdrh }
45822409f8a1Sdrh 
45832409f8a1Sdrh /*
4584e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4585e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4586e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4587e604ec0bSdrh ** that are not found in the index pIdx.
45882409f8a1Sdrh **
45892409f8a1Sdrh ** An index covering an expression means that the expression can be
45902409f8a1Sdrh ** evaluated using only the index and without having to lookup the
45912409f8a1Sdrh ** corresponding table entry.
45922409f8a1Sdrh */
45932409f8a1Sdrh int sqlite3ExprCoveredByIndex(
45942409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
45952409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
45962409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
45972409f8a1Sdrh ){
45982409f8a1Sdrh   Walker w;
45992409f8a1Sdrh   struct IdxCover xcov;
46002409f8a1Sdrh   memset(&w, 0, sizeof(w));
46012409f8a1Sdrh   xcov.iCur = iCur;
46022409f8a1Sdrh   xcov.pIdx = pIdx;
46032409f8a1Sdrh   w.xExprCallback = exprIdxCover;
46042409f8a1Sdrh   w.u.pIdxCover = &xcov;
46052409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
46062409f8a1Sdrh   return !w.eCode;
46072409f8a1Sdrh }
46082409f8a1Sdrh 
46092409f8a1Sdrh 
46102409f8a1Sdrh /*
46112409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4612030796dfSdrh ** to count references to table columns in the arguments of an
4613ed551b95Sdrh ** aggregate function, in order to implement the
4614ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4615374fdce4Sdrh */
4616030796dfSdrh struct SrcCount {
4617030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4618030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4619030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4620030796dfSdrh };
4621030796dfSdrh 
4622030796dfSdrh /*
4623030796dfSdrh ** Count the number of references to columns.
4624030796dfSdrh */
4625030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4626fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4627fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4628fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4629fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4630fb0a6081Sdrh   ** NEVER() will need to be removed. */
4631fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4632374fdce4Sdrh     int i;
4633030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4634030796dfSdrh     SrcList *pSrc = p->pSrc;
4635655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4636655814d2Sdrh     for(i=0; i<nSrc; i++){
4637030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4638374fdce4Sdrh     }
4639655814d2Sdrh     if( i<nSrc ){
4640030796dfSdrh       p->nThis++;
4641374fdce4Sdrh     }else{
4642030796dfSdrh       p->nOther++;
4643374fdce4Sdrh     }
4644374fdce4Sdrh   }
4645030796dfSdrh   return WRC_Continue;
4646030796dfSdrh }
4647374fdce4Sdrh 
4648374fdce4Sdrh /*
4649030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4650030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4651030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4652030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4653374fdce4Sdrh */
4654030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4655374fdce4Sdrh   Walker w;
4656030796dfSdrh   struct SrcCount cnt;
4657374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4658374fdce4Sdrh   memset(&w, 0, sizeof(w));
4659030796dfSdrh   w.xExprCallback = exprSrcCount;
4660030796dfSdrh   w.u.pSrcCount = &cnt;
4661030796dfSdrh   cnt.pSrc = pSrcList;
4662030796dfSdrh   cnt.nThis = 0;
4663030796dfSdrh   cnt.nOther = 0;
4664030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4665030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4666374fdce4Sdrh }
4667374fdce4Sdrh 
4668374fdce4Sdrh /*
466913449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
467013449892Sdrh ** the new element.  Return a negative number if malloc fails.
46712282792aSdrh */
467217435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
467313449892Sdrh   int i;
4674cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
467517435752Sdrh        db,
4676cf643729Sdrh        pInfo->aCol,
4677cf643729Sdrh        sizeof(pInfo->aCol[0]),
4678cf643729Sdrh        &pInfo->nColumn,
4679cf643729Sdrh        &i
4680cf643729Sdrh   );
468113449892Sdrh   return i;
46822282792aSdrh }
468313449892Sdrh 
468413449892Sdrh /*
468513449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
468613449892Sdrh ** the new element.  Return a negative number if malloc fails.
468713449892Sdrh */
468817435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
468913449892Sdrh   int i;
4690cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
469117435752Sdrh        db,
4692cf643729Sdrh        pInfo->aFunc,
4693cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4694cf643729Sdrh        &pInfo->nFunc,
4695cf643729Sdrh        &i
4696cf643729Sdrh   );
469713449892Sdrh   return i;
46982282792aSdrh }
46992282792aSdrh 
47002282792aSdrh /*
47017d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
47027d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4703626a879aSdrh ** for additional information.
47042282792aSdrh */
47057d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
47062282792aSdrh   int i;
47077d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4708a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4709a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
471013449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
471113449892Sdrh 
47122282792aSdrh   switch( pExpr->op ){
471389c69d00Sdrh     case TK_AGG_COLUMN:
4714967e8b73Sdrh     case TK_COLUMN: {
47158b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
47168b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
471713449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
471813449892Sdrh       ** clause of the aggregate query */
471920bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
472013449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
472113449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
472213449892Sdrh           struct AggInfo_col *pCol;
4723c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
472413449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
472513449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
472613449892Sdrh             ** that is in the FROM clause of the aggregate query.
472713449892Sdrh             **
472813449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
472913449892Sdrh             ** is not an entry there already.
473013449892Sdrh             */
47317f906d63Sdrh             int k;
473213449892Sdrh             pCol = pAggInfo->aCol;
47337f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
473413449892Sdrh               if( pCol->iTable==pExpr->iTable &&
473513449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
47362282792aSdrh                 break;
47372282792aSdrh               }
47382282792aSdrh             }
47391e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
47401e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
47411e536953Sdanielk1977             ){
47427f906d63Sdrh               pCol = &pAggInfo->aCol[k];
47430817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
474413449892Sdrh               pCol->iTable = pExpr->iTable;
474513449892Sdrh               pCol->iColumn = pExpr->iColumn;
47460a07c107Sdrh               pCol->iMem = ++pParse->nMem;
474713449892Sdrh               pCol->iSorterColumn = -1;
47485774b806Sdrh               pCol->pExpr = pExpr;
474913449892Sdrh               if( pAggInfo->pGroupBy ){
475013449892Sdrh                 int j, n;
475113449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
475213449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
475313449892Sdrh                 n = pGB->nExpr;
475413449892Sdrh                 for(j=0; j<n; j++, pTerm++){
475513449892Sdrh                   Expr *pE = pTerm->pExpr;
475613449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
475713449892Sdrh                       pE->iColumn==pExpr->iColumn ){
475813449892Sdrh                     pCol->iSorterColumn = j;
475913449892Sdrh                     break;
47602282792aSdrh                   }
476113449892Sdrh                 }
476213449892Sdrh               }
476313449892Sdrh               if( pCol->iSorterColumn<0 ){
476413449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
476513449892Sdrh               }
476613449892Sdrh             }
476713449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
476813449892Sdrh             ** because it was there before or because we just created it).
476913449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
477013449892Sdrh             ** pAggInfo->aCol[] entry.
477113449892Sdrh             */
4772ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
477313449892Sdrh             pExpr->pAggInfo = pAggInfo;
477413449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4775cf697396Sshane             pExpr->iAgg = (i16)k;
477613449892Sdrh             break;
477713449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
477813449892Sdrh         } /* end loop over pSrcList */
4779a58fdfb1Sdanielk1977       }
47807d10d5a6Sdrh       return WRC_Prune;
47812282792aSdrh     }
47822282792aSdrh     case TK_AGG_FUNCTION: {
47833a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4784ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
47853a8c4be7Sdrh       ){
478613449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
478713449892Sdrh         ** function that is already in the pAggInfo structure
478813449892Sdrh         */
478913449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
479013449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4791619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
47922282792aSdrh             break;
47932282792aSdrh           }
47942282792aSdrh         }
479513449892Sdrh         if( i>=pAggInfo->nFunc ){
479613449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
479713449892Sdrh           */
479814db2665Sdanielk1977           u8 enc = ENC(pParse->db);
47991e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
480013449892Sdrh           if( i>=0 ){
48016ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
480213449892Sdrh             pItem = &pAggInfo->aFunc[i];
480313449892Sdrh             pItem->pExpr = pExpr;
48040a07c107Sdrh             pItem->iMem = ++pParse->nMem;
480533e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
480613449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
480780738d9cSdrh                    pExpr->u.zToken,
48086ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4809fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4810fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4811fd357974Sdrh             }else{
4812fd357974Sdrh               pItem->iDistinct = -1;
4813fd357974Sdrh             }
48142282792aSdrh           }
481513449892Sdrh         }
481613449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
481713449892Sdrh         */
4818c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4819ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4820cf697396Sshane         pExpr->iAgg = (i16)i;
482113449892Sdrh         pExpr->pAggInfo = pAggInfo;
48223a8c4be7Sdrh         return WRC_Prune;
48236e83a57fSdrh       }else{
48246e83a57fSdrh         return WRC_Continue;
48256e83a57fSdrh       }
48262282792aSdrh     }
4827a58fdfb1Sdanielk1977   }
48287d10d5a6Sdrh   return WRC_Continue;
48297d10d5a6Sdrh }
48307d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4831d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4832d5a336efSdrh   UNUSED_PARAMETER(pSelect);
48337d10d5a6Sdrh   return WRC_Continue;
4834a58fdfb1Sdanielk1977 }
4835626a879aSdrh 
4836626a879aSdrh /*
4837e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4838e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4839e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4840e8abb4caSdrh ** necessary.
4841626a879aSdrh **
4842626a879aSdrh ** This routine should only be called after the expression has been
48437d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4844626a879aSdrh */
4845d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
48467d10d5a6Sdrh   Walker w;
4847374fdce4Sdrh   memset(&w, 0, sizeof(w));
48487d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
48497d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
48507d10d5a6Sdrh   w.u.pNC = pNC;
485120bc393cSdrh   assert( pNC->pSrcList!=0 );
48527d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
48532282792aSdrh }
48545d9a4af9Sdrh 
48555d9a4af9Sdrh /*
48565d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
48575d9a4af9Sdrh ** expression list.  Return the number of errors.
48585d9a4af9Sdrh **
48595d9a4af9Sdrh ** If an error is found, the analysis is cut short.
48605d9a4af9Sdrh */
4861d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
48625d9a4af9Sdrh   struct ExprList_item *pItem;
48635d9a4af9Sdrh   int i;
48645d9a4af9Sdrh   if( pList ){
4865d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4866d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
48675d9a4af9Sdrh     }
48685d9a4af9Sdrh   }
48695d9a4af9Sdrh }
4870892d3179Sdrh 
4871892d3179Sdrh /*
4872ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4873892d3179Sdrh */
4874892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4875e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4876892d3179Sdrh     return ++pParse->nMem;
4877892d3179Sdrh   }
48782f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4879892d3179Sdrh }
4880ceea3321Sdrh 
4881ceea3321Sdrh /*
4882ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4883ceea3321Sdrh ** purpose.
4884ceea3321Sdrh **
4885ceea3321Sdrh ** If a register is currently being used by the column cache, then
488660ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4887ceea3321Sdrh ** the register becomes stale.
4888ceea3321Sdrh */
4889892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
48902dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4891ceea3321Sdrh     int i;
4892ceea3321Sdrh     struct yColCache *p;
4893ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4894ceea3321Sdrh       if( p->iReg==iReg ){
4895ceea3321Sdrh         p->tempReg = 1;
4896ceea3321Sdrh         return;
4897ceea3321Sdrh       }
4898ceea3321Sdrh     }
4899892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4900892d3179Sdrh   }
4901892d3179Sdrh }
4902892d3179Sdrh 
4903892d3179Sdrh /*
4904892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4905892d3179Sdrh */
4906892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4907e55cbd72Sdrh   int i, n;
4908892d3179Sdrh   i = pParse->iRangeReg;
4909e55cbd72Sdrh   n = pParse->nRangeReg;
4910f49f3523Sdrh   if( nReg<=n ){
4911f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4912892d3179Sdrh     pParse->iRangeReg += nReg;
4913892d3179Sdrh     pParse->nRangeReg -= nReg;
4914892d3179Sdrh   }else{
4915892d3179Sdrh     i = pParse->nMem+1;
4916892d3179Sdrh     pParse->nMem += nReg;
4917892d3179Sdrh   }
4918892d3179Sdrh   return i;
4919892d3179Sdrh }
4920892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4921f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4922892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4923892d3179Sdrh     pParse->nRangeReg = nReg;
4924892d3179Sdrh     pParse->iRangeReg = iReg;
4925892d3179Sdrh   }
4926892d3179Sdrh }
4927cdc69557Sdrh 
4928cdc69557Sdrh /*
4929cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4930cdc69557Sdrh */
4931cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4932cdc69557Sdrh   pParse->nTempReg = 0;
4933cdc69557Sdrh   pParse->nRangeReg = 0;
4934cdc69557Sdrh }
4935bb9b5f26Sdrh 
4936bb9b5f26Sdrh /*
4937bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
4938bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
4939bb9b5f26Sdrh ** statements.
4940bb9b5f26Sdrh */
4941bb9b5f26Sdrh #ifdef SQLITE_DEBUG
4942bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
4943bb9b5f26Sdrh   int i;
4944bb9b5f26Sdrh   if( pParse->nRangeReg>0
4945bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
4946bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
4947bb9b5f26Sdrh   ){
4948bb9b5f26Sdrh      return 0;
4949bb9b5f26Sdrh   }
4950bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
4951bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
4952bb9b5f26Sdrh       return 0;
4953bb9b5f26Sdrh     }
4954bb9b5f26Sdrh   }
4955bb9b5f26Sdrh   return 1;
4956bb9b5f26Sdrh }
4957bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
4958