xref: /sqlite-3.40.0/src/expr.c (revision d832da7f)
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   }
42487e262fSdrh #ifndef SQLITE_OMIT_CAST
43487e262fSdrh   if( op==TK_CAST ){
4433e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
45fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
46487e262fSdrh   }
47487e262fSdrh #endif
48259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
49259a455fSdanielk1977    && pExpr->pTab!=0
50259a455fSdanielk1977   ){
517d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
527d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
537d10d5a6Sdrh     int j = pExpr->iColumn;
547d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
557d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
567d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
577d10d5a6Sdrh   }
58a37cdde0Sdanielk1977   return pExpr->affinity;
59a37cdde0Sdanielk1977 }
60a37cdde0Sdanielk1977 
6153db1458Sdrh /*
628b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
63ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
64ae80ddeaSdrh ** implements the COLLATE operator.
650a8a406eSdrh **
660a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
670a8a406eSdrh ** and the pExpr parameter is returned unchanged.
688b4c40d8Sdrh */
694ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
704ef7efadSdrh   Parse *pParse,           /* Parsing context */
714ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
7280103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
7380103fc6Sdan   int dequote              /* True to dequote pCollName */
744ef7efadSdrh ){
750a8a406eSdrh   if( pCollName->n>0 ){
7680103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
77ae80ddeaSdrh     if( pNew ){
78ae80ddeaSdrh       pNew->pLeft = pExpr;
79a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
800a8a406eSdrh       pExpr = pNew;
81ae80ddeaSdrh     }
820a8a406eSdrh   }
830a8a406eSdrh   return pExpr;
840a8a406eSdrh }
850a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
860a8a406eSdrh   Token s;
87261d8a51Sdrh   assert( zC!=0 );
8840aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
8980103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
900a8a406eSdrh }
910a8a406eSdrh 
920a8a406eSdrh /*
930b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
94a4c3c87eSdrh ** or likelihood() function at the root of an expression.
950a8a406eSdrh */
960a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
97a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
98a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
99cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
100cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
101a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
102cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
103cca9f3d2Sdrh     }else{
1040b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
105d91eba96Sdrh       pExpr = pExpr->pLeft;
106cca9f3d2Sdrh     }
107d91eba96Sdrh   }
1080a8a406eSdrh   return pExpr;
1098b4c40d8Sdrh }
1108b4c40d8Sdrh 
1118b4c40d8Sdrh /*
112ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
113ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
114ae80ddeaSdrh **
115ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
116ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
117ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
118ae80ddeaSdrh ** precedence over right operands.
1190202b29eSdanielk1977 */
1207cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
121ae80ddeaSdrh   sqlite3 *db = pParse->db;
1227cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1237d10d5a6Sdrh   Expr *p = pExpr;
124261d8a51Sdrh   while( p ){
125ae80ddeaSdrh     int op = p->op;
126fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
127ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
128ae80ddeaSdrh       p = p->pLeft;
129ae80ddeaSdrh       continue;
130ae80ddeaSdrh     }
13136e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1327a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
133ae80ddeaSdrh       break;
134ae80ddeaSdrh     }
135a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
136ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
137a58d4a96Sdrh      && p->pTab!=0
138ae80ddeaSdrh     ){
1397d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1407d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1417d10d5a6Sdrh       int j = p->iColumn;
1427d10d5a6Sdrh       if( j>=0 ){
143ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
144c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1450202b29eSdanielk1977       }
1467d10d5a6Sdrh       break;
1477d10d5a6Sdrh     }
148ae80ddeaSdrh     if( p->flags & EP_Collate ){
1492308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1507d10d5a6Sdrh         p = p->pLeft;
151ae80ddeaSdrh       }else{
1522308ed38Sdrh         Expr *pNext  = p->pRight;
1536728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1546728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1556728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1566728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1576728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1586728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1592308ed38Sdrh           int i;
1606728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1612308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1622308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1632308ed38Sdrh               break;
1642308ed38Sdrh             }
1652308ed38Sdrh           }
1662308ed38Sdrh         }
1672308ed38Sdrh         p = pNext;
168ae80ddeaSdrh       }
169ae80ddeaSdrh     }else{
170ae80ddeaSdrh       break;
171ae80ddeaSdrh     }
1720202b29eSdanielk1977   }
1737cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1747cedc8d4Sdanielk1977     pColl = 0;
1757cedc8d4Sdanielk1977   }
1767cedc8d4Sdanielk1977   return pColl;
1770202b29eSdanielk1977 }
1780202b29eSdanielk1977 
1790202b29eSdanielk1977 /*
180626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
181626a879aSdrh ** type affinity of the other operand.  This routine returns the
18253db1458Sdrh ** type affinity that should be used for the comparison operator.
18353db1458Sdrh */
184e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
185bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
186e014a838Sdanielk1977   if( aff1 && aff2 ){
1878df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1888df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
189e014a838Sdanielk1977     */
1908a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
191e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
192e014a838Sdanielk1977     }else{
19305883a34Sdrh       return SQLITE_AFF_BLOB;
194e014a838Sdanielk1977     }
195e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1965f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1975f6a87b3Sdrh     ** results directly.
198e014a838Sdanielk1977     */
19905883a34Sdrh     return SQLITE_AFF_BLOB;
200e014a838Sdanielk1977   }else{
201e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
202fe05af87Sdrh     assert( aff1==0 || aff2==0 );
203e014a838Sdanielk1977     return (aff1 + aff2);
204e014a838Sdanielk1977   }
205e014a838Sdanielk1977 }
206e014a838Sdanielk1977 
20753db1458Sdrh /*
20853db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
20953db1458Sdrh ** be applied to both operands prior to doing the comparison.
21053db1458Sdrh */
211e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
212e014a838Sdanielk1977   char aff;
213e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
214e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2156a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
216e014a838Sdanielk1977   assert( pExpr->pLeft );
217bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
218e014a838Sdanielk1977   if( pExpr->pRight ){
219e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2206ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2216ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2226ab3a2ecSdanielk1977   }else if( !aff ){
22305883a34Sdrh     aff = SQLITE_AFF_BLOB;
224e014a838Sdanielk1977   }
225e014a838Sdanielk1977   return aff;
226e014a838Sdanielk1977 }
227e014a838Sdanielk1977 
228e014a838Sdanielk1977 /*
229e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
230e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
231e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
232e014a838Sdanielk1977 ** the comparison in pExpr.
233e014a838Sdanielk1977 */
234e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
235e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2368a51256cSdrh   switch( aff ){
23705883a34Sdrh     case SQLITE_AFF_BLOB:
2388a51256cSdrh       return 1;
2398a51256cSdrh     case SQLITE_AFF_TEXT:
2408a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2418a51256cSdrh     default:
2428a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2438a51256cSdrh   }
244e014a838Sdanielk1977 }
245e014a838Sdanielk1977 
246a37cdde0Sdanielk1977 /*
24735573356Sdrh ** Return the P5 value that should be used for a binary comparison
248a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
249a37cdde0Sdanielk1977 */
25035573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
25135573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2521bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
25335573356Sdrh   return aff;
254a37cdde0Sdanielk1977 }
255a37cdde0Sdanielk1977 
256a2e00042Sdrh /*
2570202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2580202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2590202b29eSdanielk1977 **
2600202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2610202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2620202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2630202b29eSdanielk1977 ** type.
264bcbb04e5Sdanielk1977 **
265bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
266bcbb04e5Sdanielk1977 ** it is not considered.
2670202b29eSdanielk1977 */
268bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
269bcbb04e5Sdanielk1977   Parse *pParse,
270bcbb04e5Sdanielk1977   Expr *pLeft,
271bcbb04e5Sdanielk1977   Expr *pRight
272bcbb04e5Sdanielk1977 ){
273ec41ddacSdrh   CollSeq *pColl;
274ec41ddacSdrh   assert( pLeft );
275ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
276ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
277ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
278ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
279ec41ddacSdrh   }else{
280ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2810202b29eSdanielk1977     if( !pColl ){
2827cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2830202b29eSdanielk1977     }
284ec41ddacSdrh   }
2850202b29eSdanielk1977   return pColl;
2860202b29eSdanielk1977 }
2870202b29eSdanielk1977 
2880202b29eSdanielk1977 /*
289be5c89acSdrh ** Generate code for a comparison operator.
290be5c89acSdrh */
291be5c89acSdrh static int codeCompare(
292be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
293be5c89acSdrh   Expr *pLeft,      /* The left operand */
294be5c89acSdrh   Expr *pRight,     /* The right operand */
295be5c89acSdrh   int opcode,       /* The comparison opcode */
29635573356Sdrh   int in1, int in2, /* Register holding operands */
297be5c89acSdrh   int dest,         /* Jump here if true.  */
298be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
299be5c89acSdrh ){
30035573356Sdrh   int p5;
30135573356Sdrh   int addr;
30235573356Sdrh   CollSeq *p4;
30335573356Sdrh 
30435573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
30535573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
30635573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
30735573356Sdrh                            (void*)p4, P4_COLLSEQ);
3081bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
30935573356Sdrh   return addr;
310be5c89acSdrh }
311be5c89acSdrh 
312cfbb5e82Sdan /*
313870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
314*d832da7fSdrh **
315*d832da7fSdrh ** A vector is defined as any expression that results in two or more
316*d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
317*d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
318*d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
319*d832da7fSdrh ** considered a vector if it has two or more result columns.
320870a0705Sdan */
321870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
32276dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
323870a0705Sdan }
324870a0705Sdan 
325870a0705Sdan /*
326cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
327cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
328cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
329cfbb5e82Sdan ** any other type of expression, return 1.
330cfbb5e82Sdan */
33171c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
33276dbe7a8Sdrh   if( pExpr->op==TK_VECTOR ){
33371c57db0Sdan     return pExpr->x.pList->nExpr;
33476dbe7a8Sdrh   }else if( pExpr->op==TK_SELECT ){
33576dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
33676dbe7a8Sdrh   }else{
33776dbe7a8Sdrh     return 1;
33876dbe7a8Sdrh   }
33971c57db0Sdan }
34071c57db0Sdan 
341f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
342ba00e30aSdan /*
343fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
344fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
345fc7f27b9Sdrh ** ensure that i is within range.
346fc7f27b9Sdrh **
34776dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
34876dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
34976dbe7a8Sdrh **
350fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
351fc7f27b9Sdrh **
352fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
35376dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
35476dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
35576dbe7a8Sdrh ** been positioned.
356ba00e30aSdan */
357fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
358870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
359870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
360870a0705Sdan     if( pVector->op==TK_SELECT ){
36171c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
362870a0705Sdan     }else{
36371c57db0Sdan       return pVector->x.pList->a[i].pExpr;
36471c57db0Sdan     }
365870a0705Sdan   }
366870a0705Sdan   return pVector;
367870a0705Sdan }
368fc7f27b9Sdrh #endif /* !defined(SQLITE_OMIT_SUBQUERY) */
369fc7f27b9Sdrh 
370fc7f27b9Sdrh #ifndef SQLITE_OMIT_SUBQUERY
371fc7f27b9Sdrh /*
372fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
373fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
374fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
375fc7f27b9Sdrh **
3768762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
3778762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
3788762ec19Sdrh **
379fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
380fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
381fc7f27b9Sdrh **
3828762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
38376dbe7a8Sdrh ** then the returne object will reference pVector and so pVector must remain
3848762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
3858762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
38676dbe7a8Sdrh ** returns.
3878762ec19Sdrh **
3888762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
3898762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
3908762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
391fc7f27b9Sdrh */
392fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
393fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
394fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
395a1251bc4Sdrh   int iField           /* Which column of the vector to return */
396fc7f27b9Sdrh ){
397fc7f27b9Sdrh   Expr *pRet;
398a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
399a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
400fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
401fc7f27b9Sdrh     **
402fc7f27b9Sdrh     ** pLeft:           pVector containing TK_SELECT
4038762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
404fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
405fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
406fc7f27b9Sdrh     **                  if the result is not yet computed.
407fc7f27b9Sdrh     **
408fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
409fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4108762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4118762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4128762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4138762ec19Sdrh     ** will own the pVector.
414fc7f27b9Sdrh     */
4158bd0d58eSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0, 0);
4168bd0d58eSdrh     if( pRet ){
4178bd0d58eSdrh       pRet->iColumn = iField;
4188bd0d58eSdrh       pRet->pLeft = pVector;
4198bd0d58eSdrh     }
420fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
421fc7f27b9Sdrh   }else{
422a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
423a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
424fc7f27b9Sdrh   }
425fc7f27b9Sdrh   return pRet;
426fc7f27b9Sdrh }
427fc7f27b9Sdrh #endif /* !define(SQLITE_OMIT_SUBQUERY) */
42871c57db0Sdan 
4295c288b92Sdan /*
4305c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4315c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4325c288b92Sdan ** sub-select returns more than one column, the first in an array
4335c288b92Sdan ** of registers in which the result is stored).
4345c288b92Sdan **
4355c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4365c288b92Sdan */
4375c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4388da209b1Sdan   int reg = 0;
439f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4405c288b92Sdan   if( pExpr->op==TK_SELECT ){
4418da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4428da209b1Sdan   }
443f9b2e05cSdan #endif
4448da209b1Sdan   return reg;
4458da209b1Sdan }
4468da209b1Sdan 
4475c288b92Sdan /*
4485c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
449870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
450870a0705Sdan ** the register number of a register that contains the value of
451870a0705Sdan ** element iField of the vector.
452870a0705Sdan **
453870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
454870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
455870a0705Sdan ** case parameter regSelect should be the first in an array of registers
456870a0705Sdan ** containing the results of the sub-select.
457870a0705Sdan **
458870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
459870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
460870a0705Sdan ** a temporary register to be freed by the caller before returning.
4615c288b92Sdan **
4625c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
4635c288b92Sdan ** Expr object corresponding to element iElem of the vector.
4645c288b92Sdan */
4655c288b92Sdan static int exprVectorRegister(
4665c288b92Sdan   Parse *pParse,                  /* Parse context */
4675c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
468870a0705Sdan   int iField,                     /* Field to extract from pVector */
4695c288b92Sdan   int regSelect,                  /* First in array of registers */
4705c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
4715c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
4725c288b92Sdan ){
473870a0705Sdan   assert( pVector->op==TK_VECTOR || pVector->op==TK_SELECT );
4748bd0d58eSdrh   assert( pParse->nErr || pParse->db->mallocFailed
4758bd0d58eSdrh           || (pVector->op==TK_VECTOR)==(regSelect==0) );
476f358009aSdan   if( pVector->op==TK_SELECT ){
477870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
478870a0705Sdan      return regSelect+iField;
4795c288b92Sdan   }
480870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
4815c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
4825c288b92Sdan }
4835c288b92Sdan 
4845c288b92Sdan /*
4855c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
48679752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
48779752b6eSdrh ** result into register dest.
48879752b6eSdrh **
48979752b6eSdrh ** The caller must satisfy the following preconditions:
49079752b6eSdrh **
49179752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
49279752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
49379752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
4945c288b92Sdan */
49579752b6eSdrh static void codeVectorCompare(
49679752b6eSdrh   Parse *pParse,        /* Code generator context */
49779752b6eSdrh   Expr *pExpr,          /* The comparison operation */
49879752b6eSdrh   int dest,             /* Write results into this register */
49979752b6eSdrh   u8 op,                /* Comparison operator */
50079752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
50179752b6eSdrh ){
50271c57db0Sdan   Vdbe *v = pParse->pVdbe;
50371c57db0Sdan   Expr *pLeft = pExpr->pLeft;
50471c57db0Sdan   Expr *pRight = pExpr->pRight;
50571c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
50671c57db0Sdan   int nRight = sqlite3ExprVectorSize(pRight);
50771c57db0Sdan 
50871c57db0Sdan   /* Check that both sides of the comparison are vectors, and that
50971c57db0Sdan   ** both are the same length.  */
51071c57db0Sdan   if( nLeft!=nRight ){
51171c57db0Sdan     sqlite3ErrorMsg(pParse, "invalid use of row value");
51271c57db0Sdan   }else{
51371c57db0Sdan     int i;
51471c57db0Sdan     int regLeft = 0;
51571c57db0Sdan     int regRight = 0;
51679752b6eSdrh     u8 opx = op;
51779752b6eSdrh     int addrDone = sqlite3VdbeMakeLabel(v);
51871c57db0Sdan 
51971c57db0Sdan     assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
52071c57db0Sdan          || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
52171c57db0Sdan          || pExpr->op==TK_LT || pExpr->op==TK_GT
52271c57db0Sdan          || pExpr->op==TK_LE || pExpr->op==TK_GE
52371c57db0Sdan     );
52479752b6eSdrh     assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
52579752b6eSdrh               || (pExpr->op==TK_ISNOT && op==TK_NE) );
52679752b6eSdrh     assert( p5==0 || pExpr->op!=op );
52779752b6eSdrh     assert( p5==SQLITE_NULLEQ || pExpr->op==op );
52871c57db0Sdan 
52979752b6eSdrh     p5 |= SQLITE_STOREP2;
53079752b6eSdrh     if( opx==TK_LE ) opx = TK_LT;
53179752b6eSdrh     if( opx==TK_GE ) opx = TK_GT;
5325c288b92Sdan 
5335c288b92Sdan     regLeft = exprCodeSubselect(pParse, pLeft);
5345c288b92Sdan     regRight = exprCodeSubselect(pParse, pRight);
5355c288b92Sdan 
5365c288b92Sdan     for(i=0; i<nLeft; i++){
5375c288b92Sdan       int regFree1 = 0, regFree2 = 0;
5385c288b92Sdan       Expr *pL, *pR;
5395c288b92Sdan       int r1, r2;
54079752b6eSdrh       if( i>0 ) sqlite3ExprCachePush(pParse);
5415c288b92Sdan       r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5425c288b92Sdan       r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
54379752b6eSdrh       codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
54479752b6eSdrh       testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
54579752b6eSdrh       testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
54679752b6eSdrh       testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
54779752b6eSdrh       testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
54879752b6eSdrh       testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
54979752b6eSdrh       testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
55071c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree1);
55171c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree2);
55279752b6eSdrh       if( i>0 ) sqlite3ExprCachePop(pParse);
55379752b6eSdrh       if( i==nLeft-1 ){
55479752b6eSdrh         break;
55571c57db0Sdan       }
55679752b6eSdrh       if( opx==TK_EQ ){
55779752b6eSdrh         sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
55879752b6eSdrh         p5 |= SQLITE_KEEPNULL;
55979752b6eSdrh       }else if( opx==TK_NE ){
56079752b6eSdrh         sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
56179752b6eSdrh         p5 |= SQLITE_KEEPNULL;
562a2f62925Sdrh       }else{
563a2f62925Sdrh         assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
564a2f62925Sdrh         sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
56579752b6eSdrh         VdbeCoverageIf(v, op==TK_LT);
56679752b6eSdrh         VdbeCoverageIf(v, op==TK_GT);
56779752b6eSdrh         VdbeCoverageIf(v, op==TK_LE);
56879752b6eSdrh         VdbeCoverageIf(v, op==TK_GE);
56979752b6eSdrh         if( i==nLeft-2 ) opx = op;
57071c57db0Sdan       }
57179752b6eSdrh     }
57279752b6eSdrh     sqlite3VdbeResolveLabel(v, addrDone);
57379752b6eSdrh   }
57471c57db0Sdan }
57571c57db0Sdan 
5764b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
5774b5255acSdanielk1977 /*
5784b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
5794b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
5804b5255acSdanielk1977 ** pParse.
5814b5255acSdanielk1977 */
5827d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
5834b5255acSdanielk1977   int rc = SQLITE_OK;
5844b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
5854b5255acSdanielk1977   if( nHeight>mxHeight ){
5864b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
5874b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
5884b5255acSdanielk1977     );
5894b5255acSdanielk1977     rc = SQLITE_ERROR;
5904b5255acSdanielk1977   }
5914b5255acSdanielk1977   return rc;
5924b5255acSdanielk1977 }
5934b5255acSdanielk1977 
5944b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
5954b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
5964b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
5974b5255acSdanielk1977 ** first argument.
5984b5255acSdanielk1977 **
5994b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6004b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6014b5255acSdanielk1977 ** value.
6024b5255acSdanielk1977 */
6034b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6044b5255acSdanielk1977   if( p ){
6054b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6064b5255acSdanielk1977       *pnHeight = p->nHeight;
6074b5255acSdanielk1977     }
6084b5255acSdanielk1977   }
6094b5255acSdanielk1977 }
6104b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6114b5255acSdanielk1977   if( p ){
6124b5255acSdanielk1977     int i;
6134b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6144b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6154b5255acSdanielk1977     }
6164b5255acSdanielk1977   }
6174b5255acSdanielk1977 }
6184b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
6194b5255acSdanielk1977   if( p ){
6204b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6214b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6224b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6234b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
6244b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6254b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6264b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6274b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
6284b5255acSdanielk1977   }
6294b5255acSdanielk1977 }
6304b5255acSdanielk1977 
6314b5255acSdanielk1977 /*
6324b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6334b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6344b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6354b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6364b5255acSdanielk1977 ** referenced Expr plus one.
6372308ed38Sdrh **
6382308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6392308ed38Sdrh ** if appropriate.
6404b5255acSdanielk1977 */
6414b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6424b5255acSdanielk1977   int nHeight = 0;
6434b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6444b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6456ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6466ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6472308ed38Sdrh   }else if( p->x.pList ){
6486ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6492308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6506ab3a2ecSdanielk1977   }
6514b5255acSdanielk1977   p->nHeight = nHeight + 1;
6524b5255acSdanielk1977 }
6534b5255acSdanielk1977 
6544b5255acSdanielk1977 /*
6554b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6564b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6574b5255acSdanielk1977 ** leave an error in pParse.
6582308ed38Sdrh **
6592308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
6602308ed38Sdrh ** Expr.flags.
6614b5255acSdanielk1977 */
6622308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
66374893a4cSdrh   if( pParse->nErr ) return;
6644b5255acSdanielk1977   exprSetHeight(p);
6657d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
6664b5255acSdanielk1977 }
6674b5255acSdanielk1977 
6684b5255acSdanielk1977 /*
6694b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
6704b5255acSdanielk1977 ** by the select statement passed as an argument.
6714b5255acSdanielk1977 */
6724b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
6734b5255acSdanielk1977   int nHeight = 0;
6744b5255acSdanielk1977   heightOfSelect(p, &nHeight);
6754b5255acSdanielk1977   return nHeight;
6764b5255acSdanielk1977 }
6772308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
6782308ed38Sdrh /*
6792308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
6802308ed38Sdrh ** Expr.flags.
6812308ed38Sdrh */
6822308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
6832308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
6842308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6852308ed38Sdrh   }
6862308ed38Sdrh }
6874b5255acSdanielk1977 #define exprSetHeight(y)
6884b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
6894b5255acSdanielk1977 
690be5c89acSdrh /*
691b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
692b7916a78Sdrh **
693a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
694b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
695b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
696a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
697b7916a78Sdrh **
698b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
699e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
700b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
701b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
702b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
70333e619fcSdrh **
70433e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
70533e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
70633e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
70733e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
70833e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
709a76b5dfcSdrh */
710b7916a78Sdrh Expr *sqlite3ExprAlloc(
711a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
71217435752Sdrh   int op,                 /* Expression opcode */
713b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
714b7916a78Sdrh   int dequote             /* True to dequote */
71517435752Sdrh ){
716a76b5dfcSdrh   Expr *pNew;
71733e619fcSdrh   int nExtra = 0;
718cf697396Sshane   int iValue = 0;
719b7916a78Sdrh 
720575fad65Sdrh   assert( db!=0 );
721b7916a78Sdrh   if( pToken ){
72233e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
72333e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
724b7916a78Sdrh       nExtra = pToken->n+1;
725d50ffc41Sdrh       assert( iValue>=0 );
72633e619fcSdrh     }
727a76b5dfcSdrh   }
728575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
729b7916a78Sdrh   if( pNew ){
730ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7311bd10f8aSdrh     pNew->op = (u8)op;
732a58fdfb1Sdanielk1977     pNew->iAgg = -1;
733a76b5dfcSdrh     if( pToken ){
73433e619fcSdrh       if( nExtra==0 ){
73533e619fcSdrh         pNew->flags |= EP_IntValue;
73633e619fcSdrh         pNew->u.iValue = iValue;
73733e619fcSdrh       }else{
73833e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
739b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
740b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
74133e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
742244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
743244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
74433e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
745a34001c9Sdrh         }
746a34001c9Sdrh       }
74733e619fcSdrh     }
748b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
749b7916a78Sdrh     pNew->nHeight = 1;
750b7916a78Sdrh #endif
751a34001c9Sdrh   }
752a76b5dfcSdrh   return pNew;
753a76b5dfcSdrh }
754a76b5dfcSdrh 
755a76b5dfcSdrh /*
756b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
757b7916a78Sdrh ** already been dequoted.
758b7916a78Sdrh */
759b7916a78Sdrh Expr *sqlite3Expr(
760b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
761b7916a78Sdrh   int op,                 /* Expression opcode */
762b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
763b7916a78Sdrh ){
764b7916a78Sdrh   Token x;
765b7916a78Sdrh   x.z = zToken;
766b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
767b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
768b7916a78Sdrh }
769b7916a78Sdrh 
770b7916a78Sdrh /*
771b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
772b7916a78Sdrh **
773b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
774b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
775b7916a78Sdrh */
776b7916a78Sdrh void sqlite3ExprAttachSubtrees(
777b7916a78Sdrh   sqlite3 *db,
778b7916a78Sdrh   Expr *pRoot,
779b7916a78Sdrh   Expr *pLeft,
780b7916a78Sdrh   Expr *pRight
781b7916a78Sdrh ){
782b7916a78Sdrh   if( pRoot==0 ){
783b7916a78Sdrh     assert( db->mallocFailed );
784b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
785b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
786b7916a78Sdrh   }else{
787b7916a78Sdrh     if( pRight ){
788b7916a78Sdrh       pRoot->pRight = pRight;
789885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
790b7916a78Sdrh     }
791b7916a78Sdrh     if( pLeft ){
792b7916a78Sdrh       pRoot->pLeft = pLeft;
793885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
794b7916a78Sdrh     }
795b7916a78Sdrh     exprSetHeight(pRoot);
796b7916a78Sdrh   }
797b7916a78Sdrh }
798b7916a78Sdrh 
799b7916a78Sdrh /*
80060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
801b7916a78Sdrh **
802bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
803bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
804bf664469Sdrh ** free the subtrees and return NULL.
805206f3d96Sdrh */
80617435752Sdrh Expr *sqlite3PExpr(
80717435752Sdrh   Parse *pParse,          /* Parsing context */
80817435752Sdrh   int op,                 /* Expression opcode */
80917435752Sdrh   Expr *pLeft,            /* Left operand */
81017435752Sdrh   Expr *pRight,           /* Right operand */
81117435752Sdrh   const Token *pToken     /* Argument token */
81217435752Sdrh ){
8135fb52caaSdrh   Expr *p;
8141167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8155fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8165fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8175fb52caaSdrh   }else{
8181167d327Sdrh     p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
819b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8205fb52caaSdrh   }
8212b359bdbSdan   if( p ) {
8222b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8232b359bdbSdan   }
8244e0cff60Sdrh   return p;
8254e0cff60Sdrh }
8264e0cff60Sdrh 
8274e0cff60Sdrh /*
82808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
82908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
83008de4f79Sdrh */
83108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
83208de4f79Sdrh   if( pExpr ){
83308de4f79Sdrh     pExpr->x.pSelect = pSelect;
83408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
83508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
83608de4f79Sdrh   }else{
83708de4f79Sdrh     assert( pParse->db->mallocFailed );
83808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
83908de4f79Sdrh   }
84008de4f79Sdrh }
84108de4f79Sdrh 
84208de4f79Sdrh 
84308de4f79Sdrh /*
844991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
845991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
846991a1985Sdrh ** expression at compile-time return 0.
847991a1985Sdrh **
848991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
849991a1985Sdrh ** the expression really is always false or false (a false negative).
850991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
851991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8525fb52caaSdrh **
8535fb52caaSdrh ** Note that if the expression is part of conditional for a
8545fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8555fb52caaSdrh ** is it true or false, so always return 0.
8565fb52caaSdrh */
857991a1985Sdrh static int exprAlwaysTrue(Expr *p){
858991a1985Sdrh   int v = 0;
859991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
860991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
861991a1985Sdrh   return v!=0;
862991a1985Sdrh }
8635fb52caaSdrh static int exprAlwaysFalse(Expr *p){
8645fb52caaSdrh   int v = 0;
8655fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
8665fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
8675fb52caaSdrh   return v==0;
8685fb52caaSdrh }
8695fb52caaSdrh 
8705fb52caaSdrh /*
87191bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
87291bb0eedSdrh ** NULL, then just return the other expression.
8735fb52caaSdrh **
8745fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8755fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8765fb52caaSdrh ** a value of false.
87791bb0eedSdrh */
8781e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
87991bb0eedSdrh   if( pLeft==0 ){
88091bb0eedSdrh     return pRight;
88191bb0eedSdrh   }else if( pRight==0 ){
88291bb0eedSdrh     return pLeft;
8835fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
8845fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
8855fb52caaSdrh     sqlite3ExprDelete(db, pRight);
8865fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
88791bb0eedSdrh   }else{
888b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
889b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
890b7916a78Sdrh     return pNew;
891a76b5dfcSdrh   }
892a76b5dfcSdrh }
893a76b5dfcSdrh 
894a76b5dfcSdrh /*
895a76b5dfcSdrh ** Construct a new expression node for a function with multiple
896a76b5dfcSdrh ** arguments.
897a76b5dfcSdrh */
89817435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
899a76b5dfcSdrh   Expr *pNew;
900633e6d57Sdrh   sqlite3 *db = pParse->db;
9014b202ae2Sdanielk1977   assert( pToken );
902b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
903a76b5dfcSdrh   if( pNew==0 ){
904d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
905a76b5dfcSdrh     return 0;
906a76b5dfcSdrh   }
9076ab3a2ecSdanielk1977   pNew->x.pList = pList;
9086ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9092308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
910a76b5dfcSdrh   return pNew;
911a76b5dfcSdrh }
912a76b5dfcSdrh 
913a76b5dfcSdrh /*
914fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
915fa6bc000Sdrh ** in the original SQL statement.
916fa6bc000Sdrh **
917fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
918fa6bc000Sdrh ** variable number.
919fa6bc000Sdrh **
920fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
921fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
922fa6bc000Sdrh ** the SQL statement comes from an external source.
923fa6bc000Sdrh **
92451f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
925fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
92660ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
927fa6bc000Sdrh ** assigned.
928fa6bc000Sdrh */
929fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
93017435752Sdrh   sqlite3 *db = pParse->db;
931b7916a78Sdrh   const char *z;
93217435752Sdrh 
933fa6bc000Sdrh   if( pExpr==0 ) return;
934c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
93533e619fcSdrh   z = pExpr->u.zToken;
936b7916a78Sdrh   assert( z!=0 );
937b7916a78Sdrh   assert( z[0]!=0 );
938b7916a78Sdrh   if( z[1]==0 ){
939fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
940b7916a78Sdrh     assert( z[0]=='?' );
9418677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
942124c0b49Sdrh   }else{
943124c0b49Sdrh     ynVar x = 0;
944124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
945124c0b49Sdrh     if( z[0]=='?' ){
946fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
947fa6bc000Sdrh       ** use it as the variable number */
948c8d735aeSdan       i64 i;
949124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
950124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
951c5499befSdrh       testcase( i==0 );
952c5499befSdrh       testcase( i==1 );
953c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
954c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
955c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
956fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
957bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
958124c0b49Sdrh         x = 0;
959fa6bc000Sdrh       }
960fa6bc000Sdrh       if( i>pParse->nVar ){
9611df2db7fSshaneh         pParse->nVar = (int)i;
962fa6bc000Sdrh       }
963fa6bc000Sdrh     }else{
96451f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
965fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
966fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
967fa6bc000Sdrh       */
968124c0b49Sdrh       ynVar i;
969124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
970503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
971124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
972fa6bc000Sdrh           break;
973fa6bc000Sdrh         }
974fa6bc000Sdrh       }
975124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
976fa6bc000Sdrh     }
977124c0b49Sdrh     if( x>0 ){
978124c0b49Sdrh       if( x>pParse->nzVar ){
979124c0b49Sdrh         char **a;
980124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
9814a642b60Sdrh         if( a==0 ){
9824a642b60Sdrh           assert( db->mallocFailed ); /* Error reported through mallocFailed */
9834a642b60Sdrh           return;
9844a642b60Sdrh         }
985124c0b49Sdrh         pParse->azVar = a;
986124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
987124c0b49Sdrh         pParse->nzVar = x;
988124c0b49Sdrh       }
989124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
990124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
991124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
992fa6bc000Sdrh       }
993fa6bc000Sdrh     }
994fa6bc000Sdrh   }
995bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
996832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
997832b2664Sdanielk1977   }
998fa6bc000Sdrh }
999fa6bc000Sdrh 
1000fa6bc000Sdrh /*
1001f6963f99Sdan ** Recursively delete an expression tree.
1002a2e00042Sdrh */
10034f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10044f0010b1Sdrh   assert( p!=0 );
1005d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1006d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1007c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
1008c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1009c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
101071c57db0Sdan     if( p->op!=TK_SELECT_COLUMN ) sqlite3ExprDelete(db, p->pLeft);
1011633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
1012c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
10136ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
10146ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10156ab3a2ecSdanielk1977     }else{
10166ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10176ab3a2ecSdanielk1977     }
10186ab3a2ecSdanielk1977   }
101933e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1020633e6d57Sdrh     sqlite3DbFree(db, p);
1021a2e00042Sdrh   }
102233e619fcSdrh }
10234f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10244f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10254f0010b1Sdrh }
1026a2e00042Sdrh 
1027d2687b77Sdrh /*
10286ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10296ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10306ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10316ab3a2ecSdanielk1977 */
10326ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10336ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10346ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10356ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10366ab3a2ecSdanielk1977 }
10376ab3a2ecSdanielk1977 
10386ab3a2ecSdanielk1977 /*
103933e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
104033e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
104133e619fcSdrh ** how much of the tree is measured.
104233e619fcSdrh **
104333e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
104433e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
104533e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
104633e619fcSdrh **
104733e619fcSdrh ***************************************************************************
104833e619fcSdrh **
104933e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
105033e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
105133e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
105233e619fcSdrh ** The return values is always one of:
105333e619fcSdrh **
105433e619fcSdrh **      EXPR_FULLSIZE
105533e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
105633e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
105733e619fcSdrh **
105833e619fcSdrh ** The size of the structure can be found by masking the return value
105933e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
106033e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
106133e619fcSdrh **
106233e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
106333e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
106433e619fcSdrh ** During expression analysis, extra information is computed and moved into
106533e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
106633e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
106760ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
106833e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
106933e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
107033e619fcSdrh ** to enforce this constraint.
10716ab3a2ecSdanielk1977 */
10726ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
10736ab3a2ecSdanielk1977   int nSize;
107433e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1075aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1076aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
10773c19469cSdrh   if( 0==flags ){
10786ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
10796ab3a2ecSdanielk1977   }else{
1080c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
108133e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1082c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1083ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1084aecd8021Sdrh     if( p->pLeft || p->x.pList ){
108533e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
108633e619fcSdrh     }else{
1087aecd8021Sdrh       assert( p->pRight==0 );
108833e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
108933e619fcSdrh     }
10906ab3a2ecSdanielk1977   }
10916ab3a2ecSdanielk1977   return nSize;
10926ab3a2ecSdanielk1977 }
10936ab3a2ecSdanielk1977 
10946ab3a2ecSdanielk1977 /*
109533e619fcSdrh ** This function returns the space in bytes required to store the copy
109633e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
109733e619fcSdrh ** string is defined.)
10986ab3a2ecSdanielk1977 */
10996ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
110033e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
110133e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
110233e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11036ab3a2ecSdanielk1977   }
1104bc73971dSdanielk1977   return ROUND8(nByte);
11056ab3a2ecSdanielk1977 }
11066ab3a2ecSdanielk1977 
11076ab3a2ecSdanielk1977 /*
11086ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11096ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11106ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11116ab3a2ecSdanielk1977 **
11126ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
111333e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11146ab3a2ecSdanielk1977 **
11156ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11166ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11176ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11186ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11196ab3a2ecSdanielk1977 */
11206ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11216ab3a2ecSdanielk1977   int nByte = 0;
11226ab3a2ecSdanielk1977   if( p ){
11236ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11246ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1125b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11266ab3a2ecSdanielk1977     }
11276ab3a2ecSdanielk1977   }
11286ab3a2ecSdanielk1977   return nByte;
11296ab3a2ecSdanielk1977 }
11306ab3a2ecSdanielk1977 
11316ab3a2ecSdanielk1977 /*
11326ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11336ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
113433e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11356ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
113660ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11376ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11386ab3a2ecSdanielk1977 */
11393c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11403c19469cSdrh   Expr *pNew;           /* Value to return */
11413c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11423c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11436ab3a2ecSdanielk1977 
11443c19469cSdrh   assert( db!=0 );
11453c19469cSdrh   assert( p );
11463c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11473c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11486ab3a2ecSdanielk1977 
11496ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11506ab3a2ecSdanielk1977   if( pzBuffer ){
11516ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
115233e619fcSdrh     staticFlag = EP_Static;
11536ab3a2ecSdanielk1977   }else{
11543c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
11553c19469cSdrh     staticFlag = 0;
11566ab3a2ecSdanielk1977   }
11576ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
11586ab3a2ecSdanielk1977 
11596ab3a2ecSdanielk1977   if( pNew ){
11606ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
11616ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
11626ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
116333e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
11646ab3a2ecSdanielk1977     */
11653c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
116633e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
116733e619fcSdrh     int nToken;
116833e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
116933e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
117033e619fcSdrh     }else{
117133e619fcSdrh       nToken = 0;
117233e619fcSdrh     }
11733c19469cSdrh     if( dupFlags ){
11746ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11756ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11766ab3a2ecSdanielk1977     }else{
11773e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11786ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
117972ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
11806ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
11816ab3a2ecSdanielk1977       }
118272ea29d7Sdrh     }
11836ab3a2ecSdanielk1977 
118433e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1185c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
118633e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
118733e619fcSdrh     pNew->flags |= staticFlag;
11886ab3a2ecSdanielk1977 
118933e619fcSdrh     /* Copy the p->u.zToken string, if any. */
11906ab3a2ecSdanielk1977     if( nToken ){
119133e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
119233e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
11936ab3a2ecSdanielk1977     }
11946ab3a2ecSdanielk1977 
11956ab3a2ecSdanielk1977     if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
11966ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
11976ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
11983c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
11996ab3a2ecSdanielk1977       }else{
12003c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12016ab3a2ecSdanielk1977       }
12026ab3a2ecSdanielk1977     }
12036ab3a2ecSdanielk1977 
12046ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1205c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12063c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
12076ab3a2ecSdanielk1977       if( ExprHasProperty(pNew, EP_Reduced) ){
12083c19469cSdrh         pNew->pLeft = p->pLeft ?
12093c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12103c19469cSdrh         pNew->pRight = p->pRight ?
12113c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12126ab3a2ecSdanielk1977       }
12136ab3a2ecSdanielk1977       if( pzBuffer ){
12146ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12156ab3a2ecSdanielk1977       }
1216b7916a78Sdrh     }else{
1217c5cd1249Sdrh       if( !ExprHasProperty(p, EP_TokenOnly) ){
12189854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12199854260bSdrh           pNew->pLeft = p->pLeft;
12209854260bSdrh         }else{
12216ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12229854260bSdrh         }
12236ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12246ab3a2ecSdanielk1977       }
12256ab3a2ecSdanielk1977     }
12266ab3a2ecSdanielk1977   }
12276ab3a2ecSdanielk1977   return pNew;
12286ab3a2ecSdanielk1977 }
12296ab3a2ecSdanielk1977 
12306ab3a2ecSdanielk1977 /*
1231bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1232bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1233bfe31e7fSdan ** and the db->mallocFailed flag set.
1234bfe31e7fSdan */
1235eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1236bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12374e9119d9Sdan   With *pRet = 0;
12384e9119d9Sdan   if( p ){
12394e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12404e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12414e9119d9Sdan     if( pRet ){
12424e9119d9Sdan       int i;
12434e9119d9Sdan       pRet->nCte = p->nCte;
12444e9119d9Sdan       for(i=0; i<p->nCte; i++){
12454e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
12464e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
12474e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
12484e9119d9Sdan       }
12494e9119d9Sdan     }
12504e9119d9Sdan   }
12514e9119d9Sdan   return pRet;
12524e9119d9Sdan }
1253eede6a53Sdan #else
1254eede6a53Sdan # define withDup(x,y) 0
1255eede6a53Sdan #endif
12564e9119d9Sdan 
1257a76b5dfcSdrh /*
1258ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1259ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1260ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1261ff78bd2fSdrh ** without effecting the originals.
1262ff78bd2fSdrh **
12634adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
12644adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1265ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1266ff78bd2fSdrh **
1267ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
12686ab3a2ecSdanielk1977 **
1269b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
12706ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
12716ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
12726ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1273ff78bd2fSdrh */
12746ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
127572ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
12763c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1277ff78bd2fSdrh }
12786ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1279ff78bd2fSdrh   ExprList *pNew;
1280145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1281ff78bd2fSdrh   int i;
1282575fad65Sdrh   assert( db!=0 );
1283ff78bd2fSdrh   if( p==0 ) return 0;
1284575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1285ff78bd2fSdrh   if( pNew==0 ) return 0;
1286d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
1287d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1288575fad65Sdrh   pNew->a = pItem = sqlite3DbMallocRawNN(db,  i*sizeof(p->a[0]) );
1289e0048400Sdanielk1977   if( pItem==0 ){
1290633e6d57Sdrh     sqlite3DbFree(db, pNew);
1291e0048400Sdanielk1977     return 0;
1292e0048400Sdanielk1977   }
1293145716b3Sdrh   pOldItem = p->a;
1294145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
12956ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1296b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
129717435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1298b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1299145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13003e7bc9caSdrh     pItem->done = 0;
13012c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1302c2acc4e4Sdrh     pItem->u = pOldItem->u;
1303ff78bd2fSdrh   }
1304ff78bd2fSdrh   return pNew;
1305ff78bd2fSdrh }
130693758c8dSdanielk1977 
130793758c8dSdanielk1977 /*
130893758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
130993758c8dSdanielk1977 ** the build, then none of the following routines, except for
131093758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
131193758c8dSdanielk1977 ** called with a NULL argument.
131293758c8dSdanielk1977 */
13136a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13146a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13156ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1316ad3cab52Sdrh   SrcList *pNew;
1317ad3cab52Sdrh   int i;
1318113088ecSdrh   int nByte;
1319575fad65Sdrh   assert( db!=0 );
1320ad3cab52Sdrh   if( p==0 ) return 0;
1321113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1322575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1323ad3cab52Sdrh   if( pNew==0 ) return 0;
13244305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1325ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13264efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13274efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1328ed8a3bb1Sdrh     Table *pTab;
132941fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
133017435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
133117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
133217435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13338a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13344efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13355b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
13365b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
13378a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
13388a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
13398a48b9c0Sdrh     }
13408a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
13418a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
13428a48b9c0Sdrh       pNewItem->u1.pFuncArg =
13438a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
13448a48b9c0Sdrh     }
1345ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1346ed8a3bb1Sdrh     if( pTab ){
1347ed8a3bb1Sdrh       pTab->nRef++;
1348a1cb183dSdanielk1977     }
13496ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
13506ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
135117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
13526c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1353ad3cab52Sdrh   }
1354ad3cab52Sdrh   return pNew;
1355ad3cab52Sdrh }
135617435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1357ff78bd2fSdrh   IdList *pNew;
1358ff78bd2fSdrh   int i;
1359575fad65Sdrh   assert( db!=0 );
1360ff78bd2fSdrh   if( p==0 ) return 0;
1361575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1362ff78bd2fSdrh   if( pNew==0 ) return 0;
13636c535158Sdrh   pNew->nId = p->nId;
1364575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1365d5d56523Sdanielk1977   if( pNew->a==0 ){
1366633e6d57Sdrh     sqlite3DbFree(db, pNew);
1367d5d56523Sdanielk1977     return 0;
1368d5d56523Sdanielk1977   }
13696c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
13706c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
13716c535158Sdrh   ** on the duplicate created by this function. */
1372ff78bd2fSdrh   for(i=0; i<p->nId; i++){
13734efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
13744efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
137517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
13764efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1377ff78bd2fSdrh   }
1378ff78bd2fSdrh   return pNew;
1379ff78bd2fSdrh }
13806ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
138123b1b372Sdrh   Select *pNew, *pPrior;
1382575fad65Sdrh   assert( db!=0 );
1383ff78bd2fSdrh   if( p==0 ) return 0;
1384575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1385ff78bd2fSdrh   if( pNew==0 ) return 0;
1386b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
13876ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
13886ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
13896ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
13906ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
13916ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1392ff78bd2fSdrh   pNew->op = p->op;
139323b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
139423b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
139523b1b372Sdrh   pNew->pNext = 0;
13966ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
13976ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
139892b01d53Sdrh   pNew->iLimit = 0;
139992b01d53Sdrh   pNew->iOffset = 0;
14007d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1401b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1402b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1403ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
14044e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1405eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1406ff78bd2fSdrh   return pNew;
1407ff78bd2fSdrh }
140893758c8dSdanielk1977 #else
14096ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
141093758c8dSdanielk1977   assert( p==0 );
141193758c8dSdanielk1977   return 0;
141293758c8dSdanielk1977 }
141393758c8dSdanielk1977 #endif
1414ff78bd2fSdrh 
1415ff78bd2fSdrh 
1416ff78bd2fSdrh /*
1417a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1418a76b5dfcSdrh ** initially NULL, then create a new expression list.
1419b7916a78Sdrh **
1420b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1421b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1422b7916a78Sdrh ** that the new entry was successfully appended.
1423a76b5dfcSdrh */
142417435752Sdrh ExprList *sqlite3ExprListAppend(
142517435752Sdrh   Parse *pParse,          /* Parsing context */
142617435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1427b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
142817435752Sdrh ){
142917435752Sdrh   sqlite3 *db = pParse->db;
1430575fad65Sdrh   assert( db!=0 );
1431a76b5dfcSdrh   if( pList==0 ){
1432575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1433a76b5dfcSdrh     if( pList==0 ){
1434d5d56523Sdanielk1977       goto no_mem;
1435a76b5dfcSdrh     }
1436c263f7c4Sdrh     pList->nExpr = 0;
1437575fad65Sdrh     pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
1438d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1439d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1440d5d56523Sdanielk1977     struct ExprList_item *a;
1441d872bb18Sdrh     assert( pList->nExpr>0 );
1442d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1443d5d56523Sdanielk1977     if( a==0 ){
1444d5d56523Sdanielk1977       goto no_mem;
1445a76b5dfcSdrh     }
1446d5d56523Sdanielk1977     pList->a = a;
1447a76b5dfcSdrh   }
14484efc4754Sdrh   assert( pList->a!=0 );
1449b7916a78Sdrh   if( 1 ){
14504efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
14514efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1452e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1453a76b5dfcSdrh   }
1454a76b5dfcSdrh   return pList;
1455d5d56523Sdanielk1977 
1456d5d56523Sdanielk1977 no_mem:
1457d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1458633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1459633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1460d5d56523Sdanielk1977   return 0;
1461a76b5dfcSdrh }
1462a76b5dfcSdrh 
1463a76b5dfcSdrh /*
14648762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
14658762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1466a1251bc4Sdrh **
1467a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1468a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1469a1251bc4Sdrh **
1470a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
14718762ec19Sdrh ** expression list pList.  In the case of a subquery on the LHS, append
1472a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1473a1251bc4Sdrh */
1474a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1475a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1476a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1477a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1478a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1479a1251bc4Sdrh ){
1480a1251bc4Sdrh   sqlite3 *db = pParse->db;
1481a1251bc4Sdrh   int n;
1482a1251bc4Sdrh   int i;
1483a1251bc4Sdrh   if( pColumns==0 ) goto vector_append_error;
1484a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1485a1251bc4Sdrh   n = sqlite3ExprVectorSize(pExpr);
1486a1251bc4Sdrh   if( pColumns->nId!=n ){
1487a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1488a1251bc4Sdrh                     pColumns->nId, n);
1489a1251bc4Sdrh     goto vector_append_error;
1490a1251bc4Sdrh   }
1491a1251bc4Sdrh   for(i=0; i<n; i++){
1492a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1493a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1494a1251bc4Sdrh     if( pList ){
1495a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1496a1251bc4Sdrh       pColumns->a[i].zName = 0;
1497a1251bc4Sdrh     }
1498a1251bc4Sdrh   }
1499a1251bc4Sdrh   if( pExpr->op==TK_SELECT ){
1500a1251bc4Sdrh     if( pList && pList->a[0].pExpr ){
1501a1251bc4Sdrh       assert( pList->a[0].pExpr->op==TK_SELECT_COLUMN );
1502a1251bc4Sdrh       pList->a[0].pExpr->pRight = pExpr;
1503a1251bc4Sdrh       pExpr = 0;
1504a1251bc4Sdrh     }
1505a1251bc4Sdrh   }
1506a1251bc4Sdrh 
1507a1251bc4Sdrh vector_append_error:
1508a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1509a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1510a1251bc4Sdrh   return pList;
1511a1251bc4Sdrh }
1512a1251bc4Sdrh 
1513a1251bc4Sdrh /*
1514bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1515bc622bc0Sdrh */
1516bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1517bc622bc0Sdrh   if( p==0 ) return;
1518bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1519bc622bc0Sdrh   assert( p->nExpr>0 );
1520bc622bc0Sdrh   if( iSortOrder<0 ){
1521bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1522bc622bc0Sdrh     return;
1523bc622bc0Sdrh   }
1524bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1525bc622bc0Sdrh }
1526bc622bc0Sdrh 
1527bc622bc0Sdrh /*
1528b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1529b7916a78Sdrh ** on the expression list.
1530b7916a78Sdrh **
1531b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1532b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1533b7916a78Sdrh ** is set.
1534b7916a78Sdrh */
1535b7916a78Sdrh void sqlite3ExprListSetName(
1536b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1537b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1538b7916a78Sdrh   Token *pName,           /* Name to be added */
1539b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1540b7916a78Sdrh ){
1541b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1542b7916a78Sdrh   if( pList ){
1543b7916a78Sdrh     struct ExprList_item *pItem;
1544b7916a78Sdrh     assert( pList->nExpr>0 );
1545b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1546b7916a78Sdrh     assert( pItem->zName==0 );
1547b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1548244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1549b7916a78Sdrh   }
1550b7916a78Sdrh }
1551b7916a78Sdrh 
1552b7916a78Sdrh /*
1553b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1554b7916a78Sdrh ** on the expression list.
1555b7916a78Sdrh **
1556b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1557b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1558b7916a78Sdrh ** is set.
1559b7916a78Sdrh */
1560b7916a78Sdrh void sqlite3ExprListSetSpan(
1561b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1562b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1563b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1564b7916a78Sdrh ){
1565b7916a78Sdrh   sqlite3 *db = pParse->db;
1566b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1567b7916a78Sdrh   if( pList ){
1568b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1569b7916a78Sdrh     assert( pList->nExpr>0 );
1570b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1571b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1572b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1573cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1574b7916a78Sdrh   }
1575b7916a78Sdrh }
1576b7916a78Sdrh 
1577b7916a78Sdrh /*
15787a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
15797a15a4beSdanielk1977 ** leave an error message in pParse.
15807a15a4beSdanielk1977 */
15817a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
15827a15a4beSdanielk1977   Parse *pParse,
15837a15a4beSdanielk1977   ExprList *pEList,
15847a15a4beSdanielk1977   const char *zObject
15857a15a4beSdanielk1977 ){
1586b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1587c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1588c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1589b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
15907a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
15917a15a4beSdanielk1977   }
15927a15a4beSdanielk1977 }
15937a15a4beSdanielk1977 
15947a15a4beSdanielk1977 /*
1595a76b5dfcSdrh ** Delete an entire expression list.
1596a76b5dfcSdrh */
1597affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1598a76b5dfcSdrh   int i;
1599be5c89acSdrh   struct ExprList_item *pItem;
1600d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1601be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1602633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1603633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1604b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1605a76b5dfcSdrh   }
1606633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1607633e6d57Sdrh   sqlite3DbFree(db, pList);
1608a76b5dfcSdrh }
1609affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1610affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1611affa855cSdrh }
1612a76b5dfcSdrh 
1613a76b5dfcSdrh /*
16142308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
16152308ed38Sdrh ** ExprList.
1616885a5b03Sdrh */
16172308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1618885a5b03Sdrh   int i;
16192308ed38Sdrh   u32 m = 0;
16202308ed38Sdrh   if( pList ){
1621885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1622d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1623de845c2fSdrh        assert( pExpr!=0 );
1624de845c2fSdrh        m |= pExpr->flags;
1625885a5b03Sdrh     }
16262308ed38Sdrh   }
16272308ed38Sdrh   return m;
1628885a5b03Sdrh }
1629885a5b03Sdrh 
1630885a5b03Sdrh /*
1631059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1632059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1633059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1634059b2d50Sdrh ** for.
163573b211abSdrh **
16367d10d5a6Sdrh ** These callback routines are used to implement the following:
1637626a879aSdrh **
1638059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1639059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1640fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1641059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
164287abf5c0Sdrh **
1643059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1644059b2d50Sdrh ** is found to not be a constant.
164587abf5c0Sdrh **
1646feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1647059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1648059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1649feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1650feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1651feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1652feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1653feada2dfSdrh ** malformed schema error.
1654626a879aSdrh */
16557d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1656626a879aSdrh 
1657059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1658059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
16590a168377Sdrh   ** from being considered constant. */
1660059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1661059b2d50Sdrh     pWalker->eCode = 0;
16627d10d5a6Sdrh     return WRC_Abort;
16630a168377Sdrh   }
16640a168377Sdrh 
1665626a879aSdrh   switch( pExpr->op ){
1666eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1667059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1668059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1669eb55bd2fSdrh     case TK_FUNCTION:
167063f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1671b1fba286Sdrh         return WRC_Continue;
1672059b2d50Sdrh       }else{
1673059b2d50Sdrh         pWalker->eCode = 0;
1674059b2d50Sdrh         return WRC_Abort;
1675b1fba286Sdrh       }
1676626a879aSdrh     case TK_ID:
1677626a879aSdrh     case TK_COLUMN:
1678626a879aSdrh     case TK_AGG_FUNCTION:
167913449892Sdrh     case TK_AGG_COLUMN:
1680c5499befSdrh       testcase( pExpr->op==TK_ID );
1681c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1682c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1683c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1684059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1685059b2d50Sdrh         return WRC_Continue;
1686059b2d50Sdrh       }else{
1687059b2d50Sdrh         pWalker->eCode = 0;
16887d10d5a6Sdrh         return WRC_Abort;
1689059b2d50Sdrh       }
1690feada2dfSdrh     case TK_VARIABLE:
1691059b2d50Sdrh       if( pWalker->eCode==5 ){
1692feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1693feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1694feada2dfSdrh         ** of the sqlite_master table */
1695feada2dfSdrh         pExpr->op = TK_NULL;
1696059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1697feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1698feada2dfSdrh         ** sqlite3_prepare() causes an error */
1699059b2d50Sdrh         pWalker->eCode = 0;
1700feada2dfSdrh         return WRC_Abort;
1701feada2dfSdrh       }
1702feada2dfSdrh       /* Fall through */
1703626a879aSdrh     default:
1704b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1705b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
17067d10d5a6Sdrh       return WRC_Continue;
1707626a879aSdrh   }
1708626a879aSdrh }
170962c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
171062c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1711059b2d50Sdrh   pWalker->eCode = 0;
17127d10d5a6Sdrh   return WRC_Abort;
17137d10d5a6Sdrh }
1714059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
17157d10d5a6Sdrh   Walker w;
1716aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1717059b2d50Sdrh   w.eCode = initFlag;
17187d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
17197d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1720059b2d50Sdrh   w.u.iCur = iCur;
17217d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1722059b2d50Sdrh   return w.eCode;
17237d10d5a6Sdrh }
1724626a879aSdrh 
1725626a879aSdrh /*
1726059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1727eb55bd2fSdrh ** and 0 if it involves variables or function calls.
17282398937bSdrh **
17292398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
17302398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
17312398937bSdrh ** a constant.
1732fef5208cSdrh */
17334adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1734059b2d50Sdrh   return exprIsConst(p, 1, 0);
1735fef5208cSdrh }
1736fef5208cSdrh 
1737fef5208cSdrh /*
1738059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
17390a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
17400a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
17410a168377Sdrh ** an ON or USING clause.
17420a168377Sdrh */
17430a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1744059b2d50Sdrh   return exprIsConst(p, 2, 0);
17450a168377Sdrh }
17460a168377Sdrh 
17470a168377Sdrh /*
1748fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1749059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1750059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1751059b2d50Sdrh ** table other than iCur.
1752059b2d50Sdrh */
1753059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1754059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1755059b2d50Sdrh }
1756059b2d50Sdrh 
1757059b2d50Sdrh /*
1758059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1759eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1760eb55bd2fSdrh ** are any variables.
1761eb55bd2fSdrh **
1762eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1763eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1764eb55bd2fSdrh ** a constant.
1765eb55bd2fSdrh */
1766feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1767feada2dfSdrh   assert( isInit==0 || isInit==1 );
1768059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1769eb55bd2fSdrh }
1770eb55bd2fSdrh 
17715b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
17725b88bc4bSdrh /*
17735b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
17745b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
17755b88bc4bSdrh */
17765b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
17775b88bc4bSdrh   Walker w;
17785b88bc4bSdrh   memset(&w, 0, sizeof(w));
1779bec2476aSdrh   w.eCode = 1;
17805b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
17815b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
17825b88bc4bSdrh   sqlite3WalkExpr(&w, p);
178307194bffSdrh   return w.eCode==0;
17845b88bc4bSdrh }
17855b88bc4bSdrh #endif
17865b88bc4bSdrh 
1787eb55bd2fSdrh /*
178873b211abSdrh ** If the expression p codes a constant integer that is small enough
1789202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1790202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1791202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1792e4de1febSdrh */
17934adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
179492b01d53Sdrh   int rc = 0;
1795cd92e84dSdrh 
1796cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1797cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1798cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1799cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1800cd92e84dSdrh 
180192b01d53Sdrh   if( p->flags & EP_IntValue ){
180233e619fcSdrh     *pValue = p->u.iValue;
1803e4de1febSdrh     return 1;
1804e4de1febSdrh   }
180592b01d53Sdrh   switch( p->op ){
18064b59ab5eSdrh     case TK_UPLUS: {
180792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1808f6e369a1Sdrh       break;
18094b59ab5eSdrh     }
1810e4de1febSdrh     case TK_UMINUS: {
1811e4de1febSdrh       int v;
18124adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1813f6418891Smistachkin         assert( v!=(-2147483647-1) );
1814e4de1febSdrh         *pValue = -v;
181592b01d53Sdrh         rc = 1;
1816e4de1febSdrh       }
1817e4de1febSdrh       break;
1818e4de1febSdrh     }
1819e4de1febSdrh     default: break;
1820e4de1febSdrh   }
182192b01d53Sdrh   return rc;
1822e4de1febSdrh }
1823e4de1febSdrh 
1824e4de1febSdrh /*
1825039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1826039fc32eSdrh **
1827039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1828039fc32eSdrh ** to tell return TRUE.
1829039fc32eSdrh **
1830039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1831039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1832039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1833039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1834039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1835039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1836039fc32eSdrh ** TRUE.
1837039fc32eSdrh */
1838039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1839039fc32eSdrh   u8 op;
1840cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1841039fc32eSdrh   op = p->op;
1842039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1843039fc32eSdrh   switch( op ){
1844039fc32eSdrh     case TK_INTEGER:
1845039fc32eSdrh     case TK_STRING:
1846039fc32eSdrh     case TK_FLOAT:
1847039fc32eSdrh     case TK_BLOB:
1848039fc32eSdrh       return 0;
18497248a8b2Sdrh     case TK_COLUMN:
18507248a8b2Sdrh       assert( p->pTab!=0 );
185172673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
185272673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1853039fc32eSdrh     default:
1854039fc32eSdrh       return 1;
1855039fc32eSdrh   }
1856039fc32eSdrh }
1857039fc32eSdrh 
1858039fc32eSdrh /*
1859039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1860039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1861039fc32eSdrh ** argument.
1862039fc32eSdrh **
1863039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1864039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1865039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1866039fc32eSdrh ** answer.
1867039fc32eSdrh */
1868039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1869039fc32eSdrh   u8 op;
187005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1871cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1872039fc32eSdrh   op = p->op;
1873039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1874039fc32eSdrh   switch( op ){
1875039fc32eSdrh     case TK_INTEGER: {
1876039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1877039fc32eSdrh     }
1878039fc32eSdrh     case TK_FLOAT: {
1879039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1880039fc32eSdrh     }
1881039fc32eSdrh     case TK_STRING: {
1882039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1883039fc32eSdrh     }
1884039fc32eSdrh     case TK_BLOB: {
1885039fc32eSdrh       return 1;
1886039fc32eSdrh     }
18872f2855b6Sdrh     case TK_COLUMN: {
188888376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
188988376ca7Sdrh       return p->iColumn<0
18902f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
18912f2855b6Sdrh     }
1892039fc32eSdrh     default: {
1893039fc32eSdrh       return 0;
1894039fc32eSdrh     }
1895039fc32eSdrh   }
1896039fc32eSdrh }
1897039fc32eSdrh 
1898039fc32eSdrh /*
1899c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1900c4a3c779Sdrh */
19014adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
19024adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
19034adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
19044adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1905c4a3c779Sdrh   return 0;
1906c4a3c779Sdrh }
1907c4a3c779Sdrh 
19089a96b668Sdanielk1977 /*
190969c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
191069c355bdSdrh ** that can be simplified to a direct table access, then return
191169c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
191269c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
191369c355bdSdrh ** table, then return NULL.
1914b287f4b6Sdrh */
1915b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
19167b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
191769c355bdSdrh   Select *p;
1918b287f4b6Sdrh   SrcList *pSrc;
1919b287f4b6Sdrh   ExprList *pEList;
1920b287f4b6Sdrh   Table *pTab;
1921cfbb5e82Sdan   int i;
192269c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
192369c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
192469c355bdSdrh   p = pX->x.pSelect;
1925b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
19267d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1927b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1928b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
19297d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
19307d10d5a6Sdrh   }
1931b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1932b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1933b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1934b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1935b287f4b6Sdrh   pSrc = p->pSrc;
1936d1fa7bcaSdrh   assert( pSrc!=0 );
1937d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1938b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1939b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
194069c355bdSdrh   assert( pTab!=0 );
1941b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1942b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1943b287f4b6Sdrh   pEList = p->pEList;
1944cfbb5e82Sdan 
19457b35a77bSdan   /* All SELECT results must be columns. */
1946cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
1947cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
1948cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
194969c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
1950cfbb5e82Sdan   }
195169c355bdSdrh   return p;
1952b287f4b6Sdrh }
1953b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1954b287f4b6Sdrh 
1955b287f4b6Sdrh /*
19561d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
19571d8cb21fSdan ** address of the new instruction.
19581d8cb21fSdan */
19591d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
19601d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
19611d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
19621d8cb21fSdan }
19631d8cb21fSdan 
1964f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
19651d8cb21fSdan /*
19664c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
19674c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
19686be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
19696be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
19706be515ebSdrh */
19716be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
1972728e0f91Sdrh   int addr1;
19736be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
1974728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
19756be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
19766be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
19774c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
1978728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
19796be515ebSdrh }
1980f9b2e05cSdan #endif
19816be515ebSdrh 
1982bb53ecb1Sdrh 
1983bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1984bb53ecb1Sdrh /*
1985bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
1986bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
1987bb53ecb1Sdrh */
1988bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
1989bb53ecb1Sdrh   Expr *pLHS;
1990bb53ecb1Sdrh   int res;
1991bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1992bb53ecb1Sdrh   pLHS = pIn->pLeft;
1993bb53ecb1Sdrh   pIn->pLeft = 0;
1994bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
1995bb53ecb1Sdrh   pIn->pLeft = pLHS;
1996bb53ecb1Sdrh   return res;
1997bb53ecb1Sdrh }
1998bb53ecb1Sdrh #endif
1999bb53ecb1Sdrh 
20006be515ebSdrh /*
20019a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2002d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2003d4305ca6Sdrh ** might be either a list of expressions or a subquery.
20049a96b668Sdanielk1977 **
2005d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2006d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2007d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2008d4305ca6Sdrh **
20093a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2010d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2011d4305ca6Sdrh **
2012b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
20139a96b668Sdanielk1977 **
20149a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
20151ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
20161ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
20179a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
20189a96b668Sdanielk1977 **                         populated epheremal table.
2019bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2020bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
20219a96b668Sdanielk1977 **
2022d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2023d4305ca6Sdrh ** subquery such as:
20249a96b668Sdanielk1977 **
2025553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
20269a96b668Sdanielk1977 **
2027d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2028d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
202960ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2030d4305ca6Sdrh ** existing table.
2031d4305ca6Sdrh **
20323a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
20333a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
20343a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
20353a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
20363a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
20373a85625dSdrh ** IN operator.
20383a85625dSdrh **
20393a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
20403a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2041553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2042553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2043553168c7Sdan ** a UNIQUE constraint or index.
20440cdc022eSdanielk1977 **
20453a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
20463a85625dSdrh ** for fast set membership tests) then an epheremal table must
2047553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2048553168c7Sdan ** index can be found with the specified <columns> as its left-most.
20490cdc022eSdanielk1977 **
2050bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2051bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2052bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2053bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2054bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2055bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2056bb53ecb1Sdrh **
2057b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
20583a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2059e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
20603a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
20610cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2062e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2063e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
20640cdc022eSdanielk1977 **
2065e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
20666be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
20676be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
20686be515ebSdrh ** NULL values.
2069553168c7Sdan **
2070553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2071553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2072553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2073553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2074553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2075553168c7Sdan **
2076553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2077553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2078553168c7Sdan **
2079553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
20809a96b668Sdanielk1977 */
2081284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2082ba00e30aSdan int sqlite3FindInIndex(
2083ba00e30aSdan   Parse *pParse,
2084ba00e30aSdan   Expr *pX,
2085ba00e30aSdan   u32 inFlags,
2086ba00e30aSdan   int *prRhsHasNull,
2087ba00e30aSdan   int *aiMap
2088ba00e30aSdan ){
2089b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2090b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2091b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
20923a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2093b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
20949a96b668Sdanielk1977 
20951450bc6eSdrh   assert( pX->op==TK_IN );
20963a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
20971450bc6eSdrh 
20987b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
20997b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2100870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
21017b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2102870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
21037b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
21047b35a77bSdan     int i;
21057b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
21067b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
21077b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
21087b35a77bSdan     }
21097b35a77bSdan     if( i==pEList->nExpr ){
21107b35a77bSdan       prRhsHasNull = 0;
21117b35a77bSdan     }
21127b35a77bSdan   }
21137b35a77bSdan 
2114b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2115b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
21167b35a77bSdan   ** ephemeral table.  */
21177b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2118e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2119b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2120ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2121cfbb5e82Sdan     ExprList *pEList = p->pEList;
2122cfbb5e82Sdan     int nExpr = pEList->nExpr;
2123e1fb65a0Sdanielk1977 
2124b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2125b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2126b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2127b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2128b07028f7Sdrh 
2129b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2130e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2131e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2132e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
21339a96b668Sdanielk1977 
21349a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
21359a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
21369a96b668Sdanielk1977     ** successful here.
21379a96b668Sdanielk1977     */
21389a96b668Sdanielk1977     assert(v);
2139cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
21407d176105Sdrh       int iAddr = sqlite3CodeOnce(pParse);
21417d176105Sdrh       VdbeCoverage(v);
21429a96b668Sdanielk1977 
21439a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
21449a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
21459a96b668Sdanielk1977 
21469a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
21479a96b668Sdanielk1977     }else{
2148e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2149cfbb5e82Sdan       int affinity_ok = 1;
2150cfbb5e82Sdan       int i;
2151cfbb5e82Sdan 
2152cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
2153cfbb5e82Sdan       ** comparison is the same as the affinity of each column. If
2154cfbb5e82Sdan       ** it not, it is not possible to use any index.  */
2155cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2156fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2157cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
2158cfbb5e82Sdan         char idxaff = pTab->aCol[iCol].affinity;
2159cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
2160cfbb5e82Sdan         switch( cmpaff ){
2161cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2162cfbb5e82Sdan             break;
2163cfbb5e82Sdan           case SQLITE_AFF_TEXT:
2164cfbb5e82Sdan             affinity_ok = (idxaff==SQLITE_AFF_TEXT);
2165cfbb5e82Sdan             break;
2166cfbb5e82Sdan           default:
2167cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2168cfbb5e82Sdan         }
2169cfbb5e82Sdan       }
2170e1fb65a0Sdanielk1977 
21719a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
21729a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
2173e1fb65a0Sdanielk1977       ** to this collation sequence.  */
21749a96b668Sdanielk1977 
21759a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
2176cfbb5e82Sdan         if( pIdx->nKeyCol<nExpr ) continue;
2177cfbb5e82Sdan         if( mustBeUnique && (pIdx->nKeyCol!=nExpr || !IsUniqueIndex(pIdx)) ){
2178cfbb5e82Sdan           continue;
2179cfbb5e82Sdan         }
2180cfbb5e82Sdan 
2181cfbb5e82Sdan         for(i=0; i<nExpr; i++){
2182fc7f27b9Sdrh           Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2183cfbb5e82Sdan           Expr *pRhs = pEList->a[i].pExpr;
2184cfbb5e82Sdan           CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2185cfbb5e82Sdan           int j;
2186cfbb5e82Sdan 
218717994e3bSdan           assert( pReq || pParse->nErr );
218817994e3bSdan           if( pReq==0 ) break;
218917994e3bSdan 
2190cfbb5e82Sdan           for(j=0; j<nExpr; j++){
2191cfbb5e82Sdan             if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2192cfbb5e82Sdan             assert( pIdx->azColl[j] );
2193cfbb5e82Sdan             if( sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ) continue;
2194cfbb5e82Sdan             break;
2195cfbb5e82Sdan           }
2196cfbb5e82Sdan           if( j==nExpr ) break;
2197ba00e30aSdan           if( aiMap ) aiMap[i] = j;
2198cfbb5e82Sdan         }
2199cfbb5e82Sdan 
2200cfbb5e82Sdan         if( i==nExpr ){
22017d176105Sdrh           int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
22022ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
22032ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2204207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
22051ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
22061ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
22079a96b668Sdanielk1977 
22087b35a77bSdan           if( prRhsHasNull ){
22097b35a77bSdan             *prRhsHasNull = ++pParse->nMem;
22103480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2211cfbb5e82Sdan             i64 mask = (1<<nExpr)-1;
22123480bfdaSdan             sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2213cfbb5e82Sdan                 iTab, 0, 0, (u8*)&mask, P4_INT64);
22143480bfdaSdan #endif
22157b35a77bSdan             if( nExpr==1 ){
22166be515ebSdrh               sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
22170cdc022eSdanielk1977             }
22187b35a77bSdan           }
2219552fd454Sdrh           sqlite3VdbeJumpHere(v, iAddr);
22209a96b668Sdanielk1977         }
22219a96b668Sdanielk1977       }
22229a96b668Sdanielk1977     }
22239a96b668Sdanielk1977   }
22249a96b668Sdanielk1977 
2225bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2226bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2227bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
222871c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
222960ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2230bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2231bb53ecb1Sdrh   */
2232bb53ecb1Sdrh   if( eType==0
2233bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2234bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2235bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2236bb53ecb1Sdrh   ){
2237bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2238bb53ecb1Sdrh   }
2239bb53ecb1Sdrh 
22409a96b668Sdanielk1977   if( eType==0 ){
22414387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2242b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2243b74b1017Sdrh     */
22448e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
22450cdc022eSdanielk1977     int rMayHaveNull = 0;
224641a05b7bSdanielk1977     eType = IN_INDEX_EPH;
22473a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
22484a5acf8eSdrh       pParse->nQueryLoop = 0;
2249c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
225041a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
22510cdc022eSdanielk1977       }
2252e21a6e1dSdrh     }else if( prRhsHasNull ){
2253e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2254cf4d38aaSdrh     }
225541a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2256cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
22579a96b668Sdanielk1977   }else{
22589a96b668Sdanielk1977     pX->iTable = iTab;
22599a96b668Sdanielk1977   }
2260ba00e30aSdan 
2261ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2262ba00e30aSdan     int i, n;
2263ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2264ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2265ba00e30aSdan   }
22669a96b668Sdanielk1977   return eType;
22679a96b668Sdanielk1977 }
2268284f4acaSdanielk1977 #endif
2269626a879aSdrh 
2270f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2271553168c7Sdan /*
2272553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2273553168c7Sdan ** function allocates and returns a nul-terminated string containing
2274553168c7Sdan ** the affinities to be used for each column of the comparison.
2275553168c7Sdan **
2276553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2277553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2278553168c7Sdan */
227971c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
228071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
228171c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2282553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
228371c57db0Sdan   char *zRet;
228471c57db0Sdan 
2285553168c7Sdan   assert( pExpr->op==TK_IN );
228671c57db0Sdan   zRet = sqlite3DbMallocZero(pParse->db, nVal+1);
228771c57db0Sdan   if( zRet ){
228871c57db0Sdan     int i;
228971c57db0Sdan     for(i=0; i<nVal; i++){
2290fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2291553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2292553168c7Sdan       if( pSelect ){
2293553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
229471c57db0Sdan       }else{
2295553168c7Sdan         zRet[i] = a;
229671c57db0Sdan       }
229771c57db0Sdan     }
229871c57db0Sdan     zRet[nVal] = '\0';
229971c57db0Sdan   }
230071c57db0Sdan   return zRet;
230171c57db0Sdan }
2302f9b2e05cSdan #endif
230371c57db0Sdan 
23048da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
23058da209b1Sdan /*
23068da209b1Sdan ** Load the Parse object passed as the first argument with an error
23078da209b1Sdan ** message of the form:
23088da209b1Sdan **
23098da209b1Sdan **   "sub-select returns N columns - expected M"
23108da209b1Sdan */
23118da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
23128da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
23138da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
23148da209b1Sdan }
23158da209b1Sdan #endif
23168da209b1Sdan 
2317626a879aSdrh /*
2318d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2319d4187c71Sdrh ** or IN operators.  Examples:
2320626a879aSdrh **
23219cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
23229cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
23239cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
23249cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2325fef5208cSdrh **
23269cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
23279cbe6352Sdrh ** operator or subquery.
232841a05b7bSdanielk1977 **
232941a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
233041a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
233141a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
233241a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
233341a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2334fd773cf9Sdrh **
2335fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2336fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
23373a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
23383a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
23393a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
23401450bc6eSdrh **
23411450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
234239a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
234339a11819Sdrh ** array of registers and the return value is the register of the left-most
234439a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2345cce7d176Sdrh */
234651522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23471450bc6eSdrh int sqlite3CodeSubselect(
2348fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2349fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
23506be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2351fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
235241a05b7bSdanielk1977 ){
23536be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
23541450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2355b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
23561450bc6eSdrh   if( NEVER(v==0) ) return 0;
2357ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2358fc976065Sdanielk1977 
235939a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
236039a11819Sdrh   ** is encountered if any of the following is true:
236157dbd7b3Sdrh   **
236257dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
236357dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
236457dbd7b3Sdrh   **    *  We are inside a trigger
236557dbd7b3Sdrh   **
236657dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
236757dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2368b3bce662Sdanielk1977   */
2369c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
23706be515ebSdrh     jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
2371b3bce662Sdanielk1977   }
2372b3bce662Sdanielk1977 
23734a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
23744a07e3dbSdan   if( pParse->explain==2 ){
237562aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
237662aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
237762aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
237862aaa6caSdrh         pParse->iNextSelectId
23794a07e3dbSdan     );
23804a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
23814a07e3dbSdan   }
23824a07e3dbSdan #endif
23834a07e3dbSdan 
2384cce7d176Sdrh   switch( pExpr->op ){
2385fef5208cSdrh     case TK_IN: {
2386b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2387d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2388323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
238971c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2390d3d39e93Sdrh 
239171c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2392553168c7Sdan       assert( !isRowid || nVal==1 );
2393e014a838Sdanielk1977 
2394e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
23958cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2396553168c7Sdan       ** filled with index keys representing the results from the
2397553168c7Sdan       ** SELECT or the <exprlist>.
2398fef5208cSdrh       **
2399e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2400e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2401e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2402e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2403e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2404e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2405e014a838Sdanielk1977       ** is used.
2406fef5208cSdrh       */
2407832508b7Sdrh       pExpr->iTable = pParse->nTab++;
240871c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
240971c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
241071c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2411e014a838Sdanielk1977 
24126ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2413e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2414e014a838Sdanielk1977         **
2415e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2416e014a838Sdanielk1977         ** table allocated and opened above.
2417e014a838Sdanielk1977         */
24184387006cSdrh         Select *pSelect = pExpr->x.pSelect;
241971c57db0Sdan         ExprList *pEList = pSelect->pEList;
24201013c932Sdrh 
242141a05b7bSdanielk1977         assert( !isRowid );
242271c57db0Sdan         if( pEList->nExpr!=nVal ){
24238da209b1Sdan           sqlite3SubselectError(pParse, pEList->nExpr, nVal);
242471c57db0Sdan         }else{
242571c57db0Sdan           SelectDest dest;
242671c57db0Sdan           int i;
24271013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
242871c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
2429e014a838Sdanielk1977           assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
24304387006cSdrh           pSelect->iLimit = 0;
24314387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2432812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
24334387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
243471c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
24352ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
24361450bc6eSdrh             return 0;
243794ccde58Sdrh           }
243871c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2439812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
24403535ec3eSdrh           assert( pEList!=0 );
24413535ec3eSdrh           assert( pEList->nExpr>0 );
24422ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
244371c57db0Sdan           for(i=0; i<nVal; i++){
2444fc7f27b9Sdrh             Expr *p = (nVal>1) ? sqlite3VectorFieldSubexpr(pLeft, i) : pLeft;
244571c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
244671c57db0Sdan                 pParse, p, pEList->a[i].pExpr
244771c57db0Sdan             );
244871c57db0Sdan           }
244971c57db0Sdan         }
2450a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2451fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2452fef5208cSdrh         **
2453e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2454e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2455e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2456e014a838Sdanielk1977         ** a column, use numeric affinity.
2457fef5208cSdrh         */
245871c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2459e014a838Sdanielk1977         int i;
24606ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
246157dbd7b3Sdrh         struct ExprList_item *pItem;
2462ecc31805Sdrh         int r1, r2, r3;
246357dbd7b3Sdrh 
246471c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2465e014a838Sdanielk1977         if( !affinity ){
246605883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2467e014a838Sdanielk1977         }
2468323df790Sdrh         if( pKeyInfo ){
24692ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2470323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2471323df790Sdrh         }
2472e014a838Sdanielk1977 
2473e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
24742d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
24752d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
247637e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
247757dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
247857dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2479e05c929bSdrh           int iValToIns;
2480e014a838Sdanielk1977 
248157dbd7b3Sdrh           /* If the expression is not constant then we will need to
248257dbd7b3Sdrh           ** disable the test that was generated above that makes sure
248357dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
248457dbd7b3Sdrh           ** expression we need to rerun this code each time.
248557dbd7b3Sdrh           */
24866be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
24876be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
24886be515ebSdrh             jmpIfDynamic = -1;
24894794b980Sdrh           }
2490e014a838Sdanielk1977 
2491e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2492e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2493e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2494e05c929bSdrh           }else{
2495ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
249641a05b7bSdanielk1977             if( isRowid ){
2497e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2498e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2499688852abSdrh               VdbeCoverage(v);
250041a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
250141a05b7bSdanielk1977             }else{
2502ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
25033c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
25042d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2505fef5208cSdrh             }
250641a05b7bSdanielk1977           }
2507e05c929bSdrh         }
25082d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
25092d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2510fef5208cSdrh       }
2511323df790Sdrh       if( pKeyInfo ){
25122ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
251341a05b7bSdanielk1977       }
2514b3bce662Sdanielk1977       break;
2515fef5208cSdrh     }
2516fef5208cSdrh 
251751522cd3Sdrh     case TK_EXISTS:
2518fd773cf9Sdrh     case TK_SELECT:
2519fd773cf9Sdrh     default: {
252039a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
252139a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
252239a11819Sdrh       **
252339a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
252439a11819Sdrh       ** the first row into an array of registers and return the index of
252539a11819Sdrh       ** the first register.
252639a11819Sdrh       **
252739a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
252839a11819Sdrh       ** into a register and return that register number.
252939a11819Sdrh       **
253039a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
253139a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2532fef5208cSdrh       */
2533fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
253439a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
253571c57db0Sdan       int nReg;                             /* Registers to allocate */
25361398ad36Sdrh 
2537cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2538cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2539cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
25406ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
254171c57db0Sdan 
25426ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
254371c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
254471c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
254571c57db0Sdan       pParse->nMem += nReg;
254651522cd3Sdrh       if( pExpr->op==TK_SELECT ){
25476c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
254853932ce8Sdrh         dest.iSdst = dest.iSDParm;
254971c57db0Sdan         dest.nSdst = nReg;
255071c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2551d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
255251522cd3Sdrh       }else{
25536c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
25542b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2555d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
255651522cd3Sdrh       }
2557633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2558094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2559094430ebSdrh                                   &sqlite3IntTokens[1]);
256048b5b041Sdrh       pSel->iLimit = 0;
2561772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
25627d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
25631450bc6eSdrh         return 0;
256494ccde58Sdrh       }
25652b596da8Sdrh       rReg = dest.iSDParm;
2566ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2567b3bce662Sdanielk1977       break;
256819a775c2Sdrh     }
2569cce7d176Sdrh   }
2570b3bce662Sdanielk1977 
25716be515ebSdrh   if( rHasNullFlag ){
25726be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2573b3bce662Sdanielk1977   }
25746be515ebSdrh 
25756be515ebSdrh   if( jmpIfDynamic>=0 ){
25766be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2577b3bce662Sdanielk1977   }
2578d2490904Sdrh   sqlite3ExprCachePop(pParse);
2579fc976065Sdanielk1977 
25801450bc6eSdrh   return rReg;
2581cce7d176Sdrh }
258251522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2583cce7d176Sdrh 
2584e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2585e3365e6cSdrh /*
25867b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
25877b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
25887b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
25897b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
25907b35a77bSdan */
25917b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
25927b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
25937b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
25947b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
25957b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
25967b35a77bSdan       return 1;
25977b35a77bSdan     }
25987b35a77bSdan   }else if( nVector!=1 ){
25997b35a77bSdan     if( (pIn->pLeft->flags & EP_xIsSelect) ){
26007b35a77bSdan       sqlite3SubselectError(pParse, nVector, 1);
26017b35a77bSdan     }else{
26027b35a77bSdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
26037b35a77bSdan     }
26047b35a77bSdan     return 1;
26057b35a77bSdan   }
26067b35a77bSdan   return 0;
26077b35a77bSdan }
26087b35a77bSdan #endif
26097b35a77bSdan 
26107b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
26117b35a77bSdan /*
2612e3365e6cSdrh ** Generate code for an IN expression.
2613e3365e6cSdrh **
2614e3365e6cSdrh **      x IN (SELECT ...)
2615e3365e6cSdrh **      x IN (value, value, ...)
2616e3365e6cSdrh **
2617e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
2618e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
2619e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
2620e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
2621e3365e6cSdrh ** RHS contains one or more NULL values.
2622e3365e6cSdrh **
26236be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2624e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2625e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2626e3365e6cSdrh ** within the RHS then fall through.
2627e3365e6cSdrh */
2628e3365e6cSdrh static void sqlite3ExprCodeIN(
2629e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2630e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2631e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2632e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2633e3365e6cSdrh ){
2634e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2635e3365e6cSdrh   int eType;            /* Type of the RHS */
2636e3365e6cSdrh   int r1;               /* Temporary use register */
2637e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2638ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2639ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2640ba00e30aSdan   int nVector;          /* Size of vectors for this IN(...) op */
2641ba00e30aSdan   Expr *pLeft = pExpr->pLeft;
2642ba00e30aSdan   int i;
2643e3365e6cSdrh 
26447b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2645553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2646a48d7e77Sdrh   if( zAff==0 ) return;
2647ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2648ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2649ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2650ba00e30aSdan   );
2651a48d7e77Sdrh   if( aiMap==0 ){
2652a48d7e77Sdrh     sqlite3DbFree(pParse->db, zAff);
2653553168c7Sdan     return;
2654553168c7Sdan   }
26557b35a77bSdan 
2656ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2657ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2658ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2659ba00e30aSdan   ** the RHS has not yet been coded.  */
2660e3365e6cSdrh   v = pParse->pVdbe;
2661e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2662e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2663bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2664bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2665ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2666e3365e6cSdrh 
2667ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2668ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2669ba00e30aSdan   );
2670e3365e6cSdrh 
2671ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2672ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2673ba00e30aSdan   ** at r1.
2674e3365e6cSdrh   */
2675ba00e30aSdan   r1 = sqlite3GetTempRange(pParse, nVector);
2676e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2677ba00e30aSdan   if( nVector>1 && (pLeft->flags & EP_xIsSelect) ){
2678553168c7Sdan     int regSelect = sqlite3CodeSubselect(pParse, pLeft, 0, 0);
2679ba00e30aSdan     for(i=0; i<nVector; i++){
2680553168c7Sdan       sqlite3VdbeAddOp3(v, OP_Copy, regSelect+i, r1+aiMap[i], 0);
2681ba00e30aSdan     }
2682553168c7Sdan   }else{
2683553168c7Sdan     for(i=0; i<nVector; i++){
2684fc7f27b9Sdrh       Expr *pLhs = sqlite3VectorFieldSubexpr(pLeft, i);
2685553168c7Sdan       sqlite3ExprCode(pParse, pLhs, r1+aiMap[i]);
2686ba00e30aSdan     }
2687ba00e30aSdan   }
2688e3365e6cSdrh 
2689bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2690bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2691bb53ecb1Sdrh   ** sequence of comparisons.
2692bb53ecb1Sdrh   */
2693bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2694bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2695bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2696bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2697bb53ecb1Sdrh     int r2, regToFree;
2698bb53ecb1Sdrh     int regCkNull = 0;
2699bb53ecb1Sdrh     int ii;
2700bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2701bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2702bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2703a976979bSdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
2704bb53ecb1Sdrh     }
2705bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2706bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2707a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2708bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2709bb53ecb1Sdrh       }
2710bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2711bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
27124336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
27134336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
27144336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2715ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2716bb53ecb1Sdrh       }else{
2717bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2718bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2719bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2720ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2721bb53ecb1Sdrh       }
2722bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2723bb53ecb1Sdrh     }
2724bb53ecb1Sdrh     if( regCkNull ){
2725bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2726076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2727bb53ecb1Sdrh     }
2728bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2729bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2730bb53ecb1Sdrh   }else{
2731bb53ecb1Sdrh 
27327b35a77bSdan     /* If any value on the LHS is NULL, the result of the IN(...) operator
27337b35a77bSdan     ** must be either false or NULL. If these two are handled identically,
27347b35a77bSdan     ** test the LHS for NULLs and jump directly to destIfNull if any are
27357b35a77bSdan     ** found.
27367b35a77bSdan     **
27377b35a77bSdan     ** Otherwise, if NULL and false are handled differently, and the
27387b35a77bSdan     ** IN(...) operation is not a vector operation, and the LHS of the
27397b35a77bSdan     ** operator is NULL, then the result is false if the index is
27407b35a77bSdan     ** completely empty, or NULL otherwise.  */
2741094430ebSdrh     if( destIfNull==destIfFalse ){
2742d49fd4e8Sdan       for(i=0; i<nVector; i++){
2743fc7f27b9Sdrh         Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2744d49fd4e8Sdan         if( sqlite3ExprCanBeNull(p) ){
2745d49fd4e8Sdan           sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
2746471b4b92Sdrh           VdbeCoverage(v);
2747d49fd4e8Sdan         }
2748d49fd4e8Sdan       }
2749d49fd4e8Sdan     }else if( nVector==1 && sqlite3ExprCanBeNull(pExpr->pLeft) ){
2750688852abSdrh       int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2751094430ebSdrh       sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2752688852abSdrh       VdbeCoverage(v);
2753076e85f5Sdrh       sqlite3VdbeGoto(v, destIfNull);
2754094430ebSdrh       sqlite3VdbeJumpHere(v, addr1);
2755094430ebSdrh     }
2756e3365e6cSdrh 
2757e3365e6cSdrh     if( eType==IN_INDEX_ROWID ){
27587b35a77bSdan       /* In this case, the RHS is the ROWID of table b-tree */
2759eeb9565aSdrh       sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, r1);
2760688852abSdrh       VdbeCoverage(v);
27617b35a77bSdan     }else{
27627b35a77bSdan       /* In this case, the RHS is an index b-tree. Apply the comparison
27637b35a77bSdan       ** affinities to each value on the LHS of the operator.  */
27647b35a77bSdan       sqlite3VdbeAddOp4(v, OP_Affinity, r1, nVector, 0, zAff, nVector);
2765ba00e30aSdan 
27667b35a77bSdan       if( nVector>1 && destIfNull!=destIfFalse ){
27677b35a77bSdan         int iIdx = pExpr->iTable;
27687b35a77bSdan         int addr;
27697b35a77bSdan         int addrNext;
27707b35a77bSdan 
27717b35a77bSdan         /* Search the index for the key. */
27727b35a77bSdan         addr = sqlite3VdbeAddOp4Int(v, OP_Found, iIdx, 0, r1, nVector);
2773471b4b92Sdrh         VdbeCoverage(v);
27747b35a77bSdan 
27757b35a77bSdan         /* At this point the specified key is not present in the index,
27767b35a77bSdan         ** so the result of the IN(..) operator must be either NULL or
27777b35a77bSdan         ** 0. The vdbe code generated below figures out which.  */
27787b35a77bSdan         addrNext = 1+sqlite3VdbeAddOp2(v, OP_Rewind, iIdx, destIfFalse);
2779471b4b92Sdrh         VdbeCoverage(v);
27807b35a77bSdan 
2781ba00e30aSdan         for(i=0; i<nVector; i++){
2782ba00e30aSdan           Expr *p;
2783ba00e30aSdan           CollSeq *pColl;
27847b35a77bSdan           int r2 = sqlite3GetTempReg(pParse);
2785fc7f27b9Sdrh           p = sqlite3VectorFieldSubexpr(pLeft, i);
2786ba00e30aSdan           pColl = sqlite3ExprCollSeq(pParse, p);
2787ba00e30aSdan 
27887b35a77bSdan           sqlite3VdbeAddOp3(v, OP_Column, iIdx, i, r2);
27897b35a77bSdan           sqlite3VdbeAddOp4(v, OP_Eq, r1+i, 0, r2, (void*)pColl,P4_COLLSEQ);
27907b35a77bSdan           sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
2791471b4b92Sdrh           VdbeCoverage(v);
27927b35a77bSdan           sqlite3VdbeAddOp2(v, OP_Next, iIdx, addrNext);
2793471b4b92Sdrh           VdbeCoverage(v);
2794ba00e30aSdan           sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
27957b35a77bSdan           sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-3);
2796ba00e30aSdan           sqlite3ReleaseTempReg(pParse, r2);
27977b35a77bSdan         }
27987b35a77bSdan         sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2799e3365e6cSdrh 
28007b35a77bSdan         /* The key was found in the index. If it contains any NULL values,
28017b35a77bSdan         ** then the result of the IN(...) operator is NULL. Otherwise, the
28027b35a77bSdan         ** result is 1.  */
28037b35a77bSdan         sqlite3VdbeJumpHere(v, addr);
28047b35a77bSdan         for(i=0; i<nVector; i++){
2805fc7f27b9Sdrh           Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
28067b35a77bSdan           if( sqlite3ExprCanBeNull(p) ){
28077b35a77bSdan             sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
2808471b4b92Sdrh             VdbeCoverage(v);
28097b35a77bSdan           }
28107b35a77bSdan         }
28117b35a77bSdan 
28127b35a77bSdan       }else if( rRhsHasNull==0 ){
2813e3365e6cSdrh         /* This branch runs if it is known at compile time that the RHS
28147b35a77bSdan         ** cannot contain NULL values. This happens as a result
28157b35a77bSdan         ** of "NOT NULL" constraints in the database schema.
2816e3365e6cSdrh         **
2817e3365e6cSdrh         ** Also run this branch if NULL is equivalent to FALSE
28187b35a77bSdan         ** for this particular IN operator.  */
2819ba00e30aSdan         sqlite3VdbeAddOp4Int(
2820ba00e30aSdan             v, OP_NotFound, pExpr->iTable, destIfFalse, r1, nVector
2821ba00e30aSdan         );
2822688852abSdrh         VdbeCoverage(v);
2823e3365e6cSdrh       }else{
2824e3365e6cSdrh         /* In this branch, the RHS of the IN might contain a NULL and
2825e3365e6cSdrh         ** the presence of a NULL on the RHS makes a difference in the
2826e3365e6cSdrh         ** outcome.
2827e3365e6cSdrh         */
2828728e0f91Sdrh         int addr1;
2829e3365e6cSdrh 
2830e3365e6cSdrh         /* First check to see if the LHS is contained in the RHS.  If so,
28316be515ebSdrh         ** then the answer is TRUE the presence of NULLs in the RHS does
28326be515ebSdrh         ** not matter.  If the LHS is not contained in the RHS, then the
28336be515ebSdrh         ** answer is NULL if the RHS contains NULLs and the answer is
28346be515ebSdrh         ** FALSE if the RHS is NULL-free.
2835e3365e6cSdrh         */
2836728e0f91Sdrh         addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2837688852abSdrh         VdbeCoverage(v);
28386be515ebSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2839552fd454Sdrh         VdbeCoverage(v);
2840076e85f5Sdrh         sqlite3VdbeGoto(v, destIfFalse);
2841728e0f91Sdrh         sqlite3VdbeJumpHere(v, addr1);
2842e3365e6cSdrh       }
2843e3365e6cSdrh     }
2844bb53ecb1Sdrh   }
2845e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2846d2490904Sdrh   sqlite3ExprCachePop(pParse);
2847ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
2848553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
2849e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2850e3365e6cSdrh }
2851e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2852e3365e6cSdrh 
285313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2854598f1340Sdrh /*
2855598f1340Sdrh ** Generate an instruction that will put the floating point
28569cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
28570cf19ed8Sdrh **
28580cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
28590cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
28600cf19ed8Sdrh ** like the continuation of the number.
2861598f1340Sdrh */
2862b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2863fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2864598f1340Sdrh     double value;
28659339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2866d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2867598f1340Sdrh     if( negateFlag ) value = -value;
286897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2869598f1340Sdrh   }
2870598f1340Sdrh }
287113573c71Sdrh #endif
2872598f1340Sdrh 
2873598f1340Sdrh 
2874598f1340Sdrh /*
2875fec19aadSdrh ** Generate an instruction that will put the integer describe by
28769cbf3425Sdrh ** text z[0..n-1] into register iMem.
28770cf19ed8Sdrh **
28785f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2879fec19aadSdrh */
288013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
288113573c71Sdrh   Vdbe *v = pParse->pVdbe;
288292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
288333e619fcSdrh     int i = pExpr->u.iValue;
2884d50ffc41Sdrh     assert( i>=0 );
288592b01d53Sdrh     if( negFlag ) i = -i;
288692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2887fd773cf9Sdrh   }else{
28885f1d6b61Sshaneh     int c;
28895f1d6b61Sshaneh     i64 value;
2890fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2891fd773cf9Sdrh     assert( z!=0 );
28929296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
28935f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2894158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
289597bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2896fec19aadSdrh     }else{
289713573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
289813573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
289913573c71Sdrh #else
29001b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
29019296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
29029296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
29031b7ddc59Sdrh       }else
29041b7ddc59Sdrh #endif
29051b7ddc59Sdrh       {
2906b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
29079296c18aSdrh       }
290813573c71Sdrh #endif
2909fec19aadSdrh     }
2910fec19aadSdrh   }
2911c9cf901dSdanielk1977 }
2912fec19aadSdrh 
2913bea119cdSdrh #if defined(SQLITE_DEBUG)
2914bea119cdSdrh /*
2915bea119cdSdrh ** Verify the consistency of the column cache
2916bea119cdSdrh */
2917bea119cdSdrh static int cacheIsValid(Parse *pParse){
2918bea119cdSdrh   int i, n;
2919bea119cdSdrh   for(i=n=0; i<SQLITE_N_COLCACHE; i++){
2920bea119cdSdrh     if( pParse->aColCache[i].iReg>0 ) n++;
2921bea119cdSdrh   }
2922bea119cdSdrh   return n==pParse->nColCache;
2923bea119cdSdrh }
2924bea119cdSdrh #endif
2925bea119cdSdrh 
2926ceea3321Sdrh /*
2927ceea3321Sdrh ** Clear a cache entry.
2928ceea3321Sdrh */
2929ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2930ceea3321Sdrh   if( p->tempReg ){
2931ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2932ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2933ceea3321Sdrh     }
2934ceea3321Sdrh     p->tempReg = 0;
2935ceea3321Sdrh   }
2936bea119cdSdrh   p->iReg = 0;
2937bea119cdSdrh   pParse->nColCache--;
2938ee65eea4Sdan   assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2939ceea3321Sdrh }
2940ceea3321Sdrh 
2941ceea3321Sdrh 
2942ceea3321Sdrh /*
2943ceea3321Sdrh ** Record in the column cache that a particular column from a
2944ceea3321Sdrh ** particular table is stored in a particular register.
2945ceea3321Sdrh */
2946ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2947ceea3321Sdrh   int i;
2948ceea3321Sdrh   int minLru;
2949ceea3321Sdrh   int idxLru;
2950ceea3321Sdrh   struct yColCache *p;
2951ceea3321Sdrh 
2952ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2953ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
295420411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
295520411ea7Sdrh 
2956b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2957b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2958b6da74ebSdrh   ** with and without the column cache.
2959b6da74ebSdrh   */
29607e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2961b6da74ebSdrh 
296227ee406eSdrh   /* First replace any existing entry.
296327ee406eSdrh   **
296427ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
296527ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
296627ee406eSdrh   */
296727ee406eSdrh #ifndef NDEBUG
2968ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
296927ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2970ceea3321Sdrh   }
297127ee406eSdrh #endif
2972ceea3321Sdrh 
2973ceea3321Sdrh   /* Find an empty slot and replace it */
2974ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2975ceea3321Sdrh     if( p->iReg==0 ){
2976ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2977ceea3321Sdrh       p->iTable = iTab;
2978ceea3321Sdrh       p->iColumn = iCol;
2979ceea3321Sdrh       p->iReg = iReg;
2980ceea3321Sdrh       p->tempReg = 0;
2981ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2982bea119cdSdrh       pParse->nColCache++;
2983ee65eea4Sdan       assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2984ceea3321Sdrh       return;
2985ceea3321Sdrh     }
2986ceea3321Sdrh   }
2987ceea3321Sdrh 
2988ceea3321Sdrh   /* Replace the last recently used */
2989ceea3321Sdrh   minLru = 0x7fffffff;
2990ceea3321Sdrh   idxLru = -1;
2991ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2992ceea3321Sdrh     if( p->lru<minLru ){
2993ceea3321Sdrh       idxLru = i;
2994ceea3321Sdrh       minLru = p->lru;
2995ceea3321Sdrh     }
2996ceea3321Sdrh   }
299720411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2998ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2999ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
3000ceea3321Sdrh     p->iTable = iTab;
3001ceea3321Sdrh     p->iColumn = iCol;
3002ceea3321Sdrh     p->iReg = iReg;
3003ceea3321Sdrh     p->tempReg = 0;
3004ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
3005bea119cdSdrh     assert( cacheIsValid(pParse) );
3006ceea3321Sdrh     return;
3007ceea3321Sdrh   }
3008ceea3321Sdrh }
3009ceea3321Sdrh 
3010ceea3321Sdrh /*
3011f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3012f49f3523Sdrh ** Purge the range of registers from the column cache.
3013ceea3321Sdrh */
3014f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
3015ceea3321Sdrh   struct yColCache *p;
3016bea119cdSdrh   if( iReg<=0 || pParse->nColCache==0 ) return;
3017bea119cdSdrh   p = &pParse->aColCache[SQLITE_N_COLCACHE-1];
3018bea119cdSdrh   while(1){
3019bea119cdSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ) cacheEntryClear(pParse, p);
3020bea119cdSdrh     if( p==pParse->aColCache ) break;
3021bea119cdSdrh     p--;
3022ceea3321Sdrh   }
3023ceea3321Sdrh }
3024ceea3321Sdrh 
3025ceea3321Sdrh /*
3026ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3027ceea3321Sdrh ** added to the column cache after this call are removed when the
3028ceea3321Sdrh ** corresponding pop occurs.
3029ceea3321Sdrh */
3030ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3031ceea3321Sdrh   pParse->iCacheLevel++;
30329ac7962aSdrh #ifdef SQLITE_DEBUG
30339ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30349ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
30359ac7962aSdrh   }
30369ac7962aSdrh #endif
3037ceea3321Sdrh }
3038ceea3321Sdrh 
3039ceea3321Sdrh /*
3040ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3041d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3042d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3043ceea3321Sdrh */
3044d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
3045ceea3321Sdrh   int i;
3046ceea3321Sdrh   struct yColCache *p;
3047d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3048d2490904Sdrh   pParse->iCacheLevel--;
30499ac7962aSdrh #ifdef SQLITE_DEBUG
30509ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30519ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
30529ac7962aSdrh   }
30539ac7962aSdrh #endif
3054ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3055ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
3056ceea3321Sdrh       cacheEntryClear(pParse, p);
3057ceea3321Sdrh     }
3058ceea3321Sdrh   }
3059ceea3321Sdrh }
3060945498f3Sdrh 
3061945498f3Sdrh /*
30625cd79239Sdrh ** When a cached column is reused, make sure that its register is
30635cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
30645cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
30655cd79239Sdrh ** get them all.
30665cd79239Sdrh */
30675cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
30685cd79239Sdrh   int i;
30695cd79239Sdrh   struct yColCache *p;
30705cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
30715cd79239Sdrh     if( p->iReg==iReg ){
30725cd79239Sdrh       p->tempReg = 0;
30735cd79239Sdrh     }
30745cd79239Sdrh   }
30755cd79239Sdrh }
30765cd79239Sdrh 
30771f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
30781f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
30791f9ca2c8Sdrh */
30801f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
30811f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
30821f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
30831f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
30841f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
30851f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
30861f9ca2c8Sdrh ){
30871f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
30884b92f98cSdrh   if( iTabCol==XN_EXPR ){
30891f9ca2c8Sdrh     assert( pIdx->aColExpr );
30901f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
30911f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
30921c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
30934b92f98cSdrh   }else{
30944b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
30954b92f98cSdrh                                     iTabCol, regOut);
30964b92f98cSdrh   }
30971f9ca2c8Sdrh }
30981f9ca2c8Sdrh 
30995cd79239Sdrh /*
31005c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
31015c092e8aSdrh */
31025c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
31035c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
31045c092e8aSdrh   Table *pTab,    /* The table containing the value */
3105313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
31065c092e8aSdrh   int iCol,       /* Index of the column to extract */
3107313619f5Sdrh   int regOut      /* Extract the value into this register */
31085c092e8aSdrh ){
31095c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
31105c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
31115c092e8aSdrh   }else{
31125c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3113ee0ec8e1Sdrh     int x = iCol;
311435db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3115ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3116ee0ec8e1Sdrh     }
3117ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
31185c092e8aSdrh   }
31195c092e8aSdrh   if( iCol>=0 ){
31205c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
31215c092e8aSdrh   }
31225c092e8aSdrh }
31235c092e8aSdrh 
31245c092e8aSdrh /*
3125945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3126ce78bc6eSdrh ** table pTab and store the column value in a register.
3127ce78bc6eSdrh **
3128ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3129ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3130ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3131ce78bc6eSdrh ** for GetColumnToReg().
3132e55cbd72Sdrh **
3133e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3134e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3135945498f3Sdrh */
3136e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3137e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
31382133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
31392133d822Sdrh   int iColumn,     /* Index of the table column */
31402133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3141a748fdccSdrh   int iReg,        /* Store results here */
3142ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
31432133d822Sdrh ){
3144e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3145e55cbd72Sdrh   int i;
3146da250ea5Sdrh   struct yColCache *p;
3147e55cbd72Sdrh 
3148ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3149b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
3150ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
31515cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3152da250ea5Sdrh       return p->iReg;
3153e55cbd72Sdrh     }
3154e55cbd72Sdrh   }
3155e55cbd72Sdrh   assert( v!=0 );
31565c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3157a748fdccSdrh   if( p5 ){
3158a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3159a748fdccSdrh   }else{
3160ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3161a748fdccSdrh   }
3162e55cbd72Sdrh   return iReg;
3163e55cbd72Sdrh }
3164ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3165ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3166ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3167ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3168ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3169ce78bc6eSdrh   int iReg         /* Store results here */
3170ce78bc6eSdrh ){
3171ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3172ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3173ce78bc6eSdrh }
3174ce78bc6eSdrh 
3175e55cbd72Sdrh 
3176e55cbd72Sdrh /*
3177ceea3321Sdrh ** Clear all column cache entries.
3178e55cbd72Sdrh */
3179ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3180e55cbd72Sdrh   int i;
3181ceea3321Sdrh   struct yColCache *p;
3182ceea3321Sdrh 
31839ac7962aSdrh #if SQLITE_DEBUG
31849ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31859ac7962aSdrh     printf("CLEAR\n");
31869ac7962aSdrh   }
31879ac7962aSdrh #endif
3188ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3189ceea3321Sdrh     if( p->iReg ){
3190ceea3321Sdrh       cacheEntryClear(pParse, p);
3191e55cbd72Sdrh     }
3192da250ea5Sdrh   }
3193da250ea5Sdrh }
3194e55cbd72Sdrh 
3195e55cbd72Sdrh /*
3196da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3197da250ea5Sdrh ** registers starting with iStart.
3198e55cbd72Sdrh */
3199da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3200f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3201e55cbd72Sdrh }
3202e55cbd72Sdrh 
3203e55cbd72Sdrh /*
3204b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3205b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3206e55cbd72Sdrh */
3207b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3208e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3209079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3210236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3211945498f3Sdrh }
3212945498f3Sdrh 
3213f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
321492b01d53Sdrh /*
3215652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3216652fbf55Sdrh ** is used as part of the column cache.
3217f49f3523Sdrh **
3218f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3219f49f3523Sdrh ** and does not appear in a normal build.
3220652fbf55Sdrh */
3221652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3222652fbf55Sdrh   int i;
3223ceea3321Sdrh   struct yColCache *p;
3224ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3225ceea3321Sdrh     int r = p->iReg;
3226f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3227652fbf55Sdrh   }
3228652fbf55Sdrh   return 0;
3229652fbf55Sdrh }
3230f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3231652fbf55Sdrh 
3232bea119cdSdrh 
3233652fbf55Sdrh /*
3234a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
3235a4c3c87eSdrh */
3236a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3237a4c3c87eSdrh   p->op2 = p->op;
3238a4c3c87eSdrh   p->op = TK_REGISTER;
3239a4c3c87eSdrh   p->iTable = iReg;
3240a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3241a4c3c87eSdrh }
3242a4c3c87eSdrh 
324371c57db0Sdan static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
324471c57db0Sdan 
3245a4c3c87eSdrh /*
3246cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
32472dcef11bSdrh ** expression.  Attempt to store the results in register "target".
32482dcef11bSdrh ** Return the register where results are stored.
3249389a1adbSdrh **
32508b213899Sdrh ** With this routine, there is no guarantee that results will
32512dcef11bSdrh ** be stored in target.  The result might be stored in some other
32522dcef11bSdrh ** register if it is convenient to do so.  The calling function
32532dcef11bSdrh ** must check the return code and move the results to the desired
32542dcef11bSdrh ** register.
3255cce7d176Sdrh */
3256678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
32572dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
32582dcef11bSdrh   int op;                   /* The opcode being coded */
32592dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
32602dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
32612dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
32627b35a77bSdan   int r1, r2;               /* Various register numbers */
326320411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
326410d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
326571c57db0Sdan   int p5 = 0;
3266ffe07b2dSdrh 
32679cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
326820411ea7Sdrh   if( v==0 ){
326920411ea7Sdrh     assert( pParse->db->mallocFailed );
327020411ea7Sdrh     return 0;
327120411ea7Sdrh   }
3272389a1adbSdrh 
3273389a1adbSdrh   if( pExpr==0 ){
3274389a1adbSdrh     op = TK_NULL;
3275389a1adbSdrh   }else{
3276f2bc013cSdrh     op = pExpr->op;
3277389a1adbSdrh   }
3278f2bc013cSdrh   switch( op ){
327913449892Sdrh     case TK_AGG_COLUMN: {
328013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
328113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
328213449892Sdrh       if( !pAggInfo->directMode ){
32839de221dfSdrh         assert( pCol->iMem>0 );
32849de221dfSdrh         inReg = pCol->iMem;
328513449892Sdrh         break;
328613449892Sdrh       }else if( pAggInfo->useSortingIdx ){
32875134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3288389a1adbSdrh                               pCol->iSorterColumn, target);
328913449892Sdrh         break;
329013449892Sdrh       }
329113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
329213449892Sdrh     }
3293967e8b73Sdrh     case TK_COLUMN: {
3294b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3295b2b9d3d7Sdrh       if( iTab<0 ){
3296b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3297b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3298aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
3299b2b9d3d7Sdrh           break;
3300c4a3c779Sdrh         }else{
33011f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
33021f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
33031f9ca2c8Sdrh           iTab = pParse->iSelfTab;
33042282792aSdrh         }
3305b2b9d3d7Sdrh       }
3306b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3307b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3308b2b9d3d7Sdrh                                pExpr->op2);
3309cce7d176Sdrh       break;
3310cce7d176Sdrh     }
3311cce7d176Sdrh     case TK_INTEGER: {
331213573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3313fec19aadSdrh       break;
331451e9a445Sdrh     }
331513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3316598f1340Sdrh     case TK_FLOAT: {
331733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
331833e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3319598f1340Sdrh       break;
3320598f1340Sdrh     }
332113573c71Sdrh #endif
3322fec19aadSdrh     case TK_STRING: {
332333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3324076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3325cce7d176Sdrh       break;
3326cce7d176Sdrh     }
3327f0863fe5Sdrh     case TK_NULL: {
33289de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3329f0863fe5Sdrh       break;
3330f0863fe5Sdrh     }
33315338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3332c572ef7fSdanielk1977     case TK_BLOB: {
33336c8c6cecSdrh       int n;
33346c8c6cecSdrh       const char *z;
3335ca48c90fSdrh       char *zBlob;
333633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
333733e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
333833e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
333933e619fcSdrh       z = &pExpr->u.zToken[2];
3340b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3341b7916a78Sdrh       assert( z[n]=='\'' );
3342ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3343ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3344c572ef7fSdanielk1977       break;
3345c572ef7fSdanielk1977     }
33465338a5f7Sdanielk1977 #endif
334750457896Sdrh     case TK_VARIABLE: {
334833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
334933e619fcSdrh       assert( pExpr->u.zToken!=0 );
335033e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3351eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
335233e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
335304e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
335404e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
335504e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
3356895d7472Sdrh       }
335750457896Sdrh       break;
335850457896Sdrh     }
33594e0cff60Sdrh     case TK_REGISTER: {
33609de221dfSdrh       inReg = pExpr->iTable;
33614e0cff60Sdrh       break;
33624e0cff60Sdrh     }
3363487e262fSdrh #ifndef SQLITE_OMIT_CAST
3364487e262fSdrh     case TK_CAST: {
3365487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
33662dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
33671735fa88Sdrh       if( inReg!=target ){
33681735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
33691735fa88Sdrh         inReg = target;
33701735fa88Sdrh       }
33714169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
33724169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3373c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3374b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3375487e262fSdrh       break;
3376487e262fSdrh     }
3377487e262fSdrh #endif /* SQLITE_OMIT_CAST */
337871c57db0Sdan     case TK_IS:
337971c57db0Sdan     case TK_ISNOT:
338071c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
338171c57db0Sdan       p5 = SQLITE_NULLEQ;
338271c57db0Sdan       /* fall-through */
3383c9b84a1fSdrh     case TK_LT:
3384c9b84a1fSdrh     case TK_LE:
3385c9b84a1fSdrh     case TK_GT:
3386c9b84a1fSdrh     case TK_GE:
3387c9b84a1fSdrh     case TK_NE:
3388c9b84a1fSdrh     case TK_EQ: {
338971c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3390625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
339179752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
339271c57db0Sdan       }else{
339371c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3394b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
339571c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
339671c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
33977d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
33987d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
33997d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
34007d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
34017d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
34027d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3403c5499befSdrh         testcase( regFree1==0 );
3404c5499befSdrh         testcase( regFree2==0 );
3405c9b84a1fSdrh       }
34066a2fe093Sdrh       break;
34076a2fe093Sdrh     }
3408cce7d176Sdrh     case TK_AND:
3409cce7d176Sdrh     case TK_OR:
3410cce7d176Sdrh     case TK_PLUS:
3411cce7d176Sdrh     case TK_STAR:
3412cce7d176Sdrh     case TK_MINUS:
3413bf4133cbSdrh     case TK_REM:
3414bf4133cbSdrh     case TK_BITAND:
3415bf4133cbSdrh     case TK_BITOR:
341617c40294Sdrh     case TK_SLASH:
3417bf4133cbSdrh     case TK_LSHIFT:
3418855eb1cfSdrh     case TK_RSHIFT:
34190040077dSdrh     case TK_CONCAT: {
34207d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
34217d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
34227d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
34237d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
34247d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
34257d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
34267d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
34277d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
34287d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
34297d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
34307d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
34312dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
34322dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
34335b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3434c5499befSdrh       testcase( regFree1==0 );
3435c5499befSdrh       testcase( regFree2==0 );
34360040077dSdrh       break;
34370040077dSdrh     }
3438cce7d176Sdrh     case TK_UMINUS: {
3439fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3440fec19aadSdrh       assert( pLeft );
344113573c71Sdrh       if( pLeft->op==TK_INTEGER ){
344213573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
344313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
344413573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
344533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
344633e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
344713573c71Sdrh #endif
34483c84ddffSdrh       }else{
344910d1edf0Sdrh         tempX.op = TK_INTEGER;
345010d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
345110d1edf0Sdrh         tempX.u.iValue = 0;
345210d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3453e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
34542dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3455c5499befSdrh         testcase( regFree2==0 );
34563c84ddffSdrh       }
34579de221dfSdrh       inReg = target;
34586e142f54Sdrh       break;
34596e142f54Sdrh     }
3460bf4133cbSdrh     case TK_BITNOT:
34616e142f54Sdrh     case TK_NOT: {
34627d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
34637d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3464e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3465e99fa2afSdrh       testcase( regFree1==0 );
3466e99fa2afSdrh       inReg = target;
3467e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3468cce7d176Sdrh       break;
3469cce7d176Sdrh     }
3470cce7d176Sdrh     case TK_ISNULL:
3471cce7d176Sdrh     case TK_NOTNULL: {
34726a288a33Sdrh       int addr;
34737d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
34747d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
34759de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
34762dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3477c5499befSdrh       testcase( regFree1==0 );
34782dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
34797d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
34807d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3481a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
34826a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3483a37cdde0Sdanielk1977       break;
3484f2bc013cSdrh     }
34852282792aSdrh     case TK_AGG_FUNCTION: {
348613449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
34877e56e711Sdrh       if( pInfo==0 ){
348833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
348933e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
34907e56e711Sdrh       }else{
34919de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
34927e56e711Sdrh       }
34932282792aSdrh       break;
34942282792aSdrh     }
3495cce7d176Sdrh     case TK_FUNCTION: {
349612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
349712ffee8cSdrh       int nFarg;             /* Number of function arguments */
349812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
349912ffee8cSdrh       const char *zId;       /* The function name */
3500693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
350112ffee8cSdrh       int i;                 /* Loop counter */
350212ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
350312ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
350417435752Sdrh 
35056ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3506c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
350712ffee8cSdrh         pFarg = 0;
350812ffee8cSdrh       }else{
350912ffee8cSdrh         pFarg = pExpr->x.pList;
351012ffee8cSdrh       }
351112ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
351233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
351333e619fcSdrh       zId = pExpr->u.zToken;
351480738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3515cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3516cc15313cSdrh       if( pDef==0 && pParse->explain ){
3517cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3518cc15313cSdrh       }
3519cc15313cSdrh #endif
35202d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
352180738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3522feb306f5Sdrh         break;
3523feb306f5Sdrh       }
3524ae6bb957Sdrh 
3525ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
352660ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3527ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3528ae6bb957Sdrh       */
3529d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3530ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3531ae6bb957Sdrh         assert( nFarg>=2 );
3532ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3533ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3534ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3535688852abSdrh           VdbeCoverage(v);
3536f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3537ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3538ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3539d2490904Sdrh           sqlite3ExprCachePop(pParse);
3540ae6bb957Sdrh         }
3541ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3542ae6bb957Sdrh         break;
3543ae6bb957Sdrh       }
3544ae6bb957Sdrh 
3545cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3546cca9f3d2Sdrh       ** of the first argument.
3547cca9f3d2Sdrh       */
3548cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3549cca9f3d2Sdrh         assert( nFarg>=1 );
35505f02ab09Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3551cca9f3d2Sdrh         break;
3552cca9f3d2Sdrh       }
3553ae6bb957Sdrh 
3554d1a01edaSdrh       for(i=0; i<nFarg; i++){
3555d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3556693e6719Sdrh           testcase( i==31 );
3557693e6719Sdrh           constMask |= MASKBIT32(i);
3558d1a01edaSdrh         }
3559d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3560d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3561d1a01edaSdrh         }
3562d1a01edaSdrh       }
356312ffee8cSdrh       if( pFarg ){
3564d1a01edaSdrh         if( constMask ){
3565d1a01edaSdrh           r1 = pParse->nMem+1;
3566d1a01edaSdrh           pParse->nMem += nFarg;
3567d1a01edaSdrh         }else{
356812ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3569d1a01edaSdrh         }
3570a748fdccSdrh 
3571a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3572a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3573a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3574a748fdccSdrh         ** loading.
3575a748fdccSdrh         */
3576d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
35774e245a4cSdrh           u8 exprOp;
3578a748fdccSdrh           assert( nFarg==1 );
3579a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
35804e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
35814e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3582a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3583a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3584b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3585b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3586b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3587a748fdccSdrh           }
3588a748fdccSdrh         }
3589a748fdccSdrh 
3590d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
35915579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3592d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3593d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3594892d3179Sdrh       }else{
359512ffee8cSdrh         r1 = 0;
3596892d3179Sdrh       }
3597b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3598a43fa227Sdrh       /* Possibly overload the function if the first argument is
3599a43fa227Sdrh       ** a virtual table column.
3600a43fa227Sdrh       **
3601a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3602a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3603a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3604a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3605a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3606a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3607a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3608a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3609a43fa227Sdrh       */
361012ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
361112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
361212ffee8cSdrh       }else if( nFarg>0 ){
361312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3614b7f6f68fSdrh       }
3615b7f6f68fSdrh #endif
3616d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
36178b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
361866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3619682f68b0Sdanielk1977       }
36209c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
362166a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
362212ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3623d1a01edaSdrh       if( nFarg && constMask==0 ){
362412ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
36252dcef11bSdrh       }
36266ec2733bSdrh       break;
36276ec2733bSdrh     }
3628fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3629fe2093d7Sdrh     case TK_EXISTS:
363019a775c2Sdrh     case TK_SELECT: {
36318da209b1Sdan       int nCol;
3632c5499befSdrh       testcase( op==TK_EXISTS );
3633c5499befSdrh       testcase( op==TK_SELECT );
36348da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
36358da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
36368da209b1Sdan       }else{
36371450bc6eSdrh         inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
36388da209b1Sdan       }
363919a775c2Sdrh       break;
364019a775c2Sdrh     }
3641fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3642fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3643fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3644fc7f27b9Sdrh       }
3645fc7f27b9Sdrh       inReg = pExpr->pLeft->iTable + pExpr->iColumn;
3646fc7f27b9Sdrh       break;
3647fc7f27b9Sdrh     }
3648fef5208cSdrh     case TK_IN: {
3649e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3650e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3651e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3652e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
365366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3654e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3655e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3656e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3657fef5208cSdrh       break;
3658fef5208cSdrh     }
3659e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3660e3365e6cSdrh 
3661e3365e6cSdrh 
36622dcef11bSdrh     /*
36632dcef11bSdrh     **    x BETWEEN y AND z
36642dcef11bSdrh     **
36652dcef11bSdrh     ** This is equivalent to
36662dcef11bSdrh     **
36672dcef11bSdrh     **    x>=y AND x<=z
36682dcef11bSdrh     **
36692dcef11bSdrh     ** X is stored in pExpr->pLeft.
36702dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
36712dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
36722dcef11bSdrh     */
3673fef5208cSdrh     case TK_BETWEEN: {
367471c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3675fef5208cSdrh       break;
3676fef5208cSdrh     }
367794fa9c41Sdrh     case TK_SPAN:
3678ae80ddeaSdrh     case TK_COLLATE:
36794f07e5fbSdrh     case TK_UPLUS: {
36802dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3681a2e00042Sdrh       break;
3682a2e00042Sdrh     }
36832dcef11bSdrh 
3684165921a7Sdan     case TK_TRIGGER: {
368565a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
368665a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
368765a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
368865a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
368965a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
369065a7cd16Sdan       ** read the rowid field.
369165a7cd16Sdan       **
369265a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
369365a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
369465a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
369565a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
369665a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
369765a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
369865a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
369965a7cd16Sdan       ** example, if the table on which triggers are being fired is
370065a7cd16Sdan       ** declared as:
370165a7cd16Sdan       **
370265a7cd16Sdan       **   CREATE TABLE t1(a, b);
370365a7cd16Sdan       **
370465a7cd16Sdan       ** Then p1 is interpreted as follows:
370565a7cd16Sdan       **
370665a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
370765a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
370865a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
370965a7cd16Sdan       */
37102832ad42Sdan       Table *pTab = pExpr->pTab;
371165a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
371265a7cd16Sdan 
371365a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
371465a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
371565a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
371665a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
371765a7cd16Sdan 
371865a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
371976d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3720165921a7Sdan         (pExpr->iTable ? "new" : "old"),
372176d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
372276d462eeSdan         target
3723165921a7Sdan       ));
372465a7cd16Sdan 
372544dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
372665a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3727113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3728113762a2Sdrh       **
3729113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3730113762a2Sdrh       ** floating point when extracting it from the record.  */
37312832ad42Sdan       if( pExpr->iColumn>=0
37322832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
37332832ad42Sdan       ){
37342832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
37352832ad42Sdan       }
373644dbca83Sdrh #endif
3737165921a7Sdan       break;
3738165921a7Sdan     }
3739165921a7Sdan 
374071c57db0Sdan     case TK_VECTOR: {
3741d49fd4e8Sdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
374271c57db0Sdan       break;
374371c57db0Sdan     }
374471c57db0Sdan 
37452dcef11bSdrh     /*
37462dcef11bSdrh     ** Form A:
37472dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
37482dcef11bSdrh     **
37492dcef11bSdrh     ** Form B:
37502dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
37512dcef11bSdrh     **
37522dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
37532dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
37542dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
37552dcef11bSdrh     **
37562dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3757c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3758c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3759c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
37602dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
37612dcef11bSdrh     **
37622dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
37632dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
37642dcef11bSdrh     ** no ELSE term, NULL.
37652dcef11bSdrh     */
376633cd4909Sdrh     default: assert( op==TK_CASE ); {
37672dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
37682dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
37692dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
37702dcef11bSdrh       int i;                            /* Loop counter */
37712dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
37722dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
37732dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
37742dcef11bSdrh       Expr *pX;                         /* The X expression */
37751bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3776ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
377717a7f8ddSdrh 
37786ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
37796ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
37806ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3781be5c89acSdrh       aListelem = pEList->a;
3782be5c89acSdrh       nExpr = pEList->nExpr;
37832dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
37842dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
378510d1edf0Sdrh         tempX = *pX;
378633cd4909Sdrh         testcase( pX->op==TK_COLUMN );
378710d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
3788c5499befSdrh         testcase( regFree1==0 );
37892dcef11bSdrh         opCompare.op = TK_EQ;
379010d1edf0Sdrh         opCompare.pLeft = &tempX;
37912dcef11bSdrh         pTest = &opCompare;
37928b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
37938b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
37948b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
37958b1db07fSdrh         ** purposes and possibly overwritten.  */
37968b1db07fSdrh         regFree1 = 0;
3797cce7d176Sdrh       }
3798c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3799ceea3321Sdrh         sqlite3ExprCachePush(pParse);
38002dcef11bSdrh         if( pX ){
38011bd10f8aSdrh           assert( pTest!=0 );
38022dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3803f5905aa7Sdrh         }else{
38042dcef11bSdrh           pTest = aListelem[i].pExpr;
380517a7f8ddSdrh         }
38062dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
380733cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
38082dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3809c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
38109de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3811076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3812d2490904Sdrh         sqlite3ExprCachePop(pParse);
38132dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3814f570f011Sdrh       }
3815c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3816ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3817c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3818d2490904Sdrh         sqlite3ExprCachePop(pParse);
381917a7f8ddSdrh       }else{
38209de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
382117a7f8ddSdrh       }
3822c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
3823c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
38242dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
38256f34903eSdanielk1977       break;
38266f34903eSdanielk1977     }
38275338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
38286f34903eSdanielk1977     case TK_RAISE: {
3829165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3830165921a7Sdan            || pExpr->affinity==OE_Abort
3831165921a7Sdan            || pExpr->affinity==OE_Fail
3832165921a7Sdan            || pExpr->affinity==OE_Ignore
3833165921a7Sdan       );
3834e0af83acSdan       if( !pParse->pTriggerTab ){
3835e0af83acSdan         sqlite3ErrorMsg(pParse,
3836e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3837e0af83acSdan         return 0;
3838e0af83acSdan       }
3839e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3840e0af83acSdan         sqlite3MayAbort(pParse);
3841e0af83acSdan       }
384233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3843e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3844e0af83acSdan         sqlite3VdbeAddOp4(
3845e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3846688852abSdrh         VdbeCoverage(v);
3847e0af83acSdan       }else{
3848433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3849f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3850e0af83acSdan       }
3851e0af83acSdan 
3852ffe07b2dSdrh       break;
385317a7f8ddSdrh     }
38545338a5f7Sdanielk1977 #endif
3855ffe07b2dSdrh   }
38562dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
38572dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
38582dcef11bSdrh   return inReg;
38595b6afba9Sdrh }
38602dcef11bSdrh 
38612dcef11bSdrh /*
3862d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3863d1a01edaSdrh */
3864d673cddaSdrh void sqlite3ExprCodeAtInit(
3865d673cddaSdrh   Parse *pParse,    /* Parsing context */
3866d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3867d673cddaSdrh   int regDest,      /* Store the value in this register */
3868d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3869d673cddaSdrh ){
3870d1a01edaSdrh   ExprList *p;
3871d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3872d1a01edaSdrh   p = pParse->pConstExpr;
3873d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3874d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3875d673cddaSdrh   if( p ){
3876d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3877d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3878d673cddaSdrh      pItem->reusable = reusable;
3879d673cddaSdrh   }
3880d1a01edaSdrh   pParse->pConstExpr = p;
3881d1a01edaSdrh }
3882d1a01edaSdrh 
3883d1a01edaSdrh /*
38842dcef11bSdrh ** Generate code to evaluate an expression and store the results
38852dcef11bSdrh ** into a register.  Return the register number where the results
38862dcef11bSdrh ** are stored.
38872dcef11bSdrh **
38882dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3889678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
38902dcef11bSdrh ** a temporary, then set *pReg to zero.
3891f30a969bSdrh **
3892f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3893f30a969bSdrh ** code to fill the register in the initialization section of the
3894f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
38952dcef11bSdrh */
38962dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3897f30a969bSdrh   int r2;
3898f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3899d9f158e7Sdrh   if( ConstFactorOk(pParse)
3900f30a969bSdrh    && pExpr->op!=TK_REGISTER
3901f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3902f30a969bSdrh   ){
3903f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3904f30a969bSdrh     int i;
3905f30a969bSdrh     *pReg  = 0;
3906f30a969bSdrh     if( p ){
3907d673cddaSdrh       struct ExprList_item *pItem;
3908d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3909d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3910d673cddaSdrh           return pItem->u.iConstExprReg;
3911f30a969bSdrh         }
3912f30a969bSdrh       }
3913f30a969bSdrh     }
3914f30a969bSdrh     r2 = ++pParse->nMem;
3915d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3916f30a969bSdrh   }else{
39172dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3918f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
39192dcef11bSdrh     if( r2==r1 ){
39202dcef11bSdrh       *pReg = r1;
39212dcef11bSdrh     }else{
39222dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
39232dcef11bSdrh       *pReg = 0;
39242dcef11bSdrh     }
3925f30a969bSdrh   }
39262dcef11bSdrh   return r2;
39272dcef11bSdrh }
39282dcef11bSdrh 
39292dcef11bSdrh /*
39302dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
39312dcef11bSdrh ** results in register target.  The results are guaranteed to appear
39322dcef11bSdrh ** in register target.
39332dcef11bSdrh */
393405a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
39359cbf3425Sdrh   int inReg;
39369cbf3425Sdrh 
39379cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3938ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3939ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3940ebc16717Sdrh   }else{
39419cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
39421c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
39430e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
39449cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
394517a7f8ddSdrh     }
3946ebc16717Sdrh   }
3947cce7d176Sdrh }
3948cce7d176Sdrh 
3949cce7d176Sdrh /*
39501c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
39511c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
39521c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
39531c75c9d7Sdrh */
39541c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
39551c75c9d7Sdrh   sqlite3 *db = pParse->db;
39561c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
39571c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
39581c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
39591c75c9d7Sdrh }
39601c75c9d7Sdrh 
39611c75c9d7Sdrh /*
396205a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
396305a86c5cSdrh ** results in register target.  The results are guaranteed to appear
396405a86c5cSdrh ** in register target.  If the expression is constant, then this routine
396505a86c5cSdrh ** might choose to code the expression at initialization time.
396605a86c5cSdrh */
396705a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
396805a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
396905a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
397005a86c5cSdrh   }else{
397105a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
397205a86c5cSdrh   }
3973cce7d176Sdrh }
3974cce7d176Sdrh 
3975cce7d176Sdrh /*
397660ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
3977de4fcfddSdrh ** in register target.
397825303780Sdrh **
39792dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
39802dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
39812dcef11bSdrh ** the result is a copy of the cache register.
39822dcef11bSdrh **
39832dcef11bSdrh ** This routine is used for expressions that are used multiple
39842dcef11bSdrh ** times.  They are evaluated once and the results of the expression
39852dcef11bSdrh ** are reused.
398625303780Sdrh */
398705a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
398825303780Sdrh   Vdbe *v = pParse->pVdbe;
398925303780Sdrh   int iMem;
399005a86c5cSdrh 
399105a86c5cSdrh   assert( target>0 );
399205a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
399305a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
39942dcef11bSdrh   iMem = ++pParse->nMem;
399505a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3996a4c3c87eSdrh   exprToRegister(pExpr, iMem);
399725303780Sdrh }
39987e02e5e6Sdrh 
3999678ccce8Sdrh /*
4000268380caSdrh ** Generate code that pushes the value of every element of the given
40019cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4002268380caSdrh **
4003892d3179Sdrh ** Return the number of elements evaluated.
4004d1a01edaSdrh **
4005d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4006d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4007d1a01edaSdrh **
4008d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4009d1a01edaSdrh ** factored out into initialization code.
4010b0df9634Sdrh **
4011b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4012b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4013b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
4014268380caSdrh */
40154adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4016268380caSdrh   Parse *pParse,     /* Parsing context */
4017389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4018191b54cbSdrh   int target,        /* Where to write results */
40195579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4020d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4021268380caSdrh ){
4022268380caSdrh   struct ExprList_item *pItem;
40235579d59fSdrh   int i, j, n;
4024d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
40255579d59fSdrh   Vdbe *v = pParse->pVdbe;
40269d8b3072Sdrh   assert( pList!=0 );
40279cbf3425Sdrh   assert( target>0 );
4028d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4029268380caSdrh   n = pList->nExpr;
4030d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4031191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
40327445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
40335579d59fSdrh     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
40345579d59fSdrh       sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
40355579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4036d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
4037d1a01edaSdrh     }else{
40387445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4039746fd9ccSdrh       if( inReg!=target+i ){
40404eded604Sdrh         VdbeOp *pOp;
40414eded604Sdrh         if( copyOp==OP_Copy
40424eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
40434eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
40444eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
40454eded604Sdrh         ){
40464eded604Sdrh           pOp->p3++;
40474eded604Sdrh         }else{
40484eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
40494eded604Sdrh         }
4050d1a01edaSdrh       }
4051d176611bSdrh     }
4052268380caSdrh   }
4053f9b596ebSdrh   return n;
4054268380caSdrh }
4055268380caSdrh 
4056268380caSdrh /*
405736c563a2Sdrh ** Generate code for a BETWEEN operator.
405836c563a2Sdrh **
405936c563a2Sdrh **    x BETWEEN y AND z
406036c563a2Sdrh **
406136c563a2Sdrh ** The above is equivalent to
406236c563a2Sdrh **
406336c563a2Sdrh **    x>=y AND x<=z
406436c563a2Sdrh **
406536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
406660ec914cSpeter.d.reid ** elimination of x.
406736c563a2Sdrh */
406836c563a2Sdrh static void exprCodeBetween(
406936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
407036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
407136c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
407271c57db0Sdan   void (*xJumpIf)(Parse*,Expr*,int,int),
407336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
407436c563a2Sdrh ){
407536c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
407636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
407736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
407836c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
407936c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
408036c563a2Sdrh 
408171c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
408271c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
408371c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
408471c57db0Sdan 
408536c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
408636c563a2Sdrh   exprX = *pExpr->pLeft;
408736c563a2Sdrh   exprAnd.op = TK_AND;
408836c563a2Sdrh   exprAnd.pLeft = &compLeft;
408936c563a2Sdrh   exprAnd.pRight = &compRight;
409036c563a2Sdrh   compLeft.op = TK_GE;
409136c563a2Sdrh   compLeft.pLeft = &exprX;
409236c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
409336c563a2Sdrh   compRight.op = TK_LE;
409436c563a2Sdrh   compRight.pLeft = &exprX;
409536c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
4096625015e0Sdan   if( sqlite3ExprIsVector(&exprX)==0 ){
4097a4c3c87eSdrh     exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
409871c57db0Sdan   }
409971c57db0Sdan   if( xJumpIf ){
410071c57db0Sdan     xJumpIf(pParse, &exprAnd, dest, jumpIfNull);
410136c563a2Sdrh   }else{
410271c57db0Sdan     exprX.flags |= EP_FromJoin;
410371c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
410436c563a2Sdrh   }
410536c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
410636c563a2Sdrh 
410736c563a2Sdrh   /* Ensure adequate test coverage */
410836c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
410936c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
411036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
411136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
411236c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
411336c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
411436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
411536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
411636c563a2Sdrh }
411736c563a2Sdrh 
411836c563a2Sdrh /*
4119cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4120cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4121cce7d176Sdrh ** continues straight thru if the expression is false.
4122f5905aa7Sdrh **
4123f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
412435573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4125f2bc013cSdrh **
4126f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4127f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4128f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4129f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4130f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4131cce7d176Sdrh */
41324adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4133cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4134cce7d176Sdrh   int op = 0;
41352dcef11bSdrh   int regFree1 = 0;
41362dcef11bSdrh   int regFree2 = 0;
41372dcef11bSdrh   int r1, r2;
41382dcef11bSdrh 
413935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
414048864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
414133cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4142f2bc013cSdrh   op = pExpr->op;
41437b35a77bSdan   switch( op ){
4144cce7d176Sdrh     case TK_AND: {
41454adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4146c5499befSdrh       testcase( jumpIfNull==0 );
414735573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
414854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41494adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
41504adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4151d2490904Sdrh       sqlite3ExprCachePop(pParse);
4152cce7d176Sdrh       break;
4153cce7d176Sdrh     }
4154cce7d176Sdrh     case TK_OR: {
4155c5499befSdrh       testcase( jumpIfNull==0 );
41564adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
415754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41584adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4159d2490904Sdrh       sqlite3ExprCachePop(pParse);
4160cce7d176Sdrh       break;
4161cce7d176Sdrh     }
4162cce7d176Sdrh     case TK_NOT: {
4163c5499befSdrh       testcase( jumpIfNull==0 );
41644adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4165cce7d176Sdrh       break;
4166cce7d176Sdrh     }
4167de845c2fSdrh     case TK_IS:
4168de845c2fSdrh     case TK_ISNOT:
4169de845c2fSdrh       testcase( op==TK_IS );
4170de845c2fSdrh       testcase( op==TK_ISNOT );
4171de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4172de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4173de845c2fSdrh       /* Fall thru */
4174cce7d176Sdrh     case TK_LT:
4175cce7d176Sdrh     case TK_LE:
4176cce7d176Sdrh     case TK_GT:
4177cce7d176Sdrh     case TK_GE:
4178cce7d176Sdrh     case TK_NE:
41790ac65892Sdrh     case TK_EQ: {
4180625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4181c5499befSdrh       testcase( jumpIfNull==0 );
4182b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4183b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
418435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
41852dcef11bSdrh                   r1, r2, dest, jumpIfNull);
41867d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41877d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41887d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41897d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4190de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4191de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4192de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4193de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4194de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4195de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
41966a2fe093Sdrh       testcase( regFree1==0 );
41976a2fe093Sdrh       testcase( regFree2==0 );
41986a2fe093Sdrh       break;
41996a2fe093Sdrh     }
4200cce7d176Sdrh     case TK_ISNULL:
4201cce7d176Sdrh     case TK_NOTNULL: {
42027d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
42037d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
42042dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42052dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
42067d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42077d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4208c5499befSdrh       testcase( regFree1==0 );
4209cce7d176Sdrh       break;
4210cce7d176Sdrh     }
4211fef5208cSdrh     case TK_BETWEEN: {
42125c03f30aSdrh       testcase( jumpIfNull==0 );
421371c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4214fef5208cSdrh       break;
4215fef5208cSdrh     }
4216bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4217e3365e6cSdrh     case TK_IN: {
4218e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4219e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4220e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4221076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4222e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4223e3365e6cSdrh       break;
4224e3365e6cSdrh     }
4225bb201344Sshaneh #endif
4226cce7d176Sdrh     default: {
42277b35a77bSdan     default_expr:
4228991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4229076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4230991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4231991a1985Sdrh         /* No-op */
4232991a1985Sdrh       }else{
42332dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
42342dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4235688852abSdrh         VdbeCoverage(v);
4236c5499befSdrh         testcase( regFree1==0 );
4237c5499befSdrh         testcase( jumpIfNull==0 );
4238991a1985Sdrh       }
4239cce7d176Sdrh       break;
4240cce7d176Sdrh     }
4241cce7d176Sdrh   }
42422dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42432dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4244cce7d176Sdrh }
4245cce7d176Sdrh 
4246cce7d176Sdrh /*
424766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4248cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4249cce7d176Sdrh ** continues straight thru if the expression is true.
4250f5905aa7Sdrh **
4251f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
425235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
425335573356Sdrh ** is 0.
4254cce7d176Sdrh */
42554adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4256cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4257cce7d176Sdrh   int op = 0;
42582dcef11bSdrh   int regFree1 = 0;
42592dcef11bSdrh   int regFree2 = 0;
42602dcef11bSdrh   int r1, r2;
42612dcef11bSdrh 
426235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
426348864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
426433cd4909Sdrh   if( pExpr==0 )    return;
4265f2bc013cSdrh 
4266f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4267f2bc013cSdrh   **
4268f2bc013cSdrh   **       pExpr->op            op
4269f2bc013cSdrh   **       ---------          ----------
4270f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4271f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4272f2bc013cSdrh   **       TK_NE              OP_Eq
4273f2bc013cSdrh   **       TK_EQ              OP_Ne
4274f2bc013cSdrh   **       TK_GT              OP_Le
4275f2bc013cSdrh   **       TK_LE              OP_Gt
4276f2bc013cSdrh   **       TK_GE              OP_Lt
4277f2bc013cSdrh   **       TK_LT              OP_Ge
4278f2bc013cSdrh   **
4279f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4280f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4281f2bc013cSdrh   ** can compute the mapping above using the following expression.
4282f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4283f2bc013cSdrh   */
4284f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4285f2bc013cSdrh 
4286f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4287f2bc013cSdrh   */
4288f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4289f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4290f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4291f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4292f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4293f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4294f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4295f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4296f2bc013cSdrh 
4297ba00e30aSdan   switch( pExpr->op ){
4298cce7d176Sdrh     case TK_AND: {
4299c5499befSdrh       testcase( jumpIfNull==0 );
43004adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
430154e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43024adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4303d2490904Sdrh       sqlite3ExprCachePop(pParse);
4304cce7d176Sdrh       break;
4305cce7d176Sdrh     }
4306cce7d176Sdrh     case TK_OR: {
43074adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4308c5499befSdrh       testcase( jumpIfNull==0 );
430935573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
431054e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43114adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
43124adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4313d2490904Sdrh       sqlite3ExprCachePop(pParse);
4314cce7d176Sdrh       break;
4315cce7d176Sdrh     }
4316cce7d176Sdrh     case TK_NOT: {
43175c03f30aSdrh       testcase( jumpIfNull==0 );
43184adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4319cce7d176Sdrh       break;
4320cce7d176Sdrh     }
4321de845c2fSdrh     case TK_IS:
4322de845c2fSdrh     case TK_ISNOT:
4323de845c2fSdrh       testcase( pExpr->op==TK_IS );
4324de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4325de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4326de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4327de845c2fSdrh       /* Fall thru */
4328cce7d176Sdrh     case TK_LT:
4329cce7d176Sdrh     case TK_LE:
4330cce7d176Sdrh     case TK_GT:
4331cce7d176Sdrh     case TK_GE:
4332cce7d176Sdrh     case TK_NE:
4333cce7d176Sdrh     case TK_EQ: {
4334625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4335c5499befSdrh       testcase( jumpIfNull==0 );
4336b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4337b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
433835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
43392dcef11bSdrh                   r1, r2, dest, jumpIfNull);
43407d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
43417d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
43427d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
43437d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4344de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4345de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4346de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4347de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4348de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4349de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
43506a2fe093Sdrh       testcase( regFree1==0 );
43516a2fe093Sdrh       testcase( regFree2==0 );
43526a2fe093Sdrh       break;
43536a2fe093Sdrh     }
4354cce7d176Sdrh     case TK_ISNULL:
4355cce7d176Sdrh     case TK_NOTNULL: {
43562dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
43572dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
43587d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
43597d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4360c5499befSdrh       testcase( regFree1==0 );
4361cce7d176Sdrh       break;
4362cce7d176Sdrh     }
4363fef5208cSdrh     case TK_BETWEEN: {
43645c03f30aSdrh       testcase( jumpIfNull==0 );
436571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4366fef5208cSdrh       break;
4367fef5208cSdrh     }
4368bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4369e3365e6cSdrh     case TK_IN: {
4370e3365e6cSdrh       if( jumpIfNull ){
4371e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4372e3365e6cSdrh       }else{
4373e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4374e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4375e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4376e3365e6cSdrh       }
4377e3365e6cSdrh       break;
4378e3365e6cSdrh     }
4379bb201344Sshaneh #endif
4380cce7d176Sdrh     default: {
4381ba00e30aSdan     default_expr:
4382991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4383076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4384991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4385991a1985Sdrh         /* no-op */
4386991a1985Sdrh       }else{
43872dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
43882dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4389688852abSdrh         VdbeCoverage(v);
4390c5499befSdrh         testcase( regFree1==0 );
4391c5499befSdrh         testcase( jumpIfNull==0 );
4392991a1985Sdrh       }
4393cce7d176Sdrh       break;
4394cce7d176Sdrh     }
4395cce7d176Sdrh   }
43962dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
43972dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4398cce7d176Sdrh }
43992282792aSdrh 
44002282792aSdrh /*
440172bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
440272bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
440372bc8208Sdrh ** ensures that the original pExpr is unchanged.
440472bc8208Sdrh */
440572bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
440672bc8208Sdrh   sqlite3 *db = pParse->db;
440772bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
440872bc8208Sdrh   if( db->mallocFailed==0 ){
440972bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
441072bc8208Sdrh   }
441172bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
441272bc8208Sdrh }
441372bc8208Sdrh 
441472bc8208Sdrh 
441572bc8208Sdrh /*
44161d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
44171d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
44181d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
44191d9da70aSdrh ** other than the top-level COLLATE operator.
4420d40aab0eSdrh **
4421619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4422619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4423619a1305Sdrh **
442466518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
442566518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
442666518ca7Sdrh **
44271d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4428d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
44291d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
44301d9da70aSdrh ** returns 2, then you do not really know for certain if the two
44311d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4432d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
44331d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4434d40aab0eSdrh ** just might result in some slightly slower code.  But returning
44351d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
44362282792aSdrh */
4437619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
443810d1edf0Sdrh   u32 combinedFlags;
44394b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
44401d9da70aSdrh     return pB==pA ? 0 : 2;
44412282792aSdrh   }
444210d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
444310d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
444410d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
444510d1edf0Sdrh       return 0;
444610d1edf0Sdrh     }
44471d9da70aSdrh     return 2;
44486ab3a2ecSdanielk1977   }
4449c2acc4e4Sdrh   if( pA->op!=pB->op ){
4450619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
4451ae80ddeaSdrh       return 1;
4452ae80ddeaSdrh     }
4453619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
4454ae80ddeaSdrh       return 1;
4455ae80ddeaSdrh     }
4456ae80ddeaSdrh     return 2;
4457ae80ddeaSdrh   }
44582edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4459390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4460390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4461390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
446210d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
446310d1edf0Sdrh     }
446410d1edf0Sdrh   }
446510d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
446685f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
446710d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4468619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
4469619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
4470619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
44717693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4472619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
447366518ca7Sdrh       if( pA->iTable!=pB->iTable
447485f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
44751d9da70aSdrh     }
44761d9da70aSdrh   }
44772646da7eSdrh   return 0;
44782646da7eSdrh }
44792282792aSdrh 
44808c6f666bSdrh /*
44818c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
44828c6f666bSdrh ** non-zero if they differ in any way.
44838c6f666bSdrh **
4484619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4485619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4486619a1305Sdrh **
44878c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
44888c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
44898c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
44908c6f666bSdrh ** a malfunction will result.
44918c6f666bSdrh **
44928c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
44938c6f666bSdrh ** always differs from a non-NULL pointer.
44948c6f666bSdrh */
4495619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
44968c6f666bSdrh   int i;
44978c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
44988c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
44998c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
45008c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
45018c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
45028c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
45038c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
4504619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
45058c6f666bSdrh   }
45068c6f666bSdrh   return 0;
45078c6f666bSdrh }
450813449892Sdrh 
45092282792aSdrh /*
45104bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
45114bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
45124bd5f73fSdrh ** be false.  Examples:
45134bd5f73fSdrh **
4514619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
45154bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4516619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
45174bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4518619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4519619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4520619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
45214bd5f73fSdrh **
45224bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
45234bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
45244bd5f73fSdrh **
45254bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
45264bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
45274bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
45284bd5f73fSdrh */
45294bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
4530619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
4531619a1305Sdrh     return 1;
4532619a1305Sdrh   }
4533619a1305Sdrh   if( pE2->op==TK_OR
4534619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
4535619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
4536619a1305Sdrh   ){
4537619a1305Sdrh     return 1;
4538619a1305Sdrh   }
4539619a1305Sdrh   if( pE2->op==TK_NOTNULL
4540619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
4541619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
4542619a1305Sdrh   ){
4543619a1305Sdrh     return 1;
4544619a1305Sdrh   }
4545619a1305Sdrh   return 0;
45464bd5f73fSdrh }
45474bd5f73fSdrh 
45484bd5f73fSdrh /*
4549030796dfSdrh ** An instance of the following structure is used by the tree walker
45502409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
45512409f8a1Sdrh ** index only, without having to do a search for the corresponding
45522409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
45532409f8a1Sdrh ** is the cursor for the table.
45542409f8a1Sdrh */
45552409f8a1Sdrh struct IdxCover {
45562409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
45572409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
45582409f8a1Sdrh };
45592409f8a1Sdrh 
45602409f8a1Sdrh /*
45612409f8a1Sdrh ** Check to see if there are references to columns in table
45622409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
45632409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
45642409f8a1Sdrh */
45652409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
45662409f8a1Sdrh   if( pExpr->op==TK_COLUMN
45672409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
45682409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
45692409f8a1Sdrh   ){
45702409f8a1Sdrh     pWalker->eCode = 1;
45712409f8a1Sdrh     return WRC_Abort;
45722409f8a1Sdrh   }
45732409f8a1Sdrh   return WRC_Continue;
45742409f8a1Sdrh }
45752409f8a1Sdrh 
45762409f8a1Sdrh /*
4577e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4578e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4579e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4580e604ec0bSdrh ** that are not found in the index pIdx.
45812409f8a1Sdrh **
45822409f8a1Sdrh ** An index covering an expression means that the expression can be
45832409f8a1Sdrh ** evaluated using only the index and without having to lookup the
45842409f8a1Sdrh ** corresponding table entry.
45852409f8a1Sdrh */
45862409f8a1Sdrh int sqlite3ExprCoveredByIndex(
45872409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
45882409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
45892409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
45902409f8a1Sdrh ){
45912409f8a1Sdrh   Walker w;
45922409f8a1Sdrh   struct IdxCover xcov;
45932409f8a1Sdrh   memset(&w, 0, sizeof(w));
45942409f8a1Sdrh   xcov.iCur = iCur;
45952409f8a1Sdrh   xcov.pIdx = pIdx;
45962409f8a1Sdrh   w.xExprCallback = exprIdxCover;
45972409f8a1Sdrh   w.u.pIdxCover = &xcov;
45982409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
45992409f8a1Sdrh   return !w.eCode;
46002409f8a1Sdrh }
46012409f8a1Sdrh 
46022409f8a1Sdrh 
46032409f8a1Sdrh /*
46042409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4605030796dfSdrh ** to count references to table columns in the arguments of an
4606ed551b95Sdrh ** aggregate function, in order to implement the
4607ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4608374fdce4Sdrh */
4609030796dfSdrh struct SrcCount {
4610030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4611030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4612030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4613030796dfSdrh };
4614030796dfSdrh 
4615030796dfSdrh /*
4616030796dfSdrh ** Count the number of references to columns.
4617030796dfSdrh */
4618030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4619fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4620fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4621fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4622fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4623fb0a6081Sdrh   ** NEVER() will need to be removed. */
4624fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4625374fdce4Sdrh     int i;
4626030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4627030796dfSdrh     SrcList *pSrc = p->pSrc;
4628655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4629655814d2Sdrh     for(i=0; i<nSrc; i++){
4630030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4631374fdce4Sdrh     }
4632655814d2Sdrh     if( i<nSrc ){
4633030796dfSdrh       p->nThis++;
4634374fdce4Sdrh     }else{
4635030796dfSdrh       p->nOther++;
4636374fdce4Sdrh     }
4637374fdce4Sdrh   }
4638030796dfSdrh   return WRC_Continue;
4639030796dfSdrh }
4640374fdce4Sdrh 
4641374fdce4Sdrh /*
4642030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4643030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4644030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4645030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4646374fdce4Sdrh */
4647030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4648374fdce4Sdrh   Walker w;
4649030796dfSdrh   struct SrcCount cnt;
4650374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4651374fdce4Sdrh   memset(&w, 0, sizeof(w));
4652030796dfSdrh   w.xExprCallback = exprSrcCount;
4653030796dfSdrh   w.u.pSrcCount = &cnt;
4654030796dfSdrh   cnt.pSrc = pSrcList;
4655030796dfSdrh   cnt.nThis = 0;
4656030796dfSdrh   cnt.nOther = 0;
4657030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4658030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4659374fdce4Sdrh }
4660374fdce4Sdrh 
4661374fdce4Sdrh /*
466213449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
466313449892Sdrh ** the new element.  Return a negative number if malloc fails.
46642282792aSdrh */
466517435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
466613449892Sdrh   int i;
4667cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
466817435752Sdrh        db,
4669cf643729Sdrh        pInfo->aCol,
4670cf643729Sdrh        sizeof(pInfo->aCol[0]),
4671cf643729Sdrh        &pInfo->nColumn,
4672cf643729Sdrh        &i
4673cf643729Sdrh   );
467413449892Sdrh   return i;
46752282792aSdrh }
467613449892Sdrh 
467713449892Sdrh /*
467813449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
467913449892Sdrh ** the new element.  Return a negative number if malloc fails.
468013449892Sdrh */
468117435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
468213449892Sdrh   int i;
4683cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
468417435752Sdrh        db,
4685cf643729Sdrh        pInfo->aFunc,
4686cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4687cf643729Sdrh        &pInfo->nFunc,
4688cf643729Sdrh        &i
4689cf643729Sdrh   );
469013449892Sdrh   return i;
46912282792aSdrh }
46922282792aSdrh 
46932282792aSdrh /*
46947d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
46957d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4696626a879aSdrh ** for additional information.
46972282792aSdrh */
46987d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
46992282792aSdrh   int i;
47007d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4701a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4702a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
470313449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
470413449892Sdrh 
47052282792aSdrh   switch( pExpr->op ){
470689c69d00Sdrh     case TK_AGG_COLUMN:
4707967e8b73Sdrh     case TK_COLUMN: {
47088b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
47098b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
471013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
471113449892Sdrh       ** clause of the aggregate query */
471220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
471313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
471413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
471513449892Sdrh           struct AggInfo_col *pCol;
4716c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
471713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
471813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
471913449892Sdrh             ** that is in the FROM clause of the aggregate query.
472013449892Sdrh             **
472113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
472213449892Sdrh             ** is not an entry there already.
472313449892Sdrh             */
47247f906d63Sdrh             int k;
472513449892Sdrh             pCol = pAggInfo->aCol;
47267f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
472713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
472813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
47292282792aSdrh                 break;
47302282792aSdrh               }
47312282792aSdrh             }
47321e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
47331e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
47341e536953Sdanielk1977             ){
47357f906d63Sdrh               pCol = &pAggInfo->aCol[k];
47360817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
473713449892Sdrh               pCol->iTable = pExpr->iTable;
473813449892Sdrh               pCol->iColumn = pExpr->iColumn;
47390a07c107Sdrh               pCol->iMem = ++pParse->nMem;
474013449892Sdrh               pCol->iSorterColumn = -1;
47415774b806Sdrh               pCol->pExpr = pExpr;
474213449892Sdrh               if( pAggInfo->pGroupBy ){
474313449892Sdrh                 int j, n;
474413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
474513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
474613449892Sdrh                 n = pGB->nExpr;
474713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
474813449892Sdrh                   Expr *pE = pTerm->pExpr;
474913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
475013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
475113449892Sdrh                     pCol->iSorterColumn = j;
475213449892Sdrh                     break;
47532282792aSdrh                   }
475413449892Sdrh                 }
475513449892Sdrh               }
475613449892Sdrh               if( pCol->iSorterColumn<0 ){
475713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
475813449892Sdrh               }
475913449892Sdrh             }
476013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
476113449892Sdrh             ** because it was there before or because we just created it).
476213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
476313449892Sdrh             ** pAggInfo->aCol[] entry.
476413449892Sdrh             */
4765ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
476613449892Sdrh             pExpr->pAggInfo = pAggInfo;
476713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4768cf697396Sshane             pExpr->iAgg = (i16)k;
476913449892Sdrh             break;
477013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
477113449892Sdrh         } /* end loop over pSrcList */
4772a58fdfb1Sdanielk1977       }
47737d10d5a6Sdrh       return WRC_Prune;
47742282792aSdrh     }
47752282792aSdrh     case TK_AGG_FUNCTION: {
47763a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4777ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
47783a8c4be7Sdrh       ){
477913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
478013449892Sdrh         ** function that is already in the pAggInfo structure
478113449892Sdrh         */
478213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
478313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4784619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
47852282792aSdrh             break;
47862282792aSdrh           }
47872282792aSdrh         }
478813449892Sdrh         if( i>=pAggInfo->nFunc ){
478913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
479013449892Sdrh           */
479114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
47921e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
479313449892Sdrh           if( i>=0 ){
47946ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
479513449892Sdrh             pItem = &pAggInfo->aFunc[i];
479613449892Sdrh             pItem->pExpr = pExpr;
47970a07c107Sdrh             pItem->iMem = ++pParse->nMem;
479833e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
479913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
480080738d9cSdrh                    pExpr->u.zToken,
48016ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4802fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4803fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4804fd357974Sdrh             }else{
4805fd357974Sdrh               pItem->iDistinct = -1;
4806fd357974Sdrh             }
48072282792aSdrh           }
480813449892Sdrh         }
480913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
481013449892Sdrh         */
4811c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4812ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4813cf697396Sshane         pExpr->iAgg = (i16)i;
481413449892Sdrh         pExpr->pAggInfo = pAggInfo;
48153a8c4be7Sdrh         return WRC_Prune;
48166e83a57fSdrh       }else{
48176e83a57fSdrh         return WRC_Continue;
48186e83a57fSdrh       }
48192282792aSdrh     }
4820a58fdfb1Sdanielk1977   }
48217d10d5a6Sdrh   return WRC_Continue;
48227d10d5a6Sdrh }
48237d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4824d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4825d5a336efSdrh   UNUSED_PARAMETER(pSelect);
48267d10d5a6Sdrh   return WRC_Continue;
4827a58fdfb1Sdanielk1977 }
4828626a879aSdrh 
4829626a879aSdrh /*
4830e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4831e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4832e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4833e8abb4caSdrh ** necessary.
4834626a879aSdrh **
4835626a879aSdrh ** This routine should only be called after the expression has been
48367d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4837626a879aSdrh */
4838d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
48397d10d5a6Sdrh   Walker w;
4840374fdce4Sdrh   memset(&w, 0, sizeof(w));
48417d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
48427d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
48437d10d5a6Sdrh   w.u.pNC = pNC;
484420bc393cSdrh   assert( pNC->pSrcList!=0 );
48457d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
48462282792aSdrh }
48475d9a4af9Sdrh 
48485d9a4af9Sdrh /*
48495d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
48505d9a4af9Sdrh ** expression list.  Return the number of errors.
48515d9a4af9Sdrh **
48525d9a4af9Sdrh ** If an error is found, the analysis is cut short.
48535d9a4af9Sdrh */
4854d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
48555d9a4af9Sdrh   struct ExprList_item *pItem;
48565d9a4af9Sdrh   int i;
48575d9a4af9Sdrh   if( pList ){
4858d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4859d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
48605d9a4af9Sdrh     }
48615d9a4af9Sdrh   }
48625d9a4af9Sdrh }
4863892d3179Sdrh 
4864892d3179Sdrh /*
4865ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4866892d3179Sdrh */
4867892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4868e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4869892d3179Sdrh     return ++pParse->nMem;
4870892d3179Sdrh   }
48712f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4872892d3179Sdrh }
4873ceea3321Sdrh 
4874ceea3321Sdrh /*
4875ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4876ceea3321Sdrh ** purpose.
4877ceea3321Sdrh **
4878ceea3321Sdrh ** If a register is currently being used by the column cache, then
487960ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4880ceea3321Sdrh ** the register becomes stale.
4881ceea3321Sdrh */
4882892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
48832dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4884ceea3321Sdrh     int i;
4885ceea3321Sdrh     struct yColCache *p;
4886ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4887ceea3321Sdrh       if( p->iReg==iReg ){
4888ceea3321Sdrh         p->tempReg = 1;
4889ceea3321Sdrh         return;
4890ceea3321Sdrh       }
4891ceea3321Sdrh     }
4892892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4893892d3179Sdrh   }
4894892d3179Sdrh }
4895892d3179Sdrh 
4896892d3179Sdrh /*
4897892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4898892d3179Sdrh */
4899892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4900e55cbd72Sdrh   int i, n;
4901892d3179Sdrh   i = pParse->iRangeReg;
4902e55cbd72Sdrh   n = pParse->nRangeReg;
4903f49f3523Sdrh   if( nReg<=n ){
4904f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4905892d3179Sdrh     pParse->iRangeReg += nReg;
4906892d3179Sdrh     pParse->nRangeReg -= nReg;
4907892d3179Sdrh   }else{
4908892d3179Sdrh     i = pParse->nMem+1;
4909892d3179Sdrh     pParse->nMem += nReg;
4910892d3179Sdrh   }
4911892d3179Sdrh   return i;
4912892d3179Sdrh }
4913892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4914f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4915892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4916892d3179Sdrh     pParse->nRangeReg = nReg;
4917892d3179Sdrh     pParse->iRangeReg = iReg;
4918892d3179Sdrh   }
4919892d3179Sdrh }
4920cdc69557Sdrh 
4921cdc69557Sdrh /*
4922cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4923cdc69557Sdrh */
4924cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4925cdc69557Sdrh   pParse->nTempReg = 0;
4926cdc69557Sdrh   pParse->nRangeReg = 0;
4927cdc69557Sdrh }
4928bb9b5f26Sdrh 
4929bb9b5f26Sdrh /*
4930bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
4931bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
4932bb9b5f26Sdrh ** statements.
4933bb9b5f26Sdrh */
4934bb9b5f26Sdrh #ifdef SQLITE_DEBUG
4935bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
4936bb9b5f26Sdrh   int i;
4937bb9b5f26Sdrh   if( pParse->nRangeReg>0
4938bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
4939bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
4940bb9b5f26Sdrh   ){
4941bb9b5f26Sdrh      return 0;
4942bb9b5f26Sdrh   }
4943bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
4944bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
4945bb9b5f26Sdrh       return 0;
4946bb9b5f26Sdrh     }
4947bb9b5f26Sdrh   }
4948bb9b5f26Sdrh   return 1;
4949bb9b5f26Sdrh }
4950bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
4951