xref: /sqlite-3.40.0/src/expr.c (revision b98a2e35)
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
61b8d29c2fSdan   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
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);
23413ac46eeSdrh   }else if( 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 
355ba00e30aSdan /*
356fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
357fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
358fc7f27b9Sdrh ** ensure that i is within range.
359fc7f27b9Sdrh **
36076dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
36176dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
36276dbe7a8Sdrh **
363fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
364fc7f27b9Sdrh **
365fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
36676dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
36776dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
36876dbe7a8Sdrh ** been positioned.
369ba00e30aSdan */
370fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
371870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
372870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
3739f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
3749f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
37571c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
376870a0705Sdan     }else{
37771c57db0Sdan       return pVector->x.pList->a[i].pExpr;
37871c57db0Sdan     }
379870a0705Sdan   }
380870a0705Sdan   return pVector;
381870a0705Sdan }
382fc7f27b9Sdrh 
383fc7f27b9Sdrh /*
384fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
385fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
386fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
387fc7f27b9Sdrh **
3888762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
3898762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
3908762ec19Sdrh **
391fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
392fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
393fc7f27b9Sdrh **
3948762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
395fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
3968762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
3978762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
39876dbe7a8Sdrh ** returns.
3998762ec19Sdrh **
4008762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4018762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4028762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
403fc7f27b9Sdrh */
404fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
405fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
406fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
407a1251bc4Sdrh   int iField           /* Which column of the vector to return */
408fc7f27b9Sdrh ){
409fc7f27b9Sdrh   Expr *pRet;
410a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
411a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
412fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
413fc7f27b9Sdrh     **
414966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4158762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
416fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
417966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
418fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
419fc7f27b9Sdrh     **                  if the result is not yet computed.
420fc7f27b9Sdrh     **
421fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
422fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4238762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4248762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4258762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4268762ec19Sdrh     ** will own the pVector.
427fc7f27b9Sdrh     */
428abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4298bd0d58eSdrh     if( pRet ){
4308bd0d58eSdrh       pRet->iColumn = iField;
4318bd0d58eSdrh       pRet->pLeft = pVector;
4328bd0d58eSdrh     }
433fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
434fc7f27b9Sdrh   }else{
435a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
436a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
437fc7f27b9Sdrh   }
438fc7f27b9Sdrh   return pRet;
439fc7f27b9Sdrh }
44071c57db0Sdan 
4415c288b92Sdan /*
4425c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4435c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4445c288b92Sdan ** sub-select returns more than one column, the first in an array
4455c288b92Sdan ** of registers in which the result is stored).
4465c288b92Sdan **
4475c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4485c288b92Sdan */
4495c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4508da209b1Sdan   int reg = 0;
451f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4525c288b92Sdan   if( pExpr->op==TK_SELECT ){
4538da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4548da209b1Sdan   }
455f9b2e05cSdan #endif
4568da209b1Sdan   return reg;
4578da209b1Sdan }
4588da209b1Sdan 
4595c288b92Sdan /*
4605c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
461870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
462870a0705Sdan ** the register number of a register that contains the value of
463870a0705Sdan ** element iField of the vector.
464870a0705Sdan **
465870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
466870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
467870a0705Sdan ** case parameter regSelect should be the first in an array of registers
468870a0705Sdan ** containing the results of the sub-select.
469870a0705Sdan **
470870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
471870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
472870a0705Sdan ** a temporary register to be freed by the caller before returning.
4735c288b92Sdan **
4745c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
4755c288b92Sdan ** Expr object corresponding to element iElem of the vector.
4765c288b92Sdan */
4775c288b92Sdan static int exprVectorRegister(
4785c288b92Sdan   Parse *pParse,                  /* Parse context */
4795c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
480870a0705Sdan   int iField,                     /* Field to extract from pVector */
4815c288b92Sdan   int regSelect,                  /* First in array of registers */
4825c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
4835c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
4845c288b92Sdan ){
48512abf408Sdrh   u8 op = pVector->op;
486c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
48712abf408Sdrh   if( op==TK_REGISTER ){
48812abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
48912abf408Sdrh     return pVector->iTable+iField;
49012abf408Sdrh   }
49112abf408Sdrh   if( op==TK_SELECT ){
492870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
493870a0705Sdan      return regSelect+iField;
4945c288b92Sdan   }
495870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
4965c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
4975c288b92Sdan }
4985c288b92Sdan 
4995c288b92Sdan /*
5005c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
50179752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
50279752b6eSdrh ** result into register dest.
50379752b6eSdrh **
50479752b6eSdrh ** The caller must satisfy the following preconditions:
50579752b6eSdrh **
50679752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
50779752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
50879752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5095c288b92Sdan */
51079752b6eSdrh static void codeVectorCompare(
51179752b6eSdrh   Parse *pParse,        /* Code generator context */
51279752b6eSdrh   Expr *pExpr,          /* The comparison operation */
51379752b6eSdrh   int dest,             /* Write results into this register */
51479752b6eSdrh   u8 op,                /* Comparison operator */
51579752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
51679752b6eSdrh ){
51771c57db0Sdan   Vdbe *v = pParse->pVdbe;
51871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
51971c57db0Sdan   Expr *pRight = pExpr->pRight;
52071c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
52171c57db0Sdan   int i;
52271c57db0Sdan   int regLeft = 0;
52371c57db0Sdan   int regRight = 0;
52479752b6eSdrh   u8 opx = op;
52579752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
52671c57db0Sdan 
527245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
528245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
529245ce62eSdrh     return;
530245ce62eSdrh   }
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(
723cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
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 ){
747*b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
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 */
822abfd35eaSdrh   Expr *pRight            /* Right operand */
82317435752Sdrh ){
8245fb52caaSdrh   Expr *p;
8251167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8265fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8275fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8285fb52caaSdrh   }else{
829abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
830abfd35eaSdrh     if( p ){
831abfd35eaSdrh       memset(p, 0, sizeof(Expr));
832abfd35eaSdrh       p->op = op & TKFLG_MASK;
833abfd35eaSdrh       p->iAgg = -1;
834abfd35eaSdrh     }
835b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8365fb52caaSdrh   }
8372b359bdbSdan   if( p ) {
8382b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8392b359bdbSdan   }
8404e0cff60Sdrh   return p;
8414e0cff60Sdrh }
8424e0cff60Sdrh 
8434e0cff60Sdrh /*
84408de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
84508de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
84608de4f79Sdrh */
84708de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
84808de4f79Sdrh   if( pExpr ){
84908de4f79Sdrh     pExpr->x.pSelect = pSelect;
85008de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
85108de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
85208de4f79Sdrh   }else{
85308de4f79Sdrh     assert( pParse->db->mallocFailed );
85408de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
85508de4f79Sdrh   }
85608de4f79Sdrh }
85708de4f79Sdrh 
85808de4f79Sdrh 
85908de4f79Sdrh /*
860991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
861991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
862991a1985Sdrh ** expression at compile-time return 0.
863991a1985Sdrh **
864991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
865991a1985Sdrh ** the expression really is always false or false (a false negative).
866991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
867991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8685fb52caaSdrh **
8695fb52caaSdrh ** Note that if the expression is part of conditional for a
8705fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8715fb52caaSdrh ** is it true or false, so always return 0.
8725fb52caaSdrh */
873991a1985Sdrh static int exprAlwaysTrue(Expr *p){
874991a1985Sdrh   int v = 0;
875991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
876991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
877991a1985Sdrh   return v!=0;
878991a1985Sdrh }
8795fb52caaSdrh static int exprAlwaysFalse(Expr *p){
8805fb52caaSdrh   int v = 0;
8815fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
8825fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
8835fb52caaSdrh   return v==0;
8845fb52caaSdrh }
8855fb52caaSdrh 
8865fb52caaSdrh /*
88791bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
88891bb0eedSdrh ** NULL, then just return the other expression.
8895fb52caaSdrh **
8905fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8915fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8925fb52caaSdrh ** a value of false.
89391bb0eedSdrh */
8941e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
89591bb0eedSdrh   if( pLeft==0 ){
89691bb0eedSdrh     return pRight;
89791bb0eedSdrh   }else if( pRight==0 ){
89891bb0eedSdrh     return pLeft;
8995fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9005fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9015fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9025fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
90391bb0eedSdrh   }else{
904b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
905b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
906b7916a78Sdrh     return pNew;
907a76b5dfcSdrh   }
908a76b5dfcSdrh }
909a76b5dfcSdrh 
910a76b5dfcSdrh /*
911a76b5dfcSdrh ** Construct a new expression node for a function with multiple
912a76b5dfcSdrh ** arguments.
913a76b5dfcSdrh */
91417435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
915a76b5dfcSdrh   Expr *pNew;
916633e6d57Sdrh   sqlite3 *db = pParse->db;
9174b202ae2Sdanielk1977   assert( pToken );
918b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
919a76b5dfcSdrh   if( pNew==0 ){
920d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
921a76b5dfcSdrh     return 0;
922a76b5dfcSdrh   }
9236ab3a2ecSdanielk1977   pNew->x.pList = pList;
9246ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9252308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
926a76b5dfcSdrh   return pNew;
927a76b5dfcSdrh }
928a76b5dfcSdrh 
929a76b5dfcSdrh /*
930fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
931fa6bc000Sdrh ** in the original SQL statement.
932fa6bc000Sdrh **
933fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
934fa6bc000Sdrh ** variable number.
935fa6bc000Sdrh **
936fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9379bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
938fa6bc000Sdrh ** the SQL statement comes from an external source.
939fa6bc000Sdrh **
94051f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
941fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
94260ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
943fa6bc000Sdrh ** assigned.
944fa6bc000Sdrh */
945de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
94617435752Sdrh   sqlite3 *db = pParse->db;
947b7916a78Sdrh   const char *z;
948f326d66dSdrh   ynVar x;
94917435752Sdrh 
950fa6bc000Sdrh   if( pExpr==0 ) return;
951c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
95233e619fcSdrh   z = pExpr->u.zToken;
953b7916a78Sdrh   assert( z!=0 );
954b7916a78Sdrh   assert( z[0]!=0 );
955b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
956b7916a78Sdrh   if( z[1]==0 ){
957fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
958b7916a78Sdrh     assert( z[0]=='?' );
959f326d66dSdrh     x = (ynVar)(++pParse->nVar);
960124c0b49Sdrh   }else{
961f326d66dSdrh     int doAdd = 0;
962124c0b49Sdrh     if( z[0]=='?' ){
963fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
964fa6bc000Sdrh       ** use it as the variable number */
965c8d735aeSdan       i64 i;
96618814dfbSdrh       int bOk;
96718814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
96818814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
96918814dfbSdrh         bOk = 1;
97018814dfbSdrh       }else{
97118814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
97218814dfbSdrh       }
973c5499befSdrh       testcase( i==0 );
974c5499befSdrh       testcase( i==1 );
975c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
976c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
977c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
978fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
979bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
980c9b39288Sdrh         return;
981fa6bc000Sdrh       }
9828e74e7baSdrh       x = (ynVar)i;
983f326d66dSdrh       if( x>pParse->nVar ){
984f326d66dSdrh         pParse->nVar = (int)x;
985f326d66dSdrh         doAdd = 1;
986f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
987f326d66dSdrh         doAdd = 1;
988fa6bc000Sdrh       }
989fa6bc000Sdrh     }else{
99051f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
991fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
992fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
993fa6bc000Sdrh       */
9949bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
9959bf755ccSdrh       if( x==0 ){
9969bf755ccSdrh         x = (ynVar)(++pParse->nVar);
997f326d66dSdrh         doAdd = 1;
998f326d66dSdrh       }
999f326d66dSdrh     }
1000f326d66dSdrh     if( doAdd ){
10019bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1002fa6bc000Sdrh     }
1003fa6bc000Sdrh   }
1004c9b39288Sdrh   pExpr->iColumn = x;
1005f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1006832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1007832b2664Sdanielk1977   }
1008fa6bc000Sdrh }
1009fa6bc000Sdrh 
1010fa6bc000Sdrh /*
1011f6963f99Sdan ** Recursively delete an expression tree.
1012a2e00042Sdrh */
10134f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10144f0010b1Sdrh   assert( p!=0 );
1015d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1016d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1017209bc522Sdrh #ifdef SQLITE_DEBUG
1018209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1019209bc522Sdrh     assert( p->pLeft==0 );
1020209bc522Sdrh     assert( p->pRight==0 );
1021209bc522Sdrh     assert( p->x.pSelect==0 );
1022209bc522Sdrh   }
1023209bc522Sdrh #endif
1024209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1025c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1026c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10274910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1028633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
10296ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
10306ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10316ab3a2ecSdanielk1977     }else{
10326ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10336ab3a2ecSdanielk1977     }
10346ab3a2ecSdanielk1977   }
1035209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
103633e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1037dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1038a2e00042Sdrh   }
103933e619fcSdrh }
10404f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10414f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10424f0010b1Sdrh }
1043a2e00042Sdrh 
1044d2687b77Sdrh /*
10456ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10466ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10476ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10486ab3a2ecSdanielk1977 */
10496ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10506ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10516ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10526ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10536ab3a2ecSdanielk1977 }
10546ab3a2ecSdanielk1977 
10556ab3a2ecSdanielk1977 /*
105633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
105733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
105833e619fcSdrh ** how much of the tree is measured.
105933e619fcSdrh **
106033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
106133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
106233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
106333e619fcSdrh **
106433e619fcSdrh ***************************************************************************
106533e619fcSdrh **
106633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
106733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
106833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
106933e619fcSdrh ** The return values is always one of:
107033e619fcSdrh **
107133e619fcSdrh **      EXPR_FULLSIZE
107233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
107333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
107433e619fcSdrh **
107533e619fcSdrh ** The size of the structure can be found by masking the return value
107633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
107733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
107833e619fcSdrh **
107933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
108033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
108133e619fcSdrh ** During expression analysis, extra information is computed and moved into
108233e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
108333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
108460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
108533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
108633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
108733e619fcSdrh ** to enforce this constraint.
10886ab3a2ecSdanielk1977 */
10896ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
10906ab3a2ecSdanielk1977   int nSize;
109133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1092aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1093aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
109447073f62Sdrh   if( 0==flags || p->op==TK_SELECT_COLUMN ){
10956ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
10966ab3a2ecSdanielk1977   }else{
1097c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
109833e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1099c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1100ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1101aecd8021Sdrh     if( p->pLeft || p->x.pList ){
110233e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
110333e619fcSdrh     }else{
1104aecd8021Sdrh       assert( p->pRight==0 );
110533e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
110633e619fcSdrh     }
11076ab3a2ecSdanielk1977   }
11086ab3a2ecSdanielk1977   return nSize;
11096ab3a2ecSdanielk1977 }
11106ab3a2ecSdanielk1977 
11116ab3a2ecSdanielk1977 /*
111233e619fcSdrh ** This function returns the space in bytes required to store the copy
111333e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
111433e619fcSdrh ** string is defined.)
11156ab3a2ecSdanielk1977 */
11166ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
111733e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
111833e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
111933e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11206ab3a2ecSdanielk1977   }
1121bc73971dSdanielk1977   return ROUND8(nByte);
11226ab3a2ecSdanielk1977 }
11236ab3a2ecSdanielk1977 
11246ab3a2ecSdanielk1977 /*
11256ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11266ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11276ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11286ab3a2ecSdanielk1977 **
11296ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
113033e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11316ab3a2ecSdanielk1977 **
11326ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11336ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11346ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11356ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11366ab3a2ecSdanielk1977 */
11376ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11386ab3a2ecSdanielk1977   int nByte = 0;
11396ab3a2ecSdanielk1977   if( p ){
11406ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11416ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1142b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11436ab3a2ecSdanielk1977     }
11446ab3a2ecSdanielk1977   }
11456ab3a2ecSdanielk1977   return nByte;
11466ab3a2ecSdanielk1977 }
11476ab3a2ecSdanielk1977 
11486ab3a2ecSdanielk1977 /*
11496ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11506ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
115133e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11526ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
115360ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11546ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11556ab3a2ecSdanielk1977 */
11563c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11573c19469cSdrh   Expr *pNew;           /* Value to return */
11583c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11593c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11606ab3a2ecSdanielk1977 
11613c19469cSdrh   assert( db!=0 );
11623c19469cSdrh   assert( p );
11633c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11643c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11656ab3a2ecSdanielk1977 
11666ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11676ab3a2ecSdanielk1977   if( pzBuffer ){
11686ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
116933e619fcSdrh     staticFlag = EP_Static;
11706ab3a2ecSdanielk1977   }else{
11713c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
11723c19469cSdrh     staticFlag = 0;
11736ab3a2ecSdanielk1977   }
11746ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
11756ab3a2ecSdanielk1977 
11766ab3a2ecSdanielk1977   if( pNew ){
11776ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
11786ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
11796ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
118033e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
11816ab3a2ecSdanielk1977     */
11823c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
118333e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
118433e619fcSdrh     int nToken;
118533e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
118633e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
118733e619fcSdrh     }else{
118833e619fcSdrh       nToken = 0;
118933e619fcSdrh     }
11903c19469cSdrh     if( dupFlags ){
11916ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11926ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11936ab3a2ecSdanielk1977     }else{
11943e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11956ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
119672ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
11976ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
11986ab3a2ecSdanielk1977       }
119972ea29d7Sdrh     }
12006ab3a2ecSdanielk1977 
120133e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1202c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
120333e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
120433e619fcSdrh     pNew->flags |= staticFlag;
12056ab3a2ecSdanielk1977 
120633e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12076ab3a2ecSdanielk1977     if( nToken ){
120833e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
120933e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12106ab3a2ecSdanielk1977     }
12116ab3a2ecSdanielk1977 
1212209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12136ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12146ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12153c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12166ab3a2ecSdanielk1977       }else{
12173c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12186ab3a2ecSdanielk1977       }
12196ab3a2ecSdanielk1977     }
12206ab3a2ecSdanielk1977 
12216ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1222c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12233c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1224209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12253c19469cSdrh         pNew->pLeft = p->pLeft ?
12263c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12273c19469cSdrh         pNew->pRight = p->pRight ?
12283c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12296ab3a2ecSdanielk1977       }
12306ab3a2ecSdanielk1977       if( pzBuffer ){
12316ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12326ab3a2ecSdanielk1977       }
1233b7916a78Sdrh     }else{
1234209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12359854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12369854260bSdrh           pNew->pLeft = p->pLeft;
123747073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
123847073f62Sdrh           assert( p->pRight==0  || p->pRight==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;
1301b163748eSdrh   Expr *pPriorSelectCol = 0;
1302575fad65Sdrh   assert( db!=0 );
1303ff78bd2fSdrh   if( p==0 ) return 0;
130443606175Sdrh   pNew = sqlite3DbMallocRawNN(db,
130543606175Sdrh              sizeof(*pNew)+sizeof(pNew->a[0])*(p->nExpr-1) );
1306ff78bd2fSdrh   if( pNew==0 ) return 0;
130743606175Sdrh   pNew->nAlloc = pNew->nExpr = p->nExpr;
130843606175Sdrh   pItem = pNew->a;
1309145716b3Sdrh   pOldItem = p->a;
1310145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13116ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
131247073f62Sdrh     Expr *pNewExpr;
1313b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
131447073f62Sdrh     if( pOldExpr
131547073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
131647073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
131747073f62Sdrh     ){
131847073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
131947073f62Sdrh       if( pNewExpr->iColumn==0 ){
132047073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1321b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1322b163748eSdrh       }else{
1323b163748eSdrh         assert( i>0 );
1324b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1325b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1326b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1327b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
132847073f62Sdrh       }
132947073f62Sdrh     }
133017435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1331b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1332145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13333e7bc9caSdrh     pItem->done = 0;
13342c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1335c2acc4e4Sdrh     pItem->u = pOldItem->u;
1336ff78bd2fSdrh   }
1337ff78bd2fSdrh   return pNew;
1338ff78bd2fSdrh }
133993758c8dSdanielk1977 
134093758c8dSdanielk1977 /*
134193758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
134293758c8dSdanielk1977 ** the build, then none of the following routines, except for
134393758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
134493758c8dSdanielk1977 ** called with a NULL argument.
134593758c8dSdanielk1977 */
13466a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13476a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13486ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1349ad3cab52Sdrh   SrcList *pNew;
1350ad3cab52Sdrh   int i;
1351113088ecSdrh   int nByte;
1352575fad65Sdrh   assert( db!=0 );
1353ad3cab52Sdrh   if( p==0 ) return 0;
1354113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1355575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1356ad3cab52Sdrh   if( pNew==0 ) return 0;
13574305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1358ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13594efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13604efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1361ed8a3bb1Sdrh     Table *pTab;
136241fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
136317435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
136417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
136517435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13668a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13674efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13685b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
13695b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
13708a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
13718a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
13728a48b9c0Sdrh     }
13738a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
13748a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
13758a48b9c0Sdrh       pNewItem->u1.pFuncArg =
13768a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
13778a48b9c0Sdrh     }
1378ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1379ed8a3bb1Sdrh     if( pTab ){
138079df7782Sdrh       pTab->nTabRef++;
1381a1cb183dSdanielk1977     }
13826ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
13836ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
138417435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
13856c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1386ad3cab52Sdrh   }
1387ad3cab52Sdrh   return pNew;
1388ad3cab52Sdrh }
138917435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1390ff78bd2fSdrh   IdList *pNew;
1391ff78bd2fSdrh   int i;
1392575fad65Sdrh   assert( db!=0 );
1393ff78bd2fSdrh   if( p==0 ) return 0;
1394575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1395ff78bd2fSdrh   if( pNew==0 ) return 0;
13966c535158Sdrh   pNew->nId = p->nId;
1397575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1398d5d56523Sdanielk1977   if( pNew->a==0 ){
1399dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1400d5d56523Sdanielk1977     return 0;
1401d5d56523Sdanielk1977   }
14026c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14036c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14046c535158Sdrh   ** on the duplicate created by this function. */
1405ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14064efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14074efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
140817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14094efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1410ff78bd2fSdrh   }
1411ff78bd2fSdrh   return pNew;
1412ff78bd2fSdrh }
1413a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1414a7466205Sdan   Select *pRet = 0;
1415a7466205Sdan   Select *pNext = 0;
1416a7466205Sdan   Select **pp = &pRet;
1417a7466205Sdan   Select *p;
1418a7466205Sdan 
1419575fad65Sdrh   assert( db!=0 );
1420a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1421a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1422a7466205Sdan     if( pNew==0 ) break;
1423b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14246ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14256ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14266ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14276ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14286ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1429ff78bd2fSdrh     pNew->op = p->op;
1430a7466205Sdan     pNew->pNext = pNext;
1431a7466205Sdan     pNew->pPrior = 0;
14326ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
14336ab3a2ecSdanielk1977     pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
143492b01d53Sdrh     pNew->iLimit = 0;
143592b01d53Sdrh     pNew->iOffset = 0;
14367d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1437b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1438b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1439ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14404e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
1441eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1442a7466205Sdan     *pp = pNew;
1443a7466205Sdan     pp = &pNew->pPrior;
1444a7466205Sdan     pNext = pNew;
1445a7466205Sdan   }
1446a7466205Sdan 
1447a7466205Sdan   return pRet;
1448ff78bd2fSdrh }
144993758c8dSdanielk1977 #else
14506ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
145193758c8dSdanielk1977   assert( p==0 );
145293758c8dSdanielk1977   return 0;
145393758c8dSdanielk1977 }
145493758c8dSdanielk1977 #endif
1455ff78bd2fSdrh 
1456ff78bd2fSdrh 
1457ff78bd2fSdrh /*
1458a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1459a76b5dfcSdrh ** initially NULL, then create a new expression list.
1460b7916a78Sdrh **
1461b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1462b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1463b7916a78Sdrh ** that the new entry was successfully appended.
1464a76b5dfcSdrh */
146517435752Sdrh ExprList *sqlite3ExprListAppend(
146617435752Sdrh   Parse *pParse,          /* Parsing context */
146717435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1468b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
146917435752Sdrh ){
147043606175Sdrh   struct ExprList_item *pItem;
147117435752Sdrh   sqlite3 *db = pParse->db;
1472575fad65Sdrh   assert( db!=0 );
1473a76b5dfcSdrh   if( pList==0 ){
1474575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1475a76b5dfcSdrh     if( pList==0 ){
1476d5d56523Sdanielk1977       goto no_mem;
1477a76b5dfcSdrh     }
1478c263f7c4Sdrh     pList->nExpr = 0;
147943606175Sdrh     pList->nAlloc = 1;
148043606175Sdrh   }else if( pList->nExpr==pList->nAlloc ){
148143606175Sdrh     ExprList *pNew;
148243606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
148343606175Sdrh              sizeof(*pList)+(2*pList->nAlloc - 1)*sizeof(pList->a[0]));
148443606175Sdrh     if( pNew==0 ){
1485d5d56523Sdanielk1977       goto no_mem;
1486a76b5dfcSdrh     }
148743606175Sdrh     pList = pNew;
148843606175Sdrh     pList->nAlloc *= 2;
1489a76b5dfcSdrh   }
149043606175Sdrh   pItem = &pList->a[pList->nExpr++];
1491a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1492a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1493a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1494e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1495a76b5dfcSdrh   return pList;
1496d5d56523Sdanielk1977 
1497d5d56523Sdanielk1977 no_mem:
1498d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1499633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1500633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1501d5d56523Sdanielk1977   return 0;
1502a76b5dfcSdrh }
1503a76b5dfcSdrh 
1504a76b5dfcSdrh /*
15058762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15068762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1507a1251bc4Sdrh **
1508a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1509a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1510a1251bc4Sdrh **
1511a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1512b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1513a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1514a1251bc4Sdrh */
1515a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1516a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1517a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1518a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1519a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1520a1251bc4Sdrh ){
1521a1251bc4Sdrh   sqlite3 *db = pParse->db;
1522a1251bc4Sdrh   int n;
1523a1251bc4Sdrh   int i;
152466860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1525321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1526321e828dSdrh   ** exit prior to this routine being invoked */
1527321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1528a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1529966e2911Sdrh 
1530966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1531966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1532966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1533966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1534966e2911Sdrh   */
1535966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1536a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1537a1251bc4Sdrh                     pColumns->nId, n);
1538a1251bc4Sdrh     goto vector_append_error;
1539a1251bc4Sdrh   }
1540966e2911Sdrh 
1541966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1542a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1543a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1544a1251bc4Sdrh     if( pList ){
154566860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1546a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1547a1251bc4Sdrh       pColumns->a[i].zName = 0;
1548a1251bc4Sdrh     }
1549a1251bc4Sdrh   }
1550966e2911Sdrh 
1551ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1552966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1553f4dd26c5Sdrh     assert( pFirst!=0 );
1554966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1555966e2911Sdrh 
1556966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1557966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1558966e2911Sdrh     pFirst->pRight = pExpr;
1559a1251bc4Sdrh     pExpr = 0;
1560966e2911Sdrh 
1561966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1562966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1563966e2911Sdrh     pFirst->iTable = pColumns->nId;
1564a1251bc4Sdrh   }
1565a1251bc4Sdrh 
1566a1251bc4Sdrh vector_append_error:
1567a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1568a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1569a1251bc4Sdrh   return pList;
1570a1251bc4Sdrh }
1571a1251bc4Sdrh 
1572a1251bc4Sdrh /*
1573bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1574bc622bc0Sdrh */
1575bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1576bc622bc0Sdrh   if( p==0 ) return;
1577bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1578bc622bc0Sdrh   assert( p->nExpr>0 );
1579bc622bc0Sdrh   if( iSortOrder<0 ){
1580bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1581bc622bc0Sdrh     return;
1582bc622bc0Sdrh   }
1583bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1584bc622bc0Sdrh }
1585bc622bc0Sdrh 
1586bc622bc0Sdrh /*
1587b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1588b7916a78Sdrh ** on the expression list.
1589b7916a78Sdrh **
1590b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1591b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1592b7916a78Sdrh ** is set.
1593b7916a78Sdrh */
1594b7916a78Sdrh void sqlite3ExprListSetName(
1595b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1596b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1597b7916a78Sdrh   Token *pName,           /* Name to be added */
1598b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1599b7916a78Sdrh ){
1600b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1601b7916a78Sdrh   if( pList ){
1602b7916a78Sdrh     struct ExprList_item *pItem;
1603b7916a78Sdrh     assert( pList->nExpr>0 );
1604b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1605b7916a78Sdrh     assert( pItem->zName==0 );
1606b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1607244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1608b7916a78Sdrh   }
1609b7916a78Sdrh }
1610b7916a78Sdrh 
1611b7916a78Sdrh /*
1612b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1613b7916a78Sdrh ** on the expression list.
1614b7916a78Sdrh **
1615b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1616b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1617b7916a78Sdrh ** is set.
1618b7916a78Sdrh */
1619b7916a78Sdrh void sqlite3ExprListSetSpan(
1620b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1621b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1622b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1623b7916a78Sdrh ){
1624b7916a78Sdrh   sqlite3 *db = pParse->db;
1625b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1626b7916a78Sdrh   if( pList ){
1627b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1628b7916a78Sdrh     assert( pList->nExpr>0 );
1629b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1630b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1631b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1632cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1633b7916a78Sdrh   }
1634b7916a78Sdrh }
1635b7916a78Sdrh 
1636b7916a78Sdrh /*
16377a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16387a15a4beSdanielk1977 ** leave an error message in pParse.
16397a15a4beSdanielk1977 */
16407a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16417a15a4beSdanielk1977   Parse *pParse,
16427a15a4beSdanielk1977   ExprList *pEList,
16437a15a4beSdanielk1977   const char *zObject
16447a15a4beSdanielk1977 ){
1645b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1646c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1647c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1648b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16497a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16507a15a4beSdanielk1977   }
16517a15a4beSdanielk1977 }
16527a15a4beSdanielk1977 
16537a15a4beSdanielk1977 /*
1654a76b5dfcSdrh ** Delete an entire expression list.
1655a76b5dfcSdrh */
1656affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1657ac48b751Sdrh   int i = pList->nExpr;
1658ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1659ac48b751Sdrh   assert( pList->nExpr>0 );
1660ac48b751Sdrh   do{
1661633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1662633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1663b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1664ac48b751Sdrh     pItem++;
1665ac48b751Sdrh   }while( --i>0 );
1666dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1667a76b5dfcSdrh }
1668affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1669affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1670affa855cSdrh }
1671a76b5dfcSdrh 
1672a76b5dfcSdrh /*
16732308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
16742308ed38Sdrh ** ExprList.
1675885a5b03Sdrh */
16762308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1677885a5b03Sdrh   int i;
16782308ed38Sdrh   u32 m = 0;
16792308ed38Sdrh   if( pList ){
1680885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1681d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1682de845c2fSdrh        assert( pExpr!=0 );
1683de845c2fSdrh        m |= pExpr->flags;
1684885a5b03Sdrh     }
16852308ed38Sdrh   }
16862308ed38Sdrh   return m;
1687885a5b03Sdrh }
1688885a5b03Sdrh 
1689885a5b03Sdrh /*
1690059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1691059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1692059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1693059b2d50Sdrh ** for.
169473b211abSdrh **
16957d10d5a6Sdrh ** These callback routines are used to implement the following:
1696626a879aSdrh **
1697059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1698059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1699fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1700059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
170187abf5c0Sdrh **
1702059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1703059b2d50Sdrh ** is found to not be a constant.
170487abf5c0Sdrh **
1705feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1706059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1707059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1708feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1709feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1710feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1711feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1712feada2dfSdrh ** malformed schema error.
1713626a879aSdrh */
17147d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1715626a879aSdrh 
1716059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1717059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
17180a168377Sdrh   ** from being considered constant. */
1719059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1720059b2d50Sdrh     pWalker->eCode = 0;
17217d10d5a6Sdrh     return WRC_Abort;
17220a168377Sdrh   }
17230a168377Sdrh 
1724626a879aSdrh   switch( pExpr->op ){
1725eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1726059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1727059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1728eb55bd2fSdrh     case TK_FUNCTION:
172963f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1730b1fba286Sdrh         return WRC_Continue;
1731059b2d50Sdrh       }else{
1732059b2d50Sdrh         pWalker->eCode = 0;
1733059b2d50Sdrh         return WRC_Abort;
1734b1fba286Sdrh       }
1735626a879aSdrh     case TK_ID:
1736626a879aSdrh     case TK_COLUMN:
1737626a879aSdrh     case TK_AGG_FUNCTION:
173813449892Sdrh     case TK_AGG_COLUMN:
1739c5499befSdrh       testcase( pExpr->op==TK_ID );
1740c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1741c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1742c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1743059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1744059b2d50Sdrh         return WRC_Continue;
1745f43ce0b4Sdrh       }
1746f43ce0b4Sdrh       /* Fall through */
1747f43ce0b4Sdrh     case TK_IF_NULL_ROW:
1748f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1749059b2d50Sdrh       pWalker->eCode = 0;
17507d10d5a6Sdrh       return WRC_Abort;
1751feada2dfSdrh     case TK_VARIABLE:
1752059b2d50Sdrh       if( pWalker->eCode==5 ){
1753feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1754feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1755feada2dfSdrh         ** of the sqlite_master table */
1756feada2dfSdrh         pExpr->op = TK_NULL;
1757059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1758feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1759feada2dfSdrh         ** sqlite3_prepare() causes an error */
1760059b2d50Sdrh         pWalker->eCode = 0;
1761feada2dfSdrh         return WRC_Abort;
1762feada2dfSdrh       }
1763feada2dfSdrh       /* Fall through */
1764626a879aSdrh     default:
1765b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1766b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
17677d10d5a6Sdrh       return WRC_Continue;
1768626a879aSdrh   }
1769626a879aSdrh }
177062c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
177162c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1772059b2d50Sdrh   pWalker->eCode = 0;
17737d10d5a6Sdrh   return WRC_Abort;
17747d10d5a6Sdrh }
1775059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
17767d10d5a6Sdrh   Walker w;
1777059b2d50Sdrh   w.eCode = initFlag;
17787d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
17797d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1780979dd1beSdrh #ifdef SQLITE_DEBUG
1781979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1782979dd1beSdrh #endif
1783059b2d50Sdrh   w.u.iCur = iCur;
17847d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1785059b2d50Sdrh   return w.eCode;
17867d10d5a6Sdrh }
1787626a879aSdrh 
1788626a879aSdrh /*
1789059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1790eb55bd2fSdrh ** and 0 if it involves variables or function calls.
17912398937bSdrh **
17922398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
17932398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
17942398937bSdrh ** a constant.
1795fef5208cSdrh */
17964adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1797059b2d50Sdrh   return exprIsConst(p, 1, 0);
1798fef5208cSdrh }
1799fef5208cSdrh 
1800fef5208cSdrh /*
1801059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
18020a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
18030a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
18040a168377Sdrh ** an ON or USING clause.
18050a168377Sdrh */
18060a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1807059b2d50Sdrh   return exprIsConst(p, 2, 0);
18080a168377Sdrh }
18090a168377Sdrh 
18100a168377Sdrh /*
1811fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1812059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1813059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1814059b2d50Sdrh ** table other than iCur.
1815059b2d50Sdrh */
1816059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1817059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1818059b2d50Sdrh }
1819059b2d50Sdrh 
1820ab31a845Sdan 
1821ab31a845Sdan /*
1822ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1823ab31a845Sdan */
1824ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1825ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1826ab31a845Sdan   int i;
1827ab31a845Sdan 
1828ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1829ab31a845Sdan   ** it constant.  */
1830ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1831ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
18325aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
1833ab31a845Sdan       CollSeq *pColl = sqlite3ExprCollSeq(pWalker->pParse, p);
1834ab31a845Sdan       if( pColl==0 || sqlite3_stricmp("BINARY", pColl->zName)==0 ){
1835ab31a845Sdan         return WRC_Prune;
1836ab31a845Sdan       }
1837ab31a845Sdan     }
1838ab31a845Sdan   }
1839ab31a845Sdan 
1840ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1841ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1842ab31a845Sdan     pWalker->eCode = 0;
1843ab31a845Sdan     return WRC_Abort;
1844ab31a845Sdan   }
1845ab31a845Sdan 
1846ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1847ab31a845Sdan }
1848ab31a845Sdan 
1849ab31a845Sdan /*
1850ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1851ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1852ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1853ab314001Sdrh **
1854ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1855ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1856ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1857ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1858ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1859ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1860ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1861ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1862ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1863ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1864ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1865ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1866ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1867ab31a845Sdan */
1868ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1869ab31a845Sdan   Walker w;
1870ab31a845Sdan   w.eCode = 1;
1871ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1872979dd1beSdrh   w.xSelectCallback = 0;
1873ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1874ab31a845Sdan   w.pParse = pParse;
1875ab31a845Sdan   sqlite3WalkExpr(&w, p);
1876ab31a845Sdan   return w.eCode;
1877ab31a845Sdan }
1878ab31a845Sdan 
1879059b2d50Sdrh /*
1880059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1881eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1882eb55bd2fSdrh ** are any variables.
1883eb55bd2fSdrh **
1884eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1885eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1886eb55bd2fSdrh ** a constant.
1887eb55bd2fSdrh */
1888feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1889feada2dfSdrh   assert( isInit==0 || isInit==1 );
1890059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1891eb55bd2fSdrh }
1892eb55bd2fSdrh 
18935b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
18945b88bc4bSdrh /*
18955b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
18965b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
18975b88bc4bSdrh */
18985b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
18995b88bc4bSdrh   Walker w;
1900bec2476aSdrh   w.eCode = 1;
19015b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
19025b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
1903979dd1beSdrh #ifdef SQLITE_DEBUG
1904979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1905979dd1beSdrh #endif
19065b88bc4bSdrh   sqlite3WalkExpr(&w, p);
190707194bffSdrh   return w.eCode==0;
19085b88bc4bSdrh }
19095b88bc4bSdrh #endif
19105b88bc4bSdrh 
1911eb55bd2fSdrh /*
191273b211abSdrh ** If the expression p codes a constant integer that is small enough
1913202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1914202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1915202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1916e4de1febSdrh */
19174adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
191892b01d53Sdrh   int rc = 0;
1919ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
1920cd92e84dSdrh 
1921cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1922cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1923cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1924cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1925cd92e84dSdrh 
192692b01d53Sdrh   if( p->flags & EP_IntValue ){
192733e619fcSdrh     *pValue = p->u.iValue;
1928e4de1febSdrh     return 1;
1929e4de1febSdrh   }
193092b01d53Sdrh   switch( p->op ){
19314b59ab5eSdrh     case TK_UPLUS: {
193292b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1933f6e369a1Sdrh       break;
19344b59ab5eSdrh     }
1935e4de1febSdrh     case TK_UMINUS: {
1936e4de1febSdrh       int v;
19374adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1938f6418891Smistachkin         assert( v!=(-2147483647-1) );
1939e4de1febSdrh         *pValue = -v;
194092b01d53Sdrh         rc = 1;
1941e4de1febSdrh       }
1942e4de1febSdrh       break;
1943e4de1febSdrh     }
1944e4de1febSdrh     default: break;
1945e4de1febSdrh   }
194692b01d53Sdrh   return rc;
1947e4de1febSdrh }
1948e4de1febSdrh 
1949e4de1febSdrh /*
1950039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1951039fc32eSdrh **
1952039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1953039fc32eSdrh ** to tell return TRUE.
1954039fc32eSdrh **
1955039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1956039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1957039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1958039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1959039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1960039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1961039fc32eSdrh ** TRUE.
1962039fc32eSdrh */
1963039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1964039fc32eSdrh   u8 op;
1965cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1966039fc32eSdrh   op = p->op;
1967039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1968039fc32eSdrh   switch( op ){
1969039fc32eSdrh     case TK_INTEGER:
1970039fc32eSdrh     case TK_STRING:
1971039fc32eSdrh     case TK_FLOAT:
1972039fc32eSdrh     case TK_BLOB:
1973039fc32eSdrh       return 0;
19747248a8b2Sdrh     case TK_COLUMN:
19757248a8b2Sdrh       assert( p->pTab!=0 );
197672673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
197772673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1978039fc32eSdrh     default:
1979039fc32eSdrh       return 1;
1980039fc32eSdrh   }
1981039fc32eSdrh }
1982039fc32eSdrh 
1983039fc32eSdrh /*
1984039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1985039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1986039fc32eSdrh ** argument.
1987039fc32eSdrh **
1988039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1989039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1990039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1991039fc32eSdrh ** answer.
1992039fc32eSdrh */
1993039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1994039fc32eSdrh   u8 op;
199505883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1996cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1997039fc32eSdrh   op = p->op;
1998039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1999039fc32eSdrh   switch( op ){
2000039fc32eSdrh     case TK_INTEGER: {
2001039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2002039fc32eSdrh     }
2003039fc32eSdrh     case TK_FLOAT: {
2004039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2005039fc32eSdrh     }
2006039fc32eSdrh     case TK_STRING: {
2007039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2008039fc32eSdrh     }
2009039fc32eSdrh     case TK_BLOB: {
2010039fc32eSdrh       return 1;
2011039fc32eSdrh     }
20122f2855b6Sdrh     case TK_COLUMN: {
201388376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
201488376ca7Sdrh       return p->iColumn<0
20152f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
20162f2855b6Sdrh     }
2017039fc32eSdrh     default: {
2018039fc32eSdrh       return 0;
2019039fc32eSdrh     }
2020039fc32eSdrh   }
2021039fc32eSdrh }
2022039fc32eSdrh 
2023039fc32eSdrh /*
2024c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2025c4a3c779Sdrh */
20264adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
20274adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
20284adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
20294adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2030c4a3c779Sdrh   return 0;
2031c4a3c779Sdrh }
2032c4a3c779Sdrh 
20339a96b668Sdanielk1977 /*
203469c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
203569c355bdSdrh ** that can be simplified to a direct table access, then return
203669c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
203769c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
203869c355bdSdrh ** table, then return NULL.
2039b287f4b6Sdrh */
2040b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
20417b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
204269c355bdSdrh   Select *p;
2043b287f4b6Sdrh   SrcList *pSrc;
2044b287f4b6Sdrh   ExprList *pEList;
2045b287f4b6Sdrh   Table *pTab;
2046cfbb5e82Sdan   int i;
204769c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
204869c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
204969c355bdSdrh   p = pX->x.pSelect;
2050b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
20517d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2052b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2053b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
20547d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
20557d10d5a6Sdrh   }
2056b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2057b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2058b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
2059b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2060b287f4b6Sdrh   pSrc = p->pSrc;
2061d1fa7bcaSdrh   assert( pSrc!=0 );
2062d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2063b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2064b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
206569c355bdSdrh   assert( pTab!=0 );
2066b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2067b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2068b287f4b6Sdrh   pEList = p->pEList;
2069ac6b47d1Sdrh   assert( pEList!=0 );
20707b35a77bSdan   /* All SELECT results must be columns. */
2071cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2072cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2073cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
207469c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2075cfbb5e82Sdan   }
207669c355bdSdrh   return p;
2077b287f4b6Sdrh }
2078b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2079b287f4b6Sdrh 
2080f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
20811d8cb21fSdan /*
20824c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
20834c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
20846be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
20856be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
20866be515ebSdrh */
20876be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2088728e0f91Sdrh   int addr1;
20896be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2090728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
20916be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
20926be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
20934c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2094728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
20956be515ebSdrh }
2096f9b2e05cSdan #endif
20976be515ebSdrh 
2098bb53ecb1Sdrh 
2099bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2100bb53ecb1Sdrh /*
2101bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2102bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2103bb53ecb1Sdrh */
2104bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2105bb53ecb1Sdrh   Expr *pLHS;
2106bb53ecb1Sdrh   int res;
2107bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2108bb53ecb1Sdrh   pLHS = pIn->pLeft;
2109bb53ecb1Sdrh   pIn->pLeft = 0;
2110bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2111bb53ecb1Sdrh   pIn->pLeft = pLHS;
2112bb53ecb1Sdrh   return res;
2113bb53ecb1Sdrh }
2114bb53ecb1Sdrh #endif
2115bb53ecb1Sdrh 
21166be515ebSdrh /*
21179a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2118d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2119d4305ca6Sdrh ** might be either a list of expressions or a subquery.
21209a96b668Sdanielk1977 **
2121d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2122d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2123d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2124d4305ca6Sdrh **
21253a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2126d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2127d4305ca6Sdrh **
2128b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
21299a96b668Sdanielk1977 **
21309a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
21311ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
21321ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
21339a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
21349a96b668Sdanielk1977 **                         populated epheremal table.
2135bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2136bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
21379a96b668Sdanielk1977 **
2138d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2139d4305ca6Sdrh ** subquery such as:
21409a96b668Sdanielk1977 **
2141553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
21429a96b668Sdanielk1977 **
2143d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2144d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
214560ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2146d4305ca6Sdrh ** existing table.
2147d4305ca6Sdrh **
21483a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
21493a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
21503a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
21513a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
21523a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
21533a85625dSdrh ** IN operator.
21543a85625dSdrh **
21553a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
21563a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2157553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2158553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2159553168c7Sdan ** a UNIQUE constraint or index.
21600cdc022eSdanielk1977 **
21613a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
21623a85625dSdrh ** for fast set membership tests) then an epheremal table must
2163553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2164553168c7Sdan ** index can be found with the specified <columns> as its left-most.
21650cdc022eSdanielk1977 **
2166bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2167bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2168bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2169bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2170bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2171bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2172bb53ecb1Sdrh **
2173b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
21743a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2175e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
21763a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
21770cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2178e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2179e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
21800cdc022eSdanielk1977 **
2181e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
21826be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
21836be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
21846be515ebSdrh ** NULL values.
2185553168c7Sdan **
2186553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2187553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2188553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2189553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2190553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2191553168c7Sdan **
2192553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2193553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2194553168c7Sdan **
2195553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
21969a96b668Sdanielk1977 */
2197284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2198ba00e30aSdan int sqlite3FindInIndex(
21996fc8f364Sdrh   Parse *pParse,             /* Parsing context */
22006fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
22016fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
22026fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
22036fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2204ba00e30aSdan ){
2205b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2206b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2207b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
22083a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2209b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
22109a96b668Sdanielk1977 
22111450bc6eSdrh   assert( pX->op==TK_IN );
22123a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
22131450bc6eSdrh 
22147b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
22157b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2216870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
22177b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2218870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
22197b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
22207b35a77bSdan     int i;
22217b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
22227b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
22237b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
22247b35a77bSdan     }
22257b35a77bSdan     if( i==pEList->nExpr ){
22267b35a77bSdan       prRhsHasNull = 0;
22277b35a77bSdan     }
22287b35a77bSdan   }
22297b35a77bSdan 
2230b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2231b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
22327b35a77bSdan   ** ephemeral table.  */
22337b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2234e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2235b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2236ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2237cfbb5e82Sdan     ExprList *pEList = p->pEList;
2238cfbb5e82Sdan     int nExpr = pEList->nExpr;
2239e1fb65a0Sdanielk1977 
2240b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2241b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2242b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2243b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2244b07028f7Sdrh 
2245b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2246e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2247e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2248e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
22499a96b668Sdanielk1977 
2250a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2251cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
225262659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2253511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
22547d176105Sdrh       VdbeCoverage(v);
22559a96b668Sdanielk1977 
22569a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
22579a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
22589a96b668Sdanielk1977 
22599a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
22609a96b668Sdanielk1977     }else{
2261e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2262cfbb5e82Sdan       int affinity_ok = 1;
2263cfbb5e82Sdan       int i;
2264cfbb5e82Sdan 
2265cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
226662659b2aSdrh       ** comparison is the same as the affinity of each column in table
226762659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
226862659b2aSdrh       ** use any index of the RHS table.  */
2269cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2270fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2271cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
22720dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2273cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
227462659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
227562659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2276cfbb5e82Sdan         switch( cmpaff ){
2277cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2278cfbb5e82Sdan             break;
2279cfbb5e82Sdan           case SQLITE_AFF_TEXT:
228062659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
228162659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
228262659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
228362659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
228462659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2285cfbb5e82Sdan             break;
2286cfbb5e82Sdan           default:
2287cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2288cfbb5e82Sdan         }
2289cfbb5e82Sdan       }
2290e1fb65a0Sdanielk1977 
2291a84a283dSdrh       if( affinity_ok ){
2292a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2293a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2294a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2295a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
22966fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2297a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2298a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2299a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2300a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2301a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
23026fc8f364Sdrh           if( mustBeUnique ){
23036fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
23046fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
23056fc8f364Sdrh             ){
2306a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2307cfbb5e82Sdan             }
23086fc8f364Sdrh           }
2309cfbb5e82Sdan 
2310a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2311cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2312fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2313cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2314cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2315cfbb5e82Sdan             int j;
2316cfbb5e82Sdan 
23176fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2318cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2319cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2320cfbb5e82Sdan               assert( pIdx->azColl[j] );
2321106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2322106526e1Sdrh                 continue;
2323106526e1Sdrh               }
2324cfbb5e82Sdan               break;
2325cfbb5e82Sdan             }
2326cfbb5e82Sdan             if( j==nExpr ) break;
2327a84a283dSdrh             mCol = MASKBIT(j);
2328a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2329a84a283dSdrh             colUsed |= mCol;
2330ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2331cfbb5e82Sdan           }
2332cfbb5e82Sdan 
2333a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2334a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2335a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2336511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2337363fb95bSdrh #ifndef SQLITE_OMIT_EXPLAIN
2338363fb95bSdrh             sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2339363fb95bSdrh               sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2340363fb95bSdrh               P4_DYNAMIC);
2341363fb95bSdrh #endif
23422ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
23432ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2344207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
23451ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
23461ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
23479a96b668Sdanielk1977 
23487b35a77bSdan             if( prRhsHasNull ){
23493480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2350cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
23513480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2352cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
23533480bfdaSdan #endif
2354b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
23557b35a77bSdan               if( nExpr==1 ){
23566be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
23570cdc022eSdanielk1977               }
23587b35a77bSdan             }
2359552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
23609a96b668Sdanielk1977           }
2361a84a283dSdrh         } /* End loop over indexes */
2362a84a283dSdrh       } /* End if( affinity_ok ) */
2363a84a283dSdrh     } /* End if not an rowid index */
2364a84a283dSdrh   } /* End attempt to optimize using an index */
23659a96b668Sdanielk1977 
2366bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2367bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2368bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
236971c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
237060ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2371bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2372bb53ecb1Sdrh   */
2373bb53ecb1Sdrh   if( eType==0
2374bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2375bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2376bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2377bb53ecb1Sdrh   ){
2378bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2379bb53ecb1Sdrh   }
2380bb53ecb1Sdrh 
23819a96b668Sdanielk1977   if( eType==0 ){
23824387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2383b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2384b74b1017Sdrh     */
23858e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
23860cdc022eSdanielk1977     int rMayHaveNull = 0;
238741a05b7bSdanielk1977     eType = IN_INDEX_EPH;
23883a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
23894a5acf8eSdrh       pParse->nQueryLoop = 0;
2390c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
239141a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
23920cdc022eSdanielk1977       }
2393e21a6e1dSdrh     }else if( prRhsHasNull ){
2394e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2395cf4d38aaSdrh     }
239641a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2397cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
23989a96b668Sdanielk1977   }else{
23999a96b668Sdanielk1977     pX->iTable = iTab;
24009a96b668Sdanielk1977   }
2401ba00e30aSdan 
2402ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2403ba00e30aSdan     int i, n;
2404ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2405ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2406ba00e30aSdan   }
24079a96b668Sdanielk1977   return eType;
24089a96b668Sdanielk1977 }
2409284f4acaSdanielk1977 #endif
2410626a879aSdrh 
2411f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2412553168c7Sdan /*
2413553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2414553168c7Sdan ** function allocates and returns a nul-terminated string containing
2415553168c7Sdan ** the affinities to be used for each column of the comparison.
2416553168c7Sdan **
2417553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2418553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2419553168c7Sdan */
242071c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
242171c57db0Sdan   Expr *pLeft = pExpr->pLeft;
242271c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2423553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
242471c57db0Sdan   char *zRet;
242571c57db0Sdan 
2426553168c7Sdan   assert( pExpr->op==TK_IN );
24275c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
242871c57db0Sdan   if( zRet ){
242971c57db0Sdan     int i;
243071c57db0Sdan     for(i=0; i<nVal; i++){
2431fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2432553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2433553168c7Sdan       if( pSelect ){
2434553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
243571c57db0Sdan       }else{
2436553168c7Sdan         zRet[i] = a;
243771c57db0Sdan       }
243871c57db0Sdan     }
243971c57db0Sdan     zRet[nVal] = '\0';
244071c57db0Sdan   }
244171c57db0Sdan   return zRet;
244271c57db0Sdan }
2443f9b2e05cSdan #endif
244471c57db0Sdan 
24458da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
24468da209b1Sdan /*
24478da209b1Sdan ** Load the Parse object passed as the first argument with an error
24488da209b1Sdan ** message of the form:
24498da209b1Sdan **
24508da209b1Sdan **   "sub-select returns N columns - expected M"
24518da209b1Sdan */
24528da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
24538da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
24548da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
24558da209b1Sdan }
24568da209b1Sdan #endif
24578da209b1Sdan 
2458626a879aSdrh /*
245944c5604cSdan ** Expression pExpr is a vector that has been used in a context where
246044c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
246144c5604cSdan ** loads the Parse object with a message of the form:
246244c5604cSdan **
246344c5604cSdan **   "sub-select returns N columns - expected 1"
246444c5604cSdan **
246544c5604cSdan ** Or, if it is a regular scalar vector:
246644c5604cSdan **
246744c5604cSdan **   "row value misused"
246844c5604cSdan */
246944c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
247044c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
247144c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
247244c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
247344c5604cSdan   }else
247444c5604cSdan #endif
247544c5604cSdan   {
247644c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
247744c5604cSdan   }
247844c5604cSdan }
247944c5604cSdan 
248044c5604cSdan /*
2481d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2482d4187c71Sdrh ** or IN operators.  Examples:
2483626a879aSdrh **
24849cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
24859cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
24869cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
24879cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2488fef5208cSdrh **
24899cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
24909cbe6352Sdrh ** operator or subquery.
249141a05b7bSdanielk1977 **
249241a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
249341a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
249441a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
249541a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
249641a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2497fd773cf9Sdrh **
2498fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2499fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
25003a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
25013a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
25023a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
25031450bc6eSdrh **
25041450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
250539a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
250639a11819Sdrh ** array of registers and the return value is the register of the left-most
250739a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2508cce7d176Sdrh */
250951522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
25101450bc6eSdrh int sqlite3CodeSubselect(
2511fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2512fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
25136be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2514fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
251541a05b7bSdanielk1977 ){
25166be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
25171450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2518b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
25191450bc6eSdrh   if( NEVER(v==0) ) return 0;
2520ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2521fc976065Sdanielk1977 
252239a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
252339a11819Sdrh   ** is encountered if any of the following is true:
252457dbd7b3Sdrh   **
252557dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
252657dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
252757dbd7b3Sdrh   **    *  We are inside a trigger
252857dbd7b3Sdrh   **
252957dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
253057dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2531b3bce662Sdanielk1977   */
2532c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2533511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2534b3bce662Sdanielk1977   }
2535b3bce662Sdanielk1977 
25364a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
25374a07e3dbSdan   if( pParse->explain==2 ){
253862aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
253962aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
254062aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
254162aaa6caSdrh         pParse->iNextSelectId
25424a07e3dbSdan     );
25434a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
25444a07e3dbSdan   }
25454a07e3dbSdan #endif
25464a07e3dbSdan 
2547cce7d176Sdrh   switch( pExpr->op ){
2548fef5208cSdrh     case TK_IN: {
2549b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2550d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2551323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
255271c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2553d3d39e93Sdrh 
255471c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2555553168c7Sdan       assert( !isRowid || nVal==1 );
2556e014a838Sdanielk1977 
2557e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
25588cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2559553168c7Sdan       ** filled with index keys representing the results from the
2560553168c7Sdan       ** SELECT or the <exprlist>.
2561fef5208cSdrh       **
2562e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2563e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2564e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2565e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2566e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2567e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2568e014a838Sdanielk1977       ** is used.
2569fef5208cSdrh       */
2570832508b7Sdrh       pExpr->iTable = pParse->nTab++;
257171c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
257271c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
257371c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2574e014a838Sdanielk1977 
25756ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2576e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2577e014a838Sdanielk1977         **
2578e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2579e014a838Sdanielk1977         ** table allocated and opened above.
2580e014a838Sdanielk1977         */
25814387006cSdrh         Select *pSelect = pExpr->x.pSelect;
258271c57db0Sdan         ExprList *pEList = pSelect->pEList;
25831013c932Sdrh 
258441a05b7bSdanielk1977         assert( !isRowid );
258564bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
258664bcb8cfSdrh         ** error will have been caught long before we reach this point. */
258764bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
258871c57db0Sdan           SelectDest dest;
258971c57db0Sdan           int i;
25901013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
259171c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
25924387006cSdrh           pSelect->iLimit = 0;
25934387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2594812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
25954387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
259671c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
25972ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
25981450bc6eSdrh             return 0;
259994ccde58Sdrh           }
260071c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2601812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26023535ec3eSdrh           assert( pEList!=0 );
26033535ec3eSdrh           assert( pEList->nExpr>0 );
26042ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
260571c57db0Sdan           for(i=0; i<nVal; i++){
2606773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
260771c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
260871c57db0Sdan                 pParse, p, pEList->a[i].pExpr
260971c57db0Sdan             );
261071c57db0Sdan           }
261171c57db0Sdan         }
2612a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2613fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2614fef5208cSdrh         **
2615e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2616e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2617e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2618e014a838Sdanielk1977         ** a column, use numeric affinity.
2619fef5208cSdrh         */
262071c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2621e014a838Sdanielk1977         int i;
26226ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
262357dbd7b3Sdrh         struct ExprList_item *pItem;
2624ecc31805Sdrh         int r1, r2, r3;
262557dbd7b3Sdrh 
262671c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2627e014a838Sdanielk1977         if( !affinity ){
262805883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2629e014a838Sdanielk1977         }
2630323df790Sdrh         if( pKeyInfo ){
26312ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2632323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2633323df790Sdrh         }
2634e014a838Sdanielk1977 
2635e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
26362d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
26372d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
263837e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
263957dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
264057dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2641e05c929bSdrh           int iValToIns;
2642e014a838Sdanielk1977 
264357dbd7b3Sdrh           /* If the expression is not constant then we will need to
264457dbd7b3Sdrh           ** disable the test that was generated above that makes sure
264557dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
264657dbd7b3Sdrh           ** expression we need to rerun this code each time.
264757dbd7b3Sdrh           */
26486be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
26496be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
26506be515ebSdrh             jmpIfDynamic = -1;
26514794b980Sdrh           }
2652e014a838Sdanielk1977 
2653e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2654e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2655e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2656e05c929bSdrh           }else{
2657ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
265841a05b7bSdanielk1977             if( isRowid ){
2659e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2660e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2661688852abSdrh               VdbeCoverage(v);
266241a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
266341a05b7bSdanielk1977             }else{
2664ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
26653c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
26669b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2667fef5208cSdrh             }
266841a05b7bSdanielk1977           }
2669e05c929bSdrh         }
26702d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
26712d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2672fef5208cSdrh       }
2673323df790Sdrh       if( pKeyInfo ){
26742ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
267541a05b7bSdanielk1977       }
2676b3bce662Sdanielk1977       break;
2677fef5208cSdrh     }
2678fef5208cSdrh 
267951522cd3Sdrh     case TK_EXISTS:
2680fd773cf9Sdrh     case TK_SELECT:
2681fd773cf9Sdrh     default: {
268239a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
268339a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
268439a11819Sdrh       **
268539a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
268639a11819Sdrh       ** the first row into an array of registers and return the index of
268739a11819Sdrh       ** the first register.
268839a11819Sdrh       **
268939a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
269039a11819Sdrh       ** into a register and return that register number.
269139a11819Sdrh       **
269239a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
269339a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2694fef5208cSdrh       */
2695fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
269639a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
269771c57db0Sdan       int nReg;                             /* Registers to allocate */
26981398ad36Sdrh 
2699cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2700cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2701cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27026ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
270371c57db0Sdan 
27046ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
270571c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
270671c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
270771c57db0Sdan       pParse->nMem += nReg;
270851522cd3Sdrh       if( pExpr->op==TK_SELECT ){
27096c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
271053932ce8Sdrh         dest.iSdst = dest.iSDParm;
271171c57db0Sdan         dest.nSdst = nReg;
271271c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2713d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
271451522cd3Sdrh       }else{
27156c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
27162b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2717d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
271851522cd3Sdrh       }
2719633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2720e1c03b62Sdrh       pSel->pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,
2721e1c03b62Sdrh                                   &sqlite3IntTokens[1], 0);
272248b5b041Sdrh       pSel->iLimit = 0;
2723772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
27247d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
27251450bc6eSdrh         return 0;
272694ccde58Sdrh       }
27272b596da8Sdrh       rReg = dest.iSDParm;
2728ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2729b3bce662Sdanielk1977       break;
273019a775c2Sdrh     }
2731cce7d176Sdrh   }
2732b3bce662Sdanielk1977 
27336be515ebSdrh   if( rHasNullFlag ){
27346be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2735b3bce662Sdanielk1977   }
27366be515ebSdrh 
27376be515ebSdrh   if( jmpIfDynamic>=0 ){
27386be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2739b3bce662Sdanielk1977   }
2740d2490904Sdrh   sqlite3ExprCachePop(pParse);
2741fc976065Sdanielk1977 
27421450bc6eSdrh   return rReg;
2743cce7d176Sdrh }
274451522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2745cce7d176Sdrh 
2746e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2747e3365e6cSdrh /*
27487b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
27497b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
27507b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
27517b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
27527b35a77bSdan */
27537b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
27547b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
27557b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
27567b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
27577b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
27587b35a77bSdan       return 1;
27597b35a77bSdan     }
27607b35a77bSdan   }else if( nVector!=1 ){
276144c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
27627b35a77bSdan     return 1;
27637b35a77bSdan   }
27647b35a77bSdan   return 0;
27657b35a77bSdan }
27667b35a77bSdan #endif
27677b35a77bSdan 
27687b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
27697b35a77bSdan /*
2770e3365e6cSdrh ** Generate code for an IN expression.
2771e3365e6cSdrh **
2772e3365e6cSdrh **      x IN (SELECT ...)
2773e3365e6cSdrh **      x IN (value, value, ...)
2774e3365e6cSdrh **
2775ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2776e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2777e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2778e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2779e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2780e347d3e8Sdrh **
2781e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2782e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2783e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2784e347d3e8Sdrh ** determined due to NULLs.
2785e3365e6cSdrh **
27866be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2787e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2788e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2789e3365e6cSdrh ** within the RHS then fall through.
2790ecb87ac8Sdrh **
2791ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2792ecb87ac8Sdrh ** SQLite source tree for additional information.
2793e3365e6cSdrh */
2794e3365e6cSdrh static void sqlite3ExprCodeIN(
2795e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2796e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2797e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2798e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2799e3365e6cSdrh ){
2800e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2801e3365e6cSdrh   int eType;            /* Type of the RHS */
2802e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2803e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2804e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2805ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2806ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2807ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
280812abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2809e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2810ecb87ac8Sdrh   int i;                /* loop counter */
2811e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2812e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2813e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2814e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2815e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2816e3365e6cSdrh 
2817e347d3e8Sdrh   pLeft = pExpr->pLeft;
28187b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2819553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2820ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2821ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2822ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2823ba00e30aSdan   );
2824e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
28257b35a77bSdan 
2826ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2827ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2828ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2829ba00e30aSdan   ** the RHS has not yet been coded.  */
2830e3365e6cSdrh   v = pParse->pVdbe;
2831e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2832e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2833bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2834bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2835ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2836e3365e6cSdrh 
2837ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2838ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2839ba00e30aSdan   );
2840ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2841ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2842ecb87ac8Sdrh   ** nVector-1. */
2843ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2844ecb87ac8Sdrh     int j, cnt;
2845ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2846ecb87ac8Sdrh     assert( cnt==1 );
2847ecb87ac8Sdrh   }
2848ecb87ac8Sdrh #endif
2849e3365e6cSdrh 
2850ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2851ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2852ba00e30aSdan   ** at r1.
2853e347d3e8Sdrh   **
2854e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2855e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2856e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2857e347d3e8Sdrh   ** the field order that matches the RHS index.
2858e3365e6cSdrh   */
2859e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2860e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2861e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2862ecb87ac8Sdrh   if( i==nVector ){
2863e347d3e8Sdrh     /* LHS fields are not reordered */
2864e347d3e8Sdrh     rLhs = rLhsOrig;
2865ecb87ac8Sdrh   }else{
2866ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2867e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2868ba00e30aSdan     for(i=0; i<nVector; i++){
2869e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2870ba00e30aSdan     }
2871ecb87ac8Sdrh   }
2872e3365e6cSdrh 
2873bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2874bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2875bb53ecb1Sdrh   ** sequence of comparisons.
2876e347d3e8Sdrh   **
2877e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2878bb53ecb1Sdrh   */
2879bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2880bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2881bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2882bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2883bb53ecb1Sdrh     int r2, regToFree;
2884bb53ecb1Sdrh     int regCkNull = 0;
2885bb53ecb1Sdrh     int ii;
2886bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2887bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2888bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2889e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2890bb53ecb1Sdrh     }
2891bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2892bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2893a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2894bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2895bb53ecb1Sdrh       }
2896bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2897e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
28984336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
28994336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
29004336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2901ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2902bb53ecb1Sdrh       }else{
2903bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2904e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2905bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2906ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2907bb53ecb1Sdrh       }
2908bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2909bb53ecb1Sdrh     }
2910bb53ecb1Sdrh     if( regCkNull ){
2911bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2912076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2913bb53ecb1Sdrh     }
2914bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2915bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2916e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2917e347d3e8Sdrh   }
2918bb53ecb1Sdrh 
2919e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
2920e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
2921e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
2922e347d3e8Sdrh   */
2923094430ebSdrh   if( destIfNull==destIfFalse ){
2924e347d3e8Sdrh     destStep2 = destIfFalse;
2925e347d3e8Sdrh   }else{
2926e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
2927e347d3e8Sdrh   }
2928d49fd4e8Sdan   for(i=0; i<nVector; i++){
2929fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2930d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
2931e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
2932471b4b92Sdrh       VdbeCoverage(v);
2933d49fd4e8Sdan     }
2934d49fd4e8Sdan   }
2935e3365e6cSdrh 
2936e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
2937e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
2938e347d3e8Sdrh   ** true.
2939e347d3e8Sdrh   */
2940e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
2941e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
2942e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
2943e347d3e8Sdrh     ** into a single opcode. */
2944e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
2945688852abSdrh     VdbeCoverage(v);
2946e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
29477b35a77bSdan   }else{
2948e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
2949e347d3e8Sdrh     if( destIfFalse==destIfNull ){
2950e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
2951e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
2952e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
2953e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
2954e347d3e8Sdrh     }
2955e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
2956e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
2957e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
2958e347d3e8Sdrh   }
2959ba00e30aSdan 
2960e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
2961e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
2962e347d3e8Sdrh   */
2963e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
2964e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
2965471b4b92Sdrh     VdbeCoverage(v);
2966e347d3e8Sdrh   }
29677b35a77bSdan 
2968e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
2969e347d3e8Sdrh   ** FALSE, then just return false.
2970e347d3e8Sdrh   */
2971e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
2972e347d3e8Sdrh 
2973e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
2974e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
2975e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
2976e347d3e8Sdrh   **
2977e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
2978e347d3e8Sdrh   ** of the RHS.
2979e347d3e8Sdrh   */
2980e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
2981e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2982471b4b92Sdrh   VdbeCoverage(v);
2983e347d3e8Sdrh   if( nVector>1 ){
2984e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
2985e347d3e8Sdrh   }else{
2986e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
2987e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
2988e347d3e8Sdrh     destNotNull = destIfFalse;
2989e347d3e8Sdrh   }
2990ba00e30aSdan   for(i=0; i<nVector; i++){
2991ba00e30aSdan     Expr *p;
2992ba00e30aSdan     CollSeq *pColl;
2993e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
2994fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
2995ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
2996e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
2997e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
299818016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
2999471b4b92Sdrh     VdbeCoverage(v);
3000e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
30017b35a77bSdan   }
30027b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3003e347d3e8Sdrh   if( nVector>1 ){
3004e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3005e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
300618016ad2Sdrh     VdbeCoverage(v);
3007e347d3e8Sdrh 
3008e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3009e347d3e8Sdrh     ** be false. */
301018016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
30117b35a77bSdan   }
30127b35a77bSdan 
3013e347d3e8Sdrh   /* Jumps here in order to return true. */
3014e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3015e3365e6cSdrh 
3016e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3017e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3018d2490904Sdrh   sqlite3ExprCachePop(pParse);
3019ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3020e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3021ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3022553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3023e3365e6cSdrh }
3024e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3025e3365e6cSdrh 
302613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3027598f1340Sdrh /*
3028598f1340Sdrh ** Generate an instruction that will put the floating point
30299cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
30300cf19ed8Sdrh **
30310cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
30320cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
30330cf19ed8Sdrh ** like the continuation of the number.
3034598f1340Sdrh */
3035b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3036fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3037598f1340Sdrh     double value;
30389339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3039d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3040598f1340Sdrh     if( negateFlag ) value = -value;
304197bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3042598f1340Sdrh   }
3043598f1340Sdrh }
304413573c71Sdrh #endif
3045598f1340Sdrh 
3046598f1340Sdrh 
3047598f1340Sdrh /*
3048fec19aadSdrh ** Generate an instruction that will put the integer describe by
30499cbf3425Sdrh ** text z[0..n-1] into register iMem.
30500cf19ed8Sdrh **
30515f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3052fec19aadSdrh */
305313573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
305413573c71Sdrh   Vdbe *v = pParse->pVdbe;
305592b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
305633e619fcSdrh     int i = pExpr->u.iValue;
3057d50ffc41Sdrh     assert( i>=0 );
305892b01d53Sdrh     if( negFlag ) i = -i;
305992b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3060fd773cf9Sdrh   }else{
30615f1d6b61Sshaneh     int c;
30625f1d6b61Sshaneh     i64 value;
3063fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3064fd773cf9Sdrh     assert( z!=0 );
30659296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
306677320ea4Sdrh     if( c==1 || (c==2 && !negFlag) || (negFlag && value==SMALLEST_INT64)){
306713573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
306813573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
306913573c71Sdrh #else
30701b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
30719296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
307277320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
30731b7ddc59Sdrh       }else
30741b7ddc59Sdrh #endif
30751b7ddc59Sdrh       {
3076b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
30779296c18aSdrh       }
307813573c71Sdrh #endif
307977320ea4Sdrh     }else{
308077320ea4Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
308177320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3082fec19aadSdrh     }
3083fec19aadSdrh   }
3084c9cf901dSdanielk1977 }
3085fec19aadSdrh 
3086bea119cdSdrh /*
30879b40d13fSdrh ** Erase column-cache entry number i
3088bea119cdSdrh */
30899b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
30909b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3091ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
30929b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3093ceea3321Sdrh     }
3094ceea3321Sdrh   }
3095bea119cdSdrh   pParse->nColCache--;
30969b40d13fSdrh   if( i<pParse->nColCache ){
30979b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
30989b40d13fSdrh   }
3099ceea3321Sdrh }
3100ceea3321Sdrh 
3101ceea3321Sdrh 
3102ceea3321Sdrh /*
3103ceea3321Sdrh ** Record in the column cache that a particular column from a
3104ceea3321Sdrh ** particular table is stored in a particular register.
3105ceea3321Sdrh */
3106ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3107ceea3321Sdrh   int i;
3108ceea3321Sdrh   int minLru;
3109ceea3321Sdrh   int idxLru;
3110ceea3321Sdrh   struct yColCache *p;
3111ceea3321Sdrh 
3112ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3113ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
311420411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
311520411ea7Sdrh 
3116b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3117b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3118b6da74ebSdrh   ** with and without the column cache.
3119b6da74ebSdrh   */
31207e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3121b6da74ebSdrh 
312227ee406eSdrh   /* First replace any existing entry.
312327ee406eSdrh   **
312427ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
312527ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
312627ee406eSdrh   */
312727ee406eSdrh #ifndef NDEBUG
31289b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
31299b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3130ceea3321Sdrh   }
313127ee406eSdrh #endif
3132ceea3321Sdrh 
31339b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
31349b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3135ceea3321Sdrh     minLru = 0x7fffffff;
3136ceea3321Sdrh     idxLru = -1;
3137ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3138ceea3321Sdrh       if( p->lru<minLru ){
3139ceea3321Sdrh         idxLru = i;
3140ceea3321Sdrh         minLru = p->lru;
3141ceea3321Sdrh       }
3142ceea3321Sdrh     }
3143ceea3321Sdrh     p = &pParse->aColCache[idxLru];
31449b40d13fSdrh   }else{
31459b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
31469b40d13fSdrh   }
31479b40d13fSdrh 
31489b40d13fSdrh   /* Add the new entry to the end of the cache */
3149ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3150ceea3321Sdrh   p->iTable = iTab;
3151ceea3321Sdrh   p->iColumn = iCol;
3152ceea3321Sdrh   p->iReg = iReg;
3153ceea3321Sdrh   p->tempReg = 0;
3154ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3155ceea3321Sdrh }
3156ceea3321Sdrh 
3157ceea3321Sdrh /*
3158f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3159f49f3523Sdrh ** Purge the range of registers from the column cache.
3160ceea3321Sdrh */
3161f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
31629b40d13fSdrh   int i = 0;
31639b40d13fSdrh   while( i<pParse->nColCache ){
31649b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
31659b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
31669b40d13fSdrh       cacheEntryClear(pParse, i);
31679b40d13fSdrh     }else{
31689b40d13fSdrh       i++;
31699b40d13fSdrh     }
3170ceea3321Sdrh   }
3171ceea3321Sdrh }
3172ceea3321Sdrh 
3173ceea3321Sdrh /*
3174ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3175ceea3321Sdrh ** added to the column cache after this call are removed when the
3176ceea3321Sdrh ** corresponding pop occurs.
3177ceea3321Sdrh */
3178ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3179ceea3321Sdrh   pParse->iCacheLevel++;
31809ac7962aSdrh #ifdef SQLITE_DEBUG
31819ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31829ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
31839ac7962aSdrh   }
31849ac7962aSdrh #endif
3185ceea3321Sdrh }
3186ceea3321Sdrh 
3187ceea3321Sdrh /*
3188ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3189d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3190d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3191ceea3321Sdrh */
3192d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
31939b40d13fSdrh   int i = 0;
3194d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3195d2490904Sdrh   pParse->iCacheLevel--;
31969ac7962aSdrh #ifdef SQLITE_DEBUG
31979ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31989ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
31999ac7962aSdrh   }
32009ac7962aSdrh #endif
32019b40d13fSdrh   while( i<pParse->nColCache ){
32029b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
32039b40d13fSdrh       cacheEntryClear(pParse, i);
32049b40d13fSdrh     }else{
32059b40d13fSdrh       i++;
3206ceea3321Sdrh     }
3207ceea3321Sdrh   }
3208ceea3321Sdrh }
3209945498f3Sdrh 
3210945498f3Sdrh /*
32115cd79239Sdrh ** When a cached column is reused, make sure that its register is
32125cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
32135cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
32145cd79239Sdrh ** get them all.
32155cd79239Sdrh */
32165cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
32175cd79239Sdrh   int i;
32185cd79239Sdrh   struct yColCache *p;
32199b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32205cd79239Sdrh     if( p->iReg==iReg ){
32215cd79239Sdrh       p->tempReg = 0;
32225cd79239Sdrh     }
32235cd79239Sdrh   }
32245cd79239Sdrh }
32255cd79239Sdrh 
32261f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
32271f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
32281f9ca2c8Sdrh */
32291f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
32301f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
32311f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
32321f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
32331f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
32341f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
32351f9ca2c8Sdrh ){
32361f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
32374b92f98cSdrh   if( iTabCol==XN_EXPR ){
32381f9ca2c8Sdrh     assert( pIdx->aColExpr );
32391f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
32401f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
32411c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
32424b92f98cSdrh   }else{
32434b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
32444b92f98cSdrh                                     iTabCol, regOut);
32454b92f98cSdrh   }
32461f9ca2c8Sdrh }
32471f9ca2c8Sdrh 
32485cd79239Sdrh /*
32495c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
32505c092e8aSdrh */
32515c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
32525c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
32535c092e8aSdrh   Table *pTab,    /* The table containing the value */
3254313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
32555c092e8aSdrh   int iCol,       /* Index of the column to extract */
3256313619f5Sdrh   int regOut      /* Extract the value into this register */
32575c092e8aSdrh ){
3258aca19e19Sdrh   if( pTab==0 ){
3259aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3260aca19e19Sdrh     return;
3261aca19e19Sdrh   }
32625c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
32635c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
32645c092e8aSdrh   }else{
32655c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3266ee0ec8e1Sdrh     int x = iCol;
326735db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3268ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3269ee0ec8e1Sdrh     }
3270ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
32715c092e8aSdrh   }
32725c092e8aSdrh   if( iCol>=0 ){
32735c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
32745c092e8aSdrh   }
32755c092e8aSdrh }
32765c092e8aSdrh 
32775c092e8aSdrh /*
3278945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3279ce78bc6eSdrh ** table pTab and store the column value in a register.
3280ce78bc6eSdrh **
3281ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3282ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3283ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3284ce78bc6eSdrh ** for GetColumnToReg().
3285e55cbd72Sdrh **
3286e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3287e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3288945498f3Sdrh */
3289e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3290e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
32912133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
32922133d822Sdrh   int iColumn,     /* Index of the table column */
32932133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3294a748fdccSdrh   int iReg,        /* Store results here */
3295ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
32962133d822Sdrh ){
3297e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3298e55cbd72Sdrh   int i;
3299da250ea5Sdrh   struct yColCache *p;
3300e55cbd72Sdrh 
33019b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
330294881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3303ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
33045cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3305da250ea5Sdrh       return p->iReg;
3306e55cbd72Sdrh     }
3307e55cbd72Sdrh   }
3308e55cbd72Sdrh   assert( v!=0 );
33095c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3310a748fdccSdrh   if( p5 ){
3311a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3312a748fdccSdrh   }else{
3313ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3314a748fdccSdrh   }
3315e55cbd72Sdrh   return iReg;
3316e55cbd72Sdrh }
3317ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3318ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3319ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3320ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3321ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3322ce78bc6eSdrh   int iReg         /* Store results here */
3323ce78bc6eSdrh ){
3324ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3325ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3326ce78bc6eSdrh }
3327ce78bc6eSdrh 
3328e55cbd72Sdrh 
3329e55cbd72Sdrh /*
3330ceea3321Sdrh ** Clear all column cache entries.
3331e55cbd72Sdrh */
3332ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3333e55cbd72Sdrh   int i;
3334ceea3321Sdrh 
3335d879e3ebSdrh #ifdef SQLITE_DEBUG
33369ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
33379ac7962aSdrh     printf("CLEAR\n");
33389ac7962aSdrh   }
33399ac7962aSdrh #endif
33409b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
33419b40d13fSdrh     if( pParse->aColCache[i].tempReg
33429b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
33439b40d13fSdrh     ){
33449b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3345e55cbd72Sdrh     }
3346da250ea5Sdrh   }
33479b40d13fSdrh   pParse->nColCache = 0;
3348da250ea5Sdrh }
3349e55cbd72Sdrh 
3350e55cbd72Sdrh /*
3351da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3352da250ea5Sdrh ** registers starting with iStart.
3353e55cbd72Sdrh */
3354da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3355f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3356e55cbd72Sdrh }
3357e55cbd72Sdrh 
3358e55cbd72Sdrh /*
3359b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3360b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3361e55cbd72Sdrh */
3362b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3363e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3364079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3365236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3366945498f3Sdrh }
3367945498f3Sdrh 
3368f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
336992b01d53Sdrh /*
3370652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3371652fbf55Sdrh ** is used as part of the column cache.
3372f49f3523Sdrh **
3373f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3374f49f3523Sdrh ** and does not appear in a normal build.
3375652fbf55Sdrh */
3376652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3377652fbf55Sdrh   int i;
3378ceea3321Sdrh   struct yColCache *p;
33799b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3380ceea3321Sdrh     int r = p->iReg;
3381f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3382652fbf55Sdrh   }
3383652fbf55Sdrh   return 0;
3384652fbf55Sdrh }
3385f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3386652fbf55Sdrh 
3387bea119cdSdrh 
3388652fbf55Sdrh /*
338912abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
339012abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
339112abf408Sdrh ** the correct value for the expression.
3392a4c3c87eSdrh */
3393a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3394a4c3c87eSdrh   p->op2 = p->op;
3395a4c3c87eSdrh   p->op = TK_REGISTER;
3396a4c3c87eSdrh   p->iTable = iReg;
3397a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3398a4c3c87eSdrh }
3399a4c3c87eSdrh 
340012abf408Sdrh /*
340112abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
340212abf408Sdrh ** the result in continguous temporary registers.  Return the index of
340312abf408Sdrh ** the first register used to store the result.
340412abf408Sdrh **
340512abf408Sdrh ** If the returned result register is a temporary scalar, then also write
340612abf408Sdrh ** that register number into *piFreeable.  If the returned result register
340712abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
340812abf408Sdrh ** to 0.
340912abf408Sdrh */
341012abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
341112abf408Sdrh   int iResult;
341212abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
341312abf408Sdrh   if( nResult==1 ){
341412abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
341512abf408Sdrh   }else{
341612abf408Sdrh     *piFreeable = 0;
341712abf408Sdrh     if( p->op==TK_SELECT ){
3418dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3419dd1bb43aSdrh       iResult = 0;
3420dd1bb43aSdrh #else
342112abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3422dd1bb43aSdrh #endif
342312abf408Sdrh     }else{
342412abf408Sdrh       int i;
342512abf408Sdrh       iResult = pParse->nMem+1;
342612abf408Sdrh       pParse->nMem += nResult;
342712abf408Sdrh       for(i=0; i<nResult; i++){
34284b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
342912abf408Sdrh       }
343012abf408Sdrh     }
343112abf408Sdrh   }
343212abf408Sdrh   return iResult;
343312abf408Sdrh }
343412abf408Sdrh 
343571c57db0Sdan 
3436a4c3c87eSdrh /*
3437cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34382dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34392dcef11bSdrh ** Return the register where results are stored.
3440389a1adbSdrh **
34418b213899Sdrh ** With this routine, there is no guarantee that results will
34422dcef11bSdrh ** be stored in target.  The result might be stored in some other
34432dcef11bSdrh ** register if it is convenient to do so.  The calling function
34442dcef11bSdrh ** must check the return code and move the results to the desired
34452dcef11bSdrh ** register.
3446cce7d176Sdrh */
3447678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34482dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34492dcef11bSdrh   int op;                   /* The opcode being coded */
34502dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34512dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34522dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34537b35a77bSdan   int r1, r2;               /* Various register numbers */
345410d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
345571c57db0Sdan   int p5 = 0;
3456ffe07b2dSdrh 
34579cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
345820411ea7Sdrh   if( v==0 ){
345920411ea7Sdrh     assert( pParse->db->mallocFailed );
346020411ea7Sdrh     return 0;
346120411ea7Sdrh   }
3462389a1adbSdrh 
3463389a1adbSdrh   if( pExpr==0 ){
3464389a1adbSdrh     op = TK_NULL;
3465389a1adbSdrh   }else{
3466f2bc013cSdrh     op = pExpr->op;
3467389a1adbSdrh   }
3468f2bc013cSdrh   switch( op ){
346913449892Sdrh     case TK_AGG_COLUMN: {
347013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
347113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
347213449892Sdrh       if( !pAggInfo->directMode ){
34739de221dfSdrh         assert( pCol->iMem>0 );
3474c332cc30Sdrh         return pCol->iMem;
347513449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34765134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3477389a1adbSdrh                               pCol->iSorterColumn, target);
3478c332cc30Sdrh         return target;
347913449892Sdrh       }
348013449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
348113449892Sdrh     }
3482967e8b73Sdrh     case TK_COLUMN: {
3483b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3484b2b9d3d7Sdrh       if( iTab<0 ){
3485b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3486b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3487c332cc30Sdrh           return pExpr->iColumn + pParse->ckBase;
3488c4a3c779Sdrh         }else{
34891f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
34901f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
34911f9ca2c8Sdrh           iTab = pParse->iSelfTab;
34922282792aSdrh         }
3493b2b9d3d7Sdrh       }
3494c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3495b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3496b2b9d3d7Sdrh                                pExpr->op2);
3497cce7d176Sdrh     }
3498cce7d176Sdrh     case TK_INTEGER: {
349913573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3500c332cc30Sdrh       return target;
350151e9a445Sdrh     }
350213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3503598f1340Sdrh     case TK_FLOAT: {
350433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
350533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3506c332cc30Sdrh       return target;
3507598f1340Sdrh     }
350813573c71Sdrh #endif
3509fec19aadSdrh     case TK_STRING: {
351033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3511076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3512c332cc30Sdrh       return target;
3513cce7d176Sdrh     }
3514f0863fe5Sdrh     case TK_NULL: {
35159de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3516c332cc30Sdrh       return target;
3517f0863fe5Sdrh     }
35185338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3519c572ef7fSdanielk1977     case TK_BLOB: {
35206c8c6cecSdrh       int n;
35216c8c6cecSdrh       const char *z;
3522ca48c90fSdrh       char *zBlob;
352333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
352433e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
352533e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
352633e619fcSdrh       z = &pExpr->u.zToken[2];
3527b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3528b7916a78Sdrh       assert( z[n]=='\'' );
3529ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3530ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3531c332cc30Sdrh       return target;
3532c572ef7fSdanielk1977     }
35335338a5f7Sdanielk1977 #endif
353450457896Sdrh     case TK_VARIABLE: {
353533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
353633e619fcSdrh       assert( pExpr->u.zToken!=0 );
353733e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3538eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
353933e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35409bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35419bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3542ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35439bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35449bf755ccSdrh       }
3545c332cc30Sdrh       return target;
354650457896Sdrh     }
35474e0cff60Sdrh     case TK_REGISTER: {
3548c332cc30Sdrh       return pExpr->iTable;
35494e0cff60Sdrh     }
3550487e262fSdrh #ifndef SQLITE_OMIT_CAST
3551487e262fSdrh     case TK_CAST: {
3552487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35532dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35541735fa88Sdrh       if( inReg!=target ){
35551735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
35561735fa88Sdrh         inReg = target;
35571735fa88Sdrh       }
35584169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
35594169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3560c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3561b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3562c332cc30Sdrh       return inReg;
3563487e262fSdrh     }
3564487e262fSdrh #endif /* SQLITE_OMIT_CAST */
356571c57db0Sdan     case TK_IS:
356671c57db0Sdan     case TK_ISNOT:
356771c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
356871c57db0Sdan       p5 = SQLITE_NULLEQ;
356971c57db0Sdan       /* fall-through */
3570c9b84a1fSdrh     case TK_LT:
3571c9b84a1fSdrh     case TK_LE:
3572c9b84a1fSdrh     case TK_GT:
3573c9b84a1fSdrh     case TK_GE:
3574c9b84a1fSdrh     case TK_NE:
3575c9b84a1fSdrh     case TK_EQ: {
357671c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3577625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
357879752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
357971c57db0Sdan       }else{
358071c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3581b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
358271c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
358371c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
35847d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
35857d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
35867d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
35877d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
35887d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
35897d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3590c5499befSdrh         testcase( regFree1==0 );
3591c5499befSdrh         testcase( regFree2==0 );
3592c9b84a1fSdrh       }
35936a2fe093Sdrh       break;
35946a2fe093Sdrh     }
3595cce7d176Sdrh     case TK_AND:
3596cce7d176Sdrh     case TK_OR:
3597cce7d176Sdrh     case TK_PLUS:
3598cce7d176Sdrh     case TK_STAR:
3599cce7d176Sdrh     case TK_MINUS:
3600bf4133cbSdrh     case TK_REM:
3601bf4133cbSdrh     case TK_BITAND:
3602bf4133cbSdrh     case TK_BITOR:
360317c40294Sdrh     case TK_SLASH:
3604bf4133cbSdrh     case TK_LSHIFT:
3605855eb1cfSdrh     case TK_RSHIFT:
36060040077dSdrh     case TK_CONCAT: {
36077d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36087d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36097d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36107d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36117d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36127d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36137d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36147d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36157d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36167d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36177d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36182dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36192dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36205b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3621c5499befSdrh       testcase( regFree1==0 );
3622c5499befSdrh       testcase( regFree2==0 );
36230040077dSdrh       break;
36240040077dSdrh     }
3625cce7d176Sdrh     case TK_UMINUS: {
3626fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3627fec19aadSdrh       assert( pLeft );
362813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
362913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3630c332cc30Sdrh         return target;
363113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
363213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
363333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
363433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3635c332cc30Sdrh         return target;
363613573c71Sdrh #endif
36373c84ddffSdrh       }else{
363810d1edf0Sdrh         tempX.op = TK_INTEGER;
363910d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
364010d1edf0Sdrh         tempX.u.iValue = 0;
364110d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3642e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36432dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3644c5499befSdrh         testcase( regFree2==0 );
36453c84ddffSdrh       }
36466e142f54Sdrh       break;
36476e142f54Sdrh     }
3648bf4133cbSdrh     case TK_BITNOT:
36496e142f54Sdrh     case TK_NOT: {
36507d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36517d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3652e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3653e99fa2afSdrh       testcase( regFree1==0 );
3654e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3655cce7d176Sdrh       break;
3656cce7d176Sdrh     }
3657cce7d176Sdrh     case TK_ISNULL:
3658cce7d176Sdrh     case TK_NOTNULL: {
36596a288a33Sdrh       int addr;
36607d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
36617d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
36629de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
36632dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3664c5499befSdrh       testcase( regFree1==0 );
36652dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
36667d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
36677d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3668a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
36696a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3670a37cdde0Sdanielk1977       break;
3671f2bc013cSdrh     }
36722282792aSdrh     case TK_AGG_FUNCTION: {
367313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
36747e56e711Sdrh       if( pInfo==0 ){
367533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
367633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
36777e56e711Sdrh       }else{
3678c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
36797e56e711Sdrh       }
36802282792aSdrh       break;
36812282792aSdrh     }
3682cce7d176Sdrh     case TK_FUNCTION: {
368312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
368412ffee8cSdrh       int nFarg;             /* Number of function arguments */
368512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
368612ffee8cSdrh       const char *zId;       /* The function name */
3687693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
368812ffee8cSdrh       int i;                 /* Loop counter */
3689c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
369012ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
369112ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
369217435752Sdrh 
36931e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
369449c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3695ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3696ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
36971e9b53f9Sdrh       }
36986ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3699c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
370012ffee8cSdrh         pFarg = 0;
370112ffee8cSdrh       }else{
370212ffee8cSdrh         pFarg = pExpr->x.pList;
370312ffee8cSdrh       }
370412ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
370533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
370633e619fcSdrh       zId = pExpr->u.zToken;
370780738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3708cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3709cc15313cSdrh       if( pDef==0 && pParse->explain ){
3710cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3711cc15313cSdrh       }
3712cc15313cSdrh #endif
37132d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
371480738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3715feb306f5Sdrh         break;
3716feb306f5Sdrh       }
3717ae6bb957Sdrh 
3718ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
371960ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3720ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3721ae6bb957Sdrh       */
3722d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3723ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3724ae6bb957Sdrh         assert( nFarg>=2 );
3725ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3726ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3727ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3728688852abSdrh           VdbeCoverage(v);
3729f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3730ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3731ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3732d2490904Sdrh           sqlite3ExprCachePop(pParse);
3733ae6bb957Sdrh         }
3734ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3735ae6bb957Sdrh         break;
3736ae6bb957Sdrh       }
3737ae6bb957Sdrh 
3738cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3739cca9f3d2Sdrh       ** of the first argument.
3740cca9f3d2Sdrh       */
3741cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3742cca9f3d2Sdrh         assert( nFarg>=1 );
3743c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3744cca9f3d2Sdrh       }
3745ae6bb957Sdrh 
374654240751Sdrh #ifdef SQLITE_DEBUG
3747a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3748a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3749a1a523a5Sdrh       ** the SQLite type logic.
3750a1a523a5Sdrh       */
3751a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3752a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3753a1a523a5Sdrh         char aff;
3754a1a523a5Sdrh         assert( nFarg==1 );
3755a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3756a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3757a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3758a1a523a5Sdrh         return target;
3759a1a523a5Sdrh       }
376054240751Sdrh #endif
3761a1a523a5Sdrh 
3762d1a01edaSdrh       for(i=0; i<nFarg; i++){
3763d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3764693e6719Sdrh           testcase( i==31 );
3765693e6719Sdrh           constMask |= MASKBIT32(i);
3766d1a01edaSdrh         }
3767d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3768d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3769d1a01edaSdrh         }
3770d1a01edaSdrh       }
377112ffee8cSdrh       if( pFarg ){
3772d1a01edaSdrh         if( constMask ){
3773d1a01edaSdrh           r1 = pParse->nMem+1;
3774d1a01edaSdrh           pParse->nMem += nFarg;
3775d1a01edaSdrh         }else{
377612ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3777d1a01edaSdrh         }
3778a748fdccSdrh 
3779a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3780a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3781a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3782a748fdccSdrh         ** loading.
3783a748fdccSdrh         */
3784d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
37854e245a4cSdrh           u8 exprOp;
3786a748fdccSdrh           assert( nFarg==1 );
3787a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
37884e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
37894e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3790a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3791a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3792b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3793b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3794b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3795a748fdccSdrh           }
3796a748fdccSdrh         }
3797a748fdccSdrh 
3798d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
37995579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3800d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3801d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3802892d3179Sdrh       }else{
380312ffee8cSdrh         r1 = 0;
3804892d3179Sdrh       }
3805b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3806a43fa227Sdrh       /* Possibly overload the function if the first argument is
3807a43fa227Sdrh       ** a virtual table column.
3808a43fa227Sdrh       **
3809a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3810a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3811a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3812a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3813a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3814a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3815a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3816a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3817a43fa227Sdrh       */
381812ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
381912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
382012ffee8cSdrh       }else if( nFarg>0 ){
382112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3822b7f6f68fSdrh       }
3823b7f6f68fSdrh #endif
3824d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38258b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
382666a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3827682f68b0Sdanielk1977       }
38289c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
382966a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
383012ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3831d1a01edaSdrh       if( nFarg && constMask==0 ){
383212ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38332dcef11bSdrh       }
3834c332cc30Sdrh       return target;
38356ec2733bSdrh     }
3836fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3837fe2093d7Sdrh     case TK_EXISTS:
383819a775c2Sdrh     case TK_SELECT: {
38398da209b1Sdan       int nCol;
3840c5499befSdrh       testcase( op==TK_EXISTS );
3841c5499befSdrh       testcase( op==TK_SELECT );
38428da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
38438da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
38448da209b1Sdan       }else{
3845c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
38468da209b1Sdan       }
384719a775c2Sdrh       break;
384819a775c2Sdrh     }
3849fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3850966e2911Sdrh       int n;
3851fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3852fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3853fc7f27b9Sdrh       }
3854966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3855966e2911Sdrh       if( pExpr->iTable
3856966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3857966e2911Sdrh       ){
3858966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3859966e2911Sdrh                                 pExpr->iTable, n);
3860966e2911Sdrh       }
3861c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3862fc7f27b9Sdrh     }
3863fef5208cSdrh     case TK_IN: {
3864e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3865e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3866e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3867e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
386866ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3869e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3870e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3871e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3872c332cc30Sdrh       return target;
3873fef5208cSdrh     }
3874e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3875e3365e6cSdrh 
3876e3365e6cSdrh 
38772dcef11bSdrh     /*
38782dcef11bSdrh     **    x BETWEEN y AND z
38792dcef11bSdrh     **
38802dcef11bSdrh     ** This is equivalent to
38812dcef11bSdrh     **
38822dcef11bSdrh     **    x>=y AND x<=z
38832dcef11bSdrh     **
38842dcef11bSdrh     ** X is stored in pExpr->pLeft.
38852dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
38862dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
38872dcef11bSdrh     */
3888fef5208cSdrh     case TK_BETWEEN: {
388971c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3890c332cc30Sdrh       return target;
3891fef5208cSdrh     }
389294fa9c41Sdrh     case TK_SPAN:
3893ae80ddeaSdrh     case TK_COLLATE:
38944f07e5fbSdrh     case TK_UPLUS: {
3895c332cc30Sdrh       return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3896a2e00042Sdrh     }
38972dcef11bSdrh 
3898165921a7Sdan     case TK_TRIGGER: {
389965a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
390065a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
390165a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
390265a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
390365a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
390465a7cd16Sdan       ** read the rowid field.
390565a7cd16Sdan       **
390665a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
390765a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
390865a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
390965a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
391065a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
391165a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
391265a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
391365a7cd16Sdan       ** example, if the table on which triggers are being fired is
391465a7cd16Sdan       ** declared as:
391565a7cd16Sdan       **
391665a7cd16Sdan       **   CREATE TABLE t1(a, b);
391765a7cd16Sdan       **
391865a7cd16Sdan       ** Then p1 is interpreted as follows:
391965a7cd16Sdan       **
392065a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
392165a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
392265a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
392365a7cd16Sdan       */
39242832ad42Sdan       Table *pTab = pExpr->pTab;
392565a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
392665a7cd16Sdan 
392765a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
392865a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
392965a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
393065a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
393165a7cd16Sdan 
393265a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
393376d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3934165921a7Sdan         (pExpr->iTable ? "new" : "old"),
393576d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
393676d462eeSdan         target
3937165921a7Sdan       ));
393865a7cd16Sdan 
393944dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
394065a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3941113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3942113762a2Sdrh       **
3943113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3944113762a2Sdrh       ** floating point when extracting it from the record.  */
39452832ad42Sdan       if( pExpr->iColumn>=0
39462832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
39472832ad42Sdan       ){
39482832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
39492832ad42Sdan       }
395044dbca83Sdrh #endif
3951165921a7Sdan       break;
3952165921a7Sdan     }
3953165921a7Sdan 
395471c57db0Sdan     case TK_VECTOR: {
3955e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
395671c57db0Sdan       break;
395771c57db0Sdan     }
395871c57db0Sdan 
395931d6fd55Sdrh     case TK_IF_NULL_ROW: {
396031d6fd55Sdrh       int addrINR;
396131d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
396231d6fd55Sdrh       sqlite3ExprCachePush(pParse);
396331d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
396431d6fd55Sdrh       sqlite3ExprCachePop(pParse);
396531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
396631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
396731d6fd55Sdrh       break;
396831d6fd55Sdrh     }
396931d6fd55Sdrh 
39702dcef11bSdrh     /*
39712dcef11bSdrh     ** Form A:
39722dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
39732dcef11bSdrh     **
39742dcef11bSdrh     ** Form B:
39752dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
39762dcef11bSdrh     **
39772dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
39782dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
39792dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
39802dcef11bSdrh     **
39812dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3982c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3983c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3984c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
39852dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
39862dcef11bSdrh     **
39872dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
39882dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
39892dcef11bSdrh     ** no ELSE term, NULL.
39902dcef11bSdrh     */
399133cd4909Sdrh     default: assert( op==TK_CASE ); {
39922dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
39932dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
39942dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
39952dcef11bSdrh       int i;                            /* Loop counter */
39962dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
39972dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
39982dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
39992dcef11bSdrh       Expr *pX;                         /* The X expression */
40001bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4001ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
400217a7f8ddSdrh 
40036ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40046ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40056ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4006be5c89acSdrh       aListelem = pEList->a;
4007be5c89acSdrh       nExpr = pEList->nExpr;
40082dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
40092dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
401010d1edf0Sdrh         tempX = *pX;
401133cd4909Sdrh         testcase( pX->op==TK_COLUMN );
401212abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4013c5499befSdrh         testcase( regFree1==0 );
4014abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40152dcef11bSdrh         opCompare.op = TK_EQ;
401610d1edf0Sdrh         opCompare.pLeft = &tempX;
40172dcef11bSdrh         pTest = &opCompare;
40188b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40198b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40208b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40218b1db07fSdrh         ** purposes and possibly overwritten.  */
40228b1db07fSdrh         regFree1 = 0;
4023cce7d176Sdrh       }
4024c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4025ceea3321Sdrh         sqlite3ExprCachePush(pParse);
40262dcef11bSdrh         if( pX ){
40271bd10f8aSdrh           assert( pTest!=0 );
40282dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4029f5905aa7Sdrh         }else{
40302dcef11bSdrh           pTest = aListelem[i].pExpr;
403117a7f8ddSdrh         }
40322dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
403333cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
40342dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4035c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
40369de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4037076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4038d2490904Sdrh         sqlite3ExprCachePop(pParse);
40392dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4040f570f011Sdrh       }
4041c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4042ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4043c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4044d2490904Sdrh         sqlite3ExprCachePop(pParse);
404517a7f8ddSdrh       }else{
40469de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
404717a7f8ddSdrh       }
4048c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4049c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
40502dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
40516f34903eSdanielk1977       break;
40526f34903eSdanielk1977     }
40535338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
40546f34903eSdanielk1977     case TK_RAISE: {
4055165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4056165921a7Sdan            || pExpr->affinity==OE_Abort
4057165921a7Sdan            || pExpr->affinity==OE_Fail
4058165921a7Sdan            || pExpr->affinity==OE_Ignore
4059165921a7Sdan       );
4060e0af83acSdan       if( !pParse->pTriggerTab ){
4061e0af83acSdan         sqlite3ErrorMsg(pParse,
4062e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4063e0af83acSdan         return 0;
4064e0af83acSdan       }
4065e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4066e0af83acSdan         sqlite3MayAbort(pParse);
4067e0af83acSdan       }
406833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4069e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4070e0af83acSdan         sqlite3VdbeAddOp4(
4071e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4072688852abSdrh         VdbeCoverage(v);
4073e0af83acSdan       }else{
4074433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4075f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4076e0af83acSdan       }
4077e0af83acSdan 
4078ffe07b2dSdrh       break;
407917a7f8ddSdrh     }
40805338a5f7Sdanielk1977 #endif
4081ffe07b2dSdrh   }
40822dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
40832dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
40842dcef11bSdrh   return inReg;
40855b6afba9Sdrh }
40862dcef11bSdrh 
40872dcef11bSdrh /*
4088d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
40891e9b53f9Sdrh **
4090ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4091ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4092ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4093ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4094ad879ffdSdrh ** code to the same register.
4095d1a01edaSdrh */
40961e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4097d673cddaSdrh   Parse *pParse,    /* Parsing context */
4098d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4099ad879ffdSdrh   int regDest       /* Store the value in this register */
4100d673cddaSdrh ){
4101d1a01edaSdrh   ExprList *p;
4102d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4103d1a01edaSdrh   p = pParse->pConstExpr;
4104ad879ffdSdrh   if( regDest<0 && p ){
41051e9b53f9Sdrh     struct ExprList_item *pItem;
41061e9b53f9Sdrh     int i;
41071e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41085aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41091e9b53f9Sdrh         return pItem->u.iConstExprReg;
41101e9b53f9Sdrh       }
41111e9b53f9Sdrh     }
41121e9b53f9Sdrh   }
4113d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4114d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4115d673cddaSdrh   if( p ){
4116d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4117ad879ffdSdrh      pItem->reusable = regDest<0;
4118ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4119d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4120d673cddaSdrh   }
4121d1a01edaSdrh   pParse->pConstExpr = p;
41221e9b53f9Sdrh   return regDest;
4123d1a01edaSdrh }
4124d1a01edaSdrh 
4125d1a01edaSdrh /*
41262dcef11bSdrh ** Generate code to evaluate an expression and store the results
41272dcef11bSdrh ** into a register.  Return the register number where the results
41282dcef11bSdrh ** are stored.
41292dcef11bSdrh **
41302dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4131678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41322dcef11bSdrh ** a temporary, then set *pReg to zero.
4133f30a969bSdrh **
4134f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4135f30a969bSdrh ** code to fill the register in the initialization section of the
4136f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
41372dcef11bSdrh */
41382dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4139f30a969bSdrh   int r2;
4140f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4141d9f158e7Sdrh   if( ConstFactorOk(pParse)
4142f30a969bSdrh    && pExpr->op!=TK_REGISTER
4143f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4144f30a969bSdrh   ){
4145f30a969bSdrh     *pReg  = 0;
4146ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4147f30a969bSdrh   }else{
41482dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4149f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
41502dcef11bSdrh     if( r2==r1 ){
41512dcef11bSdrh       *pReg = r1;
41522dcef11bSdrh     }else{
41532dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
41542dcef11bSdrh       *pReg = 0;
41552dcef11bSdrh     }
4156f30a969bSdrh   }
41572dcef11bSdrh   return r2;
41582dcef11bSdrh }
41592dcef11bSdrh 
41602dcef11bSdrh /*
41612dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
41622dcef11bSdrh ** results in register target.  The results are guaranteed to appear
41632dcef11bSdrh ** in register target.
41642dcef11bSdrh */
416505a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
41669cbf3425Sdrh   int inReg;
41679cbf3425Sdrh 
41689cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4169ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4170ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4171ebc16717Sdrh   }else{
41729cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
41731c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
41740e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
41759cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
417617a7f8ddSdrh     }
4177ebc16717Sdrh   }
4178cce7d176Sdrh }
4179cce7d176Sdrh 
4180cce7d176Sdrh /*
41811c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
41821c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
41831c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
41841c75c9d7Sdrh */
41851c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
41861c75c9d7Sdrh   sqlite3 *db = pParse->db;
41871c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
41881c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
41891c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
41901c75c9d7Sdrh }
41911c75c9d7Sdrh 
41921c75c9d7Sdrh /*
419305a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
419405a86c5cSdrh ** results in register target.  The results are guaranteed to appear
419505a86c5cSdrh ** in register target.  If the expression is constant, then this routine
419605a86c5cSdrh ** might choose to code the expression at initialization time.
419705a86c5cSdrh */
419805a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
419905a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4200ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
420105a86c5cSdrh   }else{
420205a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
420305a86c5cSdrh   }
4204cce7d176Sdrh }
4205cce7d176Sdrh 
4206cce7d176Sdrh /*
420760ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4208de4fcfddSdrh ** in register target.
420925303780Sdrh **
42102dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42112dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42122dcef11bSdrh ** the result is a copy of the cache register.
42132dcef11bSdrh **
42142dcef11bSdrh ** This routine is used for expressions that are used multiple
42152dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42162dcef11bSdrh ** are reused.
421725303780Sdrh */
421805a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
421925303780Sdrh   Vdbe *v = pParse->pVdbe;
422025303780Sdrh   int iMem;
422105a86c5cSdrh 
422205a86c5cSdrh   assert( target>0 );
422305a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
422405a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42252dcef11bSdrh   iMem = ++pParse->nMem;
422605a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4227a4c3c87eSdrh   exprToRegister(pExpr, iMem);
422825303780Sdrh }
42297e02e5e6Sdrh 
4230678ccce8Sdrh /*
4231268380caSdrh ** Generate code that pushes the value of every element of the given
42329cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4233268380caSdrh **
4234892d3179Sdrh ** Return the number of elements evaluated.
4235d1a01edaSdrh **
4236d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4237d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4238d1a01edaSdrh **
4239d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4240d1a01edaSdrh ** factored out into initialization code.
4241b0df9634Sdrh **
4242b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4243b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4244b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
4245268380caSdrh */
42464adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4247268380caSdrh   Parse *pParse,     /* Parsing context */
4248389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4249191b54cbSdrh   int target,        /* Where to write results */
42505579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4251d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4252268380caSdrh ){
4253268380caSdrh   struct ExprList_item *pItem;
42545579d59fSdrh   int i, j, n;
4255d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
42565579d59fSdrh   Vdbe *v = pParse->pVdbe;
42579d8b3072Sdrh   assert( pList!=0 );
42589cbf3425Sdrh   assert( target>0 );
4259d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4260268380caSdrh   n = pList->nExpr;
4261d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4262191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
42637445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
4264257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4265257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4266257c13faSdan         i--;
4267257c13faSdan         n--;
4268257c13faSdan       }else{
42695579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4270257c13faSdan       }
42715579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4272ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4273d1a01edaSdrh     }else{
42747445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4275746fd9ccSdrh       if( inReg!=target+i ){
42764eded604Sdrh         VdbeOp *pOp;
42774eded604Sdrh         if( copyOp==OP_Copy
42784eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
42794eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
42804eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
42814eded604Sdrh         ){
42824eded604Sdrh           pOp->p3++;
42834eded604Sdrh         }else{
42844eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
42854eded604Sdrh         }
4286d1a01edaSdrh       }
4287d176611bSdrh     }
4288268380caSdrh   }
4289f9b596ebSdrh   return n;
4290268380caSdrh }
4291268380caSdrh 
4292268380caSdrh /*
429336c563a2Sdrh ** Generate code for a BETWEEN operator.
429436c563a2Sdrh **
429536c563a2Sdrh **    x BETWEEN y AND z
429636c563a2Sdrh **
429736c563a2Sdrh ** The above is equivalent to
429836c563a2Sdrh **
429936c563a2Sdrh **    x>=y AND x<=z
430036c563a2Sdrh **
430136c563a2Sdrh ** Code it as such, taking care to do the common subexpression
430260ec914cSpeter.d.reid ** elimination of x.
430384b19a3dSdrh **
430484b19a3dSdrh ** The xJumpIf parameter determines details:
430584b19a3dSdrh **
430684b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
430784b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
430884b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
430984b19a3dSdrh **
431084b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
431136c563a2Sdrh */
431236c563a2Sdrh static void exprCodeBetween(
431336c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
431436c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
431584b19a3dSdrh   int dest,         /* Jump destination or storage location */
431684b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
431736c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
431836c563a2Sdrh ){
431936c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
432036c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
432136c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4322db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4323db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
432484b19a3dSdrh 
432536c563a2Sdrh 
432671c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
432771c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
432871c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4329db45bd5eSdrh 
4330db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4331db45bd5eSdrh   exprX = *pExpr->pLeft;
433236c563a2Sdrh   exprAnd.op = TK_AND;
433336c563a2Sdrh   exprAnd.pLeft = &compLeft;
433436c563a2Sdrh   exprAnd.pRight = &compRight;
433536c563a2Sdrh   compLeft.op = TK_GE;
4336db45bd5eSdrh   compLeft.pLeft = &exprX;
433736c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
433836c563a2Sdrh   compRight.op = TK_LE;
4339db45bd5eSdrh   compRight.pLeft = &exprX;
434036c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
434112abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
434284b19a3dSdrh   if( xJump ){
434384b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
434436c563a2Sdrh   }else{
434536fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
434636fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
434736fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
434836fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
434936fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4350db45bd5eSdrh     exprX.flags |= EP_FromJoin;
435171c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
435236c563a2Sdrh   }
4353db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
435436c563a2Sdrh 
435536c563a2Sdrh   /* Ensure adequate test coverage */
4356db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4357db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4358db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4359db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4360db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4361db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4362db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4363db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
436484b19a3dSdrh   testcase( xJump==0 );
436536c563a2Sdrh }
436636c563a2Sdrh 
436736c563a2Sdrh /*
4368cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4369cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4370cce7d176Sdrh ** continues straight thru if the expression is false.
4371f5905aa7Sdrh **
4372f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
437335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4374f2bc013cSdrh **
4375f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4376f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4377f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4378f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4379f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4380cce7d176Sdrh */
43814adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4382cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4383cce7d176Sdrh   int op = 0;
43842dcef11bSdrh   int regFree1 = 0;
43852dcef11bSdrh   int regFree2 = 0;
43862dcef11bSdrh   int r1, r2;
43872dcef11bSdrh 
438835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
438948864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
439033cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4391f2bc013cSdrh   op = pExpr->op;
43927b35a77bSdan   switch( op ){
4393cce7d176Sdrh     case TK_AND: {
43944adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4395c5499befSdrh       testcase( jumpIfNull==0 );
439635573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
439754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43984adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
43994adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4400d2490904Sdrh       sqlite3ExprCachePop(pParse);
4401cce7d176Sdrh       break;
4402cce7d176Sdrh     }
4403cce7d176Sdrh     case TK_OR: {
4404c5499befSdrh       testcase( jumpIfNull==0 );
44054adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
440654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
44074adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4408d2490904Sdrh       sqlite3ExprCachePop(pParse);
4409cce7d176Sdrh       break;
4410cce7d176Sdrh     }
4411cce7d176Sdrh     case TK_NOT: {
4412c5499befSdrh       testcase( jumpIfNull==0 );
44134adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4414cce7d176Sdrh       break;
4415cce7d176Sdrh     }
4416de845c2fSdrh     case TK_IS:
4417de845c2fSdrh     case TK_ISNOT:
4418de845c2fSdrh       testcase( op==TK_IS );
4419de845c2fSdrh       testcase( op==TK_ISNOT );
4420de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4421de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4422de845c2fSdrh       /* Fall thru */
4423cce7d176Sdrh     case TK_LT:
4424cce7d176Sdrh     case TK_LE:
4425cce7d176Sdrh     case TK_GT:
4426cce7d176Sdrh     case TK_GE:
4427cce7d176Sdrh     case TK_NE:
44280ac65892Sdrh     case TK_EQ: {
4429625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4430c5499befSdrh       testcase( jumpIfNull==0 );
4431b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4432b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
443335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
44342dcef11bSdrh                   r1, r2, dest, jumpIfNull);
44357d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
44367d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
44377d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
44387d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4439de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4440de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4441de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4442de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4443de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4444de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
44456a2fe093Sdrh       testcase( regFree1==0 );
44466a2fe093Sdrh       testcase( regFree2==0 );
44476a2fe093Sdrh       break;
44486a2fe093Sdrh     }
4449cce7d176Sdrh     case TK_ISNULL:
4450cce7d176Sdrh     case TK_NOTNULL: {
44517d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
44527d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
44532dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
44542dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
44557d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
44567d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4457c5499befSdrh       testcase( regFree1==0 );
4458cce7d176Sdrh       break;
4459cce7d176Sdrh     }
4460fef5208cSdrh     case TK_BETWEEN: {
44615c03f30aSdrh       testcase( jumpIfNull==0 );
446271c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4463fef5208cSdrh       break;
4464fef5208cSdrh     }
4465bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4466e3365e6cSdrh     case TK_IN: {
4467e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4468e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4469e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4470076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4471e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4472e3365e6cSdrh       break;
4473e3365e6cSdrh     }
4474bb201344Sshaneh #endif
4475cce7d176Sdrh     default: {
44767b35a77bSdan     default_expr:
4477991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4478076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4479991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4480991a1985Sdrh         /* No-op */
4481991a1985Sdrh       }else{
44822dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
44832dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4484688852abSdrh         VdbeCoverage(v);
4485c5499befSdrh         testcase( regFree1==0 );
4486c5499befSdrh         testcase( jumpIfNull==0 );
4487991a1985Sdrh       }
4488cce7d176Sdrh       break;
4489cce7d176Sdrh     }
4490cce7d176Sdrh   }
44912dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44922dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4493cce7d176Sdrh }
4494cce7d176Sdrh 
4495cce7d176Sdrh /*
449666b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4497cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4498cce7d176Sdrh ** continues straight thru if the expression is true.
4499f5905aa7Sdrh **
4500f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
450135573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
450235573356Sdrh ** is 0.
4503cce7d176Sdrh */
45044adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4505cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4506cce7d176Sdrh   int op = 0;
45072dcef11bSdrh   int regFree1 = 0;
45082dcef11bSdrh   int regFree2 = 0;
45092dcef11bSdrh   int r1, r2;
45102dcef11bSdrh 
451135573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
451248864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
451333cd4909Sdrh   if( pExpr==0 )    return;
4514f2bc013cSdrh 
4515f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4516f2bc013cSdrh   **
4517f2bc013cSdrh   **       pExpr->op            op
4518f2bc013cSdrh   **       ---------          ----------
4519f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4520f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4521f2bc013cSdrh   **       TK_NE              OP_Eq
4522f2bc013cSdrh   **       TK_EQ              OP_Ne
4523f2bc013cSdrh   **       TK_GT              OP_Le
4524f2bc013cSdrh   **       TK_LE              OP_Gt
4525f2bc013cSdrh   **       TK_GE              OP_Lt
4526f2bc013cSdrh   **       TK_LT              OP_Ge
4527f2bc013cSdrh   **
4528f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4529f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4530f2bc013cSdrh   ** can compute the mapping above using the following expression.
4531f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4532f2bc013cSdrh   */
4533f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4534f2bc013cSdrh 
4535f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4536f2bc013cSdrh   */
4537f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4538f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4539f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4540f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4541f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4542f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4543f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4544f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4545f2bc013cSdrh 
4546ba00e30aSdan   switch( pExpr->op ){
4547cce7d176Sdrh     case TK_AND: {
4548c5499befSdrh       testcase( jumpIfNull==0 );
45494adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
455054e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45514adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4552d2490904Sdrh       sqlite3ExprCachePop(pParse);
4553cce7d176Sdrh       break;
4554cce7d176Sdrh     }
4555cce7d176Sdrh     case TK_OR: {
45564adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4557c5499befSdrh       testcase( jumpIfNull==0 );
455835573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
455954e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45604adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
45614adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4562d2490904Sdrh       sqlite3ExprCachePop(pParse);
4563cce7d176Sdrh       break;
4564cce7d176Sdrh     }
4565cce7d176Sdrh     case TK_NOT: {
45665c03f30aSdrh       testcase( jumpIfNull==0 );
45674adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4568cce7d176Sdrh       break;
4569cce7d176Sdrh     }
4570de845c2fSdrh     case TK_IS:
4571de845c2fSdrh     case TK_ISNOT:
4572de845c2fSdrh       testcase( pExpr->op==TK_IS );
4573de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4574de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4575de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4576de845c2fSdrh       /* Fall thru */
4577cce7d176Sdrh     case TK_LT:
4578cce7d176Sdrh     case TK_LE:
4579cce7d176Sdrh     case TK_GT:
4580cce7d176Sdrh     case TK_GE:
4581cce7d176Sdrh     case TK_NE:
4582cce7d176Sdrh     case TK_EQ: {
4583625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4584c5499befSdrh       testcase( jumpIfNull==0 );
4585b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4586b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
458735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45882dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45897d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45907d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45917d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45927d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4593de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4594de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4595de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4596de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4597de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4598de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
45996a2fe093Sdrh       testcase( regFree1==0 );
46006a2fe093Sdrh       testcase( regFree2==0 );
46016a2fe093Sdrh       break;
46026a2fe093Sdrh     }
4603cce7d176Sdrh     case TK_ISNULL:
4604cce7d176Sdrh     case TK_NOTNULL: {
46052dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46062dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46077d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
46087d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4609c5499befSdrh       testcase( regFree1==0 );
4610cce7d176Sdrh       break;
4611cce7d176Sdrh     }
4612fef5208cSdrh     case TK_BETWEEN: {
46135c03f30aSdrh       testcase( jumpIfNull==0 );
461471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4615fef5208cSdrh       break;
4616fef5208cSdrh     }
4617bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4618e3365e6cSdrh     case TK_IN: {
4619e3365e6cSdrh       if( jumpIfNull ){
4620e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4621e3365e6cSdrh       }else{
4622e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4623e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4624e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4625e3365e6cSdrh       }
4626e3365e6cSdrh       break;
4627e3365e6cSdrh     }
4628bb201344Sshaneh #endif
4629cce7d176Sdrh     default: {
4630ba00e30aSdan     default_expr:
4631991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4632076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4633991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4634991a1985Sdrh         /* no-op */
4635991a1985Sdrh       }else{
46362dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46372dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4638688852abSdrh         VdbeCoverage(v);
4639c5499befSdrh         testcase( regFree1==0 );
4640c5499befSdrh         testcase( jumpIfNull==0 );
4641991a1985Sdrh       }
4642cce7d176Sdrh       break;
4643cce7d176Sdrh     }
4644cce7d176Sdrh   }
46452dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4647cce7d176Sdrh }
46482282792aSdrh 
46492282792aSdrh /*
465072bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
465172bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
465272bc8208Sdrh ** ensures that the original pExpr is unchanged.
465372bc8208Sdrh */
465472bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
465572bc8208Sdrh   sqlite3 *db = pParse->db;
465672bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
465772bc8208Sdrh   if( db->mallocFailed==0 ){
465872bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
465972bc8208Sdrh   }
466072bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
466172bc8208Sdrh }
466272bc8208Sdrh 
46635aa550cfSdan /*
46645aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
46655aa550cfSdan ** type of expression.
46665aa550cfSdan **
46675aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
46685aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
46695aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
46705aa550cfSdan **
46715aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
46725aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
46735aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
46745aa550cfSdan ** SQL value, zero is returned.
46755aa550cfSdan */
46765aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
46775aa550cfSdan   int res = 0;
4678c0804226Sdrh   int iVar;
4679c0804226Sdrh   sqlite3_value *pL, *pR = 0;
46805aa550cfSdan 
46815aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4682c0804226Sdrh   if( pR ){
4683c0804226Sdrh     iVar = pVar->iColumn;
4684c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4685c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
46865aa307e2Sdrh     if( pL ){
46875aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
46885aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
46895aa307e2Sdrh       }
46905aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
46915aa550cfSdan     }
46925aa550cfSdan     sqlite3ValueFree(pR);
46935aa550cfSdan     sqlite3ValueFree(pL);
46945aa550cfSdan   }
46955aa550cfSdan 
46965aa550cfSdan   return res;
46975aa550cfSdan }
469872bc8208Sdrh 
469972bc8208Sdrh /*
47001d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
47011d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
47021d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
47031d9da70aSdrh ** other than the top-level COLLATE operator.
4704d40aab0eSdrh **
4705619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4706619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4707619a1305Sdrh **
470866518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
470966518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
471066518ca7Sdrh **
47111d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4712d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
47131d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
47141d9da70aSdrh ** returns 2, then you do not really know for certain if the two
47151d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4716d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
47171d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4718d40aab0eSdrh ** just might result in some slightly slower code.  But returning
47191d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
47205aa550cfSdan **
4721c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4722c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4723c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4724c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4725c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4726c0804226Sdrh ** pB causes a return value of 2.
47272282792aSdrh */
47285aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
472910d1edf0Sdrh   u32 combinedFlags;
47304b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
47311d9da70aSdrh     return pB==pA ? 0 : 2;
47322282792aSdrh   }
47335aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
47345aa550cfSdan     return 0;
47355aa550cfSdan   }
473610d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
473710d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
473810d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
473910d1edf0Sdrh       return 0;
474010d1edf0Sdrh     }
47411d9da70aSdrh     return 2;
47426ab3a2ecSdanielk1977   }
4743c2acc4e4Sdrh   if( pA->op!=pB->op ){
47445aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4745ae80ddeaSdrh       return 1;
4746ae80ddeaSdrh     }
47475aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4748ae80ddeaSdrh       return 1;
4749ae80ddeaSdrh     }
4750ae80ddeaSdrh     return 2;
4751ae80ddeaSdrh   }
47522edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4753390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4754390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4755390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
475610d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
475710d1edf0Sdrh     }
475810d1edf0Sdrh   }
475910d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
476085f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
476110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
47625aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
47635aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4764619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
47657693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4766619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
476766518ca7Sdrh       if( pA->iTable!=pB->iTable
476885f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
47691d9da70aSdrh     }
47701d9da70aSdrh   }
47712646da7eSdrh   return 0;
47722646da7eSdrh }
47732282792aSdrh 
47748c6f666bSdrh /*
47758c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
47768c6f666bSdrh ** non-zero if they differ in any way.
47778c6f666bSdrh **
4778619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4779619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4780619a1305Sdrh **
47818c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
47828c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
47838c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
47848c6f666bSdrh ** a malfunction will result.
47858c6f666bSdrh **
47868c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
47878c6f666bSdrh ** always differs from a non-NULL pointer.
47888c6f666bSdrh */
4789619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
47908c6f666bSdrh   int i;
47918c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
47928c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
47938c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
47948c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
47958c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
47968c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
47978c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
47985aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
47998c6f666bSdrh   }
48008c6f666bSdrh   return 0;
48018c6f666bSdrh }
480213449892Sdrh 
48032282792aSdrh /*
4804f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4805f9463dfbSdrh ** are ignored.
4806f9463dfbSdrh */
4807f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
48085aa550cfSdan   return sqlite3ExprCompare(0,
4809f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4810f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4811f9463dfbSdrh              iTab);
4812f9463dfbSdrh }
4813f9463dfbSdrh 
4814f9463dfbSdrh /*
48154bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
48164bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
48174bd5f73fSdrh ** be false.  Examples:
48184bd5f73fSdrh **
4819619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
48204bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4821619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
48224bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4823619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4824619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4825619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
48264bd5f73fSdrh **
48274bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
48284bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
48294bd5f73fSdrh **
4830c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4831c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4832c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4833c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
4834c0804226Sdrh **
48354bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
48364bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
48374bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
48384bd5f73fSdrh */
48395aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
48405aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
4841619a1305Sdrh     return 1;
4842619a1305Sdrh   }
4843619a1305Sdrh   if( pE2->op==TK_OR
48445aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
48455aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
4846619a1305Sdrh   ){
4847619a1305Sdrh     return 1;
4848619a1305Sdrh   }
48491ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
48501ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
48511ad93a00Sdrh     testcase( pX!=pE1->pLeft );
48525aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
4853619a1305Sdrh   }
4854619a1305Sdrh   return 0;
48554bd5f73fSdrh }
48564bd5f73fSdrh 
48574bd5f73fSdrh /*
4858030796dfSdrh ** An instance of the following structure is used by the tree walker
48592409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
48602409f8a1Sdrh ** index only, without having to do a search for the corresponding
48612409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
48622409f8a1Sdrh ** is the cursor for the table.
48632409f8a1Sdrh */
48642409f8a1Sdrh struct IdxCover {
48652409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
48662409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
48672409f8a1Sdrh };
48682409f8a1Sdrh 
48692409f8a1Sdrh /*
48702409f8a1Sdrh ** Check to see if there are references to columns in table
48712409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
48722409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
48732409f8a1Sdrh */
48742409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
48752409f8a1Sdrh   if( pExpr->op==TK_COLUMN
48762409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
48772409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
48782409f8a1Sdrh   ){
48792409f8a1Sdrh     pWalker->eCode = 1;
48802409f8a1Sdrh     return WRC_Abort;
48812409f8a1Sdrh   }
48822409f8a1Sdrh   return WRC_Continue;
48832409f8a1Sdrh }
48842409f8a1Sdrh 
48852409f8a1Sdrh /*
4886e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4887e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4888e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4889e604ec0bSdrh ** that are not found in the index pIdx.
48902409f8a1Sdrh **
48912409f8a1Sdrh ** An index covering an expression means that the expression can be
48922409f8a1Sdrh ** evaluated using only the index and without having to lookup the
48932409f8a1Sdrh ** corresponding table entry.
48942409f8a1Sdrh */
48952409f8a1Sdrh int sqlite3ExprCoveredByIndex(
48962409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
48972409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
48982409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
48992409f8a1Sdrh ){
49002409f8a1Sdrh   Walker w;
49012409f8a1Sdrh   struct IdxCover xcov;
49022409f8a1Sdrh   memset(&w, 0, sizeof(w));
49032409f8a1Sdrh   xcov.iCur = iCur;
49042409f8a1Sdrh   xcov.pIdx = pIdx;
49052409f8a1Sdrh   w.xExprCallback = exprIdxCover;
49062409f8a1Sdrh   w.u.pIdxCover = &xcov;
49072409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
49082409f8a1Sdrh   return !w.eCode;
49092409f8a1Sdrh }
49102409f8a1Sdrh 
49112409f8a1Sdrh 
49122409f8a1Sdrh /*
49132409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4914030796dfSdrh ** to count references to table columns in the arguments of an
4915ed551b95Sdrh ** aggregate function, in order to implement the
4916ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4917374fdce4Sdrh */
4918030796dfSdrh struct SrcCount {
4919030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4920030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4921030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4922030796dfSdrh };
4923030796dfSdrh 
4924030796dfSdrh /*
4925030796dfSdrh ** Count the number of references to columns.
4926030796dfSdrh */
4927030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4928fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4929fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4930fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4931fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4932fb0a6081Sdrh   ** NEVER() will need to be removed. */
4933fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4934374fdce4Sdrh     int i;
4935030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4936030796dfSdrh     SrcList *pSrc = p->pSrc;
4937655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4938655814d2Sdrh     for(i=0; i<nSrc; i++){
4939030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4940374fdce4Sdrh     }
4941655814d2Sdrh     if( i<nSrc ){
4942030796dfSdrh       p->nThis++;
4943374fdce4Sdrh     }else{
4944030796dfSdrh       p->nOther++;
4945374fdce4Sdrh     }
4946374fdce4Sdrh   }
4947030796dfSdrh   return WRC_Continue;
4948030796dfSdrh }
4949374fdce4Sdrh 
4950374fdce4Sdrh /*
4951030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4952030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4953030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4954030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4955374fdce4Sdrh */
4956030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4957374fdce4Sdrh   Walker w;
4958030796dfSdrh   struct SrcCount cnt;
4959374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4960030796dfSdrh   w.xExprCallback = exprSrcCount;
4961979dd1beSdrh   w.xSelectCallback = 0;
4962030796dfSdrh   w.u.pSrcCount = &cnt;
4963030796dfSdrh   cnt.pSrc = pSrcList;
4964030796dfSdrh   cnt.nThis = 0;
4965030796dfSdrh   cnt.nOther = 0;
4966030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4967030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4968374fdce4Sdrh }
4969374fdce4Sdrh 
4970374fdce4Sdrh /*
497113449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
497213449892Sdrh ** the new element.  Return a negative number if malloc fails.
49732282792aSdrh */
497417435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
497513449892Sdrh   int i;
4976cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
497717435752Sdrh        db,
4978cf643729Sdrh        pInfo->aCol,
4979cf643729Sdrh        sizeof(pInfo->aCol[0]),
4980cf643729Sdrh        &pInfo->nColumn,
4981cf643729Sdrh        &i
4982cf643729Sdrh   );
498313449892Sdrh   return i;
49842282792aSdrh }
498513449892Sdrh 
498613449892Sdrh /*
498713449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
498813449892Sdrh ** the new element.  Return a negative number if malloc fails.
498913449892Sdrh */
499017435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
499113449892Sdrh   int i;
4992cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
499317435752Sdrh        db,
4994cf643729Sdrh        pInfo->aFunc,
4995cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4996cf643729Sdrh        &pInfo->nFunc,
4997cf643729Sdrh        &i
4998cf643729Sdrh   );
499913449892Sdrh   return i;
50002282792aSdrh }
50012282792aSdrh 
50022282792aSdrh /*
50037d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
50047d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5005626a879aSdrh ** for additional information.
50062282792aSdrh */
50077d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
50082282792aSdrh   int i;
50097d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5010a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5011a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
501213449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
501313449892Sdrh 
50142282792aSdrh   switch( pExpr->op ){
501589c69d00Sdrh     case TK_AGG_COLUMN:
5016967e8b73Sdrh     case TK_COLUMN: {
50178b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
50188b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
501913449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
502013449892Sdrh       ** clause of the aggregate query */
502120bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
502213449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
502313449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
502413449892Sdrh           struct AggInfo_col *pCol;
5025c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
502613449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
502713449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
502813449892Sdrh             ** that is in the FROM clause of the aggregate query.
502913449892Sdrh             **
503013449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
503113449892Sdrh             ** is not an entry there already.
503213449892Sdrh             */
50337f906d63Sdrh             int k;
503413449892Sdrh             pCol = pAggInfo->aCol;
50357f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
503613449892Sdrh               if( pCol->iTable==pExpr->iTable &&
503713449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
50382282792aSdrh                 break;
50392282792aSdrh               }
50402282792aSdrh             }
50411e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
50421e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
50431e536953Sdanielk1977             ){
50447f906d63Sdrh               pCol = &pAggInfo->aCol[k];
50450817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
504613449892Sdrh               pCol->iTable = pExpr->iTable;
504713449892Sdrh               pCol->iColumn = pExpr->iColumn;
50480a07c107Sdrh               pCol->iMem = ++pParse->nMem;
504913449892Sdrh               pCol->iSorterColumn = -1;
50505774b806Sdrh               pCol->pExpr = pExpr;
505113449892Sdrh               if( pAggInfo->pGroupBy ){
505213449892Sdrh                 int j, n;
505313449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
505413449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
505513449892Sdrh                 n = pGB->nExpr;
505613449892Sdrh                 for(j=0; j<n; j++, pTerm++){
505713449892Sdrh                   Expr *pE = pTerm->pExpr;
505813449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
505913449892Sdrh                       pE->iColumn==pExpr->iColumn ){
506013449892Sdrh                     pCol->iSorterColumn = j;
506113449892Sdrh                     break;
50622282792aSdrh                   }
506313449892Sdrh                 }
506413449892Sdrh               }
506513449892Sdrh               if( pCol->iSorterColumn<0 ){
506613449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
506713449892Sdrh               }
506813449892Sdrh             }
506913449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
507013449892Sdrh             ** because it was there before or because we just created it).
507113449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
507213449892Sdrh             ** pAggInfo->aCol[] entry.
507313449892Sdrh             */
5074ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
507513449892Sdrh             pExpr->pAggInfo = pAggInfo;
507613449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5077cf697396Sshane             pExpr->iAgg = (i16)k;
507813449892Sdrh             break;
507913449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
508013449892Sdrh         } /* end loop over pSrcList */
5081a58fdfb1Sdanielk1977       }
50827d10d5a6Sdrh       return WRC_Prune;
50832282792aSdrh     }
50842282792aSdrh     case TK_AGG_FUNCTION: {
50853a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5086ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
50873a8c4be7Sdrh       ){
508813449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
508913449892Sdrh         ** function that is already in the pAggInfo structure
509013449892Sdrh         */
509113449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
509213449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
50935aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
50942282792aSdrh             break;
50952282792aSdrh           }
50962282792aSdrh         }
509713449892Sdrh         if( i>=pAggInfo->nFunc ){
509813449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
509913449892Sdrh           */
510014db2665Sdanielk1977           u8 enc = ENC(pParse->db);
51011e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
510213449892Sdrh           if( i>=0 ){
51036ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
510413449892Sdrh             pItem = &pAggInfo->aFunc[i];
510513449892Sdrh             pItem->pExpr = pExpr;
51060a07c107Sdrh             pItem->iMem = ++pParse->nMem;
510733e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
510813449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
510980738d9cSdrh                    pExpr->u.zToken,
51106ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5111fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5112fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5113fd357974Sdrh             }else{
5114fd357974Sdrh               pItem->iDistinct = -1;
5115fd357974Sdrh             }
51162282792aSdrh           }
511713449892Sdrh         }
511813449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
511913449892Sdrh         */
5120c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5121ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5122cf697396Sshane         pExpr->iAgg = (i16)i;
512313449892Sdrh         pExpr->pAggInfo = pAggInfo;
51243a8c4be7Sdrh         return WRC_Prune;
51256e83a57fSdrh       }else{
51266e83a57fSdrh         return WRC_Continue;
51276e83a57fSdrh       }
51282282792aSdrh     }
5129a58fdfb1Sdanielk1977   }
51307d10d5a6Sdrh   return WRC_Continue;
51317d10d5a6Sdrh }
51327d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5133d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5134979dd1beSdrh   pWalker->walkerDepth++;
51357d10d5a6Sdrh   return WRC_Continue;
5136a58fdfb1Sdanielk1977 }
5137979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5138979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5139979dd1beSdrh   pWalker->walkerDepth--;
5140979dd1beSdrh }
5141626a879aSdrh 
5142626a879aSdrh /*
5143e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5144e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5145e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5146e8abb4caSdrh ** necessary.
5147626a879aSdrh **
5148626a879aSdrh ** This routine should only be called after the expression has been
51497d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5150626a879aSdrh */
5151d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
51527d10d5a6Sdrh   Walker w;
51537d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
51547d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5155979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5156979dd1beSdrh   w.walkerDepth = 0;
51577d10d5a6Sdrh   w.u.pNC = pNC;
515820bc393cSdrh   assert( pNC->pSrcList!=0 );
51597d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
51602282792aSdrh }
51615d9a4af9Sdrh 
51625d9a4af9Sdrh /*
51635d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
51645d9a4af9Sdrh ** expression list.  Return the number of errors.
51655d9a4af9Sdrh **
51665d9a4af9Sdrh ** If an error is found, the analysis is cut short.
51675d9a4af9Sdrh */
5168d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
51695d9a4af9Sdrh   struct ExprList_item *pItem;
51705d9a4af9Sdrh   int i;
51715d9a4af9Sdrh   if( pList ){
5172d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5173d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
51745d9a4af9Sdrh     }
51755d9a4af9Sdrh   }
51765d9a4af9Sdrh }
5177892d3179Sdrh 
5178892d3179Sdrh /*
5179ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5180892d3179Sdrh */
5181892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5182e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5183892d3179Sdrh     return ++pParse->nMem;
5184892d3179Sdrh   }
51852f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5186892d3179Sdrh }
5187ceea3321Sdrh 
5188ceea3321Sdrh /*
5189ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5190ceea3321Sdrh ** purpose.
5191ceea3321Sdrh **
5192ceea3321Sdrh ** If a register is currently being used by the column cache, then
519360ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5194ceea3321Sdrh ** the register becomes stale.
5195ceea3321Sdrh */
5196892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
51972dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5198ceea3321Sdrh     int i;
5199ceea3321Sdrh     struct yColCache *p;
52009b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5201ceea3321Sdrh       if( p->iReg==iReg ){
5202ceea3321Sdrh         p->tempReg = 1;
5203ceea3321Sdrh         return;
5204ceea3321Sdrh       }
5205ceea3321Sdrh     }
5206892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5207892d3179Sdrh   }
5208892d3179Sdrh }
5209892d3179Sdrh 
5210892d3179Sdrh /*
5211ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5212892d3179Sdrh */
5213892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5214e55cbd72Sdrh   int i, n;
5215ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5216892d3179Sdrh   i = pParse->iRangeReg;
5217e55cbd72Sdrh   n = pParse->nRangeReg;
5218f49f3523Sdrh   if( nReg<=n ){
5219f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5220892d3179Sdrh     pParse->iRangeReg += nReg;
5221892d3179Sdrh     pParse->nRangeReg -= nReg;
5222892d3179Sdrh   }else{
5223892d3179Sdrh     i = pParse->nMem+1;
5224892d3179Sdrh     pParse->nMem += nReg;
5225892d3179Sdrh   }
5226892d3179Sdrh   return i;
5227892d3179Sdrh }
5228892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5229ed24da4bSdrh   if( nReg==1 ){
5230ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5231ed24da4bSdrh     return;
5232ed24da4bSdrh   }
5233f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5234892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5235892d3179Sdrh     pParse->nRangeReg = nReg;
5236892d3179Sdrh     pParse->iRangeReg = iReg;
5237892d3179Sdrh   }
5238892d3179Sdrh }
5239cdc69557Sdrh 
5240cdc69557Sdrh /*
5241cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5242cdc69557Sdrh */
5243cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5244cdc69557Sdrh   pParse->nTempReg = 0;
5245cdc69557Sdrh   pParse->nRangeReg = 0;
5246cdc69557Sdrh }
5247bb9b5f26Sdrh 
5248bb9b5f26Sdrh /*
5249bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5250bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5251bb9b5f26Sdrh ** statements.
5252bb9b5f26Sdrh */
5253bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5254bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5255bb9b5f26Sdrh   int i;
5256bb9b5f26Sdrh   if( pParse->nRangeReg>0
5257bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
5258bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
5259bb9b5f26Sdrh   ){
5260bb9b5f26Sdrh      return 0;
5261bb9b5f26Sdrh   }
5262bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5263bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5264bb9b5f26Sdrh       return 0;
5265bb9b5f26Sdrh     }
5266bb9b5f26Sdrh   }
5267bb9b5f26Sdrh   return 1;
5268bb9b5f26Sdrh }
5269bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5270