xref: /sqlite-3.40.0/src/expr.c (revision 9b40d13f)
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 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
47580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
489bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
49580c8c18Sdrh   op = pExpr->op;
50487e262fSdrh   if( op==TK_SELECT ){
516ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
526ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
53a37cdde0Sdanielk1977   }
54db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
55487e262fSdrh #ifndef SQLITE_OMIT_CAST
56487e262fSdrh   if( op==TK_CAST ){
5733e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
58fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
59487e262fSdrh   }
60487e262fSdrh #endif
61a28f85b0Sdrh   if( op==TK_AGG_COLUMN || op==TK_COLUMN ){
620dfa4f6fSdrh     return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
127ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
128ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
129ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
130ae80ddeaSdrh ** precedence over right operands.
1310202b29eSdanielk1977 */
1327cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
133ae80ddeaSdrh   sqlite3 *db = pParse->db;
1347cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1357d10d5a6Sdrh   Expr *p = pExpr;
136261d8a51Sdrh   while( p ){
137ae80ddeaSdrh     int op = p->op;
138fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
139ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
140ae80ddeaSdrh       p = p->pLeft;
141ae80ddeaSdrh       continue;
142ae80ddeaSdrh     }
14336e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1447a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
145ae80ddeaSdrh       break;
146ae80ddeaSdrh     }
147a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
148ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
149a58d4a96Sdrh      && p->pTab!=0
150ae80ddeaSdrh     ){
1517d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1527d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1537d10d5a6Sdrh       int j = p->iColumn;
1547d10d5a6Sdrh       if( j>=0 ){
155ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
156c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1570202b29eSdanielk1977       }
1587d10d5a6Sdrh       break;
1597d10d5a6Sdrh     }
160ae80ddeaSdrh     if( p->flags & EP_Collate ){
1612308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1627d10d5a6Sdrh         p = p->pLeft;
163ae80ddeaSdrh       }else{
1642308ed38Sdrh         Expr *pNext  = p->pRight;
1656728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1666728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1676728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1686728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1696728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1706728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1712308ed38Sdrh           int i;
1726728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1732308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1742308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1752308ed38Sdrh               break;
1762308ed38Sdrh             }
1772308ed38Sdrh           }
1782308ed38Sdrh         }
1792308ed38Sdrh         p = pNext;
180ae80ddeaSdrh       }
181ae80ddeaSdrh     }else{
182ae80ddeaSdrh       break;
183ae80ddeaSdrh     }
1840202b29eSdanielk1977   }
1857cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1867cedc8d4Sdanielk1977     pColl = 0;
1877cedc8d4Sdanielk1977   }
1887cedc8d4Sdanielk1977   return pColl;
1890202b29eSdanielk1977 }
1900202b29eSdanielk1977 
1910202b29eSdanielk1977 /*
192626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
193626a879aSdrh ** type affinity of the other operand.  This routine returns the
19453db1458Sdrh ** type affinity that should be used for the comparison operator.
19553db1458Sdrh */
196e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
197bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
198e014a838Sdanielk1977   if( aff1 && aff2 ){
1998df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2008df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
201e014a838Sdanielk1977     */
2028a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
203e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
204e014a838Sdanielk1977     }else{
20505883a34Sdrh       return SQLITE_AFF_BLOB;
206e014a838Sdanielk1977     }
207e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2085f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2095f6a87b3Sdrh     ** results directly.
210e014a838Sdanielk1977     */
21105883a34Sdrh     return SQLITE_AFF_BLOB;
212e014a838Sdanielk1977   }else{
213e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
214fe05af87Sdrh     assert( aff1==0 || aff2==0 );
215e014a838Sdanielk1977     return (aff1 + aff2);
216e014a838Sdanielk1977   }
217e014a838Sdanielk1977 }
218e014a838Sdanielk1977 
21953db1458Sdrh /*
22053db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
22153db1458Sdrh ** be applied to both operands prior to doing the comparison.
22253db1458Sdrh */
223e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
224e014a838Sdanielk1977   char aff;
225e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
226e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2276a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
228e014a838Sdanielk1977   assert( pExpr->pLeft );
229bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
230e014a838Sdanielk1977   if( pExpr->pRight ){
231e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2326ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2336ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
234d0b67a86Sdrh   }else if( NEVER(aff==0) ){
23505883a34Sdrh     aff = SQLITE_AFF_BLOB;
236e014a838Sdanielk1977   }
237e014a838Sdanielk1977   return aff;
238e014a838Sdanielk1977 }
239e014a838Sdanielk1977 
240e014a838Sdanielk1977 /*
241e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
242e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
243e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
244e014a838Sdanielk1977 ** the comparison in pExpr.
245e014a838Sdanielk1977 */
246e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
247e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2488a51256cSdrh   switch( aff ){
24905883a34Sdrh     case SQLITE_AFF_BLOB:
2508a51256cSdrh       return 1;
2518a51256cSdrh     case SQLITE_AFF_TEXT:
2528a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2538a51256cSdrh     default:
2548a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2558a51256cSdrh   }
256e014a838Sdanielk1977 }
257e014a838Sdanielk1977 
258a37cdde0Sdanielk1977 /*
25935573356Sdrh ** Return the P5 value that should be used for a binary comparison
260a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
261a37cdde0Sdanielk1977 */
26235573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
26335573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2641bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
26535573356Sdrh   return aff;
266a37cdde0Sdanielk1977 }
267a37cdde0Sdanielk1977 
268a2e00042Sdrh /*
2690202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2700202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2710202b29eSdanielk1977 **
2720202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2730202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2740202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2750202b29eSdanielk1977 ** type.
276bcbb04e5Sdanielk1977 **
277bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
278bcbb04e5Sdanielk1977 ** it is not considered.
2790202b29eSdanielk1977 */
280bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
281bcbb04e5Sdanielk1977   Parse *pParse,
282bcbb04e5Sdanielk1977   Expr *pLeft,
283bcbb04e5Sdanielk1977   Expr *pRight
284bcbb04e5Sdanielk1977 ){
285ec41ddacSdrh   CollSeq *pColl;
286ec41ddacSdrh   assert( pLeft );
287ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
288ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
289ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
290ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
291ec41ddacSdrh   }else{
292ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2930202b29eSdanielk1977     if( !pColl ){
2947cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2950202b29eSdanielk1977     }
296ec41ddacSdrh   }
2970202b29eSdanielk1977   return pColl;
2980202b29eSdanielk1977 }
2990202b29eSdanielk1977 
3000202b29eSdanielk1977 /*
301be5c89acSdrh ** Generate code for a comparison operator.
302be5c89acSdrh */
303be5c89acSdrh static int codeCompare(
304be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
305be5c89acSdrh   Expr *pLeft,      /* The left operand */
306be5c89acSdrh   Expr *pRight,     /* The right operand */
307be5c89acSdrh   int opcode,       /* The comparison opcode */
30835573356Sdrh   int in1, int in2, /* Register holding operands */
309be5c89acSdrh   int dest,         /* Jump here if true.  */
310be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
311be5c89acSdrh ){
31235573356Sdrh   int p5;
31335573356Sdrh   int addr;
31435573356Sdrh   CollSeq *p4;
31535573356Sdrh 
31635573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
31735573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
31835573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
31935573356Sdrh                            (void*)p4, P4_COLLSEQ);
3201bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
32135573356Sdrh   return addr;
322be5c89acSdrh }
323be5c89acSdrh 
324cfbb5e82Sdan /*
325870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
326d832da7fSdrh **
327d832da7fSdrh ** A vector is defined as any expression that results in two or more
328d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
329d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
330d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
331d832da7fSdrh ** considered a vector if it has two or more result columns.
332870a0705Sdan */
333870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
33476dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
335870a0705Sdan }
336870a0705Sdan 
337870a0705Sdan /*
338cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
339cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
340cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
341cfbb5e82Sdan ** any other type of expression, return 1.
342cfbb5e82Sdan */
34371c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
34412abf408Sdrh   u8 op = pExpr->op;
34512abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
34612abf408Sdrh   if( op==TK_VECTOR ){
34771c57db0Sdan     return pExpr->x.pList->nExpr;
34812abf408Sdrh   }else if( op==TK_SELECT ){
34976dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
35076dbe7a8Sdrh   }else{
35176dbe7a8Sdrh     return 1;
35276dbe7a8Sdrh   }
35371c57db0Sdan }
35471c57db0Sdan 
355f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
356ba00e30aSdan /*
357fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
358fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
359fc7f27b9Sdrh ** ensure that i is within range.
360fc7f27b9Sdrh **
36176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
36276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
36376dbe7a8Sdrh **
364fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
365fc7f27b9Sdrh **
366fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
36776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
36876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
36976dbe7a8Sdrh ** been positioned.
370ba00e30aSdan */
371fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
372870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
373870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
3749f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
3759f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
37671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
377870a0705Sdan     }else{
37871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
37971c57db0Sdan     }
380870a0705Sdan   }
381870a0705Sdan   return pVector;
382870a0705Sdan }
383fc7f27b9Sdrh #endif /* !defined(SQLITE_OMIT_SUBQUERY) */
384fc7f27b9Sdrh 
385fc7f27b9Sdrh #ifndef SQLITE_OMIT_SUBQUERY
386fc7f27b9Sdrh /*
387fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
388fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
389fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
390fc7f27b9Sdrh **
3918762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
3928762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
3938762ec19Sdrh **
394fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
395fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
396fc7f27b9Sdrh **
3978762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
398fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
3998762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4008762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
40176dbe7a8Sdrh ** returns.
4028762ec19Sdrh **
4038762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4048762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4058762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
406fc7f27b9Sdrh */
407fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
408fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
409fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
410a1251bc4Sdrh   int iField           /* Which column of the vector to return */
411fc7f27b9Sdrh ){
412fc7f27b9Sdrh   Expr *pRet;
413a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
414a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
415fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
416fc7f27b9Sdrh     **
417fc7f27b9Sdrh     ** pLeft:           pVector containing TK_SELECT
4188762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
419fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
420fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
421fc7f27b9Sdrh     **                  if the result is not yet computed.
422fc7f27b9Sdrh     **
423fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
424fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4258762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4268762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4278762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4288762ec19Sdrh     ** will own the pVector.
429fc7f27b9Sdrh     */
4308bd0d58eSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0, 0);
4318bd0d58eSdrh     if( pRet ){
4328bd0d58eSdrh       pRet->iColumn = iField;
4338bd0d58eSdrh       pRet->pLeft = pVector;
4348bd0d58eSdrh     }
435fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
436fc7f27b9Sdrh   }else{
437a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
438a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
439fc7f27b9Sdrh   }
440fc7f27b9Sdrh   return pRet;
441fc7f27b9Sdrh }
442fc7f27b9Sdrh #endif /* !define(SQLITE_OMIT_SUBQUERY) */
44371c57db0Sdan 
4445c288b92Sdan /*
4455c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4465c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4475c288b92Sdan ** sub-select returns more than one column, the first in an array
4485c288b92Sdan ** of registers in which the result is stored).
4495c288b92Sdan **
4505c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4515c288b92Sdan */
4525c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4538da209b1Sdan   int reg = 0;
454f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4555c288b92Sdan   if( pExpr->op==TK_SELECT ){
4568da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4578da209b1Sdan   }
458f9b2e05cSdan #endif
4598da209b1Sdan   return reg;
4608da209b1Sdan }
4618da209b1Sdan 
4625c288b92Sdan /*
4635c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
464870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
465870a0705Sdan ** the register number of a register that contains the value of
466870a0705Sdan ** element iField of the vector.
467870a0705Sdan **
468870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
469870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
470870a0705Sdan ** case parameter regSelect should be the first in an array of registers
471870a0705Sdan ** containing the results of the sub-select.
472870a0705Sdan **
473870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
474870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
475870a0705Sdan ** a temporary register to be freed by the caller before returning.
4765c288b92Sdan **
4775c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
4785c288b92Sdan ** Expr object corresponding to element iElem of the vector.
4795c288b92Sdan */
4805c288b92Sdan static int exprVectorRegister(
4815c288b92Sdan   Parse *pParse,                  /* Parse context */
4825c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
483870a0705Sdan   int iField,                     /* Field to extract from pVector */
4845c288b92Sdan   int regSelect,                  /* First in array of registers */
4855c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
4865c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
4875c288b92Sdan ){
48812abf408Sdrh   u8 op = pVector->op;
489c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
49012abf408Sdrh   if( op==TK_REGISTER ){
49112abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
49212abf408Sdrh     return pVector->iTable+iField;
49312abf408Sdrh   }
49412abf408Sdrh   if( op==TK_SELECT ){
495870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
496870a0705Sdan      return regSelect+iField;
4975c288b92Sdan   }
498870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
4995c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5005c288b92Sdan }
5015c288b92Sdan 
5025c288b92Sdan /*
5035c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
50479752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
50579752b6eSdrh ** result into register dest.
50679752b6eSdrh **
50779752b6eSdrh ** The caller must satisfy the following preconditions:
50879752b6eSdrh **
50979752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
51079752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
51179752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5125c288b92Sdan */
51379752b6eSdrh static void codeVectorCompare(
51479752b6eSdrh   Parse *pParse,        /* Code generator context */
51579752b6eSdrh   Expr *pExpr,          /* The comparison operation */
51679752b6eSdrh   int dest,             /* Write results into this register */
51779752b6eSdrh   u8 op,                /* Comparison operator */
51879752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
51979752b6eSdrh ){
52071c57db0Sdan   Vdbe *v = pParse->pVdbe;
52171c57db0Sdan   Expr *pLeft = pExpr->pLeft;
52271c57db0Sdan   Expr *pRight = pExpr->pRight;
52371c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
52471c57db0Sdan   int i;
52571c57db0Sdan   int regLeft = 0;
52671c57db0Sdan   int regRight = 0;
52779752b6eSdrh   u8 opx = op;
52879752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
52971c57db0Sdan 
530b29e60c4Sdrh   assert( nLeft==sqlite3ExprVectorSize(pRight) );
53171c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
53271c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
53371c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
53471c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
53571c57db0Sdan   );
53679752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
53779752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
53879752b6eSdrh   assert( p5==0 || pExpr->op!=op );
53979752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
54071c57db0Sdan 
54179752b6eSdrh   p5 |= SQLITE_STOREP2;
54279752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
54379752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5445c288b92Sdan 
5455c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5465c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5475c288b92Sdan 
548321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5495c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5505c288b92Sdan     Expr *pL, *pR;
5515c288b92Sdan     int r1, r2;
552321e828dSdrh     assert( i>=0 && i<nLeft );
55379752b6eSdrh     if( i>0 ) sqlite3ExprCachePush(pParse);
5545c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5555c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
55679752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
55779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
55879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
55979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
56079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
56179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
56279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
56371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
56471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
56579752b6eSdrh     if( i>0 ) sqlite3ExprCachePop(pParse);
56679752b6eSdrh     if( i==nLeft-1 ){
56779752b6eSdrh       break;
56871c57db0Sdan     }
56979752b6eSdrh     if( opx==TK_EQ ){
57079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
57179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
57279752b6eSdrh     }else if( opx==TK_NE ){
57379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
57479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
575a2f62925Sdrh     }else{
576a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
577a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
57879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
57979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
58079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
58179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
58279752b6eSdrh       if( i==nLeft-2 ) opx = op;
58371c57db0Sdan     }
58479752b6eSdrh   }
58579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
58679752b6eSdrh }
58771c57db0Sdan 
5884b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
5894b5255acSdanielk1977 /*
5904b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
5914b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
5924b5255acSdanielk1977 ** pParse.
5934b5255acSdanielk1977 */
5947d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
5954b5255acSdanielk1977   int rc = SQLITE_OK;
5964b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
5974b5255acSdanielk1977   if( nHeight>mxHeight ){
5984b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
5994b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6004b5255acSdanielk1977     );
6014b5255acSdanielk1977     rc = SQLITE_ERROR;
6024b5255acSdanielk1977   }
6034b5255acSdanielk1977   return rc;
6044b5255acSdanielk1977 }
6054b5255acSdanielk1977 
6064b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6074b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6084b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6094b5255acSdanielk1977 ** first argument.
6104b5255acSdanielk1977 **
6114b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6124b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6134b5255acSdanielk1977 ** value.
6144b5255acSdanielk1977 */
6154b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6164b5255acSdanielk1977   if( p ){
6174b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6184b5255acSdanielk1977       *pnHeight = p->nHeight;
6194b5255acSdanielk1977     }
6204b5255acSdanielk1977   }
6214b5255acSdanielk1977 }
6224b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6234b5255acSdanielk1977   if( p ){
6244b5255acSdanielk1977     int i;
6254b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6264b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6274b5255acSdanielk1977     }
6284b5255acSdanielk1977   }
6294b5255acSdanielk1977 }
6304b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
6314b5255acSdanielk1977   if( p ){
6324b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6334b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6344b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6354b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
6364b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6374b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6384b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6394b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
6404b5255acSdanielk1977   }
6414b5255acSdanielk1977 }
6424b5255acSdanielk1977 
6434b5255acSdanielk1977 /*
6444b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6454b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6464b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6474b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6484b5255acSdanielk1977 ** referenced Expr plus one.
6492308ed38Sdrh **
6502308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6512308ed38Sdrh ** if appropriate.
6524b5255acSdanielk1977 */
6534b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6544b5255acSdanielk1977   int nHeight = 0;
6554b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6564b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6576ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6586ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6592308ed38Sdrh   }else if( p->x.pList ){
6606ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6612308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6626ab3a2ecSdanielk1977   }
6634b5255acSdanielk1977   p->nHeight = nHeight + 1;
6644b5255acSdanielk1977 }
6654b5255acSdanielk1977 
6664b5255acSdanielk1977 /*
6674b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6684b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6694b5255acSdanielk1977 ** leave an error in pParse.
6702308ed38Sdrh **
6712308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
6722308ed38Sdrh ** Expr.flags.
6734b5255acSdanielk1977 */
6742308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
67574893a4cSdrh   if( pParse->nErr ) return;
6764b5255acSdanielk1977   exprSetHeight(p);
6777d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
6784b5255acSdanielk1977 }
6794b5255acSdanielk1977 
6804b5255acSdanielk1977 /*
6814b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
6824b5255acSdanielk1977 ** by the select statement passed as an argument.
6834b5255acSdanielk1977 */
6844b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
6854b5255acSdanielk1977   int nHeight = 0;
6864b5255acSdanielk1977   heightOfSelect(p, &nHeight);
6874b5255acSdanielk1977   return nHeight;
6884b5255acSdanielk1977 }
6892308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
6902308ed38Sdrh /*
6912308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
6922308ed38Sdrh ** Expr.flags.
6932308ed38Sdrh */
6942308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
6952308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
6962308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6972308ed38Sdrh   }
6982308ed38Sdrh }
6994b5255acSdanielk1977 #define exprSetHeight(y)
7004b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7014b5255acSdanielk1977 
702be5c89acSdrh /*
703b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
704b7916a78Sdrh **
705a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
706b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
707b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
708a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
709b7916a78Sdrh **
710b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
711e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
712b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
713b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
714b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
71533e619fcSdrh **
71633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
71733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
71833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
71933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
72033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
721a76b5dfcSdrh */
722b7916a78Sdrh Expr *sqlite3ExprAlloc(
723a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
72417435752Sdrh   int op,                 /* Expression opcode */
725b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
726b7916a78Sdrh   int dequote             /* True to dequote */
72717435752Sdrh ){
728a76b5dfcSdrh   Expr *pNew;
72933e619fcSdrh   int nExtra = 0;
730cf697396Sshane   int iValue = 0;
731b7916a78Sdrh 
732575fad65Sdrh   assert( db!=0 );
733b7916a78Sdrh   if( pToken ){
73433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
73533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
736b7916a78Sdrh       nExtra = pToken->n+1;
737d50ffc41Sdrh       assert( iValue>=0 );
73833e619fcSdrh     }
739a76b5dfcSdrh   }
740575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
741b7916a78Sdrh   if( pNew ){
742ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7431bd10f8aSdrh     pNew->op = (u8)op;
744a58fdfb1Sdanielk1977     pNew->iAgg = -1;
745a76b5dfcSdrh     if( pToken ){
74633e619fcSdrh       if( nExtra==0 ){
74733e619fcSdrh         pNew->flags |= EP_IntValue;
74833e619fcSdrh         pNew->u.iValue = iValue;
74933e619fcSdrh       }else{
75033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
751b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
752b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
75333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
754244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
755244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
75633e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
757a34001c9Sdrh         }
758a34001c9Sdrh       }
75933e619fcSdrh     }
760b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
761b7916a78Sdrh     pNew->nHeight = 1;
762b7916a78Sdrh #endif
763a34001c9Sdrh   }
764a76b5dfcSdrh   return pNew;
765a76b5dfcSdrh }
766a76b5dfcSdrh 
767a76b5dfcSdrh /*
768b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
769b7916a78Sdrh ** already been dequoted.
770b7916a78Sdrh */
771b7916a78Sdrh Expr *sqlite3Expr(
772b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
773b7916a78Sdrh   int op,                 /* Expression opcode */
774b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
775b7916a78Sdrh ){
776b7916a78Sdrh   Token x;
777b7916a78Sdrh   x.z = zToken;
778b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
779b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
780b7916a78Sdrh }
781b7916a78Sdrh 
782b7916a78Sdrh /*
783b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
784b7916a78Sdrh **
785b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
786b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
787b7916a78Sdrh */
788b7916a78Sdrh void sqlite3ExprAttachSubtrees(
789b7916a78Sdrh   sqlite3 *db,
790b7916a78Sdrh   Expr *pRoot,
791b7916a78Sdrh   Expr *pLeft,
792b7916a78Sdrh   Expr *pRight
793b7916a78Sdrh ){
794b7916a78Sdrh   if( pRoot==0 ){
795b7916a78Sdrh     assert( db->mallocFailed );
796b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
797b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
798b7916a78Sdrh   }else{
799b7916a78Sdrh     if( pRight ){
800b7916a78Sdrh       pRoot->pRight = pRight;
801885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
802b7916a78Sdrh     }
803b7916a78Sdrh     if( pLeft ){
804b7916a78Sdrh       pRoot->pLeft = pLeft;
805885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
806b7916a78Sdrh     }
807b7916a78Sdrh     exprSetHeight(pRoot);
808b7916a78Sdrh   }
809b7916a78Sdrh }
810b7916a78Sdrh 
811b7916a78Sdrh /*
81260ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
813b7916a78Sdrh **
814bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
815bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
816bf664469Sdrh ** free the subtrees and return NULL.
817206f3d96Sdrh */
81817435752Sdrh Expr *sqlite3PExpr(
81917435752Sdrh   Parse *pParse,          /* Parsing context */
82017435752Sdrh   int op,                 /* Expression opcode */
82117435752Sdrh   Expr *pLeft,            /* Left operand */
82217435752Sdrh   Expr *pRight,           /* Right operand */
82317435752Sdrh   const Token *pToken     /* Argument token */
82417435752Sdrh ){
8255fb52caaSdrh   Expr *p;
8261167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8275fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8285fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8295fb52caaSdrh   }else{
8301167d327Sdrh     p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
831b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8325fb52caaSdrh   }
8332b359bdbSdan   if( p ) {
8342b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8352b359bdbSdan   }
8364e0cff60Sdrh   return p;
8374e0cff60Sdrh }
8384e0cff60Sdrh 
8394e0cff60Sdrh /*
84008de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
84108de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
84208de4f79Sdrh */
84308de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
84408de4f79Sdrh   if( pExpr ){
84508de4f79Sdrh     pExpr->x.pSelect = pSelect;
84608de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
84708de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
84808de4f79Sdrh   }else{
84908de4f79Sdrh     assert( pParse->db->mallocFailed );
85008de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
85108de4f79Sdrh   }
85208de4f79Sdrh }
85308de4f79Sdrh 
85408de4f79Sdrh 
85508de4f79Sdrh /*
856991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
857991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
858991a1985Sdrh ** expression at compile-time return 0.
859991a1985Sdrh **
860991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
861991a1985Sdrh ** the expression really is always false or false (a false negative).
862991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
863991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8645fb52caaSdrh **
8655fb52caaSdrh ** Note that if the expression is part of conditional for a
8665fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8675fb52caaSdrh ** is it true or false, so always return 0.
8685fb52caaSdrh */
869991a1985Sdrh static int exprAlwaysTrue(Expr *p){
870991a1985Sdrh   int v = 0;
871991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
872991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
873991a1985Sdrh   return v!=0;
874991a1985Sdrh }
8755fb52caaSdrh static int exprAlwaysFalse(Expr *p){
8765fb52caaSdrh   int v = 0;
8775fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
8785fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
8795fb52caaSdrh   return v==0;
8805fb52caaSdrh }
8815fb52caaSdrh 
8825fb52caaSdrh /*
88391bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
88491bb0eedSdrh ** NULL, then just return the other expression.
8855fb52caaSdrh **
8865fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8875fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8885fb52caaSdrh ** a value of false.
88991bb0eedSdrh */
8901e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
89191bb0eedSdrh   if( pLeft==0 ){
89291bb0eedSdrh     return pRight;
89391bb0eedSdrh   }else if( pRight==0 ){
89491bb0eedSdrh     return pLeft;
8955fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
8965fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
8975fb52caaSdrh     sqlite3ExprDelete(db, pRight);
8985fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
89991bb0eedSdrh   }else{
900b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
901b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
902b7916a78Sdrh     return pNew;
903a76b5dfcSdrh   }
904a76b5dfcSdrh }
905a76b5dfcSdrh 
906a76b5dfcSdrh /*
907a76b5dfcSdrh ** Construct a new expression node for a function with multiple
908a76b5dfcSdrh ** arguments.
909a76b5dfcSdrh */
91017435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
911a76b5dfcSdrh   Expr *pNew;
912633e6d57Sdrh   sqlite3 *db = pParse->db;
9134b202ae2Sdanielk1977   assert( pToken );
914b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
915a76b5dfcSdrh   if( pNew==0 ){
916d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
917a76b5dfcSdrh     return 0;
918a76b5dfcSdrh   }
9196ab3a2ecSdanielk1977   pNew->x.pList = pList;
9206ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9212308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
922a76b5dfcSdrh   return pNew;
923a76b5dfcSdrh }
924a76b5dfcSdrh 
925a76b5dfcSdrh /*
926fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
927fa6bc000Sdrh ** in the original SQL statement.
928fa6bc000Sdrh **
929fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
930fa6bc000Sdrh ** variable number.
931fa6bc000Sdrh **
932fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
933fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
934fa6bc000Sdrh ** the SQL statement comes from an external source.
935fa6bc000Sdrh **
93651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
937fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
93860ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
939fa6bc000Sdrh ** assigned.
940fa6bc000Sdrh */
941fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
94217435752Sdrh   sqlite3 *db = pParse->db;
943b7916a78Sdrh   const char *z;
94417435752Sdrh 
945fa6bc000Sdrh   if( pExpr==0 ) return;
946c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
94733e619fcSdrh   z = pExpr->u.zToken;
948b7916a78Sdrh   assert( z!=0 );
949b7916a78Sdrh   assert( z[0]!=0 );
950b7916a78Sdrh   if( z[1]==0 ){
951fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
952b7916a78Sdrh     assert( z[0]=='?' );
9538677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
954124c0b49Sdrh   }else{
955124c0b49Sdrh     ynVar x = 0;
956124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
957124c0b49Sdrh     if( z[0]=='?' ){
958fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
959fa6bc000Sdrh       ** use it as the variable number */
960c8d735aeSdan       i64 i;
961124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
962124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
963c5499befSdrh       testcase( i==0 );
964c5499befSdrh       testcase( i==1 );
965c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
966c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
967c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
968fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
969bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
970124c0b49Sdrh         x = 0;
971fa6bc000Sdrh       }
972fa6bc000Sdrh       if( i>pParse->nVar ){
9731df2db7fSshaneh         pParse->nVar = (int)i;
974fa6bc000Sdrh       }
975fa6bc000Sdrh     }else{
97651f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
977fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
978fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
979fa6bc000Sdrh       */
980124c0b49Sdrh       ynVar i;
981124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
982503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
983124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
984fa6bc000Sdrh           break;
985fa6bc000Sdrh         }
986fa6bc000Sdrh       }
987124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
988fa6bc000Sdrh     }
989124c0b49Sdrh     if( x>0 ){
990124c0b49Sdrh       if( x>pParse->nzVar ){
991124c0b49Sdrh         char **a;
992124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
9934a642b60Sdrh         if( a==0 ){
9944a642b60Sdrh           assert( db->mallocFailed ); /* Error reported through mallocFailed */
9954a642b60Sdrh           return;
9964a642b60Sdrh         }
997124c0b49Sdrh         pParse->azVar = a;
998124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
999124c0b49Sdrh         pParse->nzVar = x;
1000124c0b49Sdrh       }
1001124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
1002124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
1003124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
1004fa6bc000Sdrh       }
1005fa6bc000Sdrh     }
1006fa6bc000Sdrh   }
1007bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1008832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1009832b2664Sdanielk1977   }
1010fa6bc000Sdrh }
1011fa6bc000Sdrh 
1012fa6bc000Sdrh /*
1013f6963f99Sdan ** Recursively delete an expression tree.
1014a2e00042Sdrh */
10154f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10164f0010b1Sdrh   assert( p!=0 );
1017d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1018d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1019209bc522Sdrh #ifdef SQLITE_DEBUG
1020209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1021209bc522Sdrh     assert( p->pLeft==0 );
1022209bc522Sdrh     assert( p->pRight==0 );
1023209bc522Sdrh     assert( p->x.pSelect==0 );
1024209bc522Sdrh   }
1025209bc522Sdrh #endif
1026209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1027c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1028c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10294910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1030633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
10316ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
10326ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10336ab3a2ecSdanielk1977     }else{
10346ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10356ab3a2ecSdanielk1977     }
10366ab3a2ecSdanielk1977   }
1037209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
103833e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1039633e6d57Sdrh     sqlite3DbFree(db, p);
1040a2e00042Sdrh   }
104133e619fcSdrh }
10424f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10434f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10444f0010b1Sdrh }
1045a2e00042Sdrh 
1046d2687b77Sdrh /*
10476ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10486ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10496ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10506ab3a2ecSdanielk1977 */
10516ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10526ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10536ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10546ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10556ab3a2ecSdanielk1977 }
10566ab3a2ecSdanielk1977 
10576ab3a2ecSdanielk1977 /*
105833e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
105933e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
106033e619fcSdrh ** how much of the tree is measured.
106133e619fcSdrh **
106233e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
106333e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
106433e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
106533e619fcSdrh **
106633e619fcSdrh ***************************************************************************
106733e619fcSdrh **
106833e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
106933e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
107033e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
107133e619fcSdrh ** The return values is always one of:
107233e619fcSdrh **
107333e619fcSdrh **      EXPR_FULLSIZE
107433e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
107533e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
107633e619fcSdrh **
107733e619fcSdrh ** The size of the structure can be found by masking the return value
107833e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
107933e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
108033e619fcSdrh **
108133e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
108233e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
108333e619fcSdrh ** During expression analysis, extra information is computed and moved into
108433e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
108533e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
108660ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
108733e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
108833e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
108933e619fcSdrh ** to enforce this constraint.
10906ab3a2ecSdanielk1977 */
10916ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
10926ab3a2ecSdanielk1977   int nSize;
109333e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1094aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1095aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
10963c19469cSdrh   if( 0==flags ){
10976ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
10986ab3a2ecSdanielk1977   }else{
1099c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
110033e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1101c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1102ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1103aecd8021Sdrh     if( p->pLeft || p->x.pList ){
110433e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
110533e619fcSdrh     }else{
1106aecd8021Sdrh       assert( p->pRight==0 );
110733e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
110833e619fcSdrh     }
11096ab3a2ecSdanielk1977   }
11106ab3a2ecSdanielk1977   return nSize;
11116ab3a2ecSdanielk1977 }
11126ab3a2ecSdanielk1977 
11136ab3a2ecSdanielk1977 /*
111433e619fcSdrh ** This function returns the space in bytes required to store the copy
111533e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
111633e619fcSdrh ** string is defined.)
11176ab3a2ecSdanielk1977 */
11186ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
111933e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
112033e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
112133e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11226ab3a2ecSdanielk1977   }
1123bc73971dSdanielk1977   return ROUND8(nByte);
11246ab3a2ecSdanielk1977 }
11256ab3a2ecSdanielk1977 
11266ab3a2ecSdanielk1977 /*
11276ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11286ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11296ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11306ab3a2ecSdanielk1977 **
11316ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
113233e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11336ab3a2ecSdanielk1977 **
11346ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11356ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11366ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11376ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11386ab3a2ecSdanielk1977 */
11396ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11406ab3a2ecSdanielk1977   int nByte = 0;
11416ab3a2ecSdanielk1977   if( p ){
11426ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11436ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1144b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11456ab3a2ecSdanielk1977     }
11466ab3a2ecSdanielk1977   }
11476ab3a2ecSdanielk1977   return nByte;
11486ab3a2ecSdanielk1977 }
11496ab3a2ecSdanielk1977 
11506ab3a2ecSdanielk1977 /*
11516ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11526ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
115333e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11546ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
115560ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11566ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11576ab3a2ecSdanielk1977 */
11583c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11593c19469cSdrh   Expr *pNew;           /* Value to return */
11603c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11613c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11626ab3a2ecSdanielk1977 
11633c19469cSdrh   assert( db!=0 );
11643c19469cSdrh   assert( p );
11653c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11663c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11676ab3a2ecSdanielk1977 
11686ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11696ab3a2ecSdanielk1977   if( pzBuffer ){
11706ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
117133e619fcSdrh     staticFlag = EP_Static;
11726ab3a2ecSdanielk1977   }else{
11733c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
11743c19469cSdrh     staticFlag = 0;
11756ab3a2ecSdanielk1977   }
11766ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
11776ab3a2ecSdanielk1977 
11786ab3a2ecSdanielk1977   if( pNew ){
11796ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
11806ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
11816ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
118233e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
11836ab3a2ecSdanielk1977     */
11843c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
118533e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
118633e619fcSdrh     int nToken;
118733e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
118833e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
118933e619fcSdrh     }else{
119033e619fcSdrh       nToken = 0;
119133e619fcSdrh     }
11923c19469cSdrh     if( dupFlags ){
11936ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11946ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11956ab3a2ecSdanielk1977     }else{
11963e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11976ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
119872ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
11996ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12006ab3a2ecSdanielk1977       }
120172ea29d7Sdrh     }
12026ab3a2ecSdanielk1977 
120333e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1204c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
120533e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
120633e619fcSdrh     pNew->flags |= staticFlag;
12076ab3a2ecSdanielk1977 
120833e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12096ab3a2ecSdanielk1977     if( nToken ){
121033e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
121133e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12126ab3a2ecSdanielk1977     }
12136ab3a2ecSdanielk1977 
1214209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12156ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12166ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12173c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12186ab3a2ecSdanielk1977       }else{
12193c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12206ab3a2ecSdanielk1977       }
12216ab3a2ecSdanielk1977     }
12226ab3a2ecSdanielk1977 
12236ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1224c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12253c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1226209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12273c19469cSdrh         pNew->pLeft = p->pLeft ?
12283c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12293c19469cSdrh         pNew->pRight = p->pRight ?
12303c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12316ab3a2ecSdanielk1977       }
12326ab3a2ecSdanielk1977       if( pzBuffer ){
12336ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12346ab3a2ecSdanielk1977       }
1235b7916a78Sdrh     }else{
1236209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12379854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12389854260bSdrh           pNew->pLeft = p->pLeft;
12399854260bSdrh         }else{
12406ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12419854260bSdrh         }
12426ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12436ab3a2ecSdanielk1977       }
12446ab3a2ecSdanielk1977     }
12456ab3a2ecSdanielk1977   }
12466ab3a2ecSdanielk1977   return pNew;
12476ab3a2ecSdanielk1977 }
12486ab3a2ecSdanielk1977 
12496ab3a2ecSdanielk1977 /*
1250bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1251bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1252bfe31e7fSdan ** and the db->mallocFailed flag set.
1253bfe31e7fSdan */
1254eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1255bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12564e9119d9Sdan   With *pRet = 0;
12574e9119d9Sdan   if( p ){
12584e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12594e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12604e9119d9Sdan     if( pRet ){
12614e9119d9Sdan       int i;
12624e9119d9Sdan       pRet->nCte = p->nCte;
12634e9119d9Sdan       for(i=0; i<p->nCte; i++){
12644e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
12654e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
12664e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
12674e9119d9Sdan       }
12684e9119d9Sdan     }
12694e9119d9Sdan   }
12704e9119d9Sdan   return pRet;
12714e9119d9Sdan }
1272eede6a53Sdan #else
1273eede6a53Sdan # define withDup(x,y) 0
1274eede6a53Sdan #endif
12754e9119d9Sdan 
1276a76b5dfcSdrh /*
1277ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1278ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1279ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1280ff78bd2fSdrh ** without effecting the originals.
1281ff78bd2fSdrh **
12824adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
12834adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1284ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1285ff78bd2fSdrh **
1286ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
12876ab3a2ecSdanielk1977 **
1288b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
12896ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
12906ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
12916ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1292ff78bd2fSdrh */
12936ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
129472ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
12953c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1296ff78bd2fSdrh }
12976ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1298ff78bd2fSdrh   ExprList *pNew;
1299145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1300ff78bd2fSdrh   int i;
1301575fad65Sdrh   assert( db!=0 );
1302ff78bd2fSdrh   if( p==0 ) return 0;
1303575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1304ff78bd2fSdrh   if( pNew==0 ) return 0;
1305d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
1306d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1307575fad65Sdrh   pNew->a = pItem = sqlite3DbMallocRawNN(db,  i*sizeof(p->a[0]) );
1308e0048400Sdanielk1977   if( pItem==0 ){
1309633e6d57Sdrh     sqlite3DbFree(db, pNew);
1310e0048400Sdanielk1977     return 0;
1311e0048400Sdanielk1977   }
1312145716b3Sdrh   pOldItem = p->a;
1313145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13146ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1315b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
131617435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1317b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1318145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13193e7bc9caSdrh     pItem->done = 0;
13202c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1321c2acc4e4Sdrh     pItem->u = pOldItem->u;
1322ff78bd2fSdrh   }
1323ff78bd2fSdrh   return pNew;
1324ff78bd2fSdrh }
132593758c8dSdanielk1977 
132693758c8dSdanielk1977 /*
132793758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
132893758c8dSdanielk1977 ** the build, then none of the following routines, except for
132993758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
133093758c8dSdanielk1977 ** called with a NULL argument.
133193758c8dSdanielk1977 */
13326a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13336a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13346ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1335ad3cab52Sdrh   SrcList *pNew;
1336ad3cab52Sdrh   int i;
1337113088ecSdrh   int nByte;
1338575fad65Sdrh   assert( db!=0 );
1339ad3cab52Sdrh   if( p==0 ) return 0;
1340113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1341575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1342ad3cab52Sdrh   if( pNew==0 ) return 0;
13434305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1344ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13454efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13464efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1347ed8a3bb1Sdrh     Table *pTab;
134841fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
134917435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
135017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
135117435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13528a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13534efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13545b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
13555b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
13568a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
13578a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
13588a48b9c0Sdrh     }
13598a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
13608a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
13618a48b9c0Sdrh       pNewItem->u1.pFuncArg =
13628a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
13638a48b9c0Sdrh     }
1364ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1365ed8a3bb1Sdrh     if( pTab ){
1366ed8a3bb1Sdrh       pTab->nRef++;
1367a1cb183dSdanielk1977     }
13686ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
13696ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
137017435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
13716c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1372ad3cab52Sdrh   }
1373ad3cab52Sdrh   return pNew;
1374ad3cab52Sdrh }
137517435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1376ff78bd2fSdrh   IdList *pNew;
1377ff78bd2fSdrh   int i;
1378575fad65Sdrh   assert( db!=0 );
1379ff78bd2fSdrh   if( p==0 ) return 0;
1380575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1381ff78bd2fSdrh   if( pNew==0 ) return 0;
13826c535158Sdrh   pNew->nId = p->nId;
1383575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1384d5d56523Sdanielk1977   if( pNew->a==0 ){
1385633e6d57Sdrh     sqlite3DbFree(db, pNew);
1386d5d56523Sdanielk1977     return 0;
1387d5d56523Sdanielk1977   }
13886c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
13896c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
13906c535158Sdrh   ** on the duplicate created by this function. */
1391ff78bd2fSdrh   for(i=0; i<p->nId; i++){
13924efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
13934efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
139417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
13954efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1396ff78bd2fSdrh   }
1397ff78bd2fSdrh   return pNew;
1398ff78bd2fSdrh }
13996ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
140023b1b372Sdrh   Select *pNew, *pPrior;
1401575fad65Sdrh   assert( db!=0 );
1402ff78bd2fSdrh   if( p==0 ) return 0;
1403575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1404ff78bd2fSdrh   if( pNew==0 ) return 0;
1405b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14066ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14076ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14086ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14096ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14106ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1411ff78bd2fSdrh   pNew->op = p->op;
141223b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
141323b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
141423b1b372Sdrh   pNew->pNext = 0;
14156ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
14166ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
141792b01d53Sdrh   pNew->iLimit = 0;
141892b01d53Sdrh   pNew->iOffset = 0;
14197d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1420b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1421b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1422ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
14234e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1424eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1425ff78bd2fSdrh   return pNew;
1426ff78bd2fSdrh }
142793758c8dSdanielk1977 #else
14286ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
142993758c8dSdanielk1977   assert( p==0 );
143093758c8dSdanielk1977   return 0;
143193758c8dSdanielk1977 }
143293758c8dSdanielk1977 #endif
1433ff78bd2fSdrh 
1434ff78bd2fSdrh 
1435ff78bd2fSdrh /*
1436a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1437a76b5dfcSdrh ** initially NULL, then create a new expression list.
1438b7916a78Sdrh **
1439b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1440b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1441b7916a78Sdrh ** that the new entry was successfully appended.
1442a76b5dfcSdrh */
144317435752Sdrh ExprList *sqlite3ExprListAppend(
144417435752Sdrh   Parse *pParse,          /* Parsing context */
144517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1446b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
144717435752Sdrh ){
144817435752Sdrh   sqlite3 *db = pParse->db;
1449575fad65Sdrh   assert( db!=0 );
1450a76b5dfcSdrh   if( pList==0 ){
1451575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1452a76b5dfcSdrh     if( pList==0 ){
1453d5d56523Sdanielk1977       goto no_mem;
1454a76b5dfcSdrh     }
1455c263f7c4Sdrh     pList->nExpr = 0;
1456575fad65Sdrh     pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
1457d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1458d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1459d5d56523Sdanielk1977     struct ExprList_item *a;
1460d872bb18Sdrh     assert( pList->nExpr>0 );
1461d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1462d5d56523Sdanielk1977     if( a==0 ){
1463d5d56523Sdanielk1977       goto no_mem;
1464a76b5dfcSdrh     }
1465d5d56523Sdanielk1977     pList->a = a;
1466a76b5dfcSdrh   }
14674efc4754Sdrh   assert( pList->a!=0 );
1468b7916a78Sdrh   if( 1 ){
14694efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
14704efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1471e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1472a76b5dfcSdrh   }
1473a76b5dfcSdrh   return pList;
1474d5d56523Sdanielk1977 
1475d5d56523Sdanielk1977 no_mem:
1476d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1477633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1478633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1479d5d56523Sdanielk1977   return 0;
1480a76b5dfcSdrh }
1481a76b5dfcSdrh 
1482a76b5dfcSdrh /*
14838762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
14848762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1485a1251bc4Sdrh **
1486a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1487a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1488a1251bc4Sdrh **
1489a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
14908762ec19Sdrh ** expression list pList.  In the case of a subquery on the LHS, append
1491a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1492a1251bc4Sdrh */
1493a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1494a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1495a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1496a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1497a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1498a1251bc4Sdrh ){
1499a1251bc4Sdrh   sqlite3 *db = pParse->db;
1500a1251bc4Sdrh   int n;
1501a1251bc4Sdrh   int i;
150266860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1503321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1504321e828dSdrh   ** exit prior to this routine being invoked */
1505321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1506a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1507a1251bc4Sdrh   n = sqlite3ExprVectorSize(pExpr);
1508a1251bc4Sdrh   if( pColumns->nId!=n ){
1509a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1510a1251bc4Sdrh                     pColumns->nId, n);
1511a1251bc4Sdrh     goto vector_append_error;
1512a1251bc4Sdrh   }
1513a1251bc4Sdrh   for(i=0; i<n; i++){
1514a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1515a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1516a1251bc4Sdrh     if( pList ){
151766860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1518a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1519a1251bc4Sdrh       pColumns->a[i].zName = 0;
1520a1251bc4Sdrh     }
1521a1251bc4Sdrh   }
1522a1251bc4Sdrh   if( pExpr->op==TK_SELECT ){
152366860af3Sdrh     if( pList && pList->a[iFirst].pExpr ){
152466860af3Sdrh       assert( pList->a[iFirst].pExpr->op==TK_SELECT_COLUMN );
152566860af3Sdrh       pList->a[iFirst].pExpr->pRight = pExpr;
1526a1251bc4Sdrh       pExpr = 0;
1527a1251bc4Sdrh     }
1528a1251bc4Sdrh   }
1529a1251bc4Sdrh 
1530a1251bc4Sdrh vector_append_error:
1531a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1532a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1533a1251bc4Sdrh   return pList;
1534a1251bc4Sdrh }
1535a1251bc4Sdrh 
1536a1251bc4Sdrh /*
1537bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1538bc622bc0Sdrh */
1539bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1540bc622bc0Sdrh   if( p==0 ) return;
1541bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1542bc622bc0Sdrh   assert( p->nExpr>0 );
1543bc622bc0Sdrh   if( iSortOrder<0 ){
1544bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1545bc622bc0Sdrh     return;
1546bc622bc0Sdrh   }
1547bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1548bc622bc0Sdrh }
1549bc622bc0Sdrh 
1550bc622bc0Sdrh /*
1551b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1552b7916a78Sdrh ** on the expression list.
1553b7916a78Sdrh **
1554b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1555b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1556b7916a78Sdrh ** is set.
1557b7916a78Sdrh */
1558b7916a78Sdrh void sqlite3ExprListSetName(
1559b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1560b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1561b7916a78Sdrh   Token *pName,           /* Name to be added */
1562b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1563b7916a78Sdrh ){
1564b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1565b7916a78Sdrh   if( pList ){
1566b7916a78Sdrh     struct ExprList_item *pItem;
1567b7916a78Sdrh     assert( pList->nExpr>0 );
1568b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1569b7916a78Sdrh     assert( pItem->zName==0 );
1570b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1571244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1572b7916a78Sdrh   }
1573b7916a78Sdrh }
1574b7916a78Sdrh 
1575b7916a78Sdrh /*
1576b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1577b7916a78Sdrh ** on the expression list.
1578b7916a78Sdrh **
1579b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1580b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1581b7916a78Sdrh ** is set.
1582b7916a78Sdrh */
1583b7916a78Sdrh void sqlite3ExprListSetSpan(
1584b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1585b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1586b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1587b7916a78Sdrh ){
1588b7916a78Sdrh   sqlite3 *db = pParse->db;
1589b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1590b7916a78Sdrh   if( pList ){
1591b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1592b7916a78Sdrh     assert( pList->nExpr>0 );
1593b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1594b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1595b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1596cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1597b7916a78Sdrh   }
1598b7916a78Sdrh }
1599b7916a78Sdrh 
1600b7916a78Sdrh /*
16017a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16027a15a4beSdanielk1977 ** leave an error message in pParse.
16037a15a4beSdanielk1977 */
16047a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16057a15a4beSdanielk1977   Parse *pParse,
16067a15a4beSdanielk1977   ExprList *pEList,
16077a15a4beSdanielk1977   const char *zObject
16087a15a4beSdanielk1977 ){
1609b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1610c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1611c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1612b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16137a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16147a15a4beSdanielk1977   }
16157a15a4beSdanielk1977 }
16167a15a4beSdanielk1977 
16177a15a4beSdanielk1977 /*
1618a76b5dfcSdrh ** Delete an entire expression list.
1619a76b5dfcSdrh */
1620affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1621a76b5dfcSdrh   int i;
1622be5c89acSdrh   struct ExprList_item *pItem;
1623d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1624be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1625633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1626633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1627b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1628a76b5dfcSdrh   }
1629633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1630633e6d57Sdrh   sqlite3DbFree(db, pList);
1631a76b5dfcSdrh }
1632affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1633affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1634affa855cSdrh }
1635a76b5dfcSdrh 
1636a76b5dfcSdrh /*
16372308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
16382308ed38Sdrh ** ExprList.
1639885a5b03Sdrh */
16402308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1641885a5b03Sdrh   int i;
16422308ed38Sdrh   u32 m = 0;
16432308ed38Sdrh   if( pList ){
1644885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1645d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1646de845c2fSdrh        assert( pExpr!=0 );
1647de845c2fSdrh        m |= pExpr->flags;
1648885a5b03Sdrh     }
16492308ed38Sdrh   }
16502308ed38Sdrh   return m;
1651885a5b03Sdrh }
1652885a5b03Sdrh 
1653885a5b03Sdrh /*
1654059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1655059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1656059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1657059b2d50Sdrh ** for.
165873b211abSdrh **
16597d10d5a6Sdrh ** These callback routines are used to implement the following:
1660626a879aSdrh **
1661059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1662059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1663fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1664059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
166587abf5c0Sdrh **
1666059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1667059b2d50Sdrh ** is found to not be a constant.
166887abf5c0Sdrh **
1669feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1670059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1671059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1672feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1673feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1674feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1675feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1676feada2dfSdrh ** malformed schema error.
1677626a879aSdrh */
16787d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1679626a879aSdrh 
1680059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1681059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
16820a168377Sdrh   ** from being considered constant. */
1683059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1684059b2d50Sdrh     pWalker->eCode = 0;
16857d10d5a6Sdrh     return WRC_Abort;
16860a168377Sdrh   }
16870a168377Sdrh 
1688626a879aSdrh   switch( pExpr->op ){
1689eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1690059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1691059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1692eb55bd2fSdrh     case TK_FUNCTION:
169363f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1694b1fba286Sdrh         return WRC_Continue;
1695059b2d50Sdrh       }else{
1696059b2d50Sdrh         pWalker->eCode = 0;
1697059b2d50Sdrh         return WRC_Abort;
1698b1fba286Sdrh       }
1699626a879aSdrh     case TK_ID:
1700626a879aSdrh     case TK_COLUMN:
1701626a879aSdrh     case TK_AGG_FUNCTION:
170213449892Sdrh     case TK_AGG_COLUMN:
1703c5499befSdrh       testcase( pExpr->op==TK_ID );
1704c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1705c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1706c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1707059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1708059b2d50Sdrh         return WRC_Continue;
1709059b2d50Sdrh       }else{
1710059b2d50Sdrh         pWalker->eCode = 0;
17117d10d5a6Sdrh         return WRC_Abort;
1712059b2d50Sdrh       }
1713feada2dfSdrh     case TK_VARIABLE:
1714059b2d50Sdrh       if( pWalker->eCode==5 ){
1715feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1716feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1717feada2dfSdrh         ** of the sqlite_master table */
1718feada2dfSdrh         pExpr->op = TK_NULL;
1719059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1720feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1721feada2dfSdrh         ** sqlite3_prepare() causes an error */
1722059b2d50Sdrh         pWalker->eCode = 0;
1723feada2dfSdrh         return WRC_Abort;
1724feada2dfSdrh       }
1725feada2dfSdrh       /* Fall through */
1726626a879aSdrh     default:
1727b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1728b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
17297d10d5a6Sdrh       return WRC_Continue;
1730626a879aSdrh   }
1731626a879aSdrh }
173262c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
173362c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1734059b2d50Sdrh   pWalker->eCode = 0;
17357d10d5a6Sdrh   return WRC_Abort;
17367d10d5a6Sdrh }
1737059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
17387d10d5a6Sdrh   Walker w;
1739aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1740059b2d50Sdrh   w.eCode = initFlag;
17417d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
17427d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1743059b2d50Sdrh   w.u.iCur = iCur;
17447d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1745059b2d50Sdrh   return w.eCode;
17467d10d5a6Sdrh }
1747626a879aSdrh 
1748626a879aSdrh /*
1749059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1750eb55bd2fSdrh ** and 0 if it involves variables or function calls.
17512398937bSdrh **
17522398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
17532398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
17542398937bSdrh ** a constant.
1755fef5208cSdrh */
17564adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1757059b2d50Sdrh   return exprIsConst(p, 1, 0);
1758fef5208cSdrh }
1759fef5208cSdrh 
1760fef5208cSdrh /*
1761059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
17620a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
17630a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
17640a168377Sdrh ** an ON or USING clause.
17650a168377Sdrh */
17660a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1767059b2d50Sdrh   return exprIsConst(p, 2, 0);
17680a168377Sdrh }
17690a168377Sdrh 
17700a168377Sdrh /*
1771fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1772059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1773059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1774059b2d50Sdrh ** table other than iCur.
1775059b2d50Sdrh */
1776059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1777059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1778059b2d50Sdrh }
1779059b2d50Sdrh 
1780059b2d50Sdrh /*
1781059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1782eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1783eb55bd2fSdrh ** are any variables.
1784eb55bd2fSdrh **
1785eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1786eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1787eb55bd2fSdrh ** a constant.
1788eb55bd2fSdrh */
1789feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1790feada2dfSdrh   assert( isInit==0 || isInit==1 );
1791059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1792eb55bd2fSdrh }
1793eb55bd2fSdrh 
17945b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
17955b88bc4bSdrh /*
17965b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
17975b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
17985b88bc4bSdrh */
17995b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
18005b88bc4bSdrh   Walker w;
18015b88bc4bSdrh   memset(&w, 0, sizeof(w));
1802bec2476aSdrh   w.eCode = 1;
18035b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
18045b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
18055b88bc4bSdrh   sqlite3WalkExpr(&w, p);
180607194bffSdrh   return w.eCode==0;
18075b88bc4bSdrh }
18085b88bc4bSdrh #endif
18095b88bc4bSdrh 
1810eb55bd2fSdrh /*
181173b211abSdrh ** If the expression p codes a constant integer that is small enough
1812202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1813202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1814202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1815e4de1febSdrh */
18164adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
181792b01d53Sdrh   int rc = 0;
1818cd92e84dSdrh 
1819cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1820cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1821cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1822cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1823cd92e84dSdrh 
182492b01d53Sdrh   if( p->flags & EP_IntValue ){
182533e619fcSdrh     *pValue = p->u.iValue;
1826e4de1febSdrh     return 1;
1827e4de1febSdrh   }
182892b01d53Sdrh   switch( p->op ){
18294b59ab5eSdrh     case TK_UPLUS: {
183092b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1831f6e369a1Sdrh       break;
18324b59ab5eSdrh     }
1833e4de1febSdrh     case TK_UMINUS: {
1834e4de1febSdrh       int v;
18354adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1836f6418891Smistachkin         assert( v!=(-2147483647-1) );
1837e4de1febSdrh         *pValue = -v;
183892b01d53Sdrh         rc = 1;
1839e4de1febSdrh       }
1840e4de1febSdrh       break;
1841e4de1febSdrh     }
1842e4de1febSdrh     default: break;
1843e4de1febSdrh   }
184492b01d53Sdrh   return rc;
1845e4de1febSdrh }
1846e4de1febSdrh 
1847e4de1febSdrh /*
1848039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1849039fc32eSdrh **
1850039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1851039fc32eSdrh ** to tell return TRUE.
1852039fc32eSdrh **
1853039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1854039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1855039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1856039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1857039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1858039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1859039fc32eSdrh ** TRUE.
1860039fc32eSdrh */
1861039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1862039fc32eSdrh   u8 op;
1863cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1864039fc32eSdrh   op = p->op;
1865039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1866039fc32eSdrh   switch( op ){
1867039fc32eSdrh     case TK_INTEGER:
1868039fc32eSdrh     case TK_STRING:
1869039fc32eSdrh     case TK_FLOAT:
1870039fc32eSdrh     case TK_BLOB:
1871039fc32eSdrh       return 0;
18727248a8b2Sdrh     case TK_COLUMN:
18737248a8b2Sdrh       assert( p->pTab!=0 );
187472673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
187572673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1876039fc32eSdrh     default:
1877039fc32eSdrh       return 1;
1878039fc32eSdrh   }
1879039fc32eSdrh }
1880039fc32eSdrh 
1881039fc32eSdrh /*
1882039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1883039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1884039fc32eSdrh ** argument.
1885039fc32eSdrh **
1886039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1887039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1888039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1889039fc32eSdrh ** answer.
1890039fc32eSdrh */
1891039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1892039fc32eSdrh   u8 op;
189305883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1894cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1895039fc32eSdrh   op = p->op;
1896039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1897039fc32eSdrh   switch( op ){
1898039fc32eSdrh     case TK_INTEGER: {
1899039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1900039fc32eSdrh     }
1901039fc32eSdrh     case TK_FLOAT: {
1902039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1903039fc32eSdrh     }
1904039fc32eSdrh     case TK_STRING: {
1905039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1906039fc32eSdrh     }
1907039fc32eSdrh     case TK_BLOB: {
1908039fc32eSdrh       return 1;
1909039fc32eSdrh     }
19102f2855b6Sdrh     case TK_COLUMN: {
191188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
191288376ca7Sdrh       return p->iColumn<0
19132f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
19142f2855b6Sdrh     }
1915039fc32eSdrh     default: {
1916039fc32eSdrh       return 0;
1917039fc32eSdrh     }
1918039fc32eSdrh   }
1919039fc32eSdrh }
1920039fc32eSdrh 
1921039fc32eSdrh /*
1922c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1923c4a3c779Sdrh */
19244adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
19254adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
19264adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
19274adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1928c4a3c779Sdrh   return 0;
1929c4a3c779Sdrh }
1930c4a3c779Sdrh 
19319a96b668Sdanielk1977 /*
193269c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
193369c355bdSdrh ** that can be simplified to a direct table access, then return
193469c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
193569c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
193669c355bdSdrh ** table, then return NULL.
1937b287f4b6Sdrh */
1938b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
19397b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
194069c355bdSdrh   Select *p;
1941b287f4b6Sdrh   SrcList *pSrc;
1942b287f4b6Sdrh   ExprList *pEList;
1943b287f4b6Sdrh   Table *pTab;
1944cfbb5e82Sdan   int i;
194569c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
194669c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
194769c355bdSdrh   p = pX->x.pSelect;
1948b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
19497d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1950b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1951b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
19527d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
19537d10d5a6Sdrh   }
1954b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1955b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1956b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1957b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1958b287f4b6Sdrh   pSrc = p->pSrc;
1959d1fa7bcaSdrh   assert( pSrc!=0 );
1960d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1961b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1962b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
196369c355bdSdrh   assert( pTab!=0 );
1964b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1965b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1966b287f4b6Sdrh   pEList = p->pEList;
1967ac6b47d1Sdrh   assert( pEList!=0 );
19687b35a77bSdan   /* All SELECT results must be columns. */
1969cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
1970cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
1971cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
197269c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
1973cfbb5e82Sdan   }
197469c355bdSdrh   return p;
1975b287f4b6Sdrh }
1976b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1977b287f4b6Sdrh 
1978f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
19791d8cb21fSdan /*
19804c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
19814c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
19826be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
19836be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
19846be515ebSdrh */
19856be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
1986728e0f91Sdrh   int addr1;
19876be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
1988728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
19896be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
19906be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
19914c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
1992728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
19936be515ebSdrh }
1994f9b2e05cSdan #endif
19956be515ebSdrh 
1996bb53ecb1Sdrh 
1997bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1998bb53ecb1Sdrh /*
1999bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2000bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2001bb53ecb1Sdrh */
2002bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2003bb53ecb1Sdrh   Expr *pLHS;
2004bb53ecb1Sdrh   int res;
2005bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2006bb53ecb1Sdrh   pLHS = pIn->pLeft;
2007bb53ecb1Sdrh   pIn->pLeft = 0;
2008bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2009bb53ecb1Sdrh   pIn->pLeft = pLHS;
2010bb53ecb1Sdrh   return res;
2011bb53ecb1Sdrh }
2012bb53ecb1Sdrh #endif
2013bb53ecb1Sdrh 
20146be515ebSdrh /*
20159a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2016d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2017d4305ca6Sdrh ** might be either a list of expressions or a subquery.
20189a96b668Sdanielk1977 **
2019d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2020d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2021d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2022d4305ca6Sdrh **
20233a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2024d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2025d4305ca6Sdrh **
2026b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
20279a96b668Sdanielk1977 **
20289a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
20291ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
20301ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
20319a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
20329a96b668Sdanielk1977 **                         populated epheremal table.
2033bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2034bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
20359a96b668Sdanielk1977 **
2036d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2037d4305ca6Sdrh ** subquery such as:
20389a96b668Sdanielk1977 **
2039553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
20409a96b668Sdanielk1977 **
2041d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2042d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
204360ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2044d4305ca6Sdrh ** existing table.
2045d4305ca6Sdrh **
20463a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
20473a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
20483a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
20493a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
20503a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
20513a85625dSdrh ** IN operator.
20523a85625dSdrh **
20533a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
20543a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2055553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2056553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2057553168c7Sdan ** a UNIQUE constraint or index.
20580cdc022eSdanielk1977 **
20593a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
20603a85625dSdrh ** for fast set membership tests) then an epheremal table must
2061553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2062553168c7Sdan ** index can be found with the specified <columns> as its left-most.
20630cdc022eSdanielk1977 **
2064bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2065bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2066bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2067bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2068bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2069bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2070bb53ecb1Sdrh **
2071b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
20723a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2073e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
20743a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
20750cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2076e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2077e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
20780cdc022eSdanielk1977 **
2079e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
20806be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
20816be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
20826be515ebSdrh ** NULL values.
2083553168c7Sdan **
2084553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2085553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2086553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2087553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2088553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2089553168c7Sdan **
2090553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2091553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2092553168c7Sdan **
2093553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
20949a96b668Sdanielk1977 */
2095284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2096ba00e30aSdan int sqlite3FindInIndex(
20976fc8f364Sdrh   Parse *pParse,             /* Parsing context */
20986fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
20996fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
21006fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
21016fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2102ba00e30aSdan ){
2103b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2104b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2105b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
21063a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2107b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
21089a96b668Sdanielk1977 
21091450bc6eSdrh   assert( pX->op==TK_IN );
21103a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
21111450bc6eSdrh 
21127b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
21137b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2114870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
21157b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2116870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
21177b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
21187b35a77bSdan     int i;
21197b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
21207b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
21217b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
21227b35a77bSdan     }
21237b35a77bSdan     if( i==pEList->nExpr ){
21247b35a77bSdan       prRhsHasNull = 0;
21257b35a77bSdan     }
21267b35a77bSdan   }
21277b35a77bSdan 
2128b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2129b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
21307b35a77bSdan   ** ephemeral table.  */
21317b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2132e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2133b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2134ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2135cfbb5e82Sdan     ExprList *pEList = p->pEList;
2136cfbb5e82Sdan     int nExpr = pEList->nExpr;
2137e1fb65a0Sdanielk1977 
2138b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2139b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2140b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2141b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2142b07028f7Sdrh 
2143b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2144e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2145e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2146e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
21479a96b668Sdanielk1977 
2148a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2149cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
215062659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2151511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
21527d176105Sdrh       VdbeCoverage(v);
21539a96b668Sdanielk1977 
21549a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
21559a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
21569a96b668Sdanielk1977 
21579a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
21589a96b668Sdanielk1977     }else{
2159e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2160cfbb5e82Sdan       int affinity_ok = 1;
2161cfbb5e82Sdan       int i;
2162cfbb5e82Sdan 
2163cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
216462659b2aSdrh       ** comparison is the same as the affinity of each column in table
216562659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
216662659b2aSdrh       ** use any index of the RHS table.  */
2167cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2168fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2169cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
21700dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2171cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
217262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
217362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2174cfbb5e82Sdan         switch( cmpaff ){
2175cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2176cfbb5e82Sdan             break;
2177cfbb5e82Sdan           case SQLITE_AFF_TEXT:
217862659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
217962659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
218062659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
218162659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
218262659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2183cfbb5e82Sdan             break;
2184cfbb5e82Sdan           default:
2185cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2186cfbb5e82Sdan         }
2187cfbb5e82Sdan       }
2188e1fb65a0Sdanielk1977 
2189a84a283dSdrh       if( affinity_ok ){
2190a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2191a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2192a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2193a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
21946fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2195a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2196a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2197a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2198a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2199a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
22006fc8f364Sdrh           if( mustBeUnique ){
22016fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
22026fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
22036fc8f364Sdrh             ){
2204a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2205cfbb5e82Sdan             }
22066fc8f364Sdrh           }
2207cfbb5e82Sdan 
2208a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2209cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2210fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2211cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2212cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2213cfbb5e82Sdan             int j;
2214cfbb5e82Sdan 
22156fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2216cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2217cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2218cfbb5e82Sdan               assert( pIdx->azColl[j] );
2219106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2220106526e1Sdrh                 continue;
2221106526e1Sdrh               }
2222cfbb5e82Sdan               break;
2223cfbb5e82Sdan             }
2224cfbb5e82Sdan             if( j==nExpr ) break;
2225a84a283dSdrh             mCol = MASKBIT(j);
2226a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2227a84a283dSdrh             colUsed |= mCol;
2228ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2229cfbb5e82Sdan           }
2230cfbb5e82Sdan 
2231a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2232a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2233a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2234511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2235363fb95bSdrh #ifndef SQLITE_OMIT_EXPLAIN
2236363fb95bSdrh             sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2237363fb95bSdrh               sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2238363fb95bSdrh               P4_DYNAMIC);
2239363fb95bSdrh #endif
22402ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
22412ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2242207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
22431ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
22441ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
22459a96b668Sdanielk1977 
22467b35a77bSdan             if( prRhsHasNull ){
22473480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2248cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
22493480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2250cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
22513480bfdaSdan #endif
2252b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
22537b35a77bSdan               if( nExpr==1 ){
22546be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
22550cdc022eSdanielk1977               }
22567b35a77bSdan             }
2257552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
22589a96b668Sdanielk1977           }
2259a84a283dSdrh         } /* End loop over indexes */
2260a84a283dSdrh       } /* End if( affinity_ok ) */
2261a84a283dSdrh     } /* End if not an rowid index */
2262a84a283dSdrh   } /* End attempt to optimize using an index */
22639a96b668Sdanielk1977 
2264bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2265bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2266bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
226771c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
226860ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2269bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2270bb53ecb1Sdrh   */
2271bb53ecb1Sdrh   if( eType==0
2272bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2273bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2274bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2275bb53ecb1Sdrh   ){
2276bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2277bb53ecb1Sdrh   }
2278bb53ecb1Sdrh 
22799a96b668Sdanielk1977   if( eType==0 ){
22804387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2281b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2282b74b1017Sdrh     */
22838e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
22840cdc022eSdanielk1977     int rMayHaveNull = 0;
228541a05b7bSdanielk1977     eType = IN_INDEX_EPH;
22863a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
22874a5acf8eSdrh       pParse->nQueryLoop = 0;
2288c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
228941a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
22900cdc022eSdanielk1977       }
2291e21a6e1dSdrh     }else if( prRhsHasNull ){
2292e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2293cf4d38aaSdrh     }
229441a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2295cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
22969a96b668Sdanielk1977   }else{
22979a96b668Sdanielk1977     pX->iTable = iTab;
22989a96b668Sdanielk1977   }
2299ba00e30aSdan 
2300ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2301ba00e30aSdan     int i, n;
2302ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2303ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2304ba00e30aSdan   }
23059a96b668Sdanielk1977   return eType;
23069a96b668Sdanielk1977 }
2307284f4acaSdanielk1977 #endif
2308626a879aSdrh 
2309f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2310553168c7Sdan /*
2311553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2312553168c7Sdan ** function allocates and returns a nul-terminated string containing
2313553168c7Sdan ** the affinities to be used for each column of the comparison.
2314553168c7Sdan **
2315553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2316553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2317553168c7Sdan */
231871c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
231971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
232071c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2321553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
232271c57db0Sdan   char *zRet;
232371c57db0Sdan 
2324553168c7Sdan   assert( pExpr->op==TK_IN );
232571c57db0Sdan   zRet = sqlite3DbMallocZero(pParse->db, nVal+1);
232671c57db0Sdan   if( zRet ){
232771c57db0Sdan     int i;
232871c57db0Sdan     for(i=0; i<nVal; i++){
2329fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2330553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2331553168c7Sdan       if( pSelect ){
2332553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
233371c57db0Sdan       }else{
2334553168c7Sdan         zRet[i] = a;
233571c57db0Sdan       }
233671c57db0Sdan     }
233771c57db0Sdan     zRet[nVal] = '\0';
233871c57db0Sdan   }
233971c57db0Sdan   return zRet;
234071c57db0Sdan }
2341f9b2e05cSdan #endif
234271c57db0Sdan 
23438da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
23448da209b1Sdan /*
23458da209b1Sdan ** Load the Parse object passed as the first argument with an error
23468da209b1Sdan ** message of the form:
23478da209b1Sdan **
23488da209b1Sdan **   "sub-select returns N columns - expected M"
23498da209b1Sdan */
23508da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
23518da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
23528da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
23538da209b1Sdan }
23548da209b1Sdan #endif
23558da209b1Sdan 
2356626a879aSdrh /*
2357d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2358d4187c71Sdrh ** or IN operators.  Examples:
2359626a879aSdrh **
23609cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
23619cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
23629cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
23639cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2364fef5208cSdrh **
23659cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
23669cbe6352Sdrh ** operator or subquery.
236741a05b7bSdanielk1977 **
236841a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
236941a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
237041a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
237141a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
237241a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2373fd773cf9Sdrh **
2374fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2375fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
23763a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
23773a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
23783a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
23791450bc6eSdrh **
23801450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
238139a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
238239a11819Sdrh ** array of registers and the return value is the register of the left-most
238339a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2384cce7d176Sdrh */
238551522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23861450bc6eSdrh int sqlite3CodeSubselect(
2387fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2388fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
23896be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2390fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
239141a05b7bSdanielk1977 ){
23926be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
23931450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2394b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
23951450bc6eSdrh   if( NEVER(v==0) ) return 0;
2396ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2397fc976065Sdanielk1977 
239839a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
239939a11819Sdrh   ** is encountered if any of the following is true:
240057dbd7b3Sdrh   **
240157dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
240257dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
240357dbd7b3Sdrh   **    *  We are inside a trigger
240457dbd7b3Sdrh   **
240557dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
240657dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2407b3bce662Sdanielk1977   */
2408c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2409511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2410b3bce662Sdanielk1977   }
2411b3bce662Sdanielk1977 
24124a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
24134a07e3dbSdan   if( pParse->explain==2 ){
241462aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
241562aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
241662aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
241762aaa6caSdrh         pParse->iNextSelectId
24184a07e3dbSdan     );
24194a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
24204a07e3dbSdan   }
24214a07e3dbSdan #endif
24224a07e3dbSdan 
2423cce7d176Sdrh   switch( pExpr->op ){
2424fef5208cSdrh     case TK_IN: {
2425b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2426d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2427323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
242871c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2429d3d39e93Sdrh 
243071c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2431553168c7Sdan       assert( !isRowid || nVal==1 );
2432e014a838Sdanielk1977 
2433e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
24348cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2435553168c7Sdan       ** filled with index keys representing the results from the
2436553168c7Sdan       ** SELECT or the <exprlist>.
2437fef5208cSdrh       **
2438e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2439e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2440e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2441e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2442e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2443e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2444e014a838Sdanielk1977       ** is used.
2445fef5208cSdrh       */
2446832508b7Sdrh       pExpr->iTable = pParse->nTab++;
244771c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
244871c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
244971c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2450e014a838Sdanielk1977 
24516ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2452e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2453e014a838Sdanielk1977         **
2454e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2455e014a838Sdanielk1977         ** table allocated and opened above.
2456e014a838Sdanielk1977         */
24574387006cSdrh         Select *pSelect = pExpr->x.pSelect;
245871c57db0Sdan         ExprList *pEList = pSelect->pEList;
24591013c932Sdrh 
246041a05b7bSdanielk1977         assert( !isRowid );
246164bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
246264bcb8cfSdrh         ** error will have been caught long before we reach this point. */
246364bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
246471c57db0Sdan           SelectDest dest;
246571c57db0Sdan           int i;
24661013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
246771c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
2468e014a838Sdanielk1977           assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
24694387006cSdrh           pSelect->iLimit = 0;
24704387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2471812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
24724387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
247371c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
24742ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
24751450bc6eSdrh             return 0;
247694ccde58Sdrh           }
247771c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2478812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
24793535ec3eSdrh           assert( pEList!=0 );
24803535ec3eSdrh           assert( pEList->nExpr>0 );
24812ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
248271c57db0Sdan           for(i=0; i<nVal; i++){
2483773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
248471c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
248571c57db0Sdan                 pParse, p, pEList->a[i].pExpr
248671c57db0Sdan             );
248771c57db0Sdan           }
248871c57db0Sdan         }
2489a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2490fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2491fef5208cSdrh         **
2492e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2493e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2494e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2495e014a838Sdanielk1977         ** a column, use numeric affinity.
2496fef5208cSdrh         */
249771c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2498e014a838Sdanielk1977         int i;
24996ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
250057dbd7b3Sdrh         struct ExprList_item *pItem;
2501ecc31805Sdrh         int r1, r2, r3;
250257dbd7b3Sdrh 
250371c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2504e014a838Sdanielk1977         if( !affinity ){
250505883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2506e014a838Sdanielk1977         }
2507323df790Sdrh         if( pKeyInfo ){
25082ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2509323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2510323df790Sdrh         }
2511e014a838Sdanielk1977 
2512e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
25132d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
25142d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
251537e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
251657dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
251757dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2518e05c929bSdrh           int iValToIns;
2519e014a838Sdanielk1977 
252057dbd7b3Sdrh           /* If the expression is not constant then we will need to
252157dbd7b3Sdrh           ** disable the test that was generated above that makes sure
252257dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
252357dbd7b3Sdrh           ** expression we need to rerun this code each time.
252457dbd7b3Sdrh           */
25256be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
25266be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
25276be515ebSdrh             jmpIfDynamic = -1;
25284794b980Sdrh           }
2529e014a838Sdanielk1977 
2530e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2531e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2532e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2533e05c929bSdrh           }else{
2534ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
253541a05b7bSdanielk1977             if( isRowid ){
2536e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2537e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2538688852abSdrh               VdbeCoverage(v);
253941a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
254041a05b7bSdanielk1977             }else{
2541ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
25423c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
25432d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2544fef5208cSdrh             }
254541a05b7bSdanielk1977           }
2546e05c929bSdrh         }
25472d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
25482d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2549fef5208cSdrh       }
2550323df790Sdrh       if( pKeyInfo ){
25512ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
255241a05b7bSdanielk1977       }
2553b3bce662Sdanielk1977       break;
2554fef5208cSdrh     }
2555fef5208cSdrh 
255651522cd3Sdrh     case TK_EXISTS:
2557fd773cf9Sdrh     case TK_SELECT:
2558fd773cf9Sdrh     default: {
255939a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
256039a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
256139a11819Sdrh       **
256239a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
256339a11819Sdrh       ** the first row into an array of registers and return the index of
256439a11819Sdrh       ** the first register.
256539a11819Sdrh       **
256639a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
256739a11819Sdrh       ** into a register and return that register number.
256839a11819Sdrh       **
256939a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
257039a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2571fef5208cSdrh       */
2572fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
257339a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
257471c57db0Sdan       int nReg;                             /* Registers to allocate */
25751398ad36Sdrh 
2576cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2577cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2578cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
25796ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
258071c57db0Sdan 
25816ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
258271c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
258371c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
258471c57db0Sdan       pParse->nMem += nReg;
258551522cd3Sdrh       if( pExpr->op==TK_SELECT ){
25866c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
258753932ce8Sdrh         dest.iSdst = dest.iSDParm;
258871c57db0Sdan         dest.nSdst = nReg;
258971c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2590d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
259151522cd3Sdrh       }else{
25926c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
25932b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2594d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
259551522cd3Sdrh       }
2596633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2597e1c03b62Sdrh       pSel->pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,
2598e1c03b62Sdrh                                   &sqlite3IntTokens[1], 0);
259948b5b041Sdrh       pSel->iLimit = 0;
2600772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
26017d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
26021450bc6eSdrh         return 0;
260394ccde58Sdrh       }
26042b596da8Sdrh       rReg = dest.iSDParm;
2605ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2606b3bce662Sdanielk1977       break;
260719a775c2Sdrh     }
2608cce7d176Sdrh   }
2609b3bce662Sdanielk1977 
26106be515ebSdrh   if( rHasNullFlag ){
26116be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2612b3bce662Sdanielk1977   }
26136be515ebSdrh 
26146be515ebSdrh   if( jmpIfDynamic>=0 ){
26156be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2616b3bce662Sdanielk1977   }
2617d2490904Sdrh   sqlite3ExprCachePop(pParse);
2618fc976065Sdanielk1977 
26191450bc6eSdrh   return rReg;
2620cce7d176Sdrh }
262151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2622cce7d176Sdrh 
2623e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2624e3365e6cSdrh /*
26257b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
26267b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
26277b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
26287b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
26297b35a77bSdan */
26307b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
26317b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
26327b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
26337b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
26347b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
26357b35a77bSdan       return 1;
26367b35a77bSdan     }
26377b35a77bSdan   }else if( nVector!=1 ){
26387b35a77bSdan     if( (pIn->pLeft->flags & EP_xIsSelect) ){
26397b35a77bSdan       sqlite3SubselectError(pParse, nVector, 1);
26407b35a77bSdan     }else{
2641e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
26427b35a77bSdan     }
26437b35a77bSdan     return 1;
26447b35a77bSdan   }
26457b35a77bSdan   return 0;
26467b35a77bSdan }
26477b35a77bSdan #endif
26487b35a77bSdan 
26497b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
26507b35a77bSdan /*
2651e3365e6cSdrh ** Generate code for an IN expression.
2652e3365e6cSdrh **
2653e3365e6cSdrh **      x IN (SELECT ...)
2654e3365e6cSdrh **      x IN (value, value, ...)
2655e3365e6cSdrh **
2656ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2657e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2658e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2659e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2660e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2661e347d3e8Sdrh **
2662e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2663e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2664e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2665e347d3e8Sdrh ** determined due to NULLs.
2666e3365e6cSdrh **
26676be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2668e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2669e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2670e3365e6cSdrh ** within the RHS then fall through.
2671ecb87ac8Sdrh **
2672ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2673ecb87ac8Sdrh ** SQLite source tree for additional information.
2674e3365e6cSdrh */
2675e3365e6cSdrh static void sqlite3ExprCodeIN(
2676e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2677e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2678e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2679e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2680e3365e6cSdrh ){
2681e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2682e3365e6cSdrh   int eType;            /* Type of the RHS */
2683e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2684e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2685e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2686ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2687ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2688ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
268912abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2690e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2691ecb87ac8Sdrh   int i;                /* loop counter */
2692e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2693e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2694e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2695e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2696e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2697e3365e6cSdrh 
2698e347d3e8Sdrh   pLeft = pExpr->pLeft;
26997b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2700553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2701ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2702ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2703ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2704ba00e30aSdan   );
2705e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
27067b35a77bSdan 
2707ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2708ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2709ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2710ba00e30aSdan   ** the RHS has not yet been coded.  */
2711e3365e6cSdrh   v = pParse->pVdbe;
2712e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2713e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2714bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2715bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2716ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2717e3365e6cSdrh 
2718ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2719ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2720ba00e30aSdan   );
2721ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2722ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2723ecb87ac8Sdrh   ** nVector-1. */
2724ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2725ecb87ac8Sdrh     int j, cnt;
2726ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2727ecb87ac8Sdrh     assert( cnt==1 );
2728ecb87ac8Sdrh   }
2729ecb87ac8Sdrh #endif
2730e3365e6cSdrh 
2731ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2732ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2733ba00e30aSdan   ** at r1.
2734e347d3e8Sdrh   **
2735e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2736e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2737e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2738e347d3e8Sdrh   ** the field order that matches the RHS index.
2739e3365e6cSdrh   */
2740e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2741e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2742e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2743ecb87ac8Sdrh   if( i==nVector ){
2744e347d3e8Sdrh     /* LHS fields are not reordered */
2745e347d3e8Sdrh     rLhs = rLhsOrig;
2746ecb87ac8Sdrh   }else{
2747ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2748e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2749ba00e30aSdan     for(i=0; i<nVector; i++){
2750e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2751ba00e30aSdan     }
2752ecb87ac8Sdrh   }
2753e3365e6cSdrh 
2754bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2755bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2756bb53ecb1Sdrh   ** sequence of comparisons.
2757e347d3e8Sdrh   **
2758e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2759bb53ecb1Sdrh   */
2760bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2761bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2762bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2763bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2764bb53ecb1Sdrh     int r2, regToFree;
2765bb53ecb1Sdrh     int regCkNull = 0;
2766bb53ecb1Sdrh     int ii;
2767bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2768bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2769bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2770e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2771bb53ecb1Sdrh     }
2772bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2773bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2774a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2775bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2776bb53ecb1Sdrh       }
2777bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2778e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
27794336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
27804336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
27814336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2782ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2783bb53ecb1Sdrh       }else{
2784bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2785e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2786bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2787ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2788bb53ecb1Sdrh       }
2789bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2790bb53ecb1Sdrh     }
2791bb53ecb1Sdrh     if( regCkNull ){
2792bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2793076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2794bb53ecb1Sdrh     }
2795bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2796bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2797e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2798e347d3e8Sdrh   }
2799bb53ecb1Sdrh 
2800e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
2801e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
2802e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
2803e347d3e8Sdrh   */
2804094430ebSdrh   if( destIfNull==destIfFalse ){
2805e347d3e8Sdrh     destStep2 = destIfFalse;
2806e347d3e8Sdrh   }else{
2807e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
2808e347d3e8Sdrh   }
2809d49fd4e8Sdan   for(i=0; i<nVector; i++){
2810fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2811d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
2812e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
2813471b4b92Sdrh       VdbeCoverage(v);
2814d49fd4e8Sdan     }
2815d49fd4e8Sdan   }
2816e3365e6cSdrh 
2817e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
2818e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
2819e347d3e8Sdrh   ** true.
2820e347d3e8Sdrh   */
2821e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
2822e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
2823e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
2824e347d3e8Sdrh     ** into a single opcode. */
2825e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
2826688852abSdrh     VdbeCoverage(v);
2827e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
28287b35a77bSdan   }else{
2829e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
2830e347d3e8Sdrh     if( destIfFalse==destIfNull ){
2831e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
2832e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
2833e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
2834e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
2835e347d3e8Sdrh     }
2836e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
2837e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
2838e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
2839e347d3e8Sdrh   }
2840ba00e30aSdan 
2841e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
2842e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
2843e347d3e8Sdrh   */
2844e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
2845e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
2846471b4b92Sdrh     VdbeCoverage(v);
2847e347d3e8Sdrh   }
28487b35a77bSdan 
2849e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
2850e347d3e8Sdrh   ** FALSE, then just return false.
2851e347d3e8Sdrh   */
2852e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
2853e347d3e8Sdrh 
2854e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
2855e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
2856e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
2857e347d3e8Sdrh   **
2858e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
2859e347d3e8Sdrh   ** of the RHS.
2860e347d3e8Sdrh   */
2861e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
2862e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2863471b4b92Sdrh   VdbeCoverage(v);
2864e347d3e8Sdrh   if( nVector>1 ){
2865e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
2866e347d3e8Sdrh   }else{
2867e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
2868e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
2869e347d3e8Sdrh     destNotNull = destIfFalse;
2870e347d3e8Sdrh   }
2871ba00e30aSdan   for(i=0; i<nVector; i++){
2872ba00e30aSdan     Expr *p;
2873ba00e30aSdan     CollSeq *pColl;
2874e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
2875fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
2876ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
2877e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
2878e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
287918016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
2880471b4b92Sdrh     VdbeCoverage(v);
2881e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
28827b35a77bSdan   }
28837b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2884e347d3e8Sdrh   if( nVector>1 ){
2885e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
2886e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
288718016ad2Sdrh     VdbeCoverage(v);
2888e347d3e8Sdrh 
2889e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
2890e347d3e8Sdrh     ** be false. */
289118016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
28927b35a77bSdan   }
28937b35a77bSdan 
2894e347d3e8Sdrh   /* Jumps here in order to return true. */
2895e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
2896e3365e6cSdrh 
2897e347d3e8Sdrh sqlite3ExprCodeIN_finished:
2898e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
2899d2490904Sdrh   sqlite3ExprCachePop(pParse);
2900ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
2901e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
2902ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
2903553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
2904e3365e6cSdrh }
2905e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2906e3365e6cSdrh 
290713573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2908598f1340Sdrh /*
2909598f1340Sdrh ** Generate an instruction that will put the floating point
29109cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
29110cf19ed8Sdrh **
29120cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
29130cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
29140cf19ed8Sdrh ** like the continuation of the number.
2915598f1340Sdrh */
2916b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2917fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2918598f1340Sdrh     double value;
29199339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2920d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2921598f1340Sdrh     if( negateFlag ) value = -value;
292297bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2923598f1340Sdrh   }
2924598f1340Sdrh }
292513573c71Sdrh #endif
2926598f1340Sdrh 
2927598f1340Sdrh 
2928598f1340Sdrh /*
2929fec19aadSdrh ** Generate an instruction that will put the integer describe by
29309cbf3425Sdrh ** text z[0..n-1] into register iMem.
29310cf19ed8Sdrh **
29325f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2933fec19aadSdrh */
293413573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
293513573c71Sdrh   Vdbe *v = pParse->pVdbe;
293692b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
293733e619fcSdrh     int i = pExpr->u.iValue;
2938d50ffc41Sdrh     assert( i>=0 );
293992b01d53Sdrh     if( negFlag ) i = -i;
294092b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2941fd773cf9Sdrh   }else{
29425f1d6b61Sshaneh     int c;
29435f1d6b61Sshaneh     i64 value;
2944fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2945fd773cf9Sdrh     assert( z!=0 );
29469296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
29475f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2948158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
294997bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2950fec19aadSdrh     }else{
295113573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
295213573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
295313573c71Sdrh #else
29541b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
29559296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
29569296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
29571b7ddc59Sdrh       }else
29581b7ddc59Sdrh #endif
29591b7ddc59Sdrh       {
2960b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
29619296c18aSdrh       }
296213573c71Sdrh #endif
2963fec19aadSdrh     }
2964fec19aadSdrh   }
2965c9cf901dSdanielk1977 }
2966fec19aadSdrh 
2967bea119cdSdrh /*
2968*9b40d13fSdrh ** Erase column-cache entry number i
2969bea119cdSdrh */
2970*9b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
2971*9b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
2972ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2973*9b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
2974ceea3321Sdrh     }
2975ceea3321Sdrh   }
2976bea119cdSdrh   pParse->nColCache--;
2977*9b40d13fSdrh   if( i<pParse->nColCache ){
2978*9b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
2979*9b40d13fSdrh   }
2980ceea3321Sdrh }
2981ceea3321Sdrh 
2982ceea3321Sdrh 
2983ceea3321Sdrh /*
2984ceea3321Sdrh ** Record in the column cache that a particular column from a
2985ceea3321Sdrh ** particular table is stored in a particular register.
2986ceea3321Sdrh */
2987ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2988ceea3321Sdrh   int i;
2989ceea3321Sdrh   int minLru;
2990ceea3321Sdrh   int idxLru;
2991ceea3321Sdrh   struct yColCache *p;
2992ceea3321Sdrh 
2993ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2994ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
299520411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
299620411ea7Sdrh 
2997b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2998b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2999b6da74ebSdrh   ** with and without the column cache.
3000b6da74ebSdrh   */
30017e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3002b6da74ebSdrh 
300327ee406eSdrh   /* First replace any existing entry.
300427ee406eSdrh   **
300527ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
300627ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
300727ee406eSdrh   */
300827ee406eSdrh #ifndef NDEBUG
3009*9b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3010*9b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3011ceea3321Sdrh   }
301227ee406eSdrh #endif
3013ceea3321Sdrh 
3014*9b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
3015*9b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3016ceea3321Sdrh     minLru = 0x7fffffff;
3017ceea3321Sdrh     idxLru = -1;
3018ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3019ceea3321Sdrh       if( p->lru<minLru ){
3020ceea3321Sdrh         idxLru = i;
3021ceea3321Sdrh         minLru = p->lru;
3022ceea3321Sdrh       }
3023ceea3321Sdrh     }
3024ceea3321Sdrh     p = &pParse->aColCache[idxLru];
3025*9b40d13fSdrh   }else{
3026*9b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
3027*9b40d13fSdrh   }
3028*9b40d13fSdrh 
3029*9b40d13fSdrh   /* Add the new entry to the end of the cache */
3030ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3031ceea3321Sdrh   p->iTable = iTab;
3032ceea3321Sdrh   p->iColumn = iCol;
3033ceea3321Sdrh   p->iReg = iReg;
3034ceea3321Sdrh   p->tempReg = 0;
3035ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3036ceea3321Sdrh }
3037ceea3321Sdrh 
3038ceea3321Sdrh /*
3039f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3040f49f3523Sdrh ** Purge the range of registers from the column cache.
3041ceea3321Sdrh */
3042f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
3043*9b40d13fSdrh   int i = 0;
3044*9b40d13fSdrh   while( i<pParse->nColCache ){
3045*9b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
3046*9b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
3047*9b40d13fSdrh       cacheEntryClear(pParse, i);
3048*9b40d13fSdrh     }else{
3049*9b40d13fSdrh       i++;
3050*9b40d13fSdrh     }
3051ceea3321Sdrh   }
3052ceea3321Sdrh }
3053ceea3321Sdrh 
3054ceea3321Sdrh /*
3055ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3056ceea3321Sdrh ** added to the column cache after this call are removed when the
3057ceea3321Sdrh ** corresponding pop occurs.
3058ceea3321Sdrh */
3059ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3060ceea3321Sdrh   pParse->iCacheLevel++;
30619ac7962aSdrh #ifdef SQLITE_DEBUG
30629ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30639ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
30649ac7962aSdrh   }
30659ac7962aSdrh #endif
3066ceea3321Sdrh }
3067ceea3321Sdrh 
3068ceea3321Sdrh /*
3069ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3070d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3071d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3072ceea3321Sdrh */
3073d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
3074*9b40d13fSdrh   int i = 0;
3075d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3076d2490904Sdrh   pParse->iCacheLevel--;
30779ac7962aSdrh #ifdef SQLITE_DEBUG
30789ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30799ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
30809ac7962aSdrh   }
30819ac7962aSdrh #endif
3082*9b40d13fSdrh   while( i<pParse->nColCache ){
3083*9b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
3084*9b40d13fSdrh       cacheEntryClear(pParse, i);
3085*9b40d13fSdrh     }else{
3086*9b40d13fSdrh       i++;
3087ceea3321Sdrh     }
3088ceea3321Sdrh   }
3089ceea3321Sdrh }
3090945498f3Sdrh 
3091945498f3Sdrh /*
30925cd79239Sdrh ** When a cached column is reused, make sure that its register is
30935cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
30945cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
30955cd79239Sdrh ** get them all.
30965cd79239Sdrh */
30975cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
30985cd79239Sdrh   int i;
30995cd79239Sdrh   struct yColCache *p;
3100*9b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
31015cd79239Sdrh     if( p->iReg==iReg ){
31025cd79239Sdrh       p->tempReg = 0;
31035cd79239Sdrh     }
31045cd79239Sdrh   }
31055cd79239Sdrh }
31065cd79239Sdrh 
31071f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
31081f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
31091f9ca2c8Sdrh */
31101f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
31111f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
31121f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
31131f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
31141f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
31151f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
31161f9ca2c8Sdrh ){
31171f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
31184b92f98cSdrh   if( iTabCol==XN_EXPR ){
31191f9ca2c8Sdrh     assert( pIdx->aColExpr );
31201f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
31211f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
31221c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
31234b92f98cSdrh   }else{
31244b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
31254b92f98cSdrh                                     iTabCol, regOut);
31264b92f98cSdrh   }
31271f9ca2c8Sdrh }
31281f9ca2c8Sdrh 
31295cd79239Sdrh /*
31305c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
31315c092e8aSdrh */
31325c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
31335c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
31345c092e8aSdrh   Table *pTab,    /* The table containing the value */
3135313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
31365c092e8aSdrh   int iCol,       /* Index of the column to extract */
3137313619f5Sdrh   int regOut      /* Extract the value into this register */
31385c092e8aSdrh ){
31395c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
31405c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
31415c092e8aSdrh   }else{
31425c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3143ee0ec8e1Sdrh     int x = iCol;
314435db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3145ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3146ee0ec8e1Sdrh     }
3147ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
31485c092e8aSdrh   }
31495c092e8aSdrh   if( iCol>=0 ){
31505c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
31515c092e8aSdrh   }
31525c092e8aSdrh }
31535c092e8aSdrh 
31545c092e8aSdrh /*
3155945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3156ce78bc6eSdrh ** table pTab and store the column value in a register.
3157ce78bc6eSdrh **
3158ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3159ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3160ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3161ce78bc6eSdrh ** for GetColumnToReg().
3162e55cbd72Sdrh **
3163e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3164e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3165945498f3Sdrh */
3166e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3167e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
31682133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
31692133d822Sdrh   int iColumn,     /* Index of the table column */
31702133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3171a748fdccSdrh   int iReg,        /* Store results here */
3172ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
31732133d822Sdrh ){
3174e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3175e55cbd72Sdrh   int i;
3176da250ea5Sdrh   struct yColCache *p;
3177e55cbd72Sdrh 
3178*9b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3179b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
3180ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
31815cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3182da250ea5Sdrh       return p->iReg;
3183e55cbd72Sdrh     }
3184e55cbd72Sdrh   }
3185e55cbd72Sdrh   assert( v!=0 );
31865c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3187a748fdccSdrh   if( p5 ){
3188a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3189a748fdccSdrh   }else{
3190ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3191a748fdccSdrh   }
3192e55cbd72Sdrh   return iReg;
3193e55cbd72Sdrh }
3194ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3195ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3196ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3197ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3198ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3199ce78bc6eSdrh   int iReg         /* Store results here */
3200ce78bc6eSdrh ){
3201ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3202ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3203ce78bc6eSdrh }
3204ce78bc6eSdrh 
3205e55cbd72Sdrh 
3206e55cbd72Sdrh /*
3207ceea3321Sdrh ** Clear all column cache entries.
3208e55cbd72Sdrh */
3209ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3210e55cbd72Sdrh   int i;
3211ceea3321Sdrh 
32129ac7962aSdrh #if SQLITE_DEBUG
32139ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32149ac7962aSdrh     printf("CLEAR\n");
32159ac7962aSdrh   }
32169ac7962aSdrh #endif
3217*9b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
3218*9b40d13fSdrh     if( pParse->aColCache[i].tempReg
3219*9b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
3220*9b40d13fSdrh     ){
3221*9b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3222e55cbd72Sdrh     }
3223da250ea5Sdrh   }
3224*9b40d13fSdrh   pParse->nColCache = 0;
3225da250ea5Sdrh }
3226e55cbd72Sdrh 
3227e55cbd72Sdrh /*
3228da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3229da250ea5Sdrh ** registers starting with iStart.
3230e55cbd72Sdrh */
3231da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3232f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3233e55cbd72Sdrh }
3234e55cbd72Sdrh 
3235e55cbd72Sdrh /*
3236b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3237b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3238e55cbd72Sdrh */
3239b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3240e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3241079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3242236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3243945498f3Sdrh }
3244945498f3Sdrh 
3245f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
324692b01d53Sdrh /*
3247652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3248652fbf55Sdrh ** is used as part of the column cache.
3249f49f3523Sdrh **
3250f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3251f49f3523Sdrh ** and does not appear in a normal build.
3252652fbf55Sdrh */
3253652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3254652fbf55Sdrh   int i;
3255ceea3321Sdrh   struct yColCache *p;
3256*9b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3257ceea3321Sdrh     int r = p->iReg;
3258f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3259652fbf55Sdrh   }
3260652fbf55Sdrh   return 0;
3261652fbf55Sdrh }
3262f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3263652fbf55Sdrh 
3264bea119cdSdrh 
3265652fbf55Sdrh /*
326612abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
326712abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
326812abf408Sdrh ** the correct value for the expression.
3269a4c3c87eSdrh */
3270a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3271a4c3c87eSdrh   p->op2 = p->op;
3272a4c3c87eSdrh   p->op = TK_REGISTER;
3273a4c3c87eSdrh   p->iTable = iReg;
3274a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3275a4c3c87eSdrh }
3276a4c3c87eSdrh 
327712abf408Sdrh /*
327812abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
327912abf408Sdrh ** the result in continguous temporary registers.  Return the index of
328012abf408Sdrh ** the first register used to store the result.
328112abf408Sdrh **
328212abf408Sdrh ** If the returned result register is a temporary scalar, then also write
328312abf408Sdrh ** that register number into *piFreeable.  If the returned result register
328412abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
328512abf408Sdrh ** to 0.
328612abf408Sdrh */
328712abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
328812abf408Sdrh   int iResult;
328912abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
329012abf408Sdrh   if( nResult==1 ){
329112abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
329212abf408Sdrh   }else{
329312abf408Sdrh     *piFreeable = 0;
329412abf408Sdrh     if( p->op==TK_SELECT ){
329512abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
329612abf408Sdrh     }else{
329712abf408Sdrh       int i;
329812abf408Sdrh       iResult = pParse->nMem+1;
329912abf408Sdrh       pParse->nMem += nResult;
330012abf408Sdrh       for(i=0; i<nResult; i++){
330112abf408Sdrh         sqlite3ExprCode(pParse, p->x.pList->a[i].pExpr, i+iResult);
330212abf408Sdrh       }
330312abf408Sdrh     }
330412abf408Sdrh   }
330512abf408Sdrh   return iResult;
330612abf408Sdrh }
330712abf408Sdrh 
330871c57db0Sdan 
3309a4c3c87eSdrh /*
3310cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
33112dcef11bSdrh ** expression.  Attempt to store the results in register "target".
33122dcef11bSdrh ** Return the register where results are stored.
3313389a1adbSdrh **
33148b213899Sdrh ** With this routine, there is no guarantee that results will
33152dcef11bSdrh ** be stored in target.  The result might be stored in some other
33162dcef11bSdrh ** register if it is convenient to do so.  The calling function
33172dcef11bSdrh ** must check the return code and move the results to the desired
33182dcef11bSdrh ** register.
3319cce7d176Sdrh */
3320678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
33212dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
33222dcef11bSdrh   int op;                   /* The opcode being coded */
33232dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
33242dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
33252dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
33267b35a77bSdan   int r1, r2;               /* Various register numbers */
332710d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
332871c57db0Sdan   int p5 = 0;
3329ffe07b2dSdrh 
33309cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
333120411ea7Sdrh   if( v==0 ){
333220411ea7Sdrh     assert( pParse->db->mallocFailed );
333320411ea7Sdrh     return 0;
333420411ea7Sdrh   }
3335389a1adbSdrh 
3336389a1adbSdrh   if( pExpr==0 ){
3337389a1adbSdrh     op = TK_NULL;
3338389a1adbSdrh   }else{
3339f2bc013cSdrh     op = pExpr->op;
3340389a1adbSdrh   }
3341f2bc013cSdrh   switch( op ){
334213449892Sdrh     case TK_AGG_COLUMN: {
334313449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
334413449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
334513449892Sdrh       if( !pAggInfo->directMode ){
33469de221dfSdrh         assert( pCol->iMem>0 );
3347c332cc30Sdrh         return pCol->iMem;
334813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
33495134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3350389a1adbSdrh                               pCol->iSorterColumn, target);
3351c332cc30Sdrh         return target;
335213449892Sdrh       }
335313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
335413449892Sdrh     }
3355967e8b73Sdrh     case TK_COLUMN: {
3356b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3357b2b9d3d7Sdrh       if( iTab<0 ){
3358b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3359b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3360c332cc30Sdrh           return pExpr->iColumn + pParse->ckBase;
3361c4a3c779Sdrh         }else{
33621f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
33631f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
33641f9ca2c8Sdrh           iTab = pParse->iSelfTab;
33652282792aSdrh         }
3366b2b9d3d7Sdrh       }
3367c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3368b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3369b2b9d3d7Sdrh                                pExpr->op2);
3370cce7d176Sdrh     }
3371cce7d176Sdrh     case TK_INTEGER: {
337213573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3373c332cc30Sdrh       return target;
337451e9a445Sdrh     }
337513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3376598f1340Sdrh     case TK_FLOAT: {
337733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
337833e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3379c332cc30Sdrh       return target;
3380598f1340Sdrh     }
338113573c71Sdrh #endif
3382fec19aadSdrh     case TK_STRING: {
338333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3384076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3385c332cc30Sdrh       return target;
3386cce7d176Sdrh     }
3387f0863fe5Sdrh     case TK_NULL: {
33889de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3389c332cc30Sdrh       return target;
3390f0863fe5Sdrh     }
33915338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3392c572ef7fSdanielk1977     case TK_BLOB: {
33936c8c6cecSdrh       int n;
33946c8c6cecSdrh       const char *z;
3395ca48c90fSdrh       char *zBlob;
339633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
339733e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
339833e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
339933e619fcSdrh       z = &pExpr->u.zToken[2];
3400b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3401b7916a78Sdrh       assert( z[n]=='\'' );
3402ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3403ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3404c332cc30Sdrh       return target;
3405c572ef7fSdanielk1977     }
34065338a5f7Sdanielk1977 #endif
340750457896Sdrh     case TK_VARIABLE: {
340833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
340933e619fcSdrh       assert( pExpr->u.zToken!=0 );
341033e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3411eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
341233e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
341304e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
341404e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
341504e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
3416895d7472Sdrh       }
3417c332cc30Sdrh       return target;
341850457896Sdrh     }
34194e0cff60Sdrh     case TK_REGISTER: {
3420c332cc30Sdrh       return pExpr->iTable;
34214e0cff60Sdrh     }
3422487e262fSdrh #ifndef SQLITE_OMIT_CAST
3423487e262fSdrh     case TK_CAST: {
3424487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
34252dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
34261735fa88Sdrh       if( inReg!=target ){
34271735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
34281735fa88Sdrh         inReg = target;
34291735fa88Sdrh       }
34304169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
34314169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3432c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3433b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3434c332cc30Sdrh       return inReg;
3435487e262fSdrh     }
3436487e262fSdrh #endif /* SQLITE_OMIT_CAST */
343771c57db0Sdan     case TK_IS:
343871c57db0Sdan     case TK_ISNOT:
343971c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
344071c57db0Sdan       p5 = SQLITE_NULLEQ;
344171c57db0Sdan       /* fall-through */
3442c9b84a1fSdrh     case TK_LT:
3443c9b84a1fSdrh     case TK_LE:
3444c9b84a1fSdrh     case TK_GT:
3445c9b84a1fSdrh     case TK_GE:
3446c9b84a1fSdrh     case TK_NE:
3447c9b84a1fSdrh     case TK_EQ: {
344871c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3449625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
345079752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
345171c57db0Sdan       }else{
345271c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3453b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
345471c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
345571c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
34567d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
34577d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
34587d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
34597d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
34607d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
34617d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3462c5499befSdrh         testcase( regFree1==0 );
3463c5499befSdrh         testcase( regFree2==0 );
3464c9b84a1fSdrh       }
34656a2fe093Sdrh       break;
34666a2fe093Sdrh     }
3467cce7d176Sdrh     case TK_AND:
3468cce7d176Sdrh     case TK_OR:
3469cce7d176Sdrh     case TK_PLUS:
3470cce7d176Sdrh     case TK_STAR:
3471cce7d176Sdrh     case TK_MINUS:
3472bf4133cbSdrh     case TK_REM:
3473bf4133cbSdrh     case TK_BITAND:
3474bf4133cbSdrh     case TK_BITOR:
347517c40294Sdrh     case TK_SLASH:
3476bf4133cbSdrh     case TK_LSHIFT:
3477855eb1cfSdrh     case TK_RSHIFT:
34780040077dSdrh     case TK_CONCAT: {
34797d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
34807d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
34817d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
34827d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
34837d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
34847d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
34857d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
34867d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
34877d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
34887d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
34897d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
34902dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
34912dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
34925b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3493c5499befSdrh       testcase( regFree1==0 );
3494c5499befSdrh       testcase( regFree2==0 );
34950040077dSdrh       break;
34960040077dSdrh     }
3497cce7d176Sdrh     case TK_UMINUS: {
3498fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3499fec19aadSdrh       assert( pLeft );
350013573c71Sdrh       if( pLeft->op==TK_INTEGER ){
350113573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3502c332cc30Sdrh         return target;
350313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
350413573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
350533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
350633e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3507c332cc30Sdrh         return target;
350813573c71Sdrh #endif
35093c84ddffSdrh       }else{
351010d1edf0Sdrh         tempX.op = TK_INTEGER;
351110d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
351210d1edf0Sdrh         tempX.u.iValue = 0;
351310d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3514e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
35152dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3516c5499befSdrh         testcase( regFree2==0 );
35173c84ddffSdrh       }
35186e142f54Sdrh       break;
35196e142f54Sdrh     }
3520bf4133cbSdrh     case TK_BITNOT:
35216e142f54Sdrh     case TK_NOT: {
35227d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
35237d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3524e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3525e99fa2afSdrh       testcase( regFree1==0 );
3526e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3527cce7d176Sdrh       break;
3528cce7d176Sdrh     }
3529cce7d176Sdrh     case TK_ISNULL:
3530cce7d176Sdrh     case TK_NOTNULL: {
35316a288a33Sdrh       int addr;
35327d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
35337d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
35349de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
35352dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3536c5499befSdrh       testcase( regFree1==0 );
35372dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
35387d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
35397d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3540a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
35416a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3542a37cdde0Sdanielk1977       break;
3543f2bc013cSdrh     }
35442282792aSdrh     case TK_AGG_FUNCTION: {
354513449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
35467e56e711Sdrh       if( pInfo==0 ){
354733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
354833e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
35497e56e711Sdrh       }else{
3550c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
35517e56e711Sdrh       }
35522282792aSdrh       break;
35532282792aSdrh     }
3554cce7d176Sdrh     case TK_FUNCTION: {
355512ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
355612ffee8cSdrh       int nFarg;             /* Number of function arguments */
355712ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
355812ffee8cSdrh       const char *zId;       /* The function name */
3559693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
356012ffee8cSdrh       int i;                 /* Loop counter */
3561c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
356212ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
356312ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
356417435752Sdrh 
35656ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3566c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
356712ffee8cSdrh         pFarg = 0;
356812ffee8cSdrh       }else{
356912ffee8cSdrh         pFarg = pExpr->x.pList;
357012ffee8cSdrh       }
357112ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
357233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
357333e619fcSdrh       zId = pExpr->u.zToken;
357480738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3575cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3576cc15313cSdrh       if( pDef==0 && pParse->explain ){
3577cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3578cc15313cSdrh       }
3579cc15313cSdrh #endif
35802d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
358180738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3582feb306f5Sdrh         break;
3583feb306f5Sdrh       }
3584ae6bb957Sdrh 
3585ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
358660ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3587ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3588ae6bb957Sdrh       */
3589d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3590ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3591ae6bb957Sdrh         assert( nFarg>=2 );
3592ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3593ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3594ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3595688852abSdrh           VdbeCoverage(v);
3596f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3597ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3598ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3599d2490904Sdrh           sqlite3ExprCachePop(pParse);
3600ae6bb957Sdrh         }
3601ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3602ae6bb957Sdrh         break;
3603ae6bb957Sdrh       }
3604ae6bb957Sdrh 
3605cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3606cca9f3d2Sdrh       ** of the first argument.
3607cca9f3d2Sdrh       */
3608cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3609cca9f3d2Sdrh         assert( nFarg>=1 );
3610c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3611cca9f3d2Sdrh       }
3612ae6bb957Sdrh 
3613d1a01edaSdrh       for(i=0; i<nFarg; i++){
3614d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3615693e6719Sdrh           testcase( i==31 );
3616693e6719Sdrh           constMask |= MASKBIT32(i);
3617d1a01edaSdrh         }
3618d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3619d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3620d1a01edaSdrh         }
3621d1a01edaSdrh       }
362212ffee8cSdrh       if( pFarg ){
3623d1a01edaSdrh         if( constMask ){
3624d1a01edaSdrh           r1 = pParse->nMem+1;
3625d1a01edaSdrh           pParse->nMem += nFarg;
3626d1a01edaSdrh         }else{
362712ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3628d1a01edaSdrh         }
3629a748fdccSdrh 
3630a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3631a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3632a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3633a748fdccSdrh         ** loading.
3634a748fdccSdrh         */
3635d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
36364e245a4cSdrh           u8 exprOp;
3637a748fdccSdrh           assert( nFarg==1 );
3638a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
36394e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
36404e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3641a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3642a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3643b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3644b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3645b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3646a748fdccSdrh           }
3647a748fdccSdrh         }
3648a748fdccSdrh 
3649d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
36505579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3651d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3652d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3653892d3179Sdrh       }else{
365412ffee8cSdrh         r1 = 0;
3655892d3179Sdrh       }
3656b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3657a43fa227Sdrh       /* Possibly overload the function if the first argument is
3658a43fa227Sdrh       ** a virtual table column.
3659a43fa227Sdrh       **
3660a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3661a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3662a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3663a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3664a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3665a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3666a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3667a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3668a43fa227Sdrh       */
366912ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
367012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
367112ffee8cSdrh       }else if( nFarg>0 ){
367212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3673b7f6f68fSdrh       }
3674b7f6f68fSdrh #endif
3675d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
36768b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
367766a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3678682f68b0Sdanielk1977       }
36799c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
368066a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
368112ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3682d1a01edaSdrh       if( nFarg && constMask==0 ){
368312ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
36842dcef11bSdrh       }
3685c332cc30Sdrh       return target;
36866ec2733bSdrh     }
3687fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3688fe2093d7Sdrh     case TK_EXISTS:
368919a775c2Sdrh     case TK_SELECT: {
36908da209b1Sdan       int nCol;
3691c5499befSdrh       testcase( op==TK_EXISTS );
3692c5499befSdrh       testcase( op==TK_SELECT );
36938da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
36948da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
36958da209b1Sdan       }else{
3696c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
36978da209b1Sdan       }
369819a775c2Sdrh       break;
369919a775c2Sdrh     }
3700fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3701fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3702fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3703fc7f27b9Sdrh       }
3704c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3705fc7f27b9Sdrh     }
3706fef5208cSdrh     case TK_IN: {
3707e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3708e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3709e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3710e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
371166ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3712e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3713e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3714e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3715c332cc30Sdrh       return target;
3716fef5208cSdrh     }
3717e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3718e3365e6cSdrh 
3719e3365e6cSdrh 
37202dcef11bSdrh     /*
37212dcef11bSdrh     **    x BETWEEN y AND z
37222dcef11bSdrh     **
37232dcef11bSdrh     ** This is equivalent to
37242dcef11bSdrh     **
37252dcef11bSdrh     **    x>=y AND x<=z
37262dcef11bSdrh     **
37272dcef11bSdrh     ** X is stored in pExpr->pLeft.
37282dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
37292dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
37302dcef11bSdrh     */
3731fef5208cSdrh     case TK_BETWEEN: {
373271c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3733c332cc30Sdrh       return target;
3734fef5208cSdrh     }
373594fa9c41Sdrh     case TK_SPAN:
3736ae80ddeaSdrh     case TK_COLLATE:
37374f07e5fbSdrh     case TK_UPLUS: {
3738c332cc30Sdrh       return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3739a2e00042Sdrh     }
37402dcef11bSdrh 
3741165921a7Sdan     case TK_TRIGGER: {
374265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
374365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
374465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
374565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
374665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
374765a7cd16Sdan       ** read the rowid field.
374865a7cd16Sdan       **
374965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
375065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
375165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
375265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
375365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
375465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
375565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
375665a7cd16Sdan       ** example, if the table on which triggers are being fired is
375765a7cd16Sdan       ** declared as:
375865a7cd16Sdan       **
375965a7cd16Sdan       **   CREATE TABLE t1(a, b);
376065a7cd16Sdan       **
376165a7cd16Sdan       ** Then p1 is interpreted as follows:
376265a7cd16Sdan       **
376365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
376465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
376565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
376665a7cd16Sdan       */
37672832ad42Sdan       Table *pTab = pExpr->pTab;
376865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
376965a7cd16Sdan 
377065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
377165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
377265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
377365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
377465a7cd16Sdan 
377565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
377676d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3777165921a7Sdan         (pExpr->iTable ? "new" : "old"),
377876d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
377976d462eeSdan         target
3780165921a7Sdan       ));
378165a7cd16Sdan 
378244dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
378365a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3784113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3785113762a2Sdrh       **
3786113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3787113762a2Sdrh       ** floating point when extracting it from the record.  */
37882832ad42Sdan       if( pExpr->iColumn>=0
37892832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
37902832ad42Sdan       ){
37912832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
37922832ad42Sdan       }
379344dbca83Sdrh #endif
3794165921a7Sdan       break;
3795165921a7Sdan     }
3796165921a7Sdan 
379771c57db0Sdan     case TK_VECTOR: {
3798e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
379971c57db0Sdan       break;
380071c57db0Sdan     }
380171c57db0Sdan 
38022dcef11bSdrh     /*
38032dcef11bSdrh     ** Form A:
38042dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
38052dcef11bSdrh     **
38062dcef11bSdrh     ** Form B:
38072dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
38082dcef11bSdrh     **
38092dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
38102dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
38112dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
38122dcef11bSdrh     **
38132dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3814c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3815c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3816c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
38172dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
38182dcef11bSdrh     **
38192dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
38202dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
38212dcef11bSdrh     ** no ELSE term, NULL.
38222dcef11bSdrh     */
382333cd4909Sdrh     default: assert( op==TK_CASE ); {
38242dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
38252dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
38262dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
38272dcef11bSdrh       int i;                            /* Loop counter */
38282dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
38292dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
38302dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
38312dcef11bSdrh       Expr *pX;                         /* The X expression */
38321bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3833ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
383417a7f8ddSdrh 
38356ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
38366ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
38376ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3838be5c89acSdrh       aListelem = pEList->a;
3839be5c89acSdrh       nExpr = pEList->nExpr;
38402dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
38412dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
384210d1edf0Sdrh         tempX = *pX;
384333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
384412abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
3845c5499befSdrh         testcase( regFree1==0 );
3846abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
38472dcef11bSdrh         opCompare.op = TK_EQ;
384810d1edf0Sdrh         opCompare.pLeft = &tempX;
38492dcef11bSdrh         pTest = &opCompare;
38508b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
38518b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
38528b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
38538b1db07fSdrh         ** purposes and possibly overwritten.  */
38548b1db07fSdrh         regFree1 = 0;
3855cce7d176Sdrh       }
3856c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3857ceea3321Sdrh         sqlite3ExprCachePush(pParse);
38582dcef11bSdrh         if( pX ){
38591bd10f8aSdrh           assert( pTest!=0 );
38602dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3861f5905aa7Sdrh         }else{
38622dcef11bSdrh           pTest = aListelem[i].pExpr;
386317a7f8ddSdrh         }
38642dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
386533cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
38662dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3867c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
38689de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3869076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3870d2490904Sdrh         sqlite3ExprCachePop(pParse);
38712dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3872f570f011Sdrh       }
3873c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3874ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3875c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3876d2490904Sdrh         sqlite3ExprCachePop(pParse);
387717a7f8ddSdrh       }else{
38789de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
387917a7f8ddSdrh       }
3880c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
3881c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
38822dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
38836f34903eSdanielk1977       break;
38846f34903eSdanielk1977     }
38855338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
38866f34903eSdanielk1977     case TK_RAISE: {
3887165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3888165921a7Sdan            || pExpr->affinity==OE_Abort
3889165921a7Sdan            || pExpr->affinity==OE_Fail
3890165921a7Sdan            || pExpr->affinity==OE_Ignore
3891165921a7Sdan       );
3892e0af83acSdan       if( !pParse->pTriggerTab ){
3893e0af83acSdan         sqlite3ErrorMsg(pParse,
3894e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3895e0af83acSdan         return 0;
3896e0af83acSdan       }
3897e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3898e0af83acSdan         sqlite3MayAbort(pParse);
3899e0af83acSdan       }
390033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3901e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3902e0af83acSdan         sqlite3VdbeAddOp4(
3903e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3904688852abSdrh         VdbeCoverage(v);
3905e0af83acSdan       }else{
3906433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3907f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3908e0af83acSdan       }
3909e0af83acSdan 
3910ffe07b2dSdrh       break;
391117a7f8ddSdrh     }
39125338a5f7Sdanielk1977 #endif
3913ffe07b2dSdrh   }
39142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
39152dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
39162dcef11bSdrh   return inReg;
39175b6afba9Sdrh }
39182dcef11bSdrh 
39192dcef11bSdrh /*
3920d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3921d1a01edaSdrh */
3922d673cddaSdrh void sqlite3ExprCodeAtInit(
3923d673cddaSdrh   Parse *pParse,    /* Parsing context */
3924d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3925d673cddaSdrh   int regDest,      /* Store the value in this register */
3926d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3927d673cddaSdrh ){
3928d1a01edaSdrh   ExprList *p;
3929d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3930d1a01edaSdrh   p = pParse->pConstExpr;
3931d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3932d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3933d673cddaSdrh   if( p ){
3934d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3935d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3936d673cddaSdrh      pItem->reusable = reusable;
3937d673cddaSdrh   }
3938d1a01edaSdrh   pParse->pConstExpr = p;
3939d1a01edaSdrh }
3940d1a01edaSdrh 
3941d1a01edaSdrh /*
39422dcef11bSdrh ** Generate code to evaluate an expression and store the results
39432dcef11bSdrh ** into a register.  Return the register number where the results
39442dcef11bSdrh ** are stored.
39452dcef11bSdrh **
39462dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3947678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
39482dcef11bSdrh ** a temporary, then set *pReg to zero.
3949f30a969bSdrh **
3950f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3951f30a969bSdrh ** code to fill the register in the initialization section of the
3952f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
39532dcef11bSdrh */
39542dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3955f30a969bSdrh   int r2;
3956f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3957d9f158e7Sdrh   if( ConstFactorOk(pParse)
3958f30a969bSdrh    && pExpr->op!=TK_REGISTER
3959f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3960f30a969bSdrh   ){
3961f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3962f30a969bSdrh     int i;
3963f30a969bSdrh     *pReg  = 0;
3964f30a969bSdrh     if( p ){
3965d673cddaSdrh       struct ExprList_item *pItem;
3966d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3967d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3968d673cddaSdrh           return pItem->u.iConstExprReg;
3969f30a969bSdrh         }
3970f30a969bSdrh       }
3971f30a969bSdrh     }
3972f30a969bSdrh     r2 = ++pParse->nMem;
3973d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3974f30a969bSdrh   }else{
39752dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3976f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
39772dcef11bSdrh     if( r2==r1 ){
39782dcef11bSdrh       *pReg = r1;
39792dcef11bSdrh     }else{
39802dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
39812dcef11bSdrh       *pReg = 0;
39822dcef11bSdrh     }
3983f30a969bSdrh   }
39842dcef11bSdrh   return r2;
39852dcef11bSdrh }
39862dcef11bSdrh 
39872dcef11bSdrh /*
39882dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
39892dcef11bSdrh ** results in register target.  The results are guaranteed to appear
39902dcef11bSdrh ** in register target.
39912dcef11bSdrh */
399205a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
39939cbf3425Sdrh   int inReg;
39949cbf3425Sdrh 
39959cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3996ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3997ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3998ebc16717Sdrh   }else{
39999cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
40001c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
40010e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
40029cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
400317a7f8ddSdrh     }
4004ebc16717Sdrh   }
4005cce7d176Sdrh }
4006cce7d176Sdrh 
4007cce7d176Sdrh /*
40081c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
40091c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
40101c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
40111c75c9d7Sdrh */
40121c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
40131c75c9d7Sdrh   sqlite3 *db = pParse->db;
40141c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
40151c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
40161c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
40171c75c9d7Sdrh }
40181c75c9d7Sdrh 
40191c75c9d7Sdrh /*
402005a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
402105a86c5cSdrh ** results in register target.  The results are guaranteed to appear
402205a86c5cSdrh ** in register target.  If the expression is constant, then this routine
402305a86c5cSdrh ** might choose to code the expression at initialization time.
402405a86c5cSdrh */
402505a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
402605a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
402705a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
402805a86c5cSdrh   }else{
402905a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
403005a86c5cSdrh   }
4031cce7d176Sdrh }
4032cce7d176Sdrh 
4033cce7d176Sdrh /*
403460ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4035de4fcfddSdrh ** in register target.
403625303780Sdrh **
40372dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
40382dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
40392dcef11bSdrh ** the result is a copy of the cache register.
40402dcef11bSdrh **
40412dcef11bSdrh ** This routine is used for expressions that are used multiple
40422dcef11bSdrh ** times.  They are evaluated once and the results of the expression
40432dcef11bSdrh ** are reused.
404425303780Sdrh */
404505a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
404625303780Sdrh   Vdbe *v = pParse->pVdbe;
404725303780Sdrh   int iMem;
404805a86c5cSdrh 
404905a86c5cSdrh   assert( target>0 );
405005a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
405105a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
40522dcef11bSdrh   iMem = ++pParse->nMem;
405305a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4054a4c3c87eSdrh   exprToRegister(pExpr, iMem);
405525303780Sdrh }
40567e02e5e6Sdrh 
4057678ccce8Sdrh /*
4058268380caSdrh ** Generate code that pushes the value of every element of the given
40599cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4060268380caSdrh **
4061892d3179Sdrh ** Return the number of elements evaluated.
4062d1a01edaSdrh **
4063d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4064d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4065d1a01edaSdrh **
4066d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4067d1a01edaSdrh ** factored out into initialization code.
4068b0df9634Sdrh **
4069b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4070b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4071b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
4072268380caSdrh */
40734adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4074268380caSdrh   Parse *pParse,     /* Parsing context */
4075389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4076191b54cbSdrh   int target,        /* Where to write results */
40775579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4078d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4079268380caSdrh ){
4080268380caSdrh   struct ExprList_item *pItem;
40815579d59fSdrh   int i, j, n;
4082d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
40835579d59fSdrh   Vdbe *v = pParse->pVdbe;
40849d8b3072Sdrh   assert( pList!=0 );
40859cbf3425Sdrh   assert( target>0 );
4086d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4087268380caSdrh   n = pList->nExpr;
4088d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4089191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
40907445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
40915579d59fSdrh     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
40925579d59fSdrh       sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
40935579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4094d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
4095d1a01edaSdrh     }else{
40967445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4097746fd9ccSdrh       if( inReg!=target+i ){
40984eded604Sdrh         VdbeOp *pOp;
40994eded604Sdrh         if( copyOp==OP_Copy
41004eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
41014eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
41024eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
41034eded604Sdrh         ){
41044eded604Sdrh           pOp->p3++;
41054eded604Sdrh         }else{
41064eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
41074eded604Sdrh         }
4108d1a01edaSdrh       }
4109d176611bSdrh     }
4110268380caSdrh   }
4111f9b596ebSdrh   return n;
4112268380caSdrh }
4113268380caSdrh 
4114268380caSdrh /*
411536c563a2Sdrh ** Generate code for a BETWEEN operator.
411636c563a2Sdrh **
411736c563a2Sdrh **    x BETWEEN y AND z
411836c563a2Sdrh **
411936c563a2Sdrh ** The above is equivalent to
412036c563a2Sdrh **
412136c563a2Sdrh **    x>=y AND x<=z
412236c563a2Sdrh **
412336c563a2Sdrh ** Code it as such, taking care to do the common subexpression
412460ec914cSpeter.d.reid ** elimination of x.
412584b19a3dSdrh **
412684b19a3dSdrh ** The xJumpIf parameter determines details:
412784b19a3dSdrh **
412884b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
412984b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
413084b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
413184b19a3dSdrh **
413284b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
413336c563a2Sdrh */
413436c563a2Sdrh static void exprCodeBetween(
413536c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
413636c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
413784b19a3dSdrh   int dest,         /* Jump destination or storage location */
413884b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
413936c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
414036c563a2Sdrh ){
414136c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
414236c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
414336c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4144db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4145db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
414684b19a3dSdrh 
414736c563a2Sdrh 
414871c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
414971c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
415071c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4151db45bd5eSdrh 
4152db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4153db45bd5eSdrh   exprX = *pExpr->pLeft;
415436c563a2Sdrh   exprAnd.op = TK_AND;
415536c563a2Sdrh   exprAnd.pLeft = &compLeft;
415636c563a2Sdrh   exprAnd.pRight = &compRight;
415736c563a2Sdrh   compLeft.op = TK_GE;
4158db45bd5eSdrh   compLeft.pLeft = &exprX;
415936c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
416036c563a2Sdrh   compRight.op = TK_LE;
4161db45bd5eSdrh   compRight.pLeft = &exprX;
416236c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
416312abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
416484b19a3dSdrh   if( xJump ){
416584b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
416636c563a2Sdrh   }else{
4167db45bd5eSdrh     exprX.flags |= EP_FromJoin;
416871c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
416936c563a2Sdrh   }
4170db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
417136c563a2Sdrh 
417236c563a2Sdrh   /* Ensure adequate test coverage */
4173db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4174db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4175db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4176db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4177db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4178db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4179db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4180db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
418184b19a3dSdrh   testcase( xJump==0 );
418236c563a2Sdrh }
418336c563a2Sdrh 
418436c563a2Sdrh /*
4185cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4186cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4187cce7d176Sdrh ** continues straight thru if the expression is false.
4188f5905aa7Sdrh **
4189f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
419035573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4191f2bc013cSdrh **
4192f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4193f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4194f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4195f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4196f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4197cce7d176Sdrh */
41984adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4199cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4200cce7d176Sdrh   int op = 0;
42012dcef11bSdrh   int regFree1 = 0;
42022dcef11bSdrh   int regFree2 = 0;
42032dcef11bSdrh   int r1, r2;
42042dcef11bSdrh 
420535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
420648864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
420733cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4208f2bc013cSdrh   op = pExpr->op;
42097b35a77bSdan   switch( op ){
4210cce7d176Sdrh     case TK_AND: {
42114adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4212c5499befSdrh       testcase( jumpIfNull==0 );
421335573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
421454e2adb5Sdrh       sqlite3ExprCachePush(pParse);
42154adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
42164adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4217d2490904Sdrh       sqlite3ExprCachePop(pParse);
4218cce7d176Sdrh       break;
4219cce7d176Sdrh     }
4220cce7d176Sdrh     case TK_OR: {
4221c5499befSdrh       testcase( jumpIfNull==0 );
42224adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
422354e2adb5Sdrh       sqlite3ExprCachePush(pParse);
42244adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4225d2490904Sdrh       sqlite3ExprCachePop(pParse);
4226cce7d176Sdrh       break;
4227cce7d176Sdrh     }
4228cce7d176Sdrh     case TK_NOT: {
4229c5499befSdrh       testcase( jumpIfNull==0 );
42304adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4231cce7d176Sdrh       break;
4232cce7d176Sdrh     }
4233de845c2fSdrh     case TK_IS:
4234de845c2fSdrh     case TK_ISNOT:
4235de845c2fSdrh       testcase( op==TK_IS );
4236de845c2fSdrh       testcase( op==TK_ISNOT );
4237de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4238de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4239de845c2fSdrh       /* Fall thru */
4240cce7d176Sdrh     case TK_LT:
4241cce7d176Sdrh     case TK_LE:
4242cce7d176Sdrh     case TK_GT:
4243cce7d176Sdrh     case TK_GE:
4244cce7d176Sdrh     case TK_NE:
42450ac65892Sdrh     case TK_EQ: {
4246625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4247c5499befSdrh       testcase( jumpIfNull==0 );
4248b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4249b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
425035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
42512dcef11bSdrh                   r1, r2, dest, jumpIfNull);
42527d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
42537d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
42547d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
42557d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4256de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4257de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4258de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4259de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4260de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4261de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
42626a2fe093Sdrh       testcase( regFree1==0 );
42636a2fe093Sdrh       testcase( regFree2==0 );
42646a2fe093Sdrh       break;
42656a2fe093Sdrh     }
4266cce7d176Sdrh     case TK_ISNULL:
4267cce7d176Sdrh     case TK_NOTNULL: {
42687d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
42697d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
42702dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42712dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
42727d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42737d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4274c5499befSdrh       testcase( regFree1==0 );
4275cce7d176Sdrh       break;
4276cce7d176Sdrh     }
4277fef5208cSdrh     case TK_BETWEEN: {
42785c03f30aSdrh       testcase( jumpIfNull==0 );
427971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4280fef5208cSdrh       break;
4281fef5208cSdrh     }
4282bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4283e3365e6cSdrh     case TK_IN: {
4284e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4285e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4286e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4287076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4288e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4289e3365e6cSdrh       break;
4290e3365e6cSdrh     }
4291bb201344Sshaneh #endif
4292cce7d176Sdrh     default: {
42937b35a77bSdan     default_expr:
4294991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4295076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4296991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4297991a1985Sdrh         /* No-op */
4298991a1985Sdrh       }else{
42992dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
43002dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4301688852abSdrh         VdbeCoverage(v);
4302c5499befSdrh         testcase( regFree1==0 );
4303c5499befSdrh         testcase( jumpIfNull==0 );
4304991a1985Sdrh       }
4305cce7d176Sdrh       break;
4306cce7d176Sdrh     }
4307cce7d176Sdrh   }
43082dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
43092dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4310cce7d176Sdrh }
4311cce7d176Sdrh 
4312cce7d176Sdrh /*
431366b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4314cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4315cce7d176Sdrh ** continues straight thru if the expression is true.
4316f5905aa7Sdrh **
4317f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
431835573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
431935573356Sdrh ** is 0.
4320cce7d176Sdrh */
43214adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4322cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4323cce7d176Sdrh   int op = 0;
43242dcef11bSdrh   int regFree1 = 0;
43252dcef11bSdrh   int regFree2 = 0;
43262dcef11bSdrh   int r1, r2;
43272dcef11bSdrh 
432835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
432948864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
433033cd4909Sdrh   if( pExpr==0 )    return;
4331f2bc013cSdrh 
4332f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4333f2bc013cSdrh   **
4334f2bc013cSdrh   **       pExpr->op            op
4335f2bc013cSdrh   **       ---------          ----------
4336f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4337f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4338f2bc013cSdrh   **       TK_NE              OP_Eq
4339f2bc013cSdrh   **       TK_EQ              OP_Ne
4340f2bc013cSdrh   **       TK_GT              OP_Le
4341f2bc013cSdrh   **       TK_LE              OP_Gt
4342f2bc013cSdrh   **       TK_GE              OP_Lt
4343f2bc013cSdrh   **       TK_LT              OP_Ge
4344f2bc013cSdrh   **
4345f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4346f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4347f2bc013cSdrh   ** can compute the mapping above using the following expression.
4348f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4349f2bc013cSdrh   */
4350f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4351f2bc013cSdrh 
4352f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4353f2bc013cSdrh   */
4354f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4355f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4356f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4357f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4358f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4359f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4360f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4361f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4362f2bc013cSdrh 
4363ba00e30aSdan   switch( pExpr->op ){
4364cce7d176Sdrh     case TK_AND: {
4365c5499befSdrh       testcase( jumpIfNull==0 );
43664adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
436754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43684adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4369d2490904Sdrh       sqlite3ExprCachePop(pParse);
4370cce7d176Sdrh       break;
4371cce7d176Sdrh     }
4372cce7d176Sdrh     case TK_OR: {
43734adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4374c5499befSdrh       testcase( jumpIfNull==0 );
437535573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
437654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43774adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
43784adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4379d2490904Sdrh       sqlite3ExprCachePop(pParse);
4380cce7d176Sdrh       break;
4381cce7d176Sdrh     }
4382cce7d176Sdrh     case TK_NOT: {
43835c03f30aSdrh       testcase( jumpIfNull==0 );
43844adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4385cce7d176Sdrh       break;
4386cce7d176Sdrh     }
4387de845c2fSdrh     case TK_IS:
4388de845c2fSdrh     case TK_ISNOT:
4389de845c2fSdrh       testcase( pExpr->op==TK_IS );
4390de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4391de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4392de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4393de845c2fSdrh       /* Fall thru */
4394cce7d176Sdrh     case TK_LT:
4395cce7d176Sdrh     case TK_LE:
4396cce7d176Sdrh     case TK_GT:
4397cce7d176Sdrh     case TK_GE:
4398cce7d176Sdrh     case TK_NE:
4399cce7d176Sdrh     case TK_EQ: {
4400625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4401c5499befSdrh       testcase( jumpIfNull==0 );
4402b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4403b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
440435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
44052dcef11bSdrh                   r1, r2, dest, jumpIfNull);
44067d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
44077d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
44087d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
44097d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4410de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4411de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4412de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4413de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4414de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4415de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
44166a2fe093Sdrh       testcase( regFree1==0 );
44176a2fe093Sdrh       testcase( regFree2==0 );
44186a2fe093Sdrh       break;
44196a2fe093Sdrh     }
4420cce7d176Sdrh     case TK_ISNULL:
4421cce7d176Sdrh     case TK_NOTNULL: {
44222dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
44232dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
44247d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
44257d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4426c5499befSdrh       testcase( regFree1==0 );
4427cce7d176Sdrh       break;
4428cce7d176Sdrh     }
4429fef5208cSdrh     case TK_BETWEEN: {
44305c03f30aSdrh       testcase( jumpIfNull==0 );
443171c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4432fef5208cSdrh       break;
4433fef5208cSdrh     }
4434bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4435e3365e6cSdrh     case TK_IN: {
4436e3365e6cSdrh       if( jumpIfNull ){
4437e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4438e3365e6cSdrh       }else{
4439e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4440e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4441e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4442e3365e6cSdrh       }
4443e3365e6cSdrh       break;
4444e3365e6cSdrh     }
4445bb201344Sshaneh #endif
4446cce7d176Sdrh     default: {
4447ba00e30aSdan     default_expr:
4448991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4449076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4450991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4451991a1985Sdrh         /* no-op */
4452991a1985Sdrh       }else{
44532dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
44542dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4455688852abSdrh         VdbeCoverage(v);
4456c5499befSdrh         testcase( regFree1==0 );
4457c5499befSdrh         testcase( jumpIfNull==0 );
4458991a1985Sdrh       }
4459cce7d176Sdrh       break;
4460cce7d176Sdrh     }
4461cce7d176Sdrh   }
44622dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44632dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4464cce7d176Sdrh }
44652282792aSdrh 
44662282792aSdrh /*
446772bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
446872bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
446972bc8208Sdrh ** ensures that the original pExpr is unchanged.
447072bc8208Sdrh */
447172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
447272bc8208Sdrh   sqlite3 *db = pParse->db;
447372bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
447472bc8208Sdrh   if( db->mallocFailed==0 ){
447572bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
447672bc8208Sdrh   }
447772bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
447872bc8208Sdrh }
447972bc8208Sdrh 
448072bc8208Sdrh 
448172bc8208Sdrh /*
44821d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
44831d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
44841d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
44851d9da70aSdrh ** other than the top-level COLLATE operator.
4486d40aab0eSdrh **
4487619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4488619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4489619a1305Sdrh **
449066518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
449166518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
449266518ca7Sdrh **
44931d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4494d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
44951d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
44961d9da70aSdrh ** returns 2, then you do not really know for certain if the two
44971d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4498d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
44991d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4500d40aab0eSdrh ** just might result in some slightly slower code.  But returning
45011d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
45022282792aSdrh */
4503619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
450410d1edf0Sdrh   u32 combinedFlags;
45054b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
45061d9da70aSdrh     return pB==pA ? 0 : 2;
45072282792aSdrh   }
450810d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
450910d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
451010d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
451110d1edf0Sdrh       return 0;
451210d1edf0Sdrh     }
45131d9da70aSdrh     return 2;
45146ab3a2ecSdanielk1977   }
4515c2acc4e4Sdrh   if( pA->op!=pB->op ){
4516619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
4517ae80ddeaSdrh       return 1;
4518ae80ddeaSdrh     }
4519619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
4520ae80ddeaSdrh       return 1;
4521ae80ddeaSdrh     }
4522ae80ddeaSdrh     return 2;
4523ae80ddeaSdrh   }
45242edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4525390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4526390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4527390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
452810d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
452910d1edf0Sdrh     }
453010d1edf0Sdrh   }
453110d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
453285f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
453310d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4534619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
4535619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
4536619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
45377693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4538619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
453966518ca7Sdrh       if( pA->iTable!=pB->iTable
454085f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
45411d9da70aSdrh     }
45421d9da70aSdrh   }
45432646da7eSdrh   return 0;
45442646da7eSdrh }
45452282792aSdrh 
45468c6f666bSdrh /*
45478c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
45488c6f666bSdrh ** non-zero if they differ in any way.
45498c6f666bSdrh **
4550619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4551619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4552619a1305Sdrh **
45538c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
45548c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
45558c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
45568c6f666bSdrh ** a malfunction will result.
45578c6f666bSdrh **
45588c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
45598c6f666bSdrh ** always differs from a non-NULL pointer.
45608c6f666bSdrh */
4561619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
45628c6f666bSdrh   int i;
45638c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
45648c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
45658c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
45668c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
45678c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
45688c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
45698c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
4570619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
45718c6f666bSdrh   }
45728c6f666bSdrh   return 0;
45738c6f666bSdrh }
457413449892Sdrh 
45752282792aSdrh /*
45764bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
45774bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
45784bd5f73fSdrh ** be false.  Examples:
45794bd5f73fSdrh **
4580619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
45814bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4582619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
45834bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4584619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4585619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4586619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
45874bd5f73fSdrh **
45884bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
45894bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
45904bd5f73fSdrh **
45914bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
45924bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
45934bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
45944bd5f73fSdrh */
45954bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
4596619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
4597619a1305Sdrh     return 1;
4598619a1305Sdrh   }
4599619a1305Sdrh   if( pE2->op==TK_OR
4600619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
4601619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
4602619a1305Sdrh   ){
4603619a1305Sdrh     return 1;
4604619a1305Sdrh   }
4605619a1305Sdrh   if( pE2->op==TK_NOTNULL
4606619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
4607619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
4608619a1305Sdrh   ){
4609619a1305Sdrh     return 1;
4610619a1305Sdrh   }
4611619a1305Sdrh   return 0;
46124bd5f73fSdrh }
46134bd5f73fSdrh 
46144bd5f73fSdrh /*
4615030796dfSdrh ** An instance of the following structure is used by the tree walker
46162409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
46172409f8a1Sdrh ** index only, without having to do a search for the corresponding
46182409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
46192409f8a1Sdrh ** is the cursor for the table.
46202409f8a1Sdrh */
46212409f8a1Sdrh struct IdxCover {
46222409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
46232409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
46242409f8a1Sdrh };
46252409f8a1Sdrh 
46262409f8a1Sdrh /*
46272409f8a1Sdrh ** Check to see if there are references to columns in table
46282409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
46292409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
46302409f8a1Sdrh */
46312409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
46322409f8a1Sdrh   if( pExpr->op==TK_COLUMN
46332409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
46342409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
46352409f8a1Sdrh   ){
46362409f8a1Sdrh     pWalker->eCode = 1;
46372409f8a1Sdrh     return WRC_Abort;
46382409f8a1Sdrh   }
46392409f8a1Sdrh   return WRC_Continue;
46402409f8a1Sdrh }
46412409f8a1Sdrh 
46422409f8a1Sdrh /*
4643e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4644e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4645e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4646e604ec0bSdrh ** that are not found in the index pIdx.
46472409f8a1Sdrh **
46482409f8a1Sdrh ** An index covering an expression means that the expression can be
46492409f8a1Sdrh ** evaluated using only the index and without having to lookup the
46502409f8a1Sdrh ** corresponding table entry.
46512409f8a1Sdrh */
46522409f8a1Sdrh int sqlite3ExprCoveredByIndex(
46532409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
46542409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
46552409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
46562409f8a1Sdrh ){
46572409f8a1Sdrh   Walker w;
46582409f8a1Sdrh   struct IdxCover xcov;
46592409f8a1Sdrh   memset(&w, 0, sizeof(w));
46602409f8a1Sdrh   xcov.iCur = iCur;
46612409f8a1Sdrh   xcov.pIdx = pIdx;
46622409f8a1Sdrh   w.xExprCallback = exprIdxCover;
46632409f8a1Sdrh   w.u.pIdxCover = &xcov;
46642409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
46652409f8a1Sdrh   return !w.eCode;
46662409f8a1Sdrh }
46672409f8a1Sdrh 
46682409f8a1Sdrh 
46692409f8a1Sdrh /*
46702409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4671030796dfSdrh ** to count references to table columns in the arguments of an
4672ed551b95Sdrh ** aggregate function, in order to implement the
4673ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4674374fdce4Sdrh */
4675030796dfSdrh struct SrcCount {
4676030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4677030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4678030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4679030796dfSdrh };
4680030796dfSdrh 
4681030796dfSdrh /*
4682030796dfSdrh ** Count the number of references to columns.
4683030796dfSdrh */
4684030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4685fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4686fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4687fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4688fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4689fb0a6081Sdrh   ** NEVER() will need to be removed. */
4690fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4691374fdce4Sdrh     int i;
4692030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4693030796dfSdrh     SrcList *pSrc = p->pSrc;
4694655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4695655814d2Sdrh     for(i=0; i<nSrc; i++){
4696030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4697374fdce4Sdrh     }
4698655814d2Sdrh     if( i<nSrc ){
4699030796dfSdrh       p->nThis++;
4700374fdce4Sdrh     }else{
4701030796dfSdrh       p->nOther++;
4702374fdce4Sdrh     }
4703374fdce4Sdrh   }
4704030796dfSdrh   return WRC_Continue;
4705030796dfSdrh }
4706374fdce4Sdrh 
4707374fdce4Sdrh /*
4708030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4709030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4710030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4711030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4712374fdce4Sdrh */
4713030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4714374fdce4Sdrh   Walker w;
4715030796dfSdrh   struct SrcCount cnt;
4716374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4717374fdce4Sdrh   memset(&w, 0, sizeof(w));
4718030796dfSdrh   w.xExprCallback = exprSrcCount;
4719030796dfSdrh   w.u.pSrcCount = &cnt;
4720030796dfSdrh   cnt.pSrc = pSrcList;
4721030796dfSdrh   cnt.nThis = 0;
4722030796dfSdrh   cnt.nOther = 0;
4723030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4724030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4725374fdce4Sdrh }
4726374fdce4Sdrh 
4727374fdce4Sdrh /*
472813449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
472913449892Sdrh ** the new element.  Return a negative number if malloc fails.
47302282792aSdrh */
473117435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
473213449892Sdrh   int i;
4733cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
473417435752Sdrh        db,
4735cf643729Sdrh        pInfo->aCol,
4736cf643729Sdrh        sizeof(pInfo->aCol[0]),
4737cf643729Sdrh        &pInfo->nColumn,
4738cf643729Sdrh        &i
4739cf643729Sdrh   );
474013449892Sdrh   return i;
47412282792aSdrh }
474213449892Sdrh 
474313449892Sdrh /*
474413449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
474513449892Sdrh ** the new element.  Return a negative number if malloc fails.
474613449892Sdrh */
474717435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
474813449892Sdrh   int i;
4749cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
475017435752Sdrh        db,
4751cf643729Sdrh        pInfo->aFunc,
4752cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4753cf643729Sdrh        &pInfo->nFunc,
4754cf643729Sdrh        &i
4755cf643729Sdrh   );
475613449892Sdrh   return i;
47572282792aSdrh }
47582282792aSdrh 
47592282792aSdrh /*
47607d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
47617d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4762626a879aSdrh ** for additional information.
47632282792aSdrh */
47647d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
47652282792aSdrh   int i;
47667d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4767a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4768a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
476913449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
477013449892Sdrh 
47712282792aSdrh   switch( pExpr->op ){
477289c69d00Sdrh     case TK_AGG_COLUMN:
4773967e8b73Sdrh     case TK_COLUMN: {
47748b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
47758b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
477613449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
477713449892Sdrh       ** clause of the aggregate query */
477820bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
477913449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
478013449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
478113449892Sdrh           struct AggInfo_col *pCol;
4782c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
478313449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
478413449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
478513449892Sdrh             ** that is in the FROM clause of the aggregate query.
478613449892Sdrh             **
478713449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
478813449892Sdrh             ** is not an entry there already.
478913449892Sdrh             */
47907f906d63Sdrh             int k;
479113449892Sdrh             pCol = pAggInfo->aCol;
47927f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
479313449892Sdrh               if( pCol->iTable==pExpr->iTable &&
479413449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
47952282792aSdrh                 break;
47962282792aSdrh               }
47972282792aSdrh             }
47981e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
47991e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
48001e536953Sdanielk1977             ){
48017f906d63Sdrh               pCol = &pAggInfo->aCol[k];
48020817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
480313449892Sdrh               pCol->iTable = pExpr->iTable;
480413449892Sdrh               pCol->iColumn = pExpr->iColumn;
48050a07c107Sdrh               pCol->iMem = ++pParse->nMem;
480613449892Sdrh               pCol->iSorterColumn = -1;
48075774b806Sdrh               pCol->pExpr = pExpr;
480813449892Sdrh               if( pAggInfo->pGroupBy ){
480913449892Sdrh                 int j, n;
481013449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
481113449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
481213449892Sdrh                 n = pGB->nExpr;
481313449892Sdrh                 for(j=0; j<n; j++, pTerm++){
481413449892Sdrh                   Expr *pE = pTerm->pExpr;
481513449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
481613449892Sdrh                       pE->iColumn==pExpr->iColumn ){
481713449892Sdrh                     pCol->iSorterColumn = j;
481813449892Sdrh                     break;
48192282792aSdrh                   }
482013449892Sdrh                 }
482113449892Sdrh               }
482213449892Sdrh               if( pCol->iSorterColumn<0 ){
482313449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
482413449892Sdrh               }
482513449892Sdrh             }
482613449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
482713449892Sdrh             ** because it was there before or because we just created it).
482813449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
482913449892Sdrh             ** pAggInfo->aCol[] entry.
483013449892Sdrh             */
4831ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
483213449892Sdrh             pExpr->pAggInfo = pAggInfo;
483313449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4834cf697396Sshane             pExpr->iAgg = (i16)k;
483513449892Sdrh             break;
483613449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
483713449892Sdrh         } /* end loop over pSrcList */
4838a58fdfb1Sdanielk1977       }
48397d10d5a6Sdrh       return WRC_Prune;
48402282792aSdrh     }
48412282792aSdrh     case TK_AGG_FUNCTION: {
48423a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4843ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
48443a8c4be7Sdrh       ){
484513449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
484613449892Sdrh         ** function that is already in the pAggInfo structure
484713449892Sdrh         */
484813449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
484913449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4850619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
48512282792aSdrh             break;
48522282792aSdrh           }
48532282792aSdrh         }
485413449892Sdrh         if( i>=pAggInfo->nFunc ){
485513449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
485613449892Sdrh           */
485714db2665Sdanielk1977           u8 enc = ENC(pParse->db);
48581e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
485913449892Sdrh           if( i>=0 ){
48606ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
486113449892Sdrh             pItem = &pAggInfo->aFunc[i];
486213449892Sdrh             pItem->pExpr = pExpr;
48630a07c107Sdrh             pItem->iMem = ++pParse->nMem;
486433e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
486513449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
486680738d9cSdrh                    pExpr->u.zToken,
48676ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4868fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4869fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4870fd357974Sdrh             }else{
4871fd357974Sdrh               pItem->iDistinct = -1;
4872fd357974Sdrh             }
48732282792aSdrh           }
487413449892Sdrh         }
487513449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
487613449892Sdrh         */
4877c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4878ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4879cf697396Sshane         pExpr->iAgg = (i16)i;
488013449892Sdrh         pExpr->pAggInfo = pAggInfo;
48813a8c4be7Sdrh         return WRC_Prune;
48826e83a57fSdrh       }else{
48836e83a57fSdrh         return WRC_Continue;
48846e83a57fSdrh       }
48852282792aSdrh     }
4886a58fdfb1Sdanielk1977   }
48877d10d5a6Sdrh   return WRC_Continue;
48887d10d5a6Sdrh }
48897d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4890d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4891d5a336efSdrh   UNUSED_PARAMETER(pSelect);
48927d10d5a6Sdrh   return WRC_Continue;
4893a58fdfb1Sdanielk1977 }
4894626a879aSdrh 
4895626a879aSdrh /*
4896e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4897e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4898e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4899e8abb4caSdrh ** necessary.
4900626a879aSdrh **
4901626a879aSdrh ** This routine should only be called after the expression has been
49027d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4903626a879aSdrh */
4904d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
49057d10d5a6Sdrh   Walker w;
4906374fdce4Sdrh   memset(&w, 0, sizeof(w));
49077d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
49087d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
49097d10d5a6Sdrh   w.u.pNC = pNC;
491020bc393cSdrh   assert( pNC->pSrcList!=0 );
49117d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
49122282792aSdrh }
49135d9a4af9Sdrh 
49145d9a4af9Sdrh /*
49155d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
49165d9a4af9Sdrh ** expression list.  Return the number of errors.
49175d9a4af9Sdrh **
49185d9a4af9Sdrh ** If an error is found, the analysis is cut short.
49195d9a4af9Sdrh */
4920d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
49215d9a4af9Sdrh   struct ExprList_item *pItem;
49225d9a4af9Sdrh   int i;
49235d9a4af9Sdrh   if( pList ){
4924d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4925d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
49265d9a4af9Sdrh     }
49275d9a4af9Sdrh   }
49285d9a4af9Sdrh }
4929892d3179Sdrh 
4930892d3179Sdrh /*
4931ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4932892d3179Sdrh */
4933892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4934e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4935892d3179Sdrh     return ++pParse->nMem;
4936892d3179Sdrh   }
49372f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4938892d3179Sdrh }
4939ceea3321Sdrh 
4940ceea3321Sdrh /*
4941ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4942ceea3321Sdrh ** purpose.
4943ceea3321Sdrh **
4944ceea3321Sdrh ** If a register is currently being used by the column cache, then
494560ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4946ceea3321Sdrh ** the register becomes stale.
4947ceea3321Sdrh */
4948892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
49492dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4950ceea3321Sdrh     int i;
4951ceea3321Sdrh     struct yColCache *p;
4952*9b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
4953ceea3321Sdrh       if( p->iReg==iReg ){
4954ceea3321Sdrh         p->tempReg = 1;
4955ceea3321Sdrh         return;
4956ceea3321Sdrh       }
4957ceea3321Sdrh     }
4958892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4959892d3179Sdrh   }
4960892d3179Sdrh }
4961892d3179Sdrh 
4962892d3179Sdrh /*
4963ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
4964892d3179Sdrh */
4965892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4966e55cbd72Sdrh   int i, n;
4967ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
4968892d3179Sdrh   i = pParse->iRangeReg;
4969e55cbd72Sdrh   n = pParse->nRangeReg;
4970f49f3523Sdrh   if( nReg<=n ){
4971f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4972892d3179Sdrh     pParse->iRangeReg += nReg;
4973892d3179Sdrh     pParse->nRangeReg -= nReg;
4974892d3179Sdrh   }else{
4975892d3179Sdrh     i = pParse->nMem+1;
4976892d3179Sdrh     pParse->nMem += nReg;
4977892d3179Sdrh   }
4978892d3179Sdrh   return i;
4979892d3179Sdrh }
4980892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4981ed24da4bSdrh   if( nReg==1 ){
4982ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
4983ed24da4bSdrh     return;
4984ed24da4bSdrh   }
4985f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4986892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4987892d3179Sdrh     pParse->nRangeReg = nReg;
4988892d3179Sdrh     pParse->iRangeReg = iReg;
4989892d3179Sdrh   }
4990892d3179Sdrh }
4991cdc69557Sdrh 
4992cdc69557Sdrh /*
4993cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4994cdc69557Sdrh */
4995cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4996cdc69557Sdrh   pParse->nTempReg = 0;
4997cdc69557Sdrh   pParse->nRangeReg = 0;
4998cdc69557Sdrh }
4999bb9b5f26Sdrh 
5000bb9b5f26Sdrh /*
5001bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5002bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5003bb9b5f26Sdrh ** statements.
5004bb9b5f26Sdrh */
5005bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5006bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5007bb9b5f26Sdrh   int i;
5008bb9b5f26Sdrh   if( pParse->nRangeReg>0
5009bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
5010bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
5011bb9b5f26Sdrh   ){
5012bb9b5f26Sdrh      return 0;
5013bb9b5f26Sdrh   }
5014bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5015bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5016bb9b5f26Sdrh       return 0;
5017bb9b5f26Sdrh     }
5018bb9b5f26Sdrh   }
5019bb9b5f26Sdrh   return 1;
5020bb9b5f26Sdrh }
5021bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5022