xref: /sqlite-3.40.0/src/expr.c (revision b8d29c2f)
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
61*b8d29c2fSdan   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 
355f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
356ba00e30aSdan /*
357fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
358fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
359fc7f27b9Sdrh ** ensure that i is within range.
360fc7f27b9Sdrh **
36176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
36276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
36376dbe7a8Sdrh **
364fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
365fc7f27b9Sdrh **
366fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
36776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
36876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
36976dbe7a8Sdrh ** been positioned.
370ba00e30aSdan */
371fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
372870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
373870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
3749f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
3759f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
37671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
377870a0705Sdan     }else{
37871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
37971c57db0Sdan     }
380870a0705Sdan   }
381870a0705Sdan   return pVector;
382870a0705Sdan }
383fc7f27b9Sdrh #endif /* !defined(SQLITE_OMIT_SUBQUERY) */
384fc7f27b9Sdrh 
385fc7f27b9Sdrh #ifndef SQLITE_OMIT_SUBQUERY
386fc7f27b9Sdrh /*
387fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
388fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
389fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
390fc7f27b9Sdrh **
3918762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
3928762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
3938762ec19Sdrh **
394fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
395fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
396fc7f27b9Sdrh **
3978762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
398fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
3998762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4008762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
40176dbe7a8Sdrh ** returns.
4028762ec19Sdrh **
4038762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4048762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4058762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
406fc7f27b9Sdrh */
407fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
408fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
409fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
410a1251bc4Sdrh   int iField           /* Which column of the vector to return */
411fc7f27b9Sdrh ){
412fc7f27b9Sdrh   Expr *pRet;
413a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
414a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
415fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
416fc7f27b9Sdrh     **
417966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4188762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
419fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
420966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
421fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
422fc7f27b9Sdrh     **                  if the result is not yet computed.
423fc7f27b9Sdrh     **
424fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
425fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4268762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4278762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4288762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4298762ec19Sdrh     ** will own the pVector.
430fc7f27b9Sdrh     */
431abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4328bd0d58eSdrh     if( pRet ){
4338bd0d58eSdrh       pRet->iColumn = iField;
4348bd0d58eSdrh       pRet->pLeft = pVector;
4358bd0d58eSdrh     }
436fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
437fc7f27b9Sdrh   }else{
438a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
439a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
440fc7f27b9Sdrh   }
441fc7f27b9Sdrh   return pRet;
442fc7f27b9Sdrh }
443fc7f27b9Sdrh #endif /* !define(SQLITE_OMIT_SUBQUERY) */
44471c57db0Sdan 
4455c288b92Sdan /*
4465c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4475c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4485c288b92Sdan ** sub-select returns more than one column, the first in an array
4495c288b92Sdan ** of registers in which the result is stored).
4505c288b92Sdan **
4515c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4525c288b92Sdan */
4535c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4548da209b1Sdan   int reg = 0;
455f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4565c288b92Sdan   if( pExpr->op==TK_SELECT ){
4578da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4588da209b1Sdan   }
459f9b2e05cSdan #endif
4608da209b1Sdan   return reg;
4618da209b1Sdan }
4628da209b1Sdan 
4635c288b92Sdan /*
4645c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
465870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
466870a0705Sdan ** the register number of a register that contains the value of
467870a0705Sdan ** element iField of the vector.
468870a0705Sdan **
469870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
470870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
471870a0705Sdan ** case parameter regSelect should be the first in an array of registers
472870a0705Sdan ** containing the results of the sub-select.
473870a0705Sdan **
474870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
475870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
476870a0705Sdan ** a temporary register to be freed by the caller before returning.
4775c288b92Sdan **
4785c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
4795c288b92Sdan ** Expr object corresponding to element iElem of the vector.
4805c288b92Sdan */
4815c288b92Sdan static int exprVectorRegister(
4825c288b92Sdan   Parse *pParse,                  /* Parse context */
4835c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
484870a0705Sdan   int iField,                     /* Field to extract from pVector */
4855c288b92Sdan   int regSelect,                  /* First in array of registers */
4865c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
4875c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
4885c288b92Sdan ){
48912abf408Sdrh   u8 op = pVector->op;
490c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
49112abf408Sdrh   if( op==TK_REGISTER ){
49212abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
49312abf408Sdrh     return pVector->iTable+iField;
49412abf408Sdrh   }
49512abf408Sdrh   if( op==TK_SELECT ){
496870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
497870a0705Sdan      return regSelect+iField;
4985c288b92Sdan   }
499870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5005c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5015c288b92Sdan }
5025c288b92Sdan 
5035c288b92Sdan /*
5045c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
50579752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
50679752b6eSdrh ** result into register dest.
50779752b6eSdrh **
50879752b6eSdrh ** The caller must satisfy the following preconditions:
50979752b6eSdrh **
51079752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
51179752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
51279752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5135c288b92Sdan */
51479752b6eSdrh static void codeVectorCompare(
51579752b6eSdrh   Parse *pParse,        /* Code generator context */
51679752b6eSdrh   Expr *pExpr,          /* The comparison operation */
51779752b6eSdrh   int dest,             /* Write results into this register */
51879752b6eSdrh   u8 op,                /* Comparison operator */
51979752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
52079752b6eSdrh ){
52171c57db0Sdan   Vdbe *v = pParse->pVdbe;
52271c57db0Sdan   Expr *pLeft = pExpr->pLeft;
52371c57db0Sdan   Expr *pRight = pExpr->pRight;
52471c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
52571c57db0Sdan   int i;
52671c57db0Sdan   int regLeft = 0;
52771c57db0Sdan   int regRight = 0;
52879752b6eSdrh   u8 opx = op;
52979752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
53071c57db0Sdan 
531245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
532245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
533245ce62eSdrh     return;
534245ce62eSdrh   }
53571c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
53671c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
53771c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
53871c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
53971c57db0Sdan   );
54079752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
54179752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
54279752b6eSdrh   assert( p5==0 || pExpr->op!=op );
54379752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
54471c57db0Sdan 
54579752b6eSdrh   p5 |= SQLITE_STOREP2;
54679752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
54779752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5485c288b92Sdan 
5495c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5505c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5515c288b92Sdan 
552321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5535c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5545c288b92Sdan     Expr *pL, *pR;
5555c288b92Sdan     int r1, r2;
556321e828dSdrh     assert( i>=0 && i<nLeft );
55779752b6eSdrh     if( i>0 ) sqlite3ExprCachePush(pParse);
5585c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5595c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
56079752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
56179752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
56279752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
56379752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
56479752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
56579752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
56679752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
56771c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
56871c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
56979752b6eSdrh     if( i>0 ) sqlite3ExprCachePop(pParse);
57079752b6eSdrh     if( i==nLeft-1 ){
57179752b6eSdrh       break;
57271c57db0Sdan     }
57379752b6eSdrh     if( opx==TK_EQ ){
57479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
57579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
57679752b6eSdrh     }else if( opx==TK_NE ){
57779752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
57879752b6eSdrh       p5 |= SQLITE_KEEPNULL;
579a2f62925Sdrh     }else{
580a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
581a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
58279752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
58379752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
58479752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
58579752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
58679752b6eSdrh       if( i==nLeft-2 ) opx = op;
58771c57db0Sdan     }
58879752b6eSdrh   }
58979752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
59079752b6eSdrh }
59171c57db0Sdan 
5924b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
5934b5255acSdanielk1977 /*
5944b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
5954b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
5964b5255acSdanielk1977 ** pParse.
5974b5255acSdanielk1977 */
5987d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
5994b5255acSdanielk1977   int rc = SQLITE_OK;
6004b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6014b5255acSdanielk1977   if( nHeight>mxHeight ){
6024b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6034b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6044b5255acSdanielk1977     );
6054b5255acSdanielk1977     rc = SQLITE_ERROR;
6064b5255acSdanielk1977   }
6074b5255acSdanielk1977   return rc;
6084b5255acSdanielk1977 }
6094b5255acSdanielk1977 
6104b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6114b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6124b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6134b5255acSdanielk1977 ** first argument.
6144b5255acSdanielk1977 **
6154b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6164b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6174b5255acSdanielk1977 ** value.
6184b5255acSdanielk1977 */
6194b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6204b5255acSdanielk1977   if( p ){
6214b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6224b5255acSdanielk1977       *pnHeight = p->nHeight;
6234b5255acSdanielk1977     }
6244b5255acSdanielk1977   }
6254b5255acSdanielk1977 }
6264b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6274b5255acSdanielk1977   if( p ){
6284b5255acSdanielk1977     int i;
6294b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6304b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6314b5255acSdanielk1977     }
6324b5255acSdanielk1977   }
6334b5255acSdanielk1977 }
6344b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
6354b5255acSdanielk1977   if( p ){
6364b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6374b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6384b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6394b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
6404b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6414b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6424b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6434b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
6444b5255acSdanielk1977   }
6454b5255acSdanielk1977 }
6464b5255acSdanielk1977 
6474b5255acSdanielk1977 /*
6484b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6494b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6504b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6514b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6524b5255acSdanielk1977 ** referenced Expr plus one.
6532308ed38Sdrh **
6542308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6552308ed38Sdrh ** if appropriate.
6564b5255acSdanielk1977 */
6574b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6584b5255acSdanielk1977   int nHeight = 0;
6594b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6604b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6616ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6626ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6632308ed38Sdrh   }else if( p->x.pList ){
6646ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6652308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6666ab3a2ecSdanielk1977   }
6674b5255acSdanielk1977   p->nHeight = nHeight + 1;
6684b5255acSdanielk1977 }
6694b5255acSdanielk1977 
6704b5255acSdanielk1977 /*
6714b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6724b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6734b5255acSdanielk1977 ** leave an error in pParse.
6742308ed38Sdrh **
6752308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
6762308ed38Sdrh ** Expr.flags.
6774b5255acSdanielk1977 */
6782308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
67974893a4cSdrh   if( pParse->nErr ) return;
6804b5255acSdanielk1977   exprSetHeight(p);
6817d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
6824b5255acSdanielk1977 }
6834b5255acSdanielk1977 
6844b5255acSdanielk1977 /*
6854b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
6864b5255acSdanielk1977 ** by the select statement passed as an argument.
6874b5255acSdanielk1977 */
6884b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
6894b5255acSdanielk1977   int nHeight = 0;
6904b5255acSdanielk1977   heightOfSelect(p, &nHeight);
6914b5255acSdanielk1977   return nHeight;
6924b5255acSdanielk1977 }
6932308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
6942308ed38Sdrh /*
6952308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
6962308ed38Sdrh ** Expr.flags.
6972308ed38Sdrh */
6982308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
6992308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7002308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7012308ed38Sdrh   }
7022308ed38Sdrh }
7034b5255acSdanielk1977 #define exprSetHeight(y)
7044b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7054b5255acSdanielk1977 
706be5c89acSdrh /*
707b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
708b7916a78Sdrh **
709a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
710b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
711b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
712a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
713b7916a78Sdrh **
714b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
715e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
716b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
717b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
718b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
71933e619fcSdrh **
72033e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
72133e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
72233e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
72333e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
72433e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
725a76b5dfcSdrh */
726b7916a78Sdrh Expr *sqlite3ExprAlloc(
727cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
72817435752Sdrh   int op,                 /* Expression opcode */
729b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
730b7916a78Sdrh   int dequote             /* True to dequote */
73117435752Sdrh ){
732a76b5dfcSdrh   Expr *pNew;
73333e619fcSdrh   int nExtra = 0;
734cf697396Sshane   int iValue = 0;
735b7916a78Sdrh 
736575fad65Sdrh   assert( db!=0 );
737b7916a78Sdrh   if( pToken ){
73833e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
73933e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
740b7916a78Sdrh       nExtra = pToken->n+1;
741d50ffc41Sdrh       assert( iValue>=0 );
74233e619fcSdrh     }
743a76b5dfcSdrh   }
744575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
745b7916a78Sdrh   if( pNew ){
746ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7471bd10f8aSdrh     pNew->op = (u8)op;
748a58fdfb1Sdanielk1977     pNew->iAgg = -1;
749a76b5dfcSdrh     if( pToken ){
75033e619fcSdrh       if( nExtra==0 ){
75133e619fcSdrh         pNew->flags |= EP_IntValue;
75233e619fcSdrh         pNew->u.iValue = iValue;
75333e619fcSdrh       }else{
75433e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
755b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
756b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
75733e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
758244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
759244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
76033e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
761a34001c9Sdrh         }
762a34001c9Sdrh       }
76333e619fcSdrh     }
764b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
765b7916a78Sdrh     pNew->nHeight = 1;
766b7916a78Sdrh #endif
767a34001c9Sdrh   }
768a76b5dfcSdrh   return pNew;
769a76b5dfcSdrh }
770a76b5dfcSdrh 
771a76b5dfcSdrh /*
772b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
773b7916a78Sdrh ** already been dequoted.
774b7916a78Sdrh */
775b7916a78Sdrh Expr *sqlite3Expr(
776b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
777b7916a78Sdrh   int op,                 /* Expression opcode */
778b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
779b7916a78Sdrh ){
780b7916a78Sdrh   Token x;
781b7916a78Sdrh   x.z = zToken;
782b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
783b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
784b7916a78Sdrh }
785b7916a78Sdrh 
786b7916a78Sdrh /*
787b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
788b7916a78Sdrh **
789b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
790b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
791b7916a78Sdrh */
792b7916a78Sdrh void sqlite3ExprAttachSubtrees(
793b7916a78Sdrh   sqlite3 *db,
794b7916a78Sdrh   Expr *pRoot,
795b7916a78Sdrh   Expr *pLeft,
796b7916a78Sdrh   Expr *pRight
797b7916a78Sdrh ){
798b7916a78Sdrh   if( pRoot==0 ){
799b7916a78Sdrh     assert( db->mallocFailed );
800b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
801b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
802b7916a78Sdrh   }else{
803b7916a78Sdrh     if( pRight ){
804b7916a78Sdrh       pRoot->pRight = pRight;
805885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
806b7916a78Sdrh     }
807b7916a78Sdrh     if( pLeft ){
808b7916a78Sdrh       pRoot->pLeft = pLeft;
809885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
810b7916a78Sdrh     }
811b7916a78Sdrh     exprSetHeight(pRoot);
812b7916a78Sdrh   }
813b7916a78Sdrh }
814b7916a78Sdrh 
815b7916a78Sdrh /*
81660ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
817b7916a78Sdrh **
818bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
819bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
820bf664469Sdrh ** free the subtrees and return NULL.
821206f3d96Sdrh */
82217435752Sdrh Expr *sqlite3PExpr(
82317435752Sdrh   Parse *pParse,          /* Parsing context */
82417435752Sdrh   int op,                 /* Expression opcode */
82517435752Sdrh   Expr *pLeft,            /* Left operand */
826abfd35eaSdrh   Expr *pRight            /* Right operand */
82717435752Sdrh ){
8285fb52caaSdrh   Expr *p;
8291167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8305fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8315fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8325fb52caaSdrh   }else{
833abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
834abfd35eaSdrh     if( p ){
835abfd35eaSdrh       memset(p, 0, sizeof(Expr));
836abfd35eaSdrh       p->op = op & TKFLG_MASK;
837abfd35eaSdrh       p->iAgg = -1;
838abfd35eaSdrh     }
839b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8405fb52caaSdrh   }
8412b359bdbSdan   if( p ) {
8422b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8432b359bdbSdan   }
8444e0cff60Sdrh   return p;
8454e0cff60Sdrh }
8464e0cff60Sdrh 
8474e0cff60Sdrh /*
84808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
84908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
85008de4f79Sdrh */
85108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
85208de4f79Sdrh   if( pExpr ){
85308de4f79Sdrh     pExpr->x.pSelect = pSelect;
85408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
85508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
85608de4f79Sdrh   }else{
85708de4f79Sdrh     assert( pParse->db->mallocFailed );
85808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
85908de4f79Sdrh   }
86008de4f79Sdrh }
86108de4f79Sdrh 
86208de4f79Sdrh 
86308de4f79Sdrh /*
864991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
865991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
866991a1985Sdrh ** expression at compile-time return 0.
867991a1985Sdrh **
868991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
869991a1985Sdrh ** the expression really is always false or false (a false negative).
870991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
871991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8725fb52caaSdrh **
8735fb52caaSdrh ** Note that if the expression is part of conditional for a
8745fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8755fb52caaSdrh ** is it true or false, so always return 0.
8765fb52caaSdrh */
877991a1985Sdrh static int exprAlwaysTrue(Expr *p){
878991a1985Sdrh   int v = 0;
879991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
880991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
881991a1985Sdrh   return v!=0;
882991a1985Sdrh }
8835fb52caaSdrh static int exprAlwaysFalse(Expr *p){
8845fb52caaSdrh   int v = 0;
8855fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
8865fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
8875fb52caaSdrh   return v==0;
8885fb52caaSdrh }
8895fb52caaSdrh 
8905fb52caaSdrh /*
89191bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
89291bb0eedSdrh ** NULL, then just return the other expression.
8935fb52caaSdrh **
8945fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8955fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8965fb52caaSdrh ** a value of false.
89791bb0eedSdrh */
8981e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
89991bb0eedSdrh   if( pLeft==0 ){
90091bb0eedSdrh     return pRight;
90191bb0eedSdrh   }else if( pRight==0 ){
90291bb0eedSdrh     return pLeft;
9035fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9045fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9055fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9065fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
90791bb0eedSdrh   }else{
908b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
909b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
910b7916a78Sdrh     return pNew;
911a76b5dfcSdrh   }
912a76b5dfcSdrh }
913a76b5dfcSdrh 
914a76b5dfcSdrh /*
915a76b5dfcSdrh ** Construct a new expression node for a function with multiple
916a76b5dfcSdrh ** arguments.
917a76b5dfcSdrh */
91817435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
919a76b5dfcSdrh   Expr *pNew;
920633e6d57Sdrh   sqlite3 *db = pParse->db;
9214b202ae2Sdanielk1977   assert( pToken );
922b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
923a76b5dfcSdrh   if( pNew==0 ){
924d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
925a76b5dfcSdrh     return 0;
926a76b5dfcSdrh   }
9276ab3a2ecSdanielk1977   pNew->x.pList = pList;
9286ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9292308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
930a76b5dfcSdrh   return pNew;
931a76b5dfcSdrh }
932a76b5dfcSdrh 
933a76b5dfcSdrh /*
934fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
935fa6bc000Sdrh ** in the original SQL statement.
936fa6bc000Sdrh **
937fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
938fa6bc000Sdrh ** variable number.
939fa6bc000Sdrh **
940fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9419bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
942fa6bc000Sdrh ** the SQL statement comes from an external source.
943fa6bc000Sdrh **
94451f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
945fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
94660ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
947fa6bc000Sdrh ** assigned.
948fa6bc000Sdrh */
949de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
95017435752Sdrh   sqlite3 *db = pParse->db;
951b7916a78Sdrh   const char *z;
952f326d66dSdrh   ynVar x;
95317435752Sdrh 
954fa6bc000Sdrh   if( pExpr==0 ) return;
955c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
95633e619fcSdrh   z = pExpr->u.zToken;
957b7916a78Sdrh   assert( z!=0 );
958b7916a78Sdrh   assert( z[0]!=0 );
959de25a88cSdrh   assert( n==sqlite3Strlen30(z) );
960b7916a78Sdrh   if( z[1]==0 ){
961fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
962b7916a78Sdrh     assert( z[0]=='?' );
963f326d66dSdrh     x = (ynVar)(++pParse->nVar);
964124c0b49Sdrh   }else{
965f326d66dSdrh     int doAdd = 0;
966124c0b49Sdrh     if( z[0]=='?' ){
967fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
968fa6bc000Sdrh       ** use it as the variable number */
969c8d735aeSdan       i64 i;
97018814dfbSdrh       int bOk;
97118814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
97218814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
97318814dfbSdrh         bOk = 1;
97418814dfbSdrh       }else{
97518814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
97618814dfbSdrh       }
977c5499befSdrh       testcase( i==0 );
978c5499befSdrh       testcase( i==1 );
979c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
980c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
981c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
982fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
983bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
984c9b39288Sdrh         return;
985fa6bc000Sdrh       }
9868e74e7baSdrh       x = (ynVar)i;
987f326d66dSdrh       if( x>pParse->nVar ){
988f326d66dSdrh         pParse->nVar = (int)x;
989f326d66dSdrh         doAdd = 1;
990f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
991f326d66dSdrh         doAdd = 1;
992fa6bc000Sdrh       }
993fa6bc000Sdrh     }else{
99451f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
995fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
996fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
997fa6bc000Sdrh       */
9989bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
9999bf755ccSdrh       if( x==0 ){
10009bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1001f326d66dSdrh         doAdd = 1;
1002f326d66dSdrh       }
1003f326d66dSdrh     }
1004f326d66dSdrh     if( doAdd ){
10059bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1006fa6bc000Sdrh     }
1007fa6bc000Sdrh   }
1008c9b39288Sdrh   pExpr->iColumn = x;
1009f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1010832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1011832b2664Sdanielk1977   }
1012fa6bc000Sdrh }
1013fa6bc000Sdrh 
1014fa6bc000Sdrh /*
1015f6963f99Sdan ** Recursively delete an expression tree.
1016a2e00042Sdrh */
10174f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10184f0010b1Sdrh   assert( p!=0 );
1019d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1020d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1021209bc522Sdrh #ifdef SQLITE_DEBUG
1022209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1023209bc522Sdrh     assert( p->pLeft==0 );
1024209bc522Sdrh     assert( p->pRight==0 );
1025209bc522Sdrh     assert( p->x.pSelect==0 );
1026209bc522Sdrh   }
1027209bc522Sdrh #endif
1028209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1029c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1030c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10314910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1032633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
10336ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
10346ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10356ab3a2ecSdanielk1977     }else{
10366ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10376ab3a2ecSdanielk1977     }
10386ab3a2ecSdanielk1977   }
1039209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
104033e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1041dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1042a2e00042Sdrh   }
104333e619fcSdrh }
10444f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10454f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10464f0010b1Sdrh }
1047a2e00042Sdrh 
1048d2687b77Sdrh /*
10496ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10506ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10516ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10526ab3a2ecSdanielk1977 */
10536ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10546ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10556ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10566ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10576ab3a2ecSdanielk1977 }
10586ab3a2ecSdanielk1977 
10596ab3a2ecSdanielk1977 /*
106033e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
106133e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
106233e619fcSdrh ** how much of the tree is measured.
106333e619fcSdrh **
106433e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
106533e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
106633e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
106733e619fcSdrh **
106833e619fcSdrh ***************************************************************************
106933e619fcSdrh **
107033e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
107133e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
107233e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
107333e619fcSdrh ** The return values is always one of:
107433e619fcSdrh **
107533e619fcSdrh **      EXPR_FULLSIZE
107633e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
107733e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
107833e619fcSdrh **
107933e619fcSdrh ** The size of the structure can be found by masking the return value
108033e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
108133e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
108233e619fcSdrh **
108333e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
108433e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
108533e619fcSdrh ** During expression analysis, extra information is computed and moved into
108633e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
108733e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
108860ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
108933e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
109033e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
109133e619fcSdrh ** to enforce this constraint.
10926ab3a2ecSdanielk1977 */
10936ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
10946ab3a2ecSdanielk1977   int nSize;
109533e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1096aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1097aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
109847073f62Sdrh   if( 0==flags || p->op==TK_SELECT_COLUMN ){
10996ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11006ab3a2ecSdanielk1977   }else{
1101c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
110233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1103c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1104ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1105aecd8021Sdrh     if( p->pLeft || p->x.pList ){
110633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
110733e619fcSdrh     }else{
1108aecd8021Sdrh       assert( p->pRight==0 );
110933e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
111033e619fcSdrh     }
11116ab3a2ecSdanielk1977   }
11126ab3a2ecSdanielk1977   return nSize;
11136ab3a2ecSdanielk1977 }
11146ab3a2ecSdanielk1977 
11156ab3a2ecSdanielk1977 /*
111633e619fcSdrh ** This function returns the space in bytes required to store the copy
111733e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
111833e619fcSdrh ** string is defined.)
11196ab3a2ecSdanielk1977 */
11206ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
112133e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
112233e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
112333e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11246ab3a2ecSdanielk1977   }
1125bc73971dSdanielk1977   return ROUND8(nByte);
11266ab3a2ecSdanielk1977 }
11276ab3a2ecSdanielk1977 
11286ab3a2ecSdanielk1977 /*
11296ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11306ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11316ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11326ab3a2ecSdanielk1977 **
11336ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
113433e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11356ab3a2ecSdanielk1977 **
11366ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11376ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11386ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11396ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11406ab3a2ecSdanielk1977 */
11416ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11426ab3a2ecSdanielk1977   int nByte = 0;
11436ab3a2ecSdanielk1977   if( p ){
11446ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11456ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1146b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11476ab3a2ecSdanielk1977     }
11486ab3a2ecSdanielk1977   }
11496ab3a2ecSdanielk1977   return nByte;
11506ab3a2ecSdanielk1977 }
11516ab3a2ecSdanielk1977 
11526ab3a2ecSdanielk1977 /*
11536ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11546ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
115533e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11566ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
115760ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11586ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11596ab3a2ecSdanielk1977 */
11603c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11613c19469cSdrh   Expr *pNew;           /* Value to return */
11623c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11633c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11646ab3a2ecSdanielk1977 
11653c19469cSdrh   assert( db!=0 );
11663c19469cSdrh   assert( p );
11673c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11683c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11696ab3a2ecSdanielk1977 
11706ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11716ab3a2ecSdanielk1977   if( pzBuffer ){
11726ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
117333e619fcSdrh     staticFlag = EP_Static;
11746ab3a2ecSdanielk1977   }else{
11753c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
11763c19469cSdrh     staticFlag = 0;
11776ab3a2ecSdanielk1977   }
11786ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
11796ab3a2ecSdanielk1977 
11806ab3a2ecSdanielk1977   if( pNew ){
11816ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
11826ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
11836ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
118433e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
11856ab3a2ecSdanielk1977     */
11863c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
118733e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
118833e619fcSdrh     int nToken;
118933e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
119033e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
119133e619fcSdrh     }else{
119233e619fcSdrh       nToken = 0;
119333e619fcSdrh     }
11943c19469cSdrh     if( dupFlags ){
11956ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11966ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11976ab3a2ecSdanielk1977     }else{
11983e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11996ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
120072ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12016ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12026ab3a2ecSdanielk1977       }
120372ea29d7Sdrh     }
12046ab3a2ecSdanielk1977 
120533e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1206c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
120733e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
120833e619fcSdrh     pNew->flags |= staticFlag;
12096ab3a2ecSdanielk1977 
121033e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12116ab3a2ecSdanielk1977     if( nToken ){
121233e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
121333e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12146ab3a2ecSdanielk1977     }
12156ab3a2ecSdanielk1977 
1216209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12176ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12186ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12193c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12206ab3a2ecSdanielk1977       }else{
12213c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12226ab3a2ecSdanielk1977       }
12236ab3a2ecSdanielk1977     }
12246ab3a2ecSdanielk1977 
12256ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1226c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12273c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1228209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12293c19469cSdrh         pNew->pLeft = p->pLeft ?
12303c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12313c19469cSdrh         pNew->pRight = p->pRight ?
12323c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12336ab3a2ecSdanielk1977       }
12346ab3a2ecSdanielk1977       if( pzBuffer ){
12356ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12366ab3a2ecSdanielk1977       }
1237b7916a78Sdrh     }else{
1238209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12399854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12409854260bSdrh           pNew->pLeft = p->pLeft;
124147073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
124247073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12439854260bSdrh         }else{
12446ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12459854260bSdrh         }
12466ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12476ab3a2ecSdanielk1977       }
12486ab3a2ecSdanielk1977     }
12496ab3a2ecSdanielk1977   }
12506ab3a2ecSdanielk1977   return pNew;
12516ab3a2ecSdanielk1977 }
12526ab3a2ecSdanielk1977 
12536ab3a2ecSdanielk1977 /*
1254bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1255bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1256bfe31e7fSdan ** and the db->mallocFailed flag set.
1257bfe31e7fSdan */
1258eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1259bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12604e9119d9Sdan   With *pRet = 0;
12614e9119d9Sdan   if( p ){
12624e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12634e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12644e9119d9Sdan     if( pRet ){
12654e9119d9Sdan       int i;
12664e9119d9Sdan       pRet->nCte = p->nCte;
12674e9119d9Sdan       for(i=0; i<p->nCte; i++){
12684e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
12694e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
12704e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
12714e9119d9Sdan       }
12724e9119d9Sdan     }
12734e9119d9Sdan   }
12744e9119d9Sdan   return pRet;
12754e9119d9Sdan }
1276eede6a53Sdan #else
1277eede6a53Sdan # define withDup(x,y) 0
1278eede6a53Sdan #endif
12794e9119d9Sdan 
1280a76b5dfcSdrh /*
1281ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1282ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1283ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1284ff78bd2fSdrh ** without effecting the originals.
1285ff78bd2fSdrh **
12864adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
12874adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1288ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1289ff78bd2fSdrh **
1290ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
12916ab3a2ecSdanielk1977 **
1292b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
12936ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
12946ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
12956ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1296ff78bd2fSdrh */
12976ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
129872ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
12993c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1300ff78bd2fSdrh }
13016ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1302ff78bd2fSdrh   ExprList *pNew;
1303145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1304ff78bd2fSdrh   int i;
1305b163748eSdrh   Expr *pPriorSelectCol = 0;
1306575fad65Sdrh   assert( db!=0 );
1307ff78bd2fSdrh   if( p==0 ) return 0;
130843606175Sdrh   pNew = sqlite3DbMallocRawNN(db,
130943606175Sdrh              sizeof(*pNew)+sizeof(pNew->a[0])*(p->nExpr-1) );
1310ff78bd2fSdrh   if( pNew==0 ) return 0;
131143606175Sdrh   pNew->nAlloc = pNew->nExpr = p->nExpr;
131243606175Sdrh   pItem = pNew->a;
1313145716b3Sdrh   pOldItem = p->a;
1314145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13156ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
131647073f62Sdrh     Expr *pNewExpr;
1317b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
131847073f62Sdrh     if( pOldExpr
131947073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
132047073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
132147073f62Sdrh     ){
132247073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
132347073f62Sdrh       if( pNewExpr->iColumn==0 ){
132447073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1325b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1326b163748eSdrh       }else{
1327b163748eSdrh         assert( i>0 );
1328b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1329b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1330b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1331b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
133247073f62Sdrh       }
133347073f62Sdrh     }
133417435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1335b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1336145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13373e7bc9caSdrh     pItem->done = 0;
13382c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1339c2acc4e4Sdrh     pItem->u = pOldItem->u;
1340ff78bd2fSdrh   }
1341ff78bd2fSdrh   return pNew;
1342ff78bd2fSdrh }
134393758c8dSdanielk1977 
134493758c8dSdanielk1977 /*
134593758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
134693758c8dSdanielk1977 ** the build, then none of the following routines, except for
134793758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
134893758c8dSdanielk1977 ** called with a NULL argument.
134993758c8dSdanielk1977 */
13506a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13516a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13526ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1353ad3cab52Sdrh   SrcList *pNew;
1354ad3cab52Sdrh   int i;
1355113088ecSdrh   int nByte;
1356575fad65Sdrh   assert( db!=0 );
1357ad3cab52Sdrh   if( p==0 ) return 0;
1358113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1359575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1360ad3cab52Sdrh   if( pNew==0 ) return 0;
13614305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1362ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13634efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13644efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1365ed8a3bb1Sdrh     Table *pTab;
136641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
136717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
136817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
136917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13708a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13714efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13725b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
13735b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
13748a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
13758a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
13768a48b9c0Sdrh     }
13778a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
13788a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
13798a48b9c0Sdrh       pNewItem->u1.pFuncArg =
13808a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
13818a48b9c0Sdrh     }
1382ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1383ed8a3bb1Sdrh     if( pTab ){
138479df7782Sdrh       pTab->nTabRef++;
1385a1cb183dSdanielk1977     }
13866ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
13876ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
138817435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
13896c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1390ad3cab52Sdrh   }
1391ad3cab52Sdrh   return pNew;
1392ad3cab52Sdrh }
139317435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1394ff78bd2fSdrh   IdList *pNew;
1395ff78bd2fSdrh   int i;
1396575fad65Sdrh   assert( db!=0 );
1397ff78bd2fSdrh   if( p==0 ) return 0;
1398575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1399ff78bd2fSdrh   if( pNew==0 ) return 0;
14006c535158Sdrh   pNew->nId = p->nId;
1401575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1402d5d56523Sdanielk1977   if( pNew->a==0 ){
1403dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1404d5d56523Sdanielk1977     return 0;
1405d5d56523Sdanielk1977   }
14066c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14076c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14086c535158Sdrh   ** on the duplicate created by this function. */
1409ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14104efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14114efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
141217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14134efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1414ff78bd2fSdrh   }
1415ff78bd2fSdrh   return pNew;
1416ff78bd2fSdrh }
1417a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1418a7466205Sdan   Select *pRet = 0;
1419a7466205Sdan   Select *pNext = 0;
1420a7466205Sdan   Select **pp = &pRet;
1421a7466205Sdan   Select *p;
1422a7466205Sdan 
1423575fad65Sdrh   assert( db!=0 );
1424a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1425a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1426a7466205Sdan     if( pNew==0 ) break;
1427b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14286ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14296ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14306ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14316ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14326ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1433ff78bd2fSdrh     pNew->op = p->op;
1434a7466205Sdan     pNew->pNext = pNext;
1435a7466205Sdan     pNew->pPrior = 0;
14366ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
14376ab3a2ecSdanielk1977     pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
143892b01d53Sdrh     pNew->iLimit = 0;
143992b01d53Sdrh     pNew->iOffset = 0;
14407d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1441b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1442b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1443ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14444e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
1445eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1446a7466205Sdan     *pp = pNew;
1447a7466205Sdan     pp = &pNew->pPrior;
1448a7466205Sdan     pNext = pNew;
1449a7466205Sdan   }
1450a7466205Sdan 
1451a7466205Sdan   return pRet;
1452ff78bd2fSdrh }
145393758c8dSdanielk1977 #else
14546ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
145593758c8dSdanielk1977   assert( p==0 );
145693758c8dSdanielk1977   return 0;
145793758c8dSdanielk1977 }
145893758c8dSdanielk1977 #endif
1459ff78bd2fSdrh 
1460ff78bd2fSdrh 
1461ff78bd2fSdrh /*
1462a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1463a76b5dfcSdrh ** initially NULL, then create a new expression list.
1464b7916a78Sdrh **
1465b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1466b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1467b7916a78Sdrh ** that the new entry was successfully appended.
1468a76b5dfcSdrh */
146917435752Sdrh ExprList *sqlite3ExprListAppend(
147017435752Sdrh   Parse *pParse,          /* Parsing context */
147117435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1472b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
147317435752Sdrh ){
147443606175Sdrh   struct ExprList_item *pItem;
147517435752Sdrh   sqlite3 *db = pParse->db;
1476575fad65Sdrh   assert( db!=0 );
1477a76b5dfcSdrh   if( pList==0 ){
1478575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1479a76b5dfcSdrh     if( pList==0 ){
1480d5d56523Sdanielk1977       goto no_mem;
1481a76b5dfcSdrh     }
1482c263f7c4Sdrh     pList->nExpr = 0;
148343606175Sdrh     pList->nAlloc = 1;
148443606175Sdrh   }else if( pList->nExpr==pList->nAlloc ){
148543606175Sdrh     ExprList *pNew;
148643606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
148743606175Sdrh              sizeof(*pList)+(2*pList->nAlloc - 1)*sizeof(pList->a[0]));
148843606175Sdrh     if( pNew==0 ){
1489d5d56523Sdanielk1977       goto no_mem;
1490a76b5dfcSdrh     }
149143606175Sdrh     pList = pNew;
149243606175Sdrh     pList->nAlloc *= 2;
1493a76b5dfcSdrh   }
149443606175Sdrh   pItem = &pList->a[pList->nExpr++];
14954efc4754Sdrh   memset(pItem, 0, sizeof(*pItem));
1496e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1497a76b5dfcSdrh   return pList;
1498d5d56523Sdanielk1977 
1499d5d56523Sdanielk1977 no_mem:
1500d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1501633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1502633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1503d5d56523Sdanielk1977   return 0;
1504a76b5dfcSdrh }
1505a76b5dfcSdrh 
1506a76b5dfcSdrh /*
15078762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15088762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1509a1251bc4Sdrh **
1510a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1511a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1512a1251bc4Sdrh **
1513a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1514b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1515a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1516a1251bc4Sdrh */
1517a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1518a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1519a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1520a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1521a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1522a1251bc4Sdrh ){
1523a1251bc4Sdrh   sqlite3 *db = pParse->db;
1524a1251bc4Sdrh   int n;
1525a1251bc4Sdrh   int i;
152666860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1527321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1528321e828dSdrh   ** exit prior to this routine being invoked */
1529321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1530a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1531966e2911Sdrh 
1532966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1533966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1534966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1535966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1536966e2911Sdrh   */
1537966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1538a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1539a1251bc4Sdrh                     pColumns->nId, n);
1540a1251bc4Sdrh     goto vector_append_error;
1541a1251bc4Sdrh   }
1542966e2911Sdrh 
1543966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1544a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1545a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1546a1251bc4Sdrh     if( pList ){
154766860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1548a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1549a1251bc4Sdrh       pColumns->a[i].zName = 0;
1550a1251bc4Sdrh     }
1551a1251bc4Sdrh   }
1552966e2911Sdrh 
1553f4dd26c5Sdrh   if( pExpr->op==TK_SELECT && pList ){
1554966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1555f4dd26c5Sdrh     assert( pFirst!=0 );
1556966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1557966e2911Sdrh 
1558966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1559966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1560966e2911Sdrh     pFirst->pRight = pExpr;
1561a1251bc4Sdrh     pExpr = 0;
1562966e2911Sdrh 
1563966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1564966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1565966e2911Sdrh     pFirst->iTable = pColumns->nId;
1566a1251bc4Sdrh   }
1567a1251bc4Sdrh 
1568a1251bc4Sdrh vector_append_error:
1569a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1570a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1571a1251bc4Sdrh   return pList;
1572a1251bc4Sdrh }
1573a1251bc4Sdrh 
1574a1251bc4Sdrh /*
1575bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1576bc622bc0Sdrh */
1577bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1578bc622bc0Sdrh   if( p==0 ) return;
1579bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1580bc622bc0Sdrh   assert( p->nExpr>0 );
1581bc622bc0Sdrh   if( iSortOrder<0 ){
1582bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1583bc622bc0Sdrh     return;
1584bc622bc0Sdrh   }
1585bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1586bc622bc0Sdrh }
1587bc622bc0Sdrh 
1588bc622bc0Sdrh /*
1589b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1590b7916a78Sdrh ** on the expression list.
1591b7916a78Sdrh **
1592b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1593b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1594b7916a78Sdrh ** is set.
1595b7916a78Sdrh */
1596b7916a78Sdrh void sqlite3ExprListSetName(
1597b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1598b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1599b7916a78Sdrh   Token *pName,           /* Name to be added */
1600b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1601b7916a78Sdrh ){
1602b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1603b7916a78Sdrh   if( pList ){
1604b7916a78Sdrh     struct ExprList_item *pItem;
1605b7916a78Sdrh     assert( pList->nExpr>0 );
1606b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1607b7916a78Sdrh     assert( pItem->zName==0 );
1608b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1609244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1610b7916a78Sdrh   }
1611b7916a78Sdrh }
1612b7916a78Sdrh 
1613b7916a78Sdrh /*
1614b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1615b7916a78Sdrh ** on the expression list.
1616b7916a78Sdrh **
1617b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1618b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1619b7916a78Sdrh ** is set.
1620b7916a78Sdrh */
1621b7916a78Sdrh void sqlite3ExprListSetSpan(
1622b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1623b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1624b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1625b7916a78Sdrh ){
1626b7916a78Sdrh   sqlite3 *db = pParse->db;
1627b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1628b7916a78Sdrh   if( pList ){
1629b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1630b7916a78Sdrh     assert( pList->nExpr>0 );
1631b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1632b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1633b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1634cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1635b7916a78Sdrh   }
1636b7916a78Sdrh }
1637b7916a78Sdrh 
1638b7916a78Sdrh /*
16397a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16407a15a4beSdanielk1977 ** leave an error message in pParse.
16417a15a4beSdanielk1977 */
16427a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16437a15a4beSdanielk1977   Parse *pParse,
16447a15a4beSdanielk1977   ExprList *pEList,
16457a15a4beSdanielk1977   const char *zObject
16467a15a4beSdanielk1977 ){
1647b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1648c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1649c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1650b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16517a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16527a15a4beSdanielk1977   }
16537a15a4beSdanielk1977 }
16547a15a4beSdanielk1977 
16557a15a4beSdanielk1977 /*
1656a76b5dfcSdrh ** Delete an entire expression list.
1657a76b5dfcSdrh */
1658affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1659ac48b751Sdrh   int i = pList->nExpr;
1660ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1661ac48b751Sdrh   assert( pList->nExpr>0 );
1662ac48b751Sdrh   do{
1663633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1664633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1665b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1666ac48b751Sdrh     pItem++;
1667ac48b751Sdrh   }while( --i>0 );
1668dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1669a76b5dfcSdrh }
1670affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1671affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1672affa855cSdrh }
1673a76b5dfcSdrh 
1674a76b5dfcSdrh /*
16752308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
16762308ed38Sdrh ** ExprList.
1677885a5b03Sdrh */
16782308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1679885a5b03Sdrh   int i;
16802308ed38Sdrh   u32 m = 0;
16812308ed38Sdrh   if( pList ){
1682885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1683d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1684de845c2fSdrh        assert( pExpr!=0 );
1685de845c2fSdrh        m |= pExpr->flags;
1686885a5b03Sdrh     }
16872308ed38Sdrh   }
16882308ed38Sdrh   return m;
1689885a5b03Sdrh }
1690885a5b03Sdrh 
1691885a5b03Sdrh /*
1692059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1693059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1694059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1695059b2d50Sdrh ** for.
169673b211abSdrh **
16977d10d5a6Sdrh ** These callback routines are used to implement the following:
1698626a879aSdrh **
1699059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1700059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1701fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1702059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
170387abf5c0Sdrh **
1704059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1705059b2d50Sdrh ** is found to not be a constant.
170687abf5c0Sdrh **
1707feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1708059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1709059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1710feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1711feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1712feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1713feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1714feada2dfSdrh ** malformed schema error.
1715626a879aSdrh */
17167d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1717626a879aSdrh 
1718059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1719059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
17200a168377Sdrh   ** from being considered constant. */
1721059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1722059b2d50Sdrh     pWalker->eCode = 0;
17237d10d5a6Sdrh     return WRC_Abort;
17240a168377Sdrh   }
17250a168377Sdrh 
1726626a879aSdrh   switch( pExpr->op ){
1727eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1728059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1729059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1730eb55bd2fSdrh     case TK_FUNCTION:
173163f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1732b1fba286Sdrh         return WRC_Continue;
1733059b2d50Sdrh       }else{
1734059b2d50Sdrh         pWalker->eCode = 0;
1735059b2d50Sdrh         return WRC_Abort;
1736b1fba286Sdrh       }
1737626a879aSdrh     case TK_ID:
1738626a879aSdrh     case TK_COLUMN:
1739626a879aSdrh     case TK_AGG_FUNCTION:
174013449892Sdrh     case TK_AGG_COLUMN:
1741c5499befSdrh       testcase( pExpr->op==TK_ID );
1742c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1743c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1744c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1745059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1746059b2d50Sdrh         return WRC_Continue;
1747059b2d50Sdrh       }else{
1748059b2d50Sdrh         pWalker->eCode = 0;
17497d10d5a6Sdrh         return WRC_Abort;
1750059b2d50Sdrh       }
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;
1777aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1778059b2d50Sdrh   w.eCode = initFlag;
17797d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
17807d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1781059b2d50Sdrh   w.u.iCur = iCur;
17827d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1783059b2d50Sdrh   return w.eCode;
17847d10d5a6Sdrh }
1785626a879aSdrh 
1786626a879aSdrh /*
1787059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1788eb55bd2fSdrh ** and 0 if it involves variables or function calls.
17892398937bSdrh **
17902398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
17912398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
17922398937bSdrh ** a constant.
1793fef5208cSdrh */
17944adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1795059b2d50Sdrh   return exprIsConst(p, 1, 0);
1796fef5208cSdrh }
1797fef5208cSdrh 
1798fef5208cSdrh /*
1799059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
18000a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
18010a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
18020a168377Sdrh ** an ON or USING clause.
18030a168377Sdrh */
18040a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1805059b2d50Sdrh   return exprIsConst(p, 2, 0);
18060a168377Sdrh }
18070a168377Sdrh 
18080a168377Sdrh /*
1809fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1810059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1811059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1812059b2d50Sdrh ** table other than iCur.
1813059b2d50Sdrh */
1814059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1815059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1816059b2d50Sdrh }
1817059b2d50Sdrh 
1818059b2d50Sdrh /*
1819059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1820eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1821eb55bd2fSdrh ** are any variables.
1822eb55bd2fSdrh **
1823eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1824eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1825eb55bd2fSdrh ** a constant.
1826eb55bd2fSdrh */
1827feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1828feada2dfSdrh   assert( isInit==0 || isInit==1 );
1829059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1830eb55bd2fSdrh }
1831eb55bd2fSdrh 
18325b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
18335b88bc4bSdrh /*
18345b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
18355b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
18365b88bc4bSdrh */
18375b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
18385b88bc4bSdrh   Walker w;
18395b88bc4bSdrh   memset(&w, 0, sizeof(w));
1840bec2476aSdrh   w.eCode = 1;
18415b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
18425b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
18435b88bc4bSdrh   sqlite3WalkExpr(&w, p);
184407194bffSdrh   return w.eCode==0;
18455b88bc4bSdrh }
18465b88bc4bSdrh #endif
18475b88bc4bSdrh 
1848eb55bd2fSdrh /*
184973b211abSdrh ** If the expression p codes a constant integer that is small enough
1850202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1851202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1852202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1853e4de1febSdrh */
18544adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
185592b01d53Sdrh   int rc = 0;
1856ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
1857cd92e84dSdrh 
1858cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1859cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1860cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1861cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1862cd92e84dSdrh 
186392b01d53Sdrh   if( p->flags & EP_IntValue ){
186433e619fcSdrh     *pValue = p->u.iValue;
1865e4de1febSdrh     return 1;
1866e4de1febSdrh   }
186792b01d53Sdrh   switch( p->op ){
18684b59ab5eSdrh     case TK_UPLUS: {
186992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1870f6e369a1Sdrh       break;
18714b59ab5eSdrh     }
1872e4de1febSdrh     case TK_UMINUS: {
1873e4de1febSdrh       int v;
18744adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1875f6418891Smistachkin         assert( v!=(-2147483647-1) );
1876e4de1febSdrh         *pValue = -v;
187792b01d53Sdrh         rc = 1;
1878e4de1febSdrh       }
1879e4de1febSdrh       break;
1880e4de1febSdrh     }
1881e4de1febSdrh     default: break;
1882e4de1febSdrh   }
188392b01d53Sdrh   return rc;
1884e4de1febSdrh }
1885e4de1febSdrh 
1886e4de1febSdrh /*
1887039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1888039fc32eSdrh **
1889039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1890039fc32eSdrh ** to tell return TRUE.
1891039fc32eSdrh **
1892039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1893039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1894039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1895039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1896039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1897039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1898039fc32eSdrh ** TRUE.
1899039fc32eSdrh */
1900039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1901039fc32eSdrh   u8 op;
1902cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1903039fc32eSdrh   op = p->op;
1904039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1905039fc32eSdrh   switch( op ){
1906039fc32eSdrh     case TK_INTEGER:
1907039fc32eSdrh     case TK_STRING:
1908039fc32eSdrh     case TK_FLOAT:
1909039fc32eSdrh     case TK_BLOB:
1910039fc32eSdrh       return 0;
19117248a8b2Sdrh     case TK_COLUMN:
19127248a8b2Sdrh       assert( p->pTab!=0 );
191372673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
191472673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1915039fc32eSdrh     default:
1916039fc32eSdrh       return 1;
1917039fc32eSdrh   }
1918039fc32eSdrh }
1919039fc32eSdrh 
1920039fc32eSdrh /*
1921039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1922039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1923039fc32eSdrh ** argument.
1924039fc32eSdrh **
1925039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1926039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1927039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1928039fc32eSdrh ** answer.
1929039fc32eSdrh */
1930039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1931039fc32eSdrh   u8 op;
193205883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1933cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1934039fc32eSdrh   op = p->op;
1935039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1936039fc32eSdrh   switch( op ){
1937039fc32eSdrh     case TK_INTEGER: {
1938039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1939039fc32eSdrh     }
1940039fc32eSdrh     case TK_FLOAT: {
1941039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1942039fc32eSdrh     }
1943039fc32eSdrh     case TK_STRING: {
1944039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1945039fc32eSdrh     }
1946039fc32eSdrh     case TK_BLOB: {
1947039fc32eSdrh       return 1;
1948039fc32eSdrh     }
19492f2855b6Sdrh     case TK_COLUMN: {
195088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
195188376ca7Sdrh       return p->iColumn<0
19522f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
19532f2855b6Sdrh     }
1954039fc32eSdrh     default: {
1955039fc32eSdrh       return 0;
1956039fc32eSdrh     }
1957039fc32eSdrh   }
1958039fc32eSdrh }
1959039fc32eSdrh 
1960039fc32eSdrh /*
1961c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1962c4a3c779Sdrh */
19634adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
19644adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
19654adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
19664adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1967c4a3c779Sdrh   return 0;
1968c4a3c779Sdrh }
1969c4a3c779Sdrh 
19709a96b668Sdanielk1977 /*
197169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
197269c355bdSdrh ** that can be simplified to a direct table access, then return
197369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
197469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
197569c355bdSdrh ** table, then return NULL.
1976b287f4b6Sdrh */
1977b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
19787b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
197969c355bdSdrh   Select *p;
1980b287f4b6Sdrh   SrcList *pSrc;
1981b287f4b6Sdrh   ExprList *pEList;
1982b287f4b6Sdrh   Table *pTab;
1983cfbb5e82Sdan   int i;
198469c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
198569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
198669c355bdSdrh   p = pX->x.pSelect;
1987b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
19887d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1989b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1990b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
19917d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
19927d10d5a6Sdrh   }
1993b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1994b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1995b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1996b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1997b287f4b6Sdrh   pSrc = p->pSrc;
1998d1fa7bcaSdrh   assert( pSrc!=0 );
1999d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2000b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2001b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
200269c355bdSdrh   assert( pTab!=0 );
2003b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2004b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2005b287f4b6Sdrh   pEList = p->pEList;
2006ac6b47d1Sdrh   assert( pEList!=0 );
20077b35a77bSdan   /* All SELECT results must be columns. */
2008cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2009cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2010cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
201169c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2012cfbb5e82Sdan   }
201369c355bdSdrh   return p;
2014b287f4b6Sdrh }
2015b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2016b287f4b6Sdrh 
2017f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
20181d8cb21fSdan /*
20194c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
20204c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
20216be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
20226be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
20236be515ebSdrh */
20246be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2025728e0f91Sdrh   int addr1;
20266be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2027728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
20286be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
20296be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
20304c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2031728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
20326be515ebSdrh }
2033f9b2e05cSdan #endif
20346be515ebSdrh 
2035bb53ecb1Sdrh 
2036bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2037bb53ecb1Sdrh /*
2038bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2039bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2040bb53ecb1Sdrh */
2041bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2042bb53ecb1Sdrh   Expr *pLHS;
2043bb53ecb1Sdrh   int res;
2044bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2045bb53ecb1Sdrh   pLHS = pIn->pLeft;
2046bb53ecb1Sdrh   pIn->pLeft = 0;
2047bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2048bb53ecb1Sdrh   pIn->pLeft = pLHS;
2049bb53ecb1Sdrh   return res;
2050bb53ecb1Sdrh }
2051bb53ecb1Sdrh #endif
2052bb53ecb1Sdrh 
20536be515ebSdrh /*
20549a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2055d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2056d4305ca6Sdrh ** might be either a list of expressions or a subquery.
20579a96b668Sdanielk1977 **
2058d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2059d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2060d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2061d4305ca6Sdrh **
20623a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2063d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2064d4305ca6Sdrh **
2065b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
20669a96b668Sdanielk1977 **
20679a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
20681ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
20691ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
20709a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
20719a96b668Sdanielk1977 **                         populated epheremal table.
2072bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2073bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
20749a96b668Sdanielk1977 **
2075d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2076d4305ca6Sdrh ** subquery such as:
20779a96b668Sdanielk1977 **
2078553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
20799a96b668Sdanielk1977 **
2080d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2081d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
208260ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2083d4305ca6Sdrh ** existing table.
2084d4305ca6Sdrh **
20853a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
20863a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
20873a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
20883a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
20893a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
20903a85625dSdrh ** IN operator.
20913a85625dSdrh **
20923a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
20933a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2094553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2095553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2096553168c7Sdan ** a UNIQUE constraint or index.
20970cdc022eSdanielk1977 **
20983a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
20993a85625dSdrh ** for fast set membership tests) then an epheremal table must
2100553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2101553168c7Sdan ** index can be found with the specified <columns> as its left-most.
21020cdc022eSdanielk1977 **
2103bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2104bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2105bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2106bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2107bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2108bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2109bb53ecb1Sdrh **
2110b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
21113a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2112e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
21133a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
21140cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2115e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2116e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
21170cdc022eSdanielk1977 **
2118e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
21196be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
21206be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
21216be515ebSdrh ** NULL values.
2122553168c7Sdan **
2123553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2124553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2125553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2126553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2127553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2128553168c7Sdan **
2129553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2130553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2131553168c7Sdan **
2132553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
21339a96b668Sdanielk1977 */
2134284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2135ba00e30aSdan int sqlite3FindInIndex(
21366fc8f364Sdrh   Parse *pParse,             /* Parsing context */
21376fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
21386fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
21396fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
21406fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2141ba00e30aSdan ){
2142b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2143b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2144b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
21453a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2146b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
21479a96b668Sdanielk1977 
21481450bc6eSdrh   assert( pX->op==TK_IN );
21493a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
21501450bc6eSdrh 
21517b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
21527b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2153870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
21547b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2155870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
21567b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
21577b35a77bSdan     int i;
21587b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
21597b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
21607b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
21617b35a77bSdan     }
21627b35a77bSdan     if( i==pEList->nExpr ){
21637b35a77bSdan       prRhsHasNull = 0;
21647b35a77bSdan     }
21657b35a77bSdan   }
21667b35a77bSdan 
2167b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2168b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
21697b35a77bSdan   ** ephemeral table.  */
21707b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2171e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2172b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2173ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2174cfbb5e82Sdan     ExprList *pEList = p->pEList;
2175cfbb5e82Sdan     int nExpr = pEList->nExpr;
2176e1fb65a0Sdanielk1977 
2177b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2178b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2179b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2180b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2181b07028f7Sdrh 
2182b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2183e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2184e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2185e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
21869a96b668Sdanielk1977 
2187a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2188cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
218962659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2190511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
21917d176105Sdrh       VdbeCoverage(v);
21929a96b668Sdanielk1977 
21939a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
21949a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
21959a96b668Sdanielk1977 
21969a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
21979a96b668Sdanielk1977     }else{
2198e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2199cfbb5e82Sdan       int affinity_ok = 1;
2200cfbb5e82Sdan       int i;
2201cfbb5e82Sdan 
2202cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
220362659b2aSdrh       ** comparison is the same as the affinity of each column in table
220462659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
220562659b2aSdrh       ** use any index of the RHS table.  */
2206cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2207fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2208cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
22090dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2210cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
221162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
221262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2213cfbb5e82Sdan         switch( cmpaff ){
2214cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2215cfbb5e82Sdan             break;
2216cfbb5e82Sdan           case SQLITE_AFF_TEXT:
221762659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
221862659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
221962659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
222062659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
222162659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2222cfbb5e82Sdan             break;
2223cfbb5e82Sdan           default:
2224cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2225cfbb5e82Sdan         }
2226cfbb5e82Sdan       }
2227e1fb65a0Sdanielk1977 
2228a84a283dSdrh       if( affinity_ok ){
2229a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2230a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2231a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2232a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
22336fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2234a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2235a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2236a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2237a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2238a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
22396fc8f364Sdrh           if( mustBeUnique ){
22406fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
22416fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
22426fc8f364Sdrh             ){
2243a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2244cfbb5e82Sdan             }
22456fc8f364Sdrh           }
2246cfbb5e82Sdan 
2247a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2248cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2249fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2250cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2251cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2252cfbb5e82Sdan             int j;
2253cfbb5e82Sdan 
22546fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2255cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2256cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2257cfbb5e82Sdan               assert( pIdx->azColl[j] );
2258106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2259106526e1Sdrh                 continue;
2260106526e1Sdrh               }
2261cfbb5e82Sdan               break;
2262cfbb5e82Sdan             }
2263cfbb5e82Sdan             if( j==nExpr ) break;
2264a84a283dSdrh             mCol = MASKBIT(j);
2265a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2266a84a283dSdrh             colUsed |= mCol;
2267ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2268cfbb5e82Sdan           }
2269cfbb5e82Sdan 
2270a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2271a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2272a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2273511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2274363fb95bSdrh #ifndef SQLITE_OMIT_EXPLAIN
2275363fb95bSdrh             sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2276363fb95bSdrh               sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2277363fb95bSdrh               P4_DYNAMIC);
2278363fb95bSdrh #endif
22792ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
22802ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2281207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
22821ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
22831ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
22849a96b668Sdanielk1977 
22857b35a77bSdan             if( prRhsHasNull ){
22863480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2287cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
22883480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2289cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
22903480bfdaSdan #endif
2291b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
22927b35a77bSdan               if( nExpr==1 ){
22936be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
22940cdc022eSdanielk1977               }
22957b35a77bSdan             }
2296552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
22979a96b668Sdanielk1977           }
2298a84a283dSdrh         } /* End loop over indexes */
2299a84a283dSdrh       } /* End if( affinity_ok ) */
2300a84a283dSdrh     } /* End if not an rowid index */
2301a84a283dSdrh   } /* End attempt to optimize using an index */
23029a96b668Sdanielk1977 
2303bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2304bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2305bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
230671c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
230760ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2308bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2309bb53ecb1Sdrh   */
2310bb53ecb1Sdrh   if( eType==0
2311bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2312bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2313bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2314bb53ecb1Sdrh   ){
2315bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2316bb53ecb1Sdrh   }
2317bb53ecb1Sdrh 
23189a96b668Sdanielk1977   if( eType==0 ){
23194387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2320b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2321b74b1017Sdrh     */
23228e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
23230cdc022eSdanielk1977     int rMayHaveNull = 0;
232441a05b7bSdanielk1977     eType = IN_INDEX_EPH;
23253a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
23264a5acf8eSdrh       pParse->nQueryLoop = 0;
2327c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
232841a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
23290cdc022eSdanielk1977       }
2330e21a6e1dSdrh     }else if( prRhsHasNull ){
2331e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2332cf4d38aaSdrh     }
233341a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2334cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
23359a96b668Sdanielk1977   }else{
23369a96b668Sdanielk1977     pX->iTable = iTab;
23379a96b668Sdanielk1977   }
2338ba00e30aSdan 
2339ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2340ba00e30aSdan     int i, n;
2341ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2342ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2343ba00e30aSdan   }
23449a96b668Sdanielk1977   return eType;
23459a96b668Sdanielk1977 }
2346284f4acaSdanielk1977 #endif
2347626a879aSdrh 
2348f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2349553168c7Sdan /*
2350553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2351553168c7Sdan ** function allocates and returns a nul-terminated string containing
2352553168c7Sdan ** the affinities to be used for each column of the comparison.
2353553168c7Sdan **
2354553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2355553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2356553168c7Sdan */
235771c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
235871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
235971c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2360553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
236171c57db0Sdan   char *zRet;
236271c57db0Sdan 
2363553168c7Sdan   assert( pExpr->op==TK_IN );
23645c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
236571c57db0Sdan   if( zRet ){
236671c57db0Sdan     int i;
236771c57db0Sdan     for(i=0; i<nVal; i++){
2368fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2369553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2370553168c7Sdan       if( pSelect ){
2371553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
237271c57db0Sdan       }else{
2373553168c7Sdan         zRet[i] = a;
237471c57db0Sdan       }
237571c57db0Sdan     }
237671c57db0Sdan     zRet[nVal] = '\0';
237771c57db0Sdan   }
237871c57db0Sdan   return zRet;
237971c57db0Sdan }
2380f9b2e05cSdan #endif
238171c57db0Sdan 
23828da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
23838da209b1Sdan /*
23848da209b1Sdan ** Load the Parse object passed as the first argument with an error
23858da209b1Sdan ** message of the form:
23868da209b1Sdan **
23878da209b1Sdan **   "sub-select returns N columns - expected M"
23888da209b1Sdan */
23898da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
23908da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
23918da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
23928da209b1Sdan }
23938da209b1Sdan #endif
23948da209b1Sdan 
2395626a879aSdrh /*
239644c5604cSdan ** Expression pExpr is a vector that has been used in a context where
239744c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
239844c5604cSdan ** loads the Parse object with a message of the form:
239944c5604cSdan **
240044c5604cSdan **   "sub-select returns N columns - expected 1"
240144c5604cSdan **
240244c5604cSdan ** Or, if it is a regular scalar vector:
240344c5604cSdan **
240444c5604cSdan **   "row value misused"
240544c5604cSdan */
240644c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
240744c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
240844c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
240944c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
241044c5604cSdan   }else
241144c5604cSdan #endif
241244c5604cSdan   {
241344c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
241444c5604cSdan   }
241544c5604cSdan }
241644c5604cSdan 
241744c5604cSdan /*
2418d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2419d4187c71Sdrh ** or IN operators.  Examples:
2420626a879aSdrh **
24219cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
24229cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
24239cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
24249cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2425fef5208cSdrh **
24269cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
24279cbe6352Sdrh ** operator or subquery.
242841a05b7bSdanielk1977 **
242941a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
243041a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
243141a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
243241a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
243341a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2434fd773cf9Sdrh **
2435fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2436fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
24373a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
24383a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
24393a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
24401450bc6eSdrh **
24411450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
244239a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
244339a11819Sdrh ** array of registers and the return value is the register of the left-most
244439a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2445cce7d176Sdrh */
244651522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
24471450bc6eSdrh int sqlite3CodeSubselect(
2448fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2449fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
24506be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2451fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
245241a05b7bSdanielk1977 ){
24536be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
24541450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2455b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
24561450bc6eSdrh   if( NEVER(v==0) ) return 0;
2457ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2458fc976065Sdanielk1977 
245939a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
246039a11819Sdrh   ** is encountered if any of the following is true:
246157dbd7b3Sdrh   **
246257dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
246357dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
246457dbd7b3Sdrh   **    *  We are inside a trigger
246557dbd7b3Sdrh   **
246657dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
246757dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2468b3bce662Sdanielk1977   */
2469c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2470511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2471b3bce662Sdanielk1977   }
2472b3bce662Sdanielk1977 
24734a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
24744a07e3dbSdan   if( pParse->explain==2 ){
247562aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
247662aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
247762aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
247862aaa6caSdrh         pParse->iNextSelectId
24794a07e3dbSdan     );
24804a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
24814a07e3dbSdan   }
24824a07e3dbSdan #endif
24834a07e3dbSdan 
2484cce7d176Sdrh   switch( pExpr->op ){
2485fef5208cSdrh     case TK_IN: {
2486b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2487d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2488323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
248971c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2490d3d39e93Sdrh 
249171c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2492553168c7Sdan       assert( !isRowid || nVal==1 );
2493e014a838Sdanielk1977 
2494e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
24958cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2496553168c7Sdan       ** filled with index keys representing the results from the
2497553168c7Sdan       ** SELECT or the <exprlist>.
2498fef5208cSdrh       **
2499e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2500e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2501e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2502e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2503e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2504e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2505e014a838Sdanielk1977       ** is used.
2506fef5208cSdrh       */
2507832508b7Sdrh       pExpr->iTable = pParse->nTab++;
250871c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
250971c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
251071c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2511e014a838Sdanielk1977 
25126ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2513e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2514e014a838Sdanielk1977         **
2515e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2516e014a838Sdanielk1977         ** table allocated and opened above.
2517e014a838Sdanielk1977         */
25184387006cSdrh         Select *pSelect = pExpr->x.pSelect;
251971c57db0Sdan         ExprList *pEList = pSelect->pEList;
25201013c932Sdrh 
252141a05b7bSdanielk1977         assert( !isRowid );
252264bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
252364bcb8cfSdrh         ** error will have been caught long before we reach this point. */
252464bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
252571c57db0Sdan           SelectDest dest;
252671c57db0Sdan           int i;
25271013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
252871c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
25294387006cSdrh           pSelect->iLimit = 0;
25304387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2531812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
25324387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
253371c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
25342ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
25351450bc6eSdrh             return 0;
253694ccde58Sdrh           }
253771c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2538812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
25393535ec3eSdrh           assert( pEList!=0 );
25403535ec3eSdrh           assert( pEList->nExpr>0 );
25412ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
254271c57db0Sdan           for(i=0; i<nVal; i++){
2543773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
254471c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
254571c57db0Sdan                 pParse, p, pEList->a[i].pExpr
254671c57db0Sdan             );
254771c57db0Sdan           }
254871c57db0Sdan         }
2549a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2550fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2551fef5208cSdrh         **
2552e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2553e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2554e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2555e014a838Sdanielk1977         ** a column, use numeric affinity.
2556fef5208cSdrh         */
255771c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2558e014a838Sdanielk1977         int i;
25596ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
256057dbd7b3Sdrh         struct ExprList_item *pItem;
2561ecc31805Sdrh         int r1, r2, r3;
256257dbd7b3Sdrh 
256371c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2564e014a838Sdanielk1977         if( !affinity ){
256505883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2566e014a838Sdanielk1977         }
2567323df790Sdrh         if( pKeyInfo ){
25682ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2569323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2570323df790Sdrh         }
2571e014a838Sdanielk1977 
2572e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
25732d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
25742d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
257537e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
257657dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
257757dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2578e05c929bSdrh           int iValToIns;
2579e014a838Sdanielk1977 
258057dbd7b3Sdrh           /* If the expression is not constant then we will need to
258157dbd7b3Sdrh           ** disable the test that was generated above that makes sure
258257dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
258357dbd7b3Sdrh           ** expression we need to rerun this code each time.
258457dbd7b3Sdrh           */
25856be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
25866be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
25876be515ebSdrh             jmpIfDynamic = -1;
25884794b980Sdrh           }
2589e014a838Sdanielk1977 
2590e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2591e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2592e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2593e05c929bSdrh           }else{
2594ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
259541a05b7bSdanielk1977             if( isRowid ){
2596e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2597e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2598688852abSdrh               VdbeCoverage(v);
259941a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
260041a05b7bSdanielk1977             }else{
2601ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
26023c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
26039b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2604fef5208cSdrh             }
260541a05b7bSdanielk1977           }
2606e05c929bSdrh         }
26072d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
26082d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2609fef5208cSdrh       }
2610323df790Sdrh       if( pKeyInfo ){
26112ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
261241a05b7bSdanielk1977       }
2613b3bce662Sdanielk1977       break;
2614fef5208cSdrh     }
2615fef5208cSdrh 
261651522cd3Sdrh     case TK_EXISTS:
2617fd773cf9Sdrh     case TK_SELECT:
2618fd773cf9Sdrh     default: {
261939a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
262039a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
262139a11819Sdrh       **
262239a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
262339a11819Sdrh       ** the first row into an array of registers and return the index of
262439a11819Sdrh       ** the first register.
262539a11819Sdrh       **
262639a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
262739a11819Sdrh       ** into a register and return that register number.
262839a11819Sdrh       **
262939a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
263039a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2631fef5208cSdrh       */
2632fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
263339a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
263471c57db0Sdan       int nReg;                             /* Registers to allocate */
26351398ad36Sdrh 
2636cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2637cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2638cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
26396ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
264071c57db0Sdan 
26416ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
264271c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
264371c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
264471c57db0Sdan       pParse->nMem += nReg;
264551522cd3Sdrh       if( pExpr->op==TK_SELECT ){
26466c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
264753932ce8Sdrh         dest.iSdst = dest.iSDParm;
264871c57db0Sdan         dest.nSdst = nReg;
264971c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2650d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
265151522cd3Sdrh       }else{
26526c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
26532b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2654d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
265551522cd3Sdrh       }
2656633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2657e1c03b62Sdrh       pSel->pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,
2658e1c03b62Sdrh                                   &sqlite3IntTokens[1], 0);
265948b5b041Sdrh       pSel->iLimit = 0;
2660772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
26617d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
26621450bc6eSdrh         return 0;
266394ccde58Sdrh       }
26642b596da8Sdrh       rReg = dest.iSDParm;
2665ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2666b3bce662Sdanielk1977       break;
266719a775c2Sdrh     }
2668cce7d176Sdrh   }
2669b3bce662Sdanielk1977 
26706be515ebSdrh   if( rHasNullFlag ){
26716be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2672b3bce662Sdanielk1977   }
26736be515ebSdrh 
26746be515ebSdrh   if( jmpIfDynamic>=0 ){
26756be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2676b3bce662Sdanielk1977   }
2677d2490904Sdrh   sqlite3ExprCachePop(pParse);
2678fc976065Sdanielk1977 
26791450bc6eSdrh   return rReg;
2680cce7d176Sdrh }
268151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2682cce7d176Sdrh 
2683e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2684e3365e6cSdrh /*
26857b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
26867b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
26877b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
26887b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
26897b35a77bSdan */
26907b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
26917b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
26927b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
26937b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
26947b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
26957b35a77bSdan       return 1;
26967b35a77bSdan     }
26977b35a77bSdan   }else if( nVector!=1 ){
269844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
26997b35a77bSdan     return 1;
27007b35a77bSdan   }
27017b35a77bSdan   return 0;
27027b35a77bSdan }
27037b35a77bSdan #endif
27047b35a77bSdan 
27057b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
27067b35a77bSdan /*
2707e3365e6cSdrh ** Generate code for an IN expression.
2708e3365e6cSdrh **
2709e3365e6cSdrh **      x IN (SELECT ...)
2710e3365e6cSdrh **      x IN (value, value, ...)
2711e3365e6cSdrh **
2712ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2713e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2714e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2715e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2716e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2717e347d3e8Sdrh **
2718e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2719e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2720e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2721e347d3e8Sdrh ** determined due to NULLs.
2722e3365e6cSdrh **
27236be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2724e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2725e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2726e3365e6cSdrh ** within the RHS then fall through.
2727ecb87ac8Sdrh **
2728ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2729ecb87ac8Sdrh ** SQLite source tree for additional information.
2730e3365e6cSdrh */
2731e3365e6cSdrh static void sqlite3ExprCodeIN(
2732e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2733e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2734e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2735e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2736e3365e6cSdrh ){
2737e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2738e3365e6cSdrh   int eType;            /* Type of the RHS */
2739e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2740e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2741e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2742ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2743ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2744ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
274512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2746e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2747ecb87ac8Sdrh   int i;                /* loop counter */
2748e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2749e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2750e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2751e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2752e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2753e3365e6cSdrh 
2754e347d3e8Sdrh   pLeft = pExpr->pLeft;
27557b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2756553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2757ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2758ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2759ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2760ba00e30aSdan   );
2761e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
27627b35a77bSdan 
2763ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2764ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2765ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2766ba00e30aSdan   ** the RHS has not yet been coded.  */
2767e3365e6cSdrh   v = pParse->pVdbe;
2768e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2769e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2770bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2771bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2772ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2773e3365e6cSdrh 
2774ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2775ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2776ba00e30aSdan   );
2777ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2778ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2779ecb87ac8Sdrh   ** nVector-1. */
2780ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2781ecb87ac8Sdrh     int j, cnt;
2782ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2783ecb87ac8Sdrh     assert( cnt==1 );
2784ecb87ac8Sdrh   }
2785ecb87ac8Sdrh #endif
2786e3365e6cSdrh 
2787ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2788ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2789ba00e30aSdan   ** at r1.
2790e347d3e8Sdrh   **
2791e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2792e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2793e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2794e347d3e8Sdrh   ** the field order that matches the RHS index.
2795e3365e6cSdrh   */
2796e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2797e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2798e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2799ecb87ac8Sdrh   if( i==nVector ){
2800e347d3e8Sdrh     /* LHS fields are not reordered */
2801e347d3e8Sdrh     rLhs = rLhsOrig;
2802ecb87ac8Sdrh   }else{
2803ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2804e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2805ba00e30aSdan     for(i=0; i<nVector; i++){
2806e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2807ba00e30aSdan     }
2808ecb87ac8Sdrh   }
2809e3365e6cSdrh 
2810bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2811bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2812bb53ecb1Sdrh   ** sequence of comparisons.
2813e347d3e8Sdrh   **
2814e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2815bb53ecb1Sdrh   */
2816bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2817bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2818bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2819bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2820bb53ecb1Sdrh     int r2, regToFree;
2821bb53ecb1Sdrh     int regCkNull = 0;
2822bb53ecb1Sdrh     int ii;
2823bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2824bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2825bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2826e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2827bb53ecb1Sdrh     }
2828bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2829bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2830a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2831bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2832bb53ecb1Sdrh       }
2833bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2834e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
28354336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
28364336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
28374336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2838ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2839bb53ecb1Sdrh       }else{
2840bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2841e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2842bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2843ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2844bb53ecb1Sdrh       }
2845bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2846bb53ecb1Sdrh     }
2847bb53ecb1Sdrh     if( regCkNull ){
2848bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2849076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2850bb53ecb1Sdrh     }
2851bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2852bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2853e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2854e347d3e8Sdrh   }
2855bb53ecb1Sdrh 
2856e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
2857e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
2858e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
2859e347d3e8Sdrh   */
2860094430ebSdrh   if( destIfNull==destIfFalse ){
2861e347d3e8Sdrh     destStep2 = destIfFalse;
2862e347d3e8Sdrh   }else{
2863e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
2864e347d3e8Sdrh   }
2865d49fd4e8Sdan   for(i=0; i<nVector; i++){
2866fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2867d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
2868e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
2869471b4b92Sdrh       VdbeCoverage(v);
2870d49fd4e8Sdan     }
2871d49fd4e8Sdan   }
2872e3365e6cSdrh 
2873e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
2874e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
2875e347d3e8Sdrh   ** true.
2876e347d3e8Sdrh   */
2877e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
2878e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
2879e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
2880e347d3e8Sdrh     ** into a single opcode. */
2881e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
2882688852abSdrh     VdbeCoverage(v);
2883e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
28847b35a77bSdan   }else{
2885e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
2886e347d3e8Sdrh     if( destIfFalse==destIfNull ){
2887e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
2888e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
2889e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
2890e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
2891e347d3e8Sdrh     }
2892e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
2893e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
2894e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
2895e347d3e8Sdrh   }
2896ba00e30aSdan 
2897e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
2898e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
2899e347d3e8Sdrh   */
2900e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
2901e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
2902471b4b92Sdrh     VdbeCoverage(v);
2903e347d3e8Sdrh   }
29047b35a77bSdan 
2905e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
2906e347d3e8Sdrh   ** FALSE, then just return false.
2907e347d3e8Sdrh   */
2908e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
2909e347d3e8Sdrh 
2910e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
2911e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
2912e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
2913e347d3e8Sdrh   **
2914e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
2915e347d3e8Sdrh   ** of the RHS.
2916e347d3e8Sdrh   */
2917e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
2918e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2919471b4b92Sdrh   VdbeCoverage(v);
2920e347d3e8Sdrh   if( nVector>1 ){
2921e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
2922e347d3e8Sdrh   }else{
2923e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
2924e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
2925e347d3e8Sdrh     destNotNull = destIfFalse;
2926e347d3e8Sdrh   }
2927ba00e30aSdan   for(i=0; i<nVector; i++){
2928ba00e30aSdan     Expr *p;
2929ba00e30aSdan     CollSeq *pColl;
2930e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
2931fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
2932ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
2933e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
2934e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
293518016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
2936471b4b92Sdrh     VdbeCoverage(v);
2937e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
29387b35a77bSdan   }
29397b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2940e347d3e8Sdrh   if( nVector>1 ){
2941e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
2942e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
294318016ad2Sdrh     VdbeCoverage(v);
2944e347d3e8Sdrh 
2945e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
2946e347d3e8Sdrh     ** be false. */
294718016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
29487b35a77bSdan   }
29497b35a77bSdan 
2950e347d3e8Sdrh   /* Jumps here in order to return true. */
2951e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
2952e3365e6cSdrh 
2953e347d3e8Sdrh sqlite3ExprCodeIN_finished:
2954e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
2955d2490904Sdrh   sqlite3ExprCachePop(pParse);
2956ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
2957e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
2958ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
2959553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
2960e3365e6cSdrh }
2961e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2962e3365e6cSdrh 
296313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2964598f1340Sdrh /*
2965598f1340Sdrh ** Generate an instruction that will put the floating point
29669cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
29670cf19ed8Sdrh **
29680cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
29690cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
29700cf19ed8Sdrh ** like the continuation of the number.
2971598f1340Sdrh */
2972b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2973fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2974598f1340Sdrh     double value;
29759339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2976d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2977598f1340Sdrh     if( negateFlag ) value = -value;
297897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2979598f1340Sdrh   }
2980598f1340Sdrh }
298113573c71Sdrh #endif
2982598f1340Sdrh 
2983598f1340Sdrh 
2984598f1340Sdrh /*
2985fec19aadSdrh ** Generate an instruction that will put the integer describe by
29869cbf3425Sdrh ** text z[0..n-1] into register iMem.
29870cf19ed8Sdrh **
29885f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2989fec19aadSdrh */
299013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
299113573c71Sdrh   Vdbe *v = pParse->pVdbe;
299292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
299333e619fcSdrh     int i = pExpr->u.iValue;
2994d50ffc41Sdrh     assert( i>=0 );
299592b01d53Sdrh     if( negFlag ) i = -i;
299692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2997fd773cf9Sdrh   }else{
29985f1d6b61Sshaneh     int c;
29995f1d6b61Sshaneh     i64 value;
3000fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3001fd773cf9Sdrh     assert( z!=0 );
30029296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
300377320ea4Sdrh     if( c==1 || (c==2 && !negFlag) || (negFlag && value==SMALLEST_INT64)){
300413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
300513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
300613573c71Sdrh #else
30071b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
30089296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
300977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
30101b7ddc59Sdrh       }else
30111b7ddc59Sdrh #endif
30121b7ddc59Sdrh       {
3013b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
30149296c18aSdrh       }
301513573c71Sdrh #endif
301677320ea4Sdrh     }else{
301777320ea4Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
301877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3019fec19aadSdrh     }
3020fec19aadSdrh   }
3021c9cf901dSdanielk1977 }
3022fec19aadSdrh 
3023bea119cdSdrh /*
30249b40d13fSdrh ** Erase column-cache entry number i
3025bea119cdSdrh */
30269b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
30279b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3028ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
30299b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3030ceea3321Sdrh     }
3031ceea3321Sdrh   }
3032bea119cdSdrh   pParse->nColCache--;
30339b40d13fSdrh   if( i<pParse->nColCache ){
30349b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
30359b40d13fSdrh   }
3036ceea3321Sdrh }
3037ceea3321Sdrh 
3038ceea3321Sdrh 
3039ceea3321Sdrh /*
3040ceea3321Sdrh ** Record in the column cache that a particular column from a
3041ceea3321Sdrh ** particular table is stored in a particular register.
3042ceea3321Sdrh */
3043ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3044ceea3321Sdrh   int i;
3045ceea3321Sdrh   int minLru;
3046ceea3321Sdrh   int idxLru;
3047ceea3321Sdrh   struct yColCache *p;
3048ceea3321Sdrh 
3049ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3050ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
305120411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
305220411ea7Sdrh 
3053b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3054b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3055b6da74ebSdrh   ** with and without the column cache.
3056b6da74ebSdrh   */
30577e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3058b6da74ebSdrh 
305927ee406eSdrh   /* First replace any existing entry.
306027ee406eSdrh   **
306127ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
306227ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
306327ee406eSdrh   */
306427ee406eSdrh #ifndef NDEBUG
30659b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
30669b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3067ceea3321Sdrh   }
306827ee406eSdrh #endif
3069ceea3321Sdrh 
30709b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
30719b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3072ceea3321Sdrh     minLru = 0x7fffffff;
3073ceea3321Sdrh     idxLru = -1;
3074ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3075ceea3321Sdrh       if( p->lru<minLru ){
3076ceea3321Sdrh         idxLru = i;
3077ceea3321Sdrh         minLru = p->lru;
3078ceea3321Sdrh       }
3079ceea3321Sdrh     }
3080ceea3321Sdrh     p = &pParse->aColCache[idxLru];
30819b40d13fSdrh   }else{
30829b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
30839b40d13fSdrh   }
30849b40d13fSdrh 
30859b40d13fSdrh   /* Add the new entry to the end of the cache */
3086ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3087ceea3321Sdrh   p->iTable = iTab;
3088ceea3321Sdrh   p->iColumn = iCol;
3089ceea3321Sdrh   p->iReg = iReg;
3090ceea3321Sdrh   p->tempReg = 0;
3091ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3092ceea3321Sdrh }
3093ceea3321Sdrh 
3094ceea3321Sdrh /*
3095f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3096f49f3523Sdrh ** Purge the range of registers from the column cache.
3097ceea3321Sdrh */
3098f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
30999b40d13fSdrh   int i = 0;
31009b40d13fSdrh   while( i<pParse->nColCache ){
31019b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
31029b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
31039b40d13fSdrh       cacheEntryClear(pParse, i);
31049b40d13fSdrh     }else{
31059b40d13fSdrh       i++;
31069b40d13fSdrh     }
3107ceea3321Sdrh   }
3108ceea3321Sdrh }
3109ceea3321Sdrh 
3110ceea3321Sdrh /*
3111ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3112ceea3321Sdrh ** added to the column cache after this call are removed when the
3113ceea3321Sdrh ** corresponding pop occurs.
3114ceea3321Sdrh */
3115ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3116ceea3321Sdrh   pParse->iCacheLevel++;
31179ac7962aSdrh #ifdef SQLITE_DEBUG
31189ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31199ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
31209ac7962aSdrh   }
31219ac7962aSdrh #endif
3122ceea3321Sdrh }
3123ceea3321Sdrh 
3124ceea3321Sdrh /*
3125ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3126d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3127d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3128ceea3321Sdrh */
3129d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
31309b40d13fSdrh   int i = 0;
3131d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3132d2490904Sdrh   pParse->iCacheLevel--;
31339ac7962aSdrh #ifdef SQLITE_DEBUG
31349ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
31359ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
31369ac7962aSdrh   }
31379ac7962aSdrh #endif
31389b40d13fSdrh   while( i<pParse->nColCache ){
31399b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
31409b40d13fSdrh       cacheEntryClear(pParse, i);
31419b40d13fSdrh     }else{
31429b40d13fSdrh       i++;
3143ceea3321Sdrh     }
3144ceea3321Sdrh   }
3145ceea3321Sdrh }
3146945498f3Sdrh 
3147945498f3Sdrh /*
31485cd79239Sdrh ** When a cached column is reused, make sure that its register is
31495cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
31505cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
31515cd79239Sdrh ** get them all.
31525cd79239Sdrh */
31535cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
31545cd79239Sdrh   int i;
31555cd79239Sdrh   struct yColCache *p;
31569b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
31575cd79239Sdrh     if( p->iReg==iReg ){
31585cd79239Sdrh       p->tempReg = 0;
31595cd79239Sdrh     }
31605cd79239Sdrh   }
31615cd79239Sdrh }
31625cd79239Sdrh 
31631f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
31641f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
31651f9ca2c8Sdrh */
31661f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
31671f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
31681f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
31691f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
31701f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
31711f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
31721f9ca2c8Sdrh ){
31731f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
31744b92f98cSdrh   if( iTabCol==XN_EXPR ){
31751f9ca2c8Sdrh     assert( pIdx->aColExpr );
31761f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
31771f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
31781c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
31794b92f98cSdrh   }else{
31804b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
31814b92f98cSdrh                                     iTabCol, regOut);
31824b92f98cSdrh   }
31831f9ca2c8Sdrh }
31841f9ca2c8Sdrh 
31855cd79239Sdrh /*
31865c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
31875c092e8aSdrh */
31885c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
31895c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
31905c092e8aSdrh   Table *pTab,    /* The table containing the value */
3191313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
31925c092e8aSdrh   int iCol,       /* Index of the column to extract */
3193313619f5Sdrh   int regOut      /* Extract the value into this register */
31945c092e8aSdrh ){
3195aca19e19Sdrh   if( pTab==0 ){
3196aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3197aca19e19Sdrh     return;
3198aca19e19Sdrh   }
31995c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
32005c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
32015c092e8aSdrh   }else{
32025c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3203ee0ec8e1Sdrh     int x = iCol;
320435db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3205ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3206ee0ec8e1Sdrh     }
3207ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
32085c092e8aSdrh   }
32095c092e8aSdrh   if( iCol>=0 ){
32105c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
32115c092e8aSdrh   }
32125c092e8aSdrh }
32135c092e8aSdrh 
32145c092e8aSdrh /*
3215945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3216ce78bc6eSdrh ** table pTab and store the column value in a register.
3217ce78bc6eSdrh **
3218ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3219ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3220ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3221ce78bc6eSdrh ** for GetColumnToReg().
3222e55cbd72Sdrh **
3223e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3224e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3225945498f3Sdrh */
3226e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3227e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
32282133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
32292133d822Sdrh   int iColumn,     /* Index of the table column */
32302133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3231a748fdccSdrh   int iReg,        /* Store results here */
3232ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
32332133d822Sdrh ){
3234e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3235e55cbd72Sdrh   int i;
3236da250ea5Sdrh   struct yColCache *p;
3237e55cbd72Sdrh 
32389b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
323994881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3240ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
32415cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3242da250ea5Sdrh       return p->iReg;
3243e55cbd72Sdrh     }
3244e55cbd72Sdrh   }
3245e55cbd72Sdrh   assert( v!=0 );
32465c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3247a748fdccSdrh   if( p5 ){
3248a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3249a748fdccSdrh   }else{
3250ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3251a748fdccSdrh   }
3252e55cbd72Sdrh   return iReg;
3253e55cbd72Sdrh }
3254ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3255ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3256ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3257ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3258ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3259ce78bc6eSdrh   int iReg         /* Store results here */
3260ce78bc6eSdrh ){
3261ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3262ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3263ce78bc6eSdrh }
3264ce78bc6eSdrh 
3265e55cbd72Sdrh 
3266e55cbd72Sdrh /*
3267ceea3321Sdrh ** Clear all column cache entries.
3268e55cbd72Sdrh */
3269ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3270e55cbd72Sdrh   int i;
3271ceea3321Sdrh 
3272d879e3ebSdrh #ifdef SQLITE_DEBUG
32739ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32749ac7962aSdrh     printf("CLEAR\n");
32759ac7962aSdrh   }
32769ac7962aSdrh #endif
32779b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
32789b40d13fSdrh     if( pParse->aColCache[i].tempReg
32799b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
32809b40d13fSdrh     ){
32819b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3282e55cbd72Sdrh     }
3283da250ea5Sdrh   }
32849b40d13fSdrh   pParse->nColCache = 0;
3285da250ea5Sdrh }
3286e55cbd72Sdrh 
3287e55cbd72Sdrh /*
3288da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3289da250ea5Sdrh ** registers starting with iStart.
3290e55cbd72Sdrh */
3291da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3292f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3293e55cbd72Sdrh }
3294e55cbd72Sdrh 
3295e55cbd72Sdrh /*
3296b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3297b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3298e55cbd72Sdrh */
3299b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3300e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3301079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3302236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3303945498f3Sdrh }
3304945498f3Sdrh 
3305f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
330692b01d53Sdrh /*
3307652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3308652fbf55Sdrh ** is used as part of the column cache.
3309f49f3523Sdrh **
3310f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3311f49f3523Sdrh ** and does not appear in a normal build.
3312652fbf55Sdrh */
3313652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3314652fbf55Sdrh   int i;
3315ceea3321Sdrh   struct yColCache *p;
33169b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3317ceea3321Sdrh     int r = p->iReg;
3318f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3319652fbf55Sdrh   }
3320652fbf55Sdrh   return 0;
3321652fbf55Sdrh }
3322f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3323652fbf55Sdrh 
3324bea119cdSdrh 
3325652fbf55Sdrh /*
332612abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
332712abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
332812abf408Sdrh ** the correct value for the expression.
3329a4c3c87eSdrh */
3330a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3331a4c3c87eSdrh   p->op2 = p->op;
3332a4c3c87eSdrh   p->op = TK_REGISTER;
3333a4c3c87eSdrh   p->iTable = iReg;
3334a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3335a4c3c87eSdrh }
3336a4c3c87eSdrh 
333712abf408Sdrh /*
333812abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
333912abf408Sdrh ** the result in continguous temporary registers.  Return the index of
334012abf408Sdrh ** the first register used to store the result.
334112abf408Sdrh **
334212abf408Sdrh ** If the returned result register is a temporary scalar, then also write
334312abf408Sdrh ** that register number into *piFreeable.  If the returned result register
334412abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
334512abf408Sdrh ** to 0.
334612abf408Sdrh */
334712abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
334812abf408Sdrh   int iResult;
334912abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
335012abf408Sdrh   if( nResult==1 ){
335112abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
335212abf408Sdrh   }else{
335312abf408Sdrh     *piFreeable = 0;
335412abf408Sdrh     if( p->op==TK_SELECT ){
335512abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
335612abf408Sdrh     }else{
335712abf408Sdrh       int i;
335812abf408Sdrh       iResult = pParse->nMem+1;
335912abf408Sdrh       pParse->nMem += nResult;
336012abf408Sdrh       for(i=0; i<nResult; i++){
33614b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
336212abf408Sdrh       }
336312abf408Sdrh     }
336412abf408Sdrh   }
336512abf408Sdrh   return iResult;
336612abf408Sdrh }
336712abf408Sdrh 
336871c57db0Sdan 
3369a4c3c87eSdrh /*
3370cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
33712dcef11bSdrh ** expression.  Attempt to store the results in register "target".
33722dcef11bSdrh ** Return the register where results are stored.
3373389a1adbSdrh **
33748b213899Sdrh ** With this routine, there is no guarantee that results will
33752dcef11bSdrh ** be stored in target.  The result might be stored in some other
33762dcef11bSdrh ** register if it is convenient to do so.  The calling function
33772dcef11bSdrh ** must check the return code and move the results to the desired
33782dcef11bSdrh ** register.
3379cce7d176Sdrh */
3380678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
33812dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
33822dcef11bSdrh   int op;                   /* The opcode being coded */
33832dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
33842dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
33852dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
33867b35a77bSdan   int r1, r2;               /* Various register numbers */
338710d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
338871c57db0Sdan   int p5 = 0;
3389ffe07b2dSdrh 
33909cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
339120411ea7Sdrh   if( v==0 ){
339220411ea7Sdrh     assert( pParse->db->mallocFailed );
339320411ea7Sdrh     return 0;
339420411ea7Sdrh   }
3395389a1adbSdrh 
3396389a1adbSdrh   if( pExpr==0 ){
3397389a1adbSdrh     op = TK_NULL;
3398389a1adbSdrh   }else{
3399f2bc013cSdrh     op = pExpr->op;
3400389a1adbSdrh   }
3401f2bc013cSdrh   switch( op ){
340213449892Sdrh     case TK_AGG_COLUMN: {
340313449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
340413449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
340513449892Sdrh       if( !pAggInfo->directMode ){
34069de221dfSdrh         assert( pCol->iMem>0 );
3407c332cc30Sdrh         return pCol->iMem;
340813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34095134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3410389a1adbSdrh                               pCol->iSorterColumn, target);
3411c332cc30Sdrh         return target;
341213449892Sdrh       }
341313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
341413449892Sdrh     }
3415967e8b73Sdrh     case TK_COLUMN: {
3416b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3417b2b9d3d7Sdrh       if( iTab<0 ){
3418b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3419b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3420c332cc30Sdrh           return pExpr->iColumn + pParse->ckBase;
3421c4a3c779Sdrh         }else{
34221f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
34231f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
34241f9ca2c8Sdrh           iTab = pParse->iSelfTab;
34252282792aSdrh         }
3426b2b9d3d7Sdrh       }
3427c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3428b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3429b2b9d3d7Sdrh                                pExpr->op2);
3430cce7d176Sdrh     }
3431cce7d176Sdrh     case TK_INTEGER: {
343213573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3433c332cc30Sdrh       return target;
343451e9a445Sdrh     }
343513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3436598f1340Sdrh     case TK_FLOAT: {
343733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
343833e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3439c332cc30Sdrh       return target;
3440598f1340Sdrh     }
344113573c71Sdrh #endif
3442fec19aadSdrh     case TK_STRING: {
344333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3444076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3445c332cc30Sdrh       return target;
3446cce7d176Sdrh     }
3447f0863fe5Sdrh     case TK_NULL: {
34489de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3449c332cc30Sdrh       return target;
3450f0863fe5Sdrh     }
34515338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3452c572ef7fSdanielk1977     case TK_BLOB: {
34536c8c6cecSdrh       int n;
34546c8c6cecSdrh       const char *z;
3455ca48c90fSdrh       char *zBlob;
345633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
345733e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
345833e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
345933e619fcSdrh       z = &pExpr->u.zToken[2];
3460b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3461b7916a78Sdrh       assert( z[n]=='\'' );
3462ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3463ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3464c332cc30Sdrh       return target;
3465c572ef7fSdanielk1977     }
34665338a5f7Sdanielk1977 #endif
346750457896Sdrh     case TK_VARIABLE: {
346833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
346933e619fcSdrh       assert( pExpr->u.zToken!=0 );
347033e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3471eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
347233e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
34739bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
34749bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3475ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
34769bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
34779bf755ccSdrh       }
3478c332cc30Sdrh       return target;
347950457896Sdrh     }
34804e0cff60Sdrh     case TK_REGISTER: {
3481c332cc30Sdrh       return pExpr->iTable;
34824e0cff60Sdrh     }
3483487e262fSdrh #ifndef SQLITE_OMIT_CAST
3484487e262fSdrh     case TK_CAST: {
3485487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
34862dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
34871735fa88Sdrh       if( inReg!=target ){
34881735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
34891735fa88Sdrh         inReg = target;
34901735fa88Sdrh       }
34914169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
34924169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3493c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3494b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3495c332cc30Sdrh       return inReg;
3496487e262fSdrh     }
3497487e262fSdrh #endif /* SQLITE_OMIT_CAST */
349871c57db0Sdan     case TK_IS:
349971c57db0Sdan     case TK_ISNOT:
350071c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
350171c57db0Sdan       p5 = SQLITE_NULLEQ;
350271c57db0Sdan       /* fall-through */
3503c9b84a1fSdrh     case TK_LT:
3504c9b84a1fSdrh     case TK_LE:
3505c9b84a1fSdrh     case TK_GT:
3506c9b84a1fSdrh     case TK_GE:
3507c9b84a1fSdrh     case TK_NE:
3508c9b84a1fSdrh     case TK_EQ: {
350971c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3510625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
351179752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
351271c57db0Sdan       }else{
351371c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3514b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
351571c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
351671c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
35177d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
35187d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
35197d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
35207d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
35217d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
35227d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3523c5499befSdrh         testcase( regFree1==0 );
3524c5499befSdrh         testcase( regFree2==0 );
3525c9b84a1fSdrh       }
35266a2fe093Sdrh       break;
35276a2fe093Sdrh     }
3528cce7d176Sdrh     case TK_AND:
3529cce7d176Sdrh     case TK_OR:
3530cce7d176Sdrh     case TK_PLUS:
3531cce7d176Sdrh     case TK_STAR:
3532cce7d176Sdrh     case TK_MINUS:
3533bf4133cbSdrh     case TK_REM:
3534bf4133cbSdrh     case TK_BITAND:
3535bf4133cbSdrh     case TK_BITOR:
353617c40294Sdrh     case TK_SLASH:
3537bf4133cbSdrh     case TK_LSHIFT:
3538855eb1cfSdrh     case TK_RSHIFT:
35390040077dSdrh     case TK_CONCAT: {
35407d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
35417d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
35427d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
35437d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
35447d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
35457d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
35467d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
35477d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
35487d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
35497d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
35507d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
35512dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35522dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
35535b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3554c5499befSdrh       testcase( regFree1==0 );
3555c5499befSdrh       testcase( regFree2==0 );
35560040077dSdrh       break;
35570040077dSdrh     }
3558cce7d176Sdrh     case TK_UMINUS: {
3559fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3560fec19aadSdrh       assert( pLeft );
356113573c71Sdrh       if( pLeft->op==TK_INTEGER ){
356213573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3563c332cc30Sdrh         return target;
356413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
356513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
356633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
356733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3568c332cc30Sdrh         return target;
356913573c71Sdrh #endif
35703c84ddffSdrh       }else{
357110d1edf0Sdrh         tempX.op = TK_INTEGER;
357210d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
357310d1edf0Sdrh         tempX.u.iValue = 0;
357410d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3575e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
35762dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3577c5499befSdrh         testcase( regFree2==0 );
35783c84ddffSdrh       }
35796e142f54Sdrh       break;
35806e142f54Sdrh     }
3581bf4133cbSdrh     case TK_BITNOT:
35826e142f54Sdrh     case TK_NOT: {
35837d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
35847d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3585e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3586e99fa2afSdrh       testcase( regFree1==0 );
3587e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3588cce7d176Sdrh       break;
3589cce7d176Sdrh     }
3590cce7d176Sdrh     case TK_ISNULL:
3591cce7d176Sdrh     case TK_NOTNULL: {
35926a288a33Sdrh       int addr;
35937d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
35947d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
35959de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
35962dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3597c5499befSdrh       testcase( regFree1==0 );
35982dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
35997d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
36007d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3601a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
36026a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3603a37cdde0Sdanielk1977       break;
3604f2bc013cSdrh     }
36052282792aSdrh     case TK_AGG_FUNCTION: {
360613449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
36077e56e711Sdrh       if( pInfo==0 ){
360833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
360933e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
36107e56e711Sdrh       }else{
3611c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
36127e56e711Sdrh       }
36132282792aSdrh       break;
36142282792aSdrh     }
3615cce7d176Sdrh     case TK_FUNCTION: {
361612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
361712ffee8cSdrh       int nFarg;             /* Number of function arguments */
361812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
361912ffee8cSdrh       const char *zId;       /* The function name */
3620693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
362112ffee8cSdrh       int i;                 /* Loop counter */
3622c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
362312ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
362412ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
362517435752Sdrh 
36261e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
362749c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3628ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3629ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
36301e9b53f9Sdrh       }
36316ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3632c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
363312ffee8cSdrh         pFarg = 0;
363412ffee8cSdrh       }else{
363512ffee8cSdrh         pFarg = pExpr->x.pList;
363612ffee8cSdrh       }
363712ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
363833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
363933e619fcSdrh       zId = pExpr->u.zToken;
364080738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3641cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3642cc15313cSdrh       if( pDef==0 && pParse->explain ){
3643cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3644cc15313cSdrh       }
3645cc15313cSdrh #endif
36462d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
364780738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3648feb306f5Sdrh         break;
3649feb306f5Sdrh       }
3650ae6bb957Sdrh 
3651ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
365260ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3653ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3654ae6bb957Sdrh       */
3655d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3656ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3657ae6bb957Sdrh         assert( nFarg>=2 );
3658ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3659ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3660ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3661688852abSdrh           VdbeCoverage(v);
3662f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3663ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3664ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3665d2490904Sdrh           sqlite3ExprCachePop(pParse);
3666ae6bb957Sdrh         }
3667ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3668ae6bb957Sdrh         break;
3669ae6bb957Sdrh       }
3670ae6bb957Sdrh 
3671cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3672cca9f3d2Sdrh       ** of the first argument.
3673cca9f3d2Sdrh       */
3674cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3675cca9f3d2Sdrh         assert( nFarg>=1 );
3676c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3677cca9f3d2Sdrh       }
3678ae6bb957Sdrh 
367954240751Sdrh #ifdef SQLITE_DEBUG
3680a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3681a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3682a1a523a5Sdrh       ** the SQLite type logic.
3683a1a523a5Sdrh       */
3684a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3685a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3686a1a523a5Sdrh         char aff;
3687a1a523a5Sdrh         assert( nFarg==1 );
3688a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3689a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3690a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3691a1a523a5Sdrh         return target;
3692a1a523a5Sdrh       }
369354240751Sdrh #endif
3694a1a523a5Sdrh 
3695d1a01edaSdrh       for(i=0; i<nFarg; i++){
3696d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3697693e6719Sdrh           testcase( i==31 );
3698693e6719Sdrh           constMask |= MASKBIT32(i);
3699d1a01edaSdrh         }
3700d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3701d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3702d1a01edaSdrh         }
3703d1a01edaSdrh       }
370412ffee8cSdrh       if( pFarg ){
3705d1a01edaSdrh         if( constMask ){
3706d1a01edaSdrh           r1 = pParse->nMem+1;
3707d1a01edaSdrh           pParse->nMem += nFarg;
3708d1a01edaSdrh         }else{
370912ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3710d1a01edaSdrh         }
3711a748fdccSdrh 
3712a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3713a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3714a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3715a748fdccSdrh         ** loading.
3716a748fdccSdrh         */
3717d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
37184e245a4cSdrh           u8 exprOp;
3719a748fdccSdrh           assert( nFarg==1 );
3720a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
37214e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
37224e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3723a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3724a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3725b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3726b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3727b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3728a748fdccSdrh           }
3729a748fdccSdrh         }
3730a748fdccSdrh 
3731d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
37325579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3733d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3734d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3735892d3179Sdrh       }else{
373612ffee8cSdrh         r1 = 0;
3737892d3179Sdrh       }
3738b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3739a43fa227Sdrh       /* Possibly overload the function if the first argument is
3740a43fa227Sdrh       ** a virtual table column.
3741a43fa227Sdrh       **
3742a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3743a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3744a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3745a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3746a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3747a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3748a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3749a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3750a43fa227Sdrh       */
375112ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
375212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
375312ffee8cSdrh       }else if( nFarg>0 ){
375412ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3755b7f6f68fSdrh       }
3756b7f6f68fSdrh #endif
3757d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
37588b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
375966a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3760682f68b0Sdanielk1977       }
37619c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
376266a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
376312ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3764d1a01edaSdrh       if( nFarg && constMask==0 ){
376512ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
37662dcef11bSdrh       }
3767c332cc30Sdrh       return target;
37686ec2733bSdrh     }
3769fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3770fe2093d7Sdrh     case TK_EXISTS:
377119a775c2Sdrh     case TK_SELECT: {
37728da209b1Sdan       int nCol;
3773c5499befSdrh       testcase( op==TK_EXISTS );
3774c5499befSdrh       testcase( op==TK_SELECT );
37758da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
37768da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
37778da209b1Sdan       }else{
3778c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
37798da209b1Sdan       }
378019a775c2Sdrh       break;
378119a775c2Sdrh     }
3782fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3783966e2911Sdrh       int n;
3784fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3785fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3786fc7f27b9Sdrh       }
3787966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3788966e2911Sdrh       if( pExpr->iTable
3789966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3790966e2911Sdrh       ){
3791966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3792966e2911Sdrh                                 pExpr->iTable, n);
3793966e2911Sdrh       }
3794c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3795fc7f27b9Sdrh     }
3796fef5208cSdrh     case TK_IN: {
3797e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3798e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3799e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3800e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
380166ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3802e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3803e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3804e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3805c332cc30Sdrh       return target;
3806fef5208cSdrh     }
3807e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3808e3365e6cSdrh 
3809e3365e6cSdrh 
38102dcef11bSdrh     /*
38112dcef11bSdrh     **    x BETWEEN y AND z
38122dcef11bSdrh     **
38132dcef11bSdrh     ** This is equivalent to
38142dcef11bSdrh     **
38152dcef11bSdrh     **    x>=y AND x<=z
38162dcef11bSdrh     **
38172dcef11bSdrh     ** X is stored in pExpr->pLeft.
38182dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
38192dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
38202dcef11bSdrh     */
3821fef5208cSdrh     case TK_BETWEEN: {
382271c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3823c332cc30Sdrh       return target;
3824fef5208cSdrh     }
382594fa9c41Sdrh     case TK_SPAN:
3826ae80ddeaSdrh     case TK_COLLATE:
38274f07e5fbSdrh     case TK_UPLUS: {
3828c332cc30Sdrh       return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3829a2e00042Sdrh     }
38302dcef11bSdrh 
3831165921a7Sdan     case TK_TRIGGER: {
383265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
383365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
383465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
383565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
383665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
383765a7cd16Sdan       ** read the rowid field.
383865a7cd16Sdan       **
383965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
384065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
384165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
384265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
384365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
384465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
384565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
384665a7cd16Sdan       ** example, if the table on which triggers are being fired is
384765a7cd16Sdan       ** declared as:
384865a7cd16Sdan       **
384965a7cd16Sdan       **   CREATE TABLE t1(a, b);
385065a7cd16Sdan       **
385165a7cd16Sdan       ** Then p1 is interpreted as follows:
385265a7cd16Sdan       **
385365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
385465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
385565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
385665a7cd16Sdan       */
38572832ad42Sdan       Table *pTab = pExpr->pTab;
385865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
385965a7cd16Sdan 
386065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
386165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
386265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
386365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
386465a7cd16Sdan 
386565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
386676d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3867165921a7Sdan         (pExpr->iTable ? "new" : "old"),
386876d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
386976d462eeSdan         target
3870165921a7Sdan       ));
387165a7cd16Sdan 
387244dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
387365a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3874113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3875113762a2Sdrh       **
3876113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3877113762a2Sdrh       ** floating point when extracting it from the record.  */
38782832ad42Sdan       if( pExpr->iColumn>=0
38792832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
38802832ad42Sdan       ){
38812832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38822832ad42Sdan       }
388344dbca83Sdrh #endif
3884165921a7Sdan       break;
3885165921a7Sdan     }
3886165921a7Sdan 
388771c57db0Sdan     case TK_VECTOR: {
3888e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
388971c57db0Sdan       break;
389071c57db0Sdan     }
389171c57db0Sdan 
38922dcef11bSdrh     /*
38932dcef11bSdrh     ** Form A:
38942dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
38952dcef11bSdrh     **
38962dcef11bSdrh     ** Form B:
38972dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
38982dcef11bSdrh     **
38992dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
39002dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
39012dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
39022dcef11bSdrh     **
39032dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3904c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3905c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3906c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
39072dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
39082dcef11bSdrh     **
39092dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
39102dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
39112dcef11bSdrh     ** no ELSE term, NULL.
39122dcef11bSdrh     */
391333cd4909Sdrh     default: assert( op==TK_CASE ); {
39142dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
39152dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
39162dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
39172dcef11bSdrh       int i;                            /* Loop counter */
39182dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
39192dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
39202dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
39212dcef11bSdrh       Expr *pX;                         /* The X expression */
39221bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3923ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
392417a7f8ddSdrh 
39256ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
39266ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
39276ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3928be5c89acSdrh       aListelem = pEList->a;
3929be5c89acSdrh       nExpr = pEList->nExpr;
39302dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
39312dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
393210d1edf0Sdrh         tempX = *pX;
393333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
393412abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
3935c5499befSdrh         testcase( regFree1==0 );
3936abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
39372dcef11bSdrh         opCompare.op = TK_EQ;
393810d1edf0Sdrh         opCompare.pLeft = &tempX;
39392dcef11bSdrh         pTest = &opCompare;
39408b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
39418b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
39428b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
39438b1db07fSdrh         ** purposes and possibly overwritten.  */
39448b1db07fSdrh         regFree1 = 0;
3945cce7d176Sdrh       }
3946c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3947ceea3321Sdrh         sqlite3ExprCachePush(pParse);
39482dcef11bSdrh         if( pX ){
39491bd10f8aSdrh           assert( pTest!=0 );
39502dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3951f5905aa7Sdrh         }else{
39522dcef11bSdrh           pTest = aListelem[i].pExpr;
395317a7f8ddSdrh         }
39542dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
395533cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
39562dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3957c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
39589de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3959076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3960d2490904Sdrh         sqlite3ExprCachePop(pParse);
39612dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3962f570f011Sdrh       }
3963c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3964ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3965c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3966d2490904Sdrh         sqlite3ExprCachePop(pParse);
396717a7f8ddSdrh       }else{
39689de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
396917a7f8ddSdrh       }
3970c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
3971c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
39722dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
39736f34903eSdanielk1977       break;
39746f34903eSdanielk1977     }
39755338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
39766f34903eSdanielk1977     case TK_RAISE: {
3977165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3978165921a7Sdan            || pExpr->affinity==OE_Abort
3979165921a7Sdan            || pExpr->affinity==OE_Fail
3980165921a7Sdan            || pExpr->affinity==OE_Ignore
3981165921a7Sdan       );
3982e0af83acSdan       if( !pParse->pTriggerTab ){
3983e0af83acSdan         sqlite3ErrorMsg(pParse,
3984e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3985e0af83acSdan         return 0;
3986e0af83acSdan       }
3987e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3988e0af83acSdan         sqlite3MayAbort(pParse);
3989e0af83acSdan       }
399033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3991e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3992e0af83acSdan         sqlite3VdbeAddOp4(
3993e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3994688852abSdrh         VdbeCoverage(v);
3995e0af83acSdan       }else{
3996433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3997f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3998e0af83acSdan       }
3999e0af83acSdan 
4000ffe07b2dSdrh       break;
400117a7f8ddSdrh     }
40025338a5f7Sdanielk1977 #endif
4003ffe07b2dSdrh   }
40042dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
40052dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
40062dcef11bSdrh   return inReg;
40075b6afba9Sdrh }
40082dcef11bSdrh 
40092dcef11bSdrh /*
4010d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
40111e9b53f9Sdrh **
4012ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4013ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4014ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4015ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4016ad879ffdSdrh ** code to the same register.
4017d1a01edaSdrh */
40181e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4019d673cddaSdrh   Parse *pParse,    /* Parsing context */
4020d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4021ad879ffdSdrh   int regDest       /* Store the value in this register */
4022d673cddaSdrh ){
4023d1a01edaSdrh   ExprList *p;
4024d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4025d1a01edaSdrh   p = pParse->pConstExpr;
4026ad879ffdSdrh   if( regDest<0 && p ){
40271e9b53f9Sdrh     struct ExprList_item *pItem;
40281e9b53f9Sdrh     int i;
40291e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
40301e9b53f9Sdrh       if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
40311e9b53f9Sdrh         return pItem->u.iConstExprReg;
40321e9b53f9Sdrh       }
40331e9b53f9Sdrh     }
40341e9b53f9Sdrh   }
4035d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4036d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4037d673cddaSdrh   if( p ){
4038d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4039ad879ffdSdrh      pItem->reusable = regDest<0;
4040ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4041d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4042d673cddaSdrh   }
4043d1a01edaSdrh   pParse->pConstExpr = p;
40441e9b53f9Sdrh   return regDest;
4045d1a01edaSdrh }
4046d1a01edaSdrh 
4047d1a01edaSdrh /*
40482dcef11bSdrh ** Generate code to evaluate an expression and store the results
40492dcef11bSdrh ** into a register.  Return the register number where the results
40502dcef11bSdrh ** are stored.
40512dcef11bSdrh **
40522dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4053678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
40542dcef11bSdrh ** a temporary, then set *pReg to zero.
4055f30a969bSdrh **
4056f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4057f30a969bSdrh ** code to fill the register in the initialization section of the
4058f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
40592dcef11bSdrh */
40602dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4061f30a969bSdrh   int r2;
4062f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4063d9f158e7Sdrh   if( ConstFactorOk(pParse)
4064f30a969bSdrh    && pExpr->op!=TK_REGISTER
4065f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4066f30a969bSdrh   ){
4067f30a969bSdrh     *pReg  = 0;
4068ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4069f30a969bSdrh   }else{
40702dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4071f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
40722dcef11bSdrh     if( r2==r1 ){
40732dcef11bSdrh       *pReg = r1;
40742dcef11bSdrh     }else{
40752dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
40762dcef11bSdrh       *pReg = 0;
40772dcef11bSdrh     }
4078f30a969bSdrh   }
40792dcef11bSdrh   return r2;
40802dcef11bSdrh }
40812dcef11bSdrh 
40822dcef11bSdrh /*
40832dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
40842dcef11bSdrh ** results in register target.  The results are guaranteed to appear
40852dcef11bSdrh ** in register target.
40862dcef11bSdrh */
408705a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
40889cbf3425Sdrh   int inReg;
40899cbf3425Sdrh 
40909cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4091ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4092ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4093ebc16717Sdrh   }else{
40949cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
40951c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
40960e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
40979cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
409817a7f8ddSdrh     }
4099ebc16717Sdrh   }
4100cce7d176Sdrh }
4101cce7d176Sdrh 
4102cce7d176Sdrh /*
41031c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
41041c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
41051c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
41061c75c9d7Sdrh */
41071c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
41081c75c9d7Sdrh   sqlite3 *db = pParse->db;
41091c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
41101c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
41111c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
41121c75c9d7Sdrh }
41131c75c9d7Sdrh 
41141c75c9d7Sdrh /*
411505a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
411605a86c5cSdrh ** results in register target.  The results are guaranteed to appear
411705a86c5cSdrh ** in register target.  If the expression is constant, then this routine
411805a86c5cSdrh ** might choose to code the expression at initialization time.
411905a86c5cSdrh */
412005a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
412105a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4122ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
412305a86c5cSdrh   }else{
412405a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
412505a86c5cSdrh   }
4126cce7d176Sdrh }
4127cce7d176Sdrh 
4128cce7d176Sdrh /*
412960ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4130de4fcfddSdrh ** in register target.
413125303780Sdrh **
41322dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
41332dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
41342dcef11bSdrh ** the result is a copy of the cache register.
41352dcef11bSdrh **
41362dcef11bSdrh ** This routine is used for expressions that are used multiple
41372dcef11bSdrh ** times.  They are evaluated once and the results of the expression
41382dcef11bSdrh ** are reused.
413925303780Sdrh */
414005a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
414125303780Sdrh   Vdbe *v = pParse->pVdbe;
414225303780Sdrh   int iMem;
414305a86c5cSdrh 
414405a86c5cSdrh   assert( target>0 );
414505a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
414605a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
41472dcef11bSdrh   iMem = ++pParse->nMem;
414805a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4149a4c3c87eSdrh   exprToRegister(pExpr, iMem);
415025303780Sdrh }
41517e02e5e6Sdrh 
4152678ccce8Sdrh /*
4153268380caSdrh ** Generate code that pushes the value of every element of the given
41549cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4155268380caSdrh **
4156892d3179Sdrh ** Return the number of elements evaluated.
4157d1a01edaSdrh **
4158d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4159d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4160d1a01edaSdrh **
4161d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4162d1a01edaSdrh ** factored out into initialization code.
4163b0df9634Sdrh **
4164b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4165b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4166b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
4167268380caSdrh */
41684adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4169268380caSdrh   Parse *pParse,     /* Parsing context */
4170389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4171191b54cbSdrh   int target,        /* Where to write results */
41725579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4173d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4174268380caSdrh ){
4175268380caSdrh   struct ExprList_item *pItem;
41765579d59fSdrh   int i, j, n;
4177d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
41785579d59fSdrh   Vdbe *v = pParse->pVdbe;
41799d8b3072Sdrh   assert( pList!=0 );
41809cbf3425Sdrh   assert( target>0 );
4181d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4182268380caSdrh   n = pList->nExpr;
4183d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4184191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
41857445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
4186257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4187257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4188257c13faSdan         i--;
4189257c13faSdan         n--;
4190257c13faSdan       }else{
41915579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4192257c13faSdan       }
41935579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4194ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4195d1a01edaSdrh     }else{
41967445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4197746fd9ccSdrh       if( inReg!=target+i ){
41984eded604Sdrh         VdbeOp *pOp;
41994eded604Sdrh         if( copyOp==OP_Copy
42004eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
42014eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
42024eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
42034eded604Sdrh         ){
42044eded604Sdrh           pOp->p3++;
42054eded604Sdrh         }else{
42064eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
42074eded604Sdrh         }
4208d1a01edaSdrh       }
4209d176611bSdrh     }
4210268380caSdrh   }
4211f9b596ebSdrh   return n;
4212268380caSdrh }
4213268380caSdrh 
4214268380caSdrh /*
421536c563a2Sdrh ** Generate code for a BETWEEN operator.
421636c563a2Sdrh **
421736c563a2Sdrh **    x BETWEEN y AND z
421836c563a2Sdrh **
421936c563a2Sdrh ** The above is equivalent to
422036c563a2Sdrh **
422136c563a2Sdrh **    x>=y AND x<=z
422236c563a2Sdrh **
422336c563a2Sdrh ** Code it as such, taking care to do the common subexpression
422460ec914cSpeter.d.reid ** elimination of x.
422584b19a3dSdrh **
422684b19a3dSdrh ** The xJumpIf parameter determines details:
422784b19a3dSdrh **
422884b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
422984b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
423084b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
423184b19a3dSdrh **
423284b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
423336c563a2Sdrh */
423436c563a2Sdrh static void exprCodeBetween(
423536c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
423636c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
423784b19a3dSdrh   int dest,         /* Jump destination or storage location */
423884b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
423936c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
424036c563a2Sdrh ){
424136c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
424236c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
424336c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4244db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4245db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
424684b19a3dSdrh 
424736c563a2Sdrh 
424871c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
424971c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
425071c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4251db45bd5eSdrh 
4252db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4253db45bd5eSdrh   exprX = *pExpr->pLeft;
425436c563a2Sdrh   exprAnd.op = TK_AND;
425536c563a2Sdrh   exprAnd.pLeft = &compLeft;
425636c563a2Sdrh   exprAnd.pRight = &compRight;
425736c563a2Sdrh   compLeft.op = TK_GE;
4258db45bd5eSdrh   compLeft.pLeft = &exprX;
425936c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
426036c563a2Sdrh   compRight.op = TK_LE;
4261db45bd5eSdrh   compRight.pLeft = &exprX;
426236c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
426312abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
426484b19a3dSdrh   if( xJump ){
426584b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
426636c563a2Sdrh   }else{
426736fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
426836fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
426936fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
427036fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
427136fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4272db45bd5eSdrh     exprX.flags |= EP_FromJoin;
427371c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
427436c563a2Sdrh   }
4275db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
427636c563a2Sdrh 
427736c563a2Sdrh   /* Ensure adequate test coverage */
4278db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4279db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4280db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4281db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4282db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4283db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4284db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4285db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
428684b19a3dSdrh   testcase( xJump==0 );
428736c563a2Sdrh }
428836c563a2Sdrh 
428936c563a2Sdrh /*
4290cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4291cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4292cce7d176Sdrh ** continues straight thru if the expression is false.
4293f5905aa7Sdrh **
4294f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
429535573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4296f2bc013cSdrh **
4297f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4298f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4299f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4300f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4301f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4302cce7d176Sdrh */
43034adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4304cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4305cce7d176Sdrh   int op = 0;
43062dcef11bSdrh   int regFree1 = 0;
43072dcef11bSdrh   int regFree2 = 0;
43082dcef11bSdrh   int r1, r2;
43092dcef11bSdrh 
431035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
431148864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
431233cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4313f2bc013cSdrh   op = pExpr->op;
43147b35a77bSdan   switch( op ){
4315cce7d176Sdrh     case TK_AND: {
43164adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4317c5499befSdrh       testcase( jumpIfNull==0 );
431835573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
431954e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43204adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
43214adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4322d2490904Sdrh       sqlite3ExprCachePop(pParse);
4323cce7d176Sdrh       break;
4324cce7d176Sdrh     }
4325cce7d176Sdrh     case TK_OR: {
4326c5499befSdrh       testcase( jumpIfNull==0 );
43274adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
432854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
43294adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4330d2490904Sdrh       sqlite3ExprCachePop(pParse);
4331cce7d176Sdrh       break;
4332cce7d176Sdrh     }
4333cce7d176Sdrh     case TK_NOT: {
4334c5499befSdrh       testcase( jumpIfNull==0 );
43354adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4336cce7d176Sdrh       break;
4337cce7d176Sdrh     }
4338de845c2fSdrh     case TK_IS:
4339de845c2fSdrh     case TK_ISNOT:
4340de845c2fSdrh       testcase( op==TK_IS );
4341de845c2fSdrh       testcase( op==TK_ISNOT );
4342de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4343de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4344de845c2fSdrh       /* Fall thru */
4345cce7d176Sdrh     case TK_LT:
4346cce7d176Sdrh     case TK_LE:
4347cce7d176Sdrh     case TK_GT:
4348cce7d176Sdrh     case TK_GE:
4349cce7d176Sdrh     case TK_NE:
43500ac65892Sdrh     case TK_EQ: {
4351625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4352c5499befSdrh       testcase( jumpIfNull==0 );
4353b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4354b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
435535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
43562dcef11bSdrh                   r1, r2, dest, jumpIfNull);
43577d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
43587d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
43597d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
43607d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4361de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4362de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4363de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4364de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4365de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4366de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
43676a2fe093Sdrh       testcase( regFree1==0 );
43686a2fe093Sdrh       testcase( regFree2==0 );
43696a2fe093Sdrh       break;
43706a2fe093Sdrh     }
4371cce7d176Sdrh     case TK_ISNULL:
4372cce7d176Sdrh     case TK_NOTNULL: {
43737d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
43747d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
43752dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
43762dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
43777d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
43787d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4379c5499befSdrh       testcase( regFree1==0 );
4380cce7d176Sdrh       break;
4381cce7d176Sdrh     }
4382fef5208cSdrh     case TK_BETWEEN: {
43835c03f30aSdrh       testcase( jumpIfNull==0 );
438471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4385fef5208cSdrh       break;
4386fef5208cSdrh     }
4387bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4388e3365e6cSdrh     case TK_IN: {
4389e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4390e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4391e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4392076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4393e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4394e3365e6cSdrh       break;
4395e3365e6cSdrh     }
4396bb201344Sshaneh #endif
4397cce7d176Sdrh     default: {
43987b35a77bSdan     default_expr:
4399991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4400076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4401991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4402991a1985Sdrh         /* No-op */
4403991a1985Sdrh       }else{
44042dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
44052dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4406688852abSdrh         VdbeCoverage(v);
4407c5499befSdrh         testcase( regFree1==0 );
4408c5499befSdrh         testcase( jumpIfNull==0 );
4409991a1985Sdrh       }
4410cce7d176Sdrh       break;
4411cce7d176Sdrh     }
4412cce7d176Sdrh   }
44132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4415cce7d176Sdrh }
4416cce7d176Sdrh 
4417cce7d176Sdrh /*
441866b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4419cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4420cce7d176Sdrh ** continues straight thru if the expression is true.
4421f5905aa7Sdrh **
4422f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
442335573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
442435573356Sdrh ** is 0.
4425cce7d176Sdrh */
44264adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4427cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4428cce7d176Sdrh   int op = 0;
44292dcef11bSdrh   int regFree1 = 0;
44302dcef11bSdrh   int regFree2 = 0;
44312dcef11bSdrh   int r1, r2;
44322dcef11bSdrh 
443335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
443448864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
443533cd4909Sdrh   if( pExpr==0 )    return;
4436f2bc013cSdrh 
4437f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4438f2bc013cSdrh   **
4439f2bc013cSdrh   **       pExpr->op            op
4440f2bc013cSdrh   **       ---------          ----------
4441f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4442f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4443f2bc013cSdrh   **       TK_NE              OP_Eq
4444f2bc013cSdrh   **       TK_EQ              OP_Ne
4445f2bc013cSdrh   **       TK_GT              OP_Le
4446f2bc013cSdrh   **       TK_LE              OP_Gt
4447f2bc013cSdrh   **       TK_GE              OP_Lt
4448f2bc013cSdrh   **       TK_LT              OP_Ge
4449f2bc013cSdrh   **
4450f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4451f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4452f2bc013cSdrh   ** can compute the mapping above using the following expression.
4453f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4454f2bc013cSdrh   */
4455f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4456f2bc013cSdrh 
4457f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4458f2bc013cSdrh   */
4459f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4460f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4461f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4462f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4463f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4464f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4465f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4466f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4467f2bc013cSdrh 
4468ba00e30aSdan   switch( pExpr->op ){
4469cce7d176Sdrh     case TK_AND: {
4470c5499befSdrh       testcase( jumpIfNull==0 );
44714adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
447254e2adb5Sdrh       sqlite3ExprCachePush(pParse);
44734adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4474d2490904Sdrh       sqlite3ExprCachePop(pParse);
4475cce7d176Sdrh       break;
4476cce7d176Sdrh     }
4477cce7d176Sdrh     case TK_OR: {
44784adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4479c5499befSdrh       testcase( jumpIfNull==0 );
448035573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
448154e2adb5Sdrh       sqlite3ExprCachePush(pParse);
44824adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
44834adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4484d2490904Sdrh       sqlite3ExprCachePop(pParse);
4485cce7d176Sdrh       break;
4486cce7d176Sdrh     }
4487cce7d176Sdrh     case TK_NOT: {
44885c03f30aSdrh       testcase( jumpIfNull==0 );
44894adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4490cce7d176Sdrh       break;
4491cce7d176Sdrh     }
4492de845c2fSdrh     case TK_IS:
4493de845c2fSdrh     case TK_ISNOT:
4494de845c2fSdrh       testcase( pExpr->op==TK_IS );
4495de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4496de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4497de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4498de845c2fSdrh       /* Fall thru */
4499cce7d176Sdrh     case TK_LT:
4500cce7d176Sdrh     case TK_LE:
4501cce7d176Sdrh     case TK_GT:
4502cce7d176Sdrh     case TK_GE:
4503cce7d176Sdrh     case TK_NE:
4504cce7d176Sdrh     case TK_EQ: {
4505625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4506c5499befSdrh       testcase( jumpIfNull==0 );
4507b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4508b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
450935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45102dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45117d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45127d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45137d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45147d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4515de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4516de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4517de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4518de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4519de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4520de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
45216a2fe093Sdrh       testcase( regFree1==0 );
45226a2fe093Sdrh       testcase( regFree2==0 );
45236a2fe093Sdrh       break;
45246a2fe093Sdrh     }
4525cce7d176Sdrh     case TK_ISNULL:
4526cce7d176Sdrh     case TK_NOTNULL: {
45272dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45282dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45297d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
45307d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4531c5499befSdrh       testcase( regFree1==0 );
4532cce7d176Sdrh       break;
4533cce7d176Sdrh     }
4534fef5208cSdrh     case TK_BETWEEN: {
45355c03f30aSdrh       testcase( jumpIfNull==0 );
453671c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4537fef5208cSdrh       break;
4538fef5208cSdrh     }
4539bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4540e3365e6cSdrh     case TK_IN: {
4541e3365e6cSdrh       if( jumpIfNull ){
4542e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4543e3365e6cSdrh       }else{
4544e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4545e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4546e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4547e3365e6cSdrh       }
4548e3365e6cSdrh       break;
4549e3365e6cSdrh     }
4550bb201344Sshaneh #endif
4551cce7d176Sdrh     default: {
4552ba00e30aSdan     default_expr:
4553991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4554076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4555991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4556991a1985Sdrh         /* no-op */
4557991a1985Sdrh       }else{
45582dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45592dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4560688852abSdrh         VdbeCoverage(v);
4561c5499befSdrh         testcase( regFree1==0 );
4562c5499befSdrh         testcase( jumpIfNull==0 );
4563991a1985Sdrh       }
4564cce7d176Sdrh       break;
4565cce7d176Sdrh     }
4566cce7d176Sdrh   }
45672dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45682dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4569cce7d176Sdrh }
45702282792aSdrh 
45712282792aSdrh /*
457272bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
457372bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
457472bc8208Sdrh ** ensures that the original pExpr is unchanged.
457572bc8208Sdrh */
457672bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
457772bc8208Sdrh   sqlite3 *db = pParse->db;
457872bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
457972bc8208Sdrh   if( db->mallocFailed==0 ){
458072bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
458172bc8208Sdrh   }
458272bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
458372bc8208Sdrh }
458472bc8208Sdrh 
458572bc8208Sdrh 
458672bc8208Sdrh /*
45871d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
45881d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
45891d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
45901d9da70aSdrh ** other than the top-level COLLATE operator.
4591d40aab0eSdrh **
4592619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4593619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4594619a1305Sdrh **
459566518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
459666518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
459766518ca7Sdrh **
45981d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4599d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
46001d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
46011d9da70aSdrh ** returns 2, then you do not really know for certain if the two
46021d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4603d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
46041d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4605d40aab0eSdrh ** just might result in some slightly slower code.  But returning
46061d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
46072282792aSdrh */
4608619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
460910d1edf0Sdrh   u32 combinedFlags;
46104b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
46111d9da70aSdrh     return pB==pA ? 0 : 2;
46122282792aSdrh   }
461310d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
461410d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
461510d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
461610d1edf0Sdrh       return 0;
461710d1edf0Sdrh     }
46181d9da70aSdrh     return 2;
46196ab3a2ecSdanielk1977   }
4620c2acc4e4Sdrh   if( pA->op!=pB->op ){
4621619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
4622ae80ddeaSdrh       return 1;
4623ae80ddeaSdrh     }
4624619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
4625ae80ddeaSdrh       return 1;
4626ae80ddeaSdrh     }
4627ae80ddeaSdrh     return 2;
4628ae80ddeaSdrh   }
46292edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4630390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4631390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4632390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
463310d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
463410d1edf0Sdrh     }
463510d1edf0Sdrh   }
463610d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
463785f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
463810d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4639619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
4640619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
4641619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
46427693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4643619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
464466518ca7Sdrh       if( pA->iTable!=pB->iTable
464585f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
46461d9da70aSdrh     }
46471d9da70aSdrh   }
46482646da7eSdrh   return 0;
46492646da7eSdrh }
46502282792aSdrh 
46518c6f666bSdrh /*
46528c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
46538c6f666bSdrh ** non-zero if they differ in any way.
46548c6f666bSdrh **
4655619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4656619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4657619a1305Sdrh **
46588c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
46598c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
46608c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
46618c6f666bSdrh ** a malfunction will result.
46628c6f666bSdrh **
46638c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
46648c6f666bSdrh ** always differs from a non-NULL pointer.
46658c6f666bSdrh */
4666619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
46678c6f666bSdrh   int i;
46688c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
46698c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
46708c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
46718c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
46728c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
46738c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
46748c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
4675619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
46768c6f666bSdrh   }
46778c6f666bSdrh   return 0;
46788c6f666bSdrh }
467913449892Sdrh 
46802282792aSdrh /*
4681f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4682f9463dfbSdrh ** are ignored.
4683f9463dfbSdrh */
4684f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
4685f9463dfbSdrh   return sqlite3ExprCompare(
4686f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4687f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4688f9463dfbSdrh              iTab);
4689f9463dfbSdrh }
4690f9463dfbSdrh 
4691f9463dfbSdrh /*
46924bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
46934bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
46944bd5f73fSdrh ** be false.  Examples:
46954bd5f73fSdrh **
4696619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
46974bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4698619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
46994bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4700619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4701619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4702619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
47034bd5f73fSdrh **
47044bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
47054bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
47064bd5f73fSdrh **
47074bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
47084bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
47094bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
47104bd5f73fSdrh */
47114bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
4712619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
4713619a1305Sdrh     return 1;
4714619a1305Sdrh   }
4715619a1305Sdrh   if( pE2->op==TK_OR
4716619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
4717619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
4718619a1305Sdrh   ){
4719619a1305Sdrh     return 1;
4720619a1305Sdrh   }
47211ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
47221ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
47231ad93a00Sdrh     testcase( pX!=pE1->pLeft );
47241ad93a00Sdrh     if( sqlite3ExprCompare(pX, pE2->pLeft, iTab)==0 ) return 1;
4725619a1305Sdrh   }
4726619a1305Sdrh   return 0;
47274bd5f73fSdrh }
47284bd5f73fSdrh 
47294bd5f73fSdrh /*
4730030796dfSdrh ** An instance of the following structure is used by the tree walker
47312409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
47322409f8a1Sdrh ** index only, without having to do a search for the corresponding
47332409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
47342409f8a1Sdrh ** is the cursor for the table.
47352409f8a1Sdrh */
47362409f8a1Sdrh struct IdxCover {
47372409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
47382409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
47392409f8a1Sdrh };
47402409f8a1Sdrh 
47412409f8a1Sdrh /*
47422409f8a1Sdrh ** Check to see if there are references to columns in table
47432409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
47442409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
47452409f8a1Sdrh */
47462409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
47472409f8a1Sdrh   if( pExpr->op==TK_COLUMN
47482409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
47492409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
47502409f8a1Sdrh   ){
47512409f8a1Sdrh     pWalker->eCode = 1;
47522409f8a1Sdrh     return WRC_Abort;
47532409f8a1Sdrh   }
47542409f8a1Sdrh   return WRC_Continue;
47552409f8a1Sdrh }
47562409f8a1Sdrh 
47572409f8a1Sdrh /*
4758e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4759e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4760e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4761e604ec0bSdrh ** that are not found in the index pIdx.
47622409f8a1Sdrh **
47632409f8a1Sdrh ** An index covering an expression means that the expression can be
47642409f8a1Sdrh ** evaluated using only the index and without having to lookup the
47652409f8a1Sdrh ** corresponding table entry.
47662409f8a1Sdrh */
47672409f8a1Sdrh int sqlite3ExprCoveredByIndex(
47682409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
47692409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
47702409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
47712409f8a1Sdrh ){
47722409f8a1Sdrh   Walker w;
47732409f8a1Sdrh   struct IdxCover xcov;
47742409f8a1Sdrh   memset(&w, 0, sizeof(w));
47752409f8a1Sdrh   xcov.iCur = iCur;
47762409f8a1Sdrh   xcov.pIdx = pIdx;
47772409f8a1Sdrh   w.xExprCallback = exprIdxCover;
47782409f8a1Sdrh   w.u.pIdxCover = &xcov;
47792409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
47802409f8a1Sdrh   return !w.eCode;
47812409f8a1Sdrh }
47822409f8a1Sdrh 
47832409f8a1Sdrh 
47842409f8a1Sdrh /*
47852409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4786030796dfSdrh ** to count references to table columns in the arguments of an
4787ed551b95Sdrh ** aggregate function, in order to implement the
4788ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4789374fdce4Sdrh */
4790030796dfSdrh struct SrcCount {
4791030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4792030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4793030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4794030796dfSdrh };
4795030796dfSdrh 
4796030796dfSdrh /*
4797030796dfSdrh ** Count the number of references to columns.
4798030796dfSdrh */
4799030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4800fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4801fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4802fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4803fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4804fb0a6081Sdrh   ** NEVER() will need to be removed. */
4805fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4806374fdce4Sdrh     int i;
4807030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4808030796dfSdrh     SrcList *pSrc = p->pSrc;
4809655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4810655814d2Sdrh     for(i=0; i<nSrc; i++){
4811030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4812374fdce4Sdrh     }
4813655814d2Sdrh     if( i<nSrc ){
4814030796dfSdrh       p->nThis++;
4815374fdce4Sdrh     }else{
4816030796dfSdrh       p->nOther++;
4817374fdce4Sdrh     }
4818374fdce4Sdrh   }
4819030796dfSdrh   return WRC_Continue;
4820030796dfSdrh }
4821374fdce4Sdrh 
4822374fdce4Sdrh /*
4823030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4824030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4825030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4826030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4827374fdce4Sdrh */
4828030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4829374fdce4Sdrh   Walker w;
4830030796dfSdrh   struct SrcCount cnt;
4831374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4832374fdce4Sdrh   memset(&w, 0, sizeof(w));
4833030796dfSdrh   w.xExprCallback = exprSrcCount;
4834030796dfSdrh   w.u.pSrcCount = &cnt;
4835030796dfSdrh   cnt.pSrc = pSrcList;
4836030796dfSdrh   cnt.nThis = 0;
4837030796dfSdrh   cnt.nOther = 0;
4838030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4839030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4840374fdce4Sdrh }
4841374fdce4Sdrh 
4842374fdce4Sdrh /*
484313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
484413449892Sdrh ** the new element.  Return a negative number if malloc fails.
48452282792aSdrh */
484617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
484713449892Sdrh   int i;
4848cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
484917435752Sdrh        db,
4850cf643729Sdrh        pInfo->aCol,
4851cf643729Sdrh        sizeof(pInfo->aCol[0]),
4852cf643729Sdrh        &pInfo->nColumn,
4853cf643729Sdrh        &i
4854cf643729Sdrh   );
485513449892Sdrh   return i;
48562282792aSdrh }
485713449892Sdrh 
485813449892Sdrh /*
485913449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
486013449892Sdrh ** the new element.  Return a negative number if malloc fails.
486113449892Sdrh */
486217435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
486313449892Sdrh   int i;
4864cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
486517435752Sdrh        db,
4866cf643729Sdrh        pInfo->aFunc,
4867cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4868cf643729Sdrh        &pInfo->nFunc,
4869cf643729Sdrh        &i
4870cf643729Sdrh   );
487113449892Sdrh   return i;
48722282792aSdrh }
48732282792aSdrh 
48742282792aSdrh /*
48757d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
48767d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4877626a879aSdrh ** for additional information.
48782282792aSdrh */
48797d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
48802282792aSdrh   int i;
48817d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4882a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4883a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
488413449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
488513449892Sdrh 
48862282792aSdrh   switch( pExpr->op ){
488789c69d00Sdrh     case TK_AGG_COLUMN:
4888967e8b73Sdrh     case TK_COLUMN: {
48898b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
48908b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
489113449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
489213449892Sdrh       ** clause of the aggregate query */
489320bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
489413449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
489513449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
489613449892Sdrh           struct AggInfo_col *pCol;
4897c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
489813449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
489913449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
490013449892Sdrh             ** that is in the FROM clause of the aggregate query.
490113449892Sdrh             **
490213449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
490313449892Sdrh             ** is not an entry there already.
490413449892Sdrh             */
49057f906d63Sdrh             int k;
490613449892Sdrh             pCol = pAggInfo->aCol;
49077f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
490813449892Sdrh               if( pCol->iTable==pExpr->iTable &&
490913449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
49102282792aSdrh                 break;
49112282792aSdrh               }
49122282792aSdrh             }
49131e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
49141e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
49151e536953Sdanielk1977             ){
49167f906d63Sdrh               pCol = &pAggInfo->aCol[k];
49170817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
491813449892Sdrh               pCol->iTable = pExpr->iTable;
491913449892Sdrh               pCol->iColumn = pExpr->iColumn;
49200a07c107Sdrh               pCol->iMem = ++pParse->nMem;
492113449892Sdrh               pCol->iSorterColumn = -1;
49225774b806Sdrh               pCol->pExpr = pExpr;
492313449892Sdrh               if( pAggInfo->pGroupBy ){
492413449892Sdrh                 int j, n;
492513449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
492613449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
492713449892Sdrh                 n = pGB->nExpr;
492813449892Sdrh                 for(j=0; j<n; j++, pTerm++){
492913449892Sdrh                   Expr *pE = pTerm->pExpr;
493013449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
493113449892Sdrh                       pE->iColumn==pExpr->iColumn ){
493213449892Sdrh                     pCol->iSorterColumn = j;
493313449892Sdrh                     break;
49342282792aSdrh                   }
493513449892Sdrh                 }
493613449892Sdrh               }
493713449892Sdrh               if( pCol->iSorterColumn<0 ){
493813449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
493913449892Sdrh               }
494013449892Sdrh             }
494113449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
494213449892Sdrh             ** because it was there before or because we just created it).
494313449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
494413449892Sdrh             ** pAggInfo->aCol[] entry.
494513449892Sdrh             */
4946ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
494713449892Sdrh             pExpr->pAggInfo = pAggInfo;
494813449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4949cf697396Sshane             pExpr->iAgg = (i16)k;
495013449892Sdrh             break;
495113449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
495213449892Sdrh         } /* end loop over pSrcList */
4953a58fdfb1Sdanielk1977       }
49547d10d5a6Sdrh       return WRC_Prune;
49552282792aSdrh     }
49562282792aSdrh     case TK_AGG_FUNCTION: {
49573a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4958ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
49593a8c4be7Sdrh       ){
496013449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
496113449892Sdrh         ** function that is already in the pAggInfo structure
496213449892Sdrh         */
496313449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
496413449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4965619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
49662282792aSdrh             break;
49672282792aSdrh           }
49682282792aSdrh         }
496913449892Sdrh         if( i>=pAggInfo->nFunc ){
497013449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
497113449892Sdrh           */
497214db2665Sdanielk1977           u8 enc = ENC(pParse->db);
49731e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
497413449892Sdrh           if( i>=0 ){
49756ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
497613449892Sdrh             pItem = &pAggInfo->aFunc[i];
497713449892Sdrh             pItem->pExpr = pExpr;
49780a07c107Sdrh             pItem->iMem = ++pParse->nMem;
497933e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
498013449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
498180738d9cSdrh                    pExpr->u.zToken,
49826ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4983fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4984fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4985fd357974Sdrh             }else{
4986fd357974Sdrh               pItem->iDistinct = -1;
4987fd357974Sdrh             }
49882282792aSdrh           }
498913449892Sdrh         }
499013449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
499113449892Sdrh         */
4992c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4993ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4994cf697396Sshane         pExpr->iAgg = (i16)i;
499513449892Sdrh         pExpr->pAggInfo = pAggInfo;
49963a8c4be7Sdrh         return WRC_Prune;
49976e83a57fSdrh       }else{
49986e83a57fSdrh         return WRC_Continue;
49996e83a57fSdrh       }
50002282792aSdrh     }
5001a58fdfb1Sdanielk1977   }
50027d10d5a6Sdrh   return WRC_Continue;
50037d10d5a6Sdrh }
50047d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5005d5a336efSdrh   UNUSED_PARAMETER(pWalker);
5006d5a336efSdrh   UNUSED_PARAMETER(pSelect);
50077d10d5a6Sdrh   return WRC_Continue;
5008a58fdfb1Sdanielk1977 }
5009626a879aSdrh 
5010626a879aSdrh /*
5011e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5012e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5013e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5014e8abb4caSdrh ** necessary.
5015626a879aSdrh **
5016626a879aSdrh ** This routine should only be called after the expression has been
50177d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5018626a879aSdrh */
5019d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
50207d10d5a6Sdrh   Walker w;
5021374fdce4Sdrh   memset(&w, 0, sizeof(w));
50227d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
50237d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
50247d10d5a6Sdrh   w.u.pNC = pNC;
502520bc393cSdrh   assert( pNC->pSrcList!=0 );
50267d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
50272282792aSdrh }
50285d9a4af9Sdrh 
50295d9a4af9Sdrh /*
50305d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
50315d9a4af9Sdrh ** expression list.  Return the number of errors.
50325d9a4af9Sdrh **
50335d9a4af9Sdrh ** If an error is found, the analysis is cut short.
50345d9a4af9Sdrh */
5035d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
50365d9a4af9Sdrh   struct ExprList_item *pItem;
50375d9a4af9Sdrh   int i;
50385d9a4af9Sdrh   if( pList ){
5039d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5040d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
50415d9a4af9Sdrh     }
50425d9a4af9Sdrh   }
50435d9a4af9Sdrh }
5044892d3179Sdrh 
5045892d3179Sdrh /*
5046ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5047892d3179Sdrh */
5048892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5049e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5050892d3179Sdrh     return ++pParse->nMem;
5051892d3179Sdrh   }
50522f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5053892d3179Sdrh }
5054ceea3321Sdrh 
5055ceea3321Sdrh /*
5056ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5057ceea3321Sdrh ** purpose.
5058ceea3321Sdrh **
5059ceea3321Sdrh ** If a register is currently being used by the column cache, then
506060ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5061ceea3321Sdrh ** the register becomes stale.
5062ceea3321Sdrh */
5063892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
50642dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5065ceea3321Sdrh     int i;
5066ceea3321Sdrh     struct yColCache *p;
50679b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5068ceea3321Sdrh       if( p->iReg==iReg ){
5069ceea3321Sdrh         p->tempReg = 1;
5070ceea3321Sdrh         return;
5071ceea3321Sdrh       }
5072ceea3321Sdrh     }
5073892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5074892d3179Sdrh   }
5075892d3179Sdrh }
5076892d3179Sdrh 
5077892d3179Sdrh /*
5078ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5079892d3179Sdrh */
5080892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5081e55cbd72Sdrh   int i, n;
5082ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5083892d3179Sdrh   i = pParse->iRangeReg;
5084e55cbd72Sdrh   n = pParse->nRangeReg;
5085f49f3523Sdrh   if( nReg<=n ){
5086f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5087892d3179Sdrh     pParse->iRangeReg += nReg;
5088892d3179Sdrh     pParse->nRangeReg -= nReg;
5089892d3179Sdrh   }else{
5090892d3179Sdrh     i = pParse->nMem+1;
5091892d3179Sdrh     pParse->nMem += nReg;
5092892d3179Sdrh   }
5093892d3179Sdrh   return i;
5094892d3179Sdrh }
5095892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5096ed24da4bSdrh   if( nReg==1 ){
5097ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5098ed24da4bSdrh     return;
5099ed24da4bSdrh   }
5100f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5101892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5102892d3179Sdrh     pParse->nRangeReg = nReg;
5103892d3179Sdrh     pParse->iRangeReg = iReg;
5104892d3179Sdrh   }
5105892d3179Sdrh }
5106cdc69557Sdrh 
5107cdc69557Sdrh /*
5108cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5109cdc69557Sdrh */
5110cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5111cdc69557Sdrh   pParse->nTempReg = 0;
5112cdc69557Sdrh   pParse->nRangeReg = 0;
5113cdc69557Sdrh }
5114bb9b5f26Sdrh 
5115bb9b5f26Sdrh /*
5116bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5117bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5118bb9b5f26Sdrh ** statements.
5119bb9b5f26Sdrh */
5120bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5121bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5122bb9b5f26Sdrh   int i;
5123bb9b5f26Sdrh   if( pParse->nRangeReg>0
5124bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
5125bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
5126bb9b5f26Sdrh   ){
5127bb9b5f26Sdrh      return 0;
5128bb9b5f26Sdrh   }
5129bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5130bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5131bb9b5f26Sdrh       return 0;
5132bb9b5f26Sdrh     }
5133bb9b5f26Sdrh   }
5134bb9b5f26Sdrh   return 1;
5135bb9b5f26Sdrh }
5136bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5137