xref: /sqlite-3.40.0/src/expr.c (revision a48d7e77)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
17e014a838Sdanielk1977 /*
18e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
19e014a838Sdanielk1977 **
20e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
21e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
22e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
23e014a838Sdanielk1977 ** indicating no affinity for the expression.
24e014a838Sdanielk1977 **
2560ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
26e014a838Sdanielk1977 ** have an affinity:
27e014a838Sdanielk1977 **
28e014a838Sdanielk1977 ** CREATE TABLE t1(a);
29e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
30e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
32e014a838Sdanielk1977 */
33bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
34580c8c18Sdrh   int op;
35580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
369bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
37580c8c18Sdrh   op = pExpr->op;
38487e262fSdrh   if( op==TK_SELECT ){
396ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
406ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
41a37cdde0Sdanielk1977   }
42487e262fSdrh #ifndef SQLITE_OMIT_CAST
43487e262fSdrh   if( op==TK_CAST ){
4433e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
45fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
46487e262fSdrh   }
47487e262fSdrh #endif
48259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
49259a455fSdanielk1977    && pExpr->pTab!=0
50259a455fSdanielk1977   ){
517d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
527d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
537d10d5a6Sdrh     int j = pExpr->iColumn;
547d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
557d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
567d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
577d10d5a6Sdrh   }
58a37cdde0Sdanielk1977   return pExpr->affinity;
59a37cdde0Sdanielk1977 }
60a37cdde0Sdanielk1977 
6153db1458Sdrh /*
628b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
63ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
64ae80ddeaSdrh ** implements the COLLATE operator.
650a8a406eSdrh **
660a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
670a8a406eSdrh ** and the pExpr parameter is returned unchanged.
688b4c40d8Sdrh */
694ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
704ef7efadSdrh   Parse *pParse,           /* Parsing context */
714ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
7280103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
7380103fc6Sdan   int dequote              /* True to dequote pCollName */
744ef7efadSdrh ){
750a8a406eSdrh   if( pCollName->n>0 ){
7680103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
77ae80ddeaSdrh     if( pNew ){
78ae80ddeaSdrh       pNew->pLeft = pExpr;
79a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
800a8a406eSdrh       pExpr = pNew;
81ae80ddeaSdrh     }
820a8a406eSdrh   }
830a8a406eSdrh   return pExpr;
840a8a406eSdrh }
850a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
860a8a406eSdrh   Token s;
87261d8a51Sdrh   assert( zC!=0 );
8840aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
8980103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
900a8a406eSdrh }
910a8a406eSdrh 
920a8a406eSdrh /*
930b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
94a4c3c87eSdrh ** or likelihood() function at the root of an expression.
950a8a406eSdrh */
960a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
97a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
98a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
99cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
100cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
101a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
102cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
103cca9f3d2Sdrh     }else{
1040b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
105d91eba96Sdrh       pExpr = pExpr->pLeft;
106cca9f3d2Sdrh     }
107d91eba96Sdrh   }
1080a8a406eSdrh   return pExpr;
1098b4c40d8Sdrh }
1108b4c40d8Sdrh 
1118b4c40d8Sdrh /*
112ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
113ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
114ae80ddeaSdrh **
115ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
116ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
117ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
118ae80ddeaSdrh ** precedence over right operands.
1190202b29eSdanielk1977 */
1207cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
121ae80ddeaSdrh   sqlite3 *db = pParse->db;
1227cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1237d10d5a6Sdrh   Expr *p = pExpr;
124261d8a51Sdrh   while( p ){
125ae80ddeaSdrh     int op = p->op;
126fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
127ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
128ae80ddeaSdrh       p = p->pLeft;
129ae80ddeaSdrh       continue;
130ae80ddeaSdrh     }
13136e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1327a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
133ae80ddeaSdrh       break;
134ae80ddeaSdrh     }
135a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
136ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
137a58d4a96Sdrh      && p->pTab!=0
138ae80ddeaSdrh     ){
1397d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1407d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1417d10d5a6Sdrh       int j = p->iColumn;
1427d10d5a6Sdrh       if( j>=0 ){
143ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
144c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1450202b29eSdanielk1977       }
1467d10d5a6Sdrh       break;
1477d10d5a6Sdrh     }
148ae80ddeaSdrh     if( p->flags & EP_Collate ){
1492308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1507d10d5a6Sdrh         p = p->pLeft;
151ae80ddeaSdrh       }else{
1522308ed38Sdrh         Expr *pNext  = p->pRight;
1536728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1546728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1556728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1566728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1576728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1586728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1592308ed38Sdrh           int i;
1606728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1612308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1622308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1632308ed38Sdrh               break;
1642308ed38Sdrh             }
1652308ed38Sdrh           }
1662308ed38Sdrh         }
1672308ed38Sdrh         p = pNext;
168ae80ddeaSdrh       }
169ae80ddeaSdrh     }else{
170ae80ddeaSdrh       break;
171ae80ddeaSdrh     }
1720202b29eSdanielk1977   }
1737cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1747cedc8d4Sdanielk1977     pColl = 0;
1757cedc8d4Sdanielk1977   }
1767cedc8d4Sdanielk1977   return pColl;
1770202b29eSdanielk1977 }
1780202b29eSdanielk1977 
1790202b29eSdanielk1977 /*
180626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
181626a879aSdrh ** type affinity of the other operand.  This routine returns the
18253db1458Sdrh ** type affinity that should be used for the comparison operator.
18353db1458Sdrh */
184e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
185bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
186e014a838Sdanielk1977   if( aff1 && aff2 ){
1878df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1888df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
189e014a838Sdanielk1977     */
1908a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
191e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
192e014a838Sdanielk1977     }else{
19305883a34Sdrh       return SQLITE_AFF_BLOB;
194e014a838Sdanielk1977     }
195e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1965f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1975f6a87b3Sdrh     ** results directly.
198e014a838Sdanielk1977     */
19905883a34Sdrh     return SQLITE_AFF_BLOB;
200e014a838Sdanielk1977   }else{
201e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
202fe05af87Sdrh     assert( aff1==0 || aff2==0 );
203e014a838Sdanielk1977     return (aff1 + aff2);
204e014a838Sdanielk1977   }
205e014a838Sdanielk1977 }
206e014a838Sdanielk1977 
20753db1458Sdrh /*
20853db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
20953db1458Sdrh ** be applied to both operands prior to doing the comparison.
21053db1458Sdrh */
211e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
212e014a838Sdanielk1977   char aff;
213e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
214e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2156a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
216e014a838Sdanielk1977   assert( pExpr->pLeft );
217bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
218e014a838Sdanielk1977   if( pExpr->pRight ){
219e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2206ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2216ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2226ab3a2ecSdanielk1977   }else if( !aff ){
22305883a34Sdrh     aff = SQLITE_AFF_BLOB;
224e014a838Sdanielk1977   }
225e014a838Sdanielk1977   return aff;
226e014a838Sdanielk1977 }
227e014a838Sdanielk1977 
228e014a838Sdanielk1977 /*
229e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
230e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
231e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
232e014a838Sdanielk1977 ** the comparison in pExpr.
233e014a838Sdanielk1977 */
234e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
235e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2368a51256cSdrh   switch( aff ){
23705883a34Sdrh     case SQLITE_AFF_BLOB:
2388a51256cSdrh       return 1;
2398a51256cSdrh     case SQLITE_AFF_TEXT:
2408a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2418a51256cSdrh     default:
2428a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2438a51256cSdrh   }
244e014a838Sdanielk1977 }
245e014a838Sdanielk1977 
246a37cdde0Sdanielk1977 /*
24735573356Sdrh ** Return the P5 value that should be used for a binary comparison
248a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
249a37cdde0Sdanielk1977 */
25035573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
25135573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2521bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
25335573356Sdrh   return aff;
254a37cdde0Sdanielk1977 }
255a37cdde0Sdanielk1977 
256a2e00042Sdrh /*
2570202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2580202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2590202b29eSdanielk1977 **
2600202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2610202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2620202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2630202b29eSdanielk1977 ** type.
264bcbb04e5Sdanielk1977 **
265bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
266bcbb04e5Sdanielk1977 ** it is not considered.
2670202b29eSdanielk1977 */
268bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
269bcbb04e5Sdanielk1977   Parse *pParse,
270bcbb04e5Sdanielk1977   Expr *pLeft,
271bcbb04e5Sdanielk1977   Expr *pRight
272bcbb04e5Sdanielk1977 ){
273ec41ddacSdrh   CollSeq *pColl;
274ec41ddacSdrh   assert( pLeft );
275ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
276ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
277ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
278ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
279ec41ddacSdrh   }else{
280ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2810202b29eSdanielk1977     if( !pColl ){
2827cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2830202b29eSdanielk1977     }
284ec41ddacSdrh   }
2850202b29eSdanielk1977   return pColl;
2860202b29eSdanielk1977 }
2870202b29eSdanielk1977 
2880202b29eSdanielk1977 /*
289be5c89acSdrh ** Generate code for a comparison operator.
290be5c89acSdrh */
291be5c89acSdrh static int codeCompare(
292be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
293be5c89acSdrh   Expr *pLeft,      /* The left operand */
294be5c89acSdrh   Expr *pRight,     /* The right operand */
295be5c89acSdrh   int opcode,       /* The comparison opcode */
29635573356Sdrh   int in1, int in2, /* Register holding operands */
297be5c89acSdrh   int dest,         /* Jump here if true.  */
298be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
299be5c89acSdrh ){
30035573356Sdrh   int p5;
30135573356Sdrh   int addr;
30235573356Sdrh   CollSeq *p4;
30335573356Sdrh 
30435573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
30535573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
30635573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
30735573356Sdrh                            (void*)p4, P4_COLLSEQ);
3081bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
30935573356Sdrh   return addr;
310be5c89acSdrh }
311be5c89acSdrh 
312cfbb5e82Sdan /*
313870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
314870a0705Sdan */
315870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
316870a0705Sdan   return ( (pExpr->op==TK_VECTOR)
317870a0705Sdan         || (pExpr->op==TK_SELECT && pExpr->x.pSelect->pEList->nExpr>1)
318870a0705Sdan   );
319870a0705Sdan }
320870a0705Sdan 
321870a0705Sdan /*
322cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
323cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
324cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
325cfbb5e82Sdan ** any other type of expression, return 1.
326cfbb5e82Sdan */
32771c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
328625015e0Sdan   if( sqlite3ExprIsVector(pExpr)==0 ) return 1;
32971c57db0Sdan   if( pExpr->flags & EP_xIsSelect ){
33071c57db0Sdan     return pExpr->x.pSelect->pEList->nExpr;
33171c57db0Sdan   }
33271c57db0Sdan   return pExpr->x.pList->nExpr;
33371c57db0Sdan }
33471c57db0Sdan 
335f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
336ba00e30aSdan /*
337ba00e30aSdan ** If the expression passed as the first argument is a TK_VECTOR, return
338ba00e30aSdan ** a pointer to the i'th field of the vector. Or, if the first argument
339870a0705Sdan ** points to a sub-select that returns more than one column, return a
340870a0705Sdan ** pointer to the i'th returned column value. Otherwise, return a copy
341870a0705Sdan ** of the first argument.
342ba00e30aSdan */
343d66e5794Sdan Expr *sqlite3ExprVectorField(Expr *pVector, int i){
344870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
345870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
346870a0705Sdan     if( pVector->op==TK_SELECT ){
34771c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
348870a0705Sdan     }else{
34971c57db0Sdan       return pVector->x.pList->a[i].pExpr;
35071c57db0Sdan     }
351870a0705Sdan   }
352870a0705Sdan   return pVector;
353870a0705Sdan }
354f9b2e05cSdan #endif
35571c57db0Sdan 
3565c288b92Sdan /*
3575c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
3585c288b92Sdan ** it. Return the register in which the result is stored (or, if the
3595c288b92Sdan ** sub-select returns more than one column, the first in an array
3605c288b92Sdan ** of registers in which the result is stored).
3615c288b92Sdan **
3625c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
3635c288b92Sdan */
3645c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
3658da209b1Sdan   int reg = 0;
366f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
3675c288b92Sdan   if( pExpr->op==TK_SELECT ){
3688da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
3698da209b1Sdan   }
370f9b2e05cSdan #endif
3718da209b1Sdan   return reg;
3728da209b1Sdan }
3738da209b1Sdan 
3745c288b92Sdan /*
3755c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
376870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
377870a0705Sdan ** the register number of a register that contains the value of
378870a0705Sdan ** element iField of the vector.
379870a0705Sdan **
380870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
381870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
382870a0705Sdan ** case parameter regSelect should be the first in an array of registers
383870a0705Sdan ** containing the results of the sub-select.
384870a0705Sdan **
385870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
386870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
387870a0705Sdan ** a temporary register to be freed by the caller before returning.
3885c288b92Sdan **
3895c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
3905c288b92Sdan ** Expr object corresponding to element iElem of the vector.
3915c288b92Sdan */
3925c288b92Sdan static int exprVectorRegister(
3935c288b92Sdan   Parse *pParse,                  /* Parse context */
3945c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
395870a0705Sdan   int iField,                     /* Field to extract from pVector */
3965c288b92Sdan   int regSelect,                  /* First in array of registers */
3975c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
3985c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
3995c288b92Sdan ){
400870a0705Sdan   assert( pVector->op==TK_VECTOR || pVector->op==TK_SELECT );
401870a0705Sdan   assert( (pVector->op==TK_VECTOR)==(regSelect==0) );
4025c288b92Sdan   if( regSelect ){
403870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
404870a0705Sdan      return regSelect+iField;
4055c288b92Sdan   }
406870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
4075c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
4085c288b92Sdan }
4095c288b92Sdan 
4105c288b92Sdan /*
4115c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
4125c288b92Sdan ** the result of the comparison and write it to register dest.
4135c288b92Sdan */
41471c57db0Sdan static void codeVectorCompare(Parse *pParse, Expr *pExpr, int dest){
41571c57db0Sdan   Vdbe *v = pParse->pVdbe;
41671c57db0Sdan   Expr *pLeft = pExpr->pLeft;
41771c57db0Sdan   Expr *pRight = pExpr->pRight;
41871c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
41971c57db0Sdan   int nRight = sqlite3ExprVectorSize(pRight);
42071c57db0Sdan   int addr = sqlite3VdbeMakeLabel(v);
42171c57db0Sdan 
42271c57db0Sdan   /* Check that both sides of the comparison are vectors, and that
42371c57db0Sdan   ** both are the same length.  */
42471c57db0Sdan   if( nLeft!=nRight ){
42571c57db0Sdan     sqlite3ErrorMsg(pParse, "invalid use of row value");
42671c57db0Sdan   }else{
42771c57db0Sdan     int p5 = (pExpr->op==TK_IS || pExpr->op==TK_ISNOT) ? SQLITE_NULLEQ : 0;
42871c57db0Sdan     int i;
42971c57db0Sdan     int regLeft = 0;
43071c57db0Sdan     int regRight = 0;
4315c288b92Sdan     int regTmp = 0;
43271c57db0Sdan 
43371c57db0Sdan     assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
43471c57db0Sdan          || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
43571c57db0Sdan          || pExpr->op==TK_LT || pExpr->op==TK_GT
43671c57db0Sdan          || pExpr->op==TK_LE || pExpr->op==TK_GE
43771c57db0Sdan     );
43871c57db0Sdan 
4395c288b92Sdan     if( pExpr->op==TK_EQ || pExpr->op==TK_NE ){
4405c288b92Sdan       regTmp = sqlite3GetTempReg(pParse);
4415c288b92Sdan       sqlite3VdbeAddOp2(v, OP_Integer, (pExpr->op==TK_EQ), dest);
4425c288b92Sdan     }
4435c288b92Sdan 
4445c288b92Sdan     regLeft = exprCodeSubselect(pParse, pLeft);
4455c288b92Sdan     regRight = exprCodeSubselect(pParse, pRight);
4465c288b92Sdan 
4475c288b92Sdan     for(i=0; i<nLeft; i++){
4485c288b92Sdan       int regFree1 = 0, regFree2 = 0;
4495c288b92Sdan       Expr *pL, *pR;
4505c288b92Sdan       int r1, r2;
4515c288b92Sdan       if( i ) sqlite3ExprCachePush(pParse);
4525c288b92Sdan       r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
4535c288b92Sdan       r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
4545c288b92Sdan 
45571c57db0Sdan       switch( pExpr->op ){
45671c57db0Sdan         case TK_IS:
4575c288b92Sdan           codeCompare(
4585c288b92Sdan               pParse, pL, pR, OP_Eq, r1, r2, dest, SQLITE_STOREP2|SQLITE_NULLEQ
4595c288b92Sdan           );
4605c288b92Sdan           sqlite3VdbeAddOp3(v, OP_IfNot, dest, addr, 1);
4615c288b92Sdan           VdbeCoverage(v);
46271c57db0Sdan           break;
46371c57db0Sdan 
46471c57db0Sdan         case TK_ISNOT:
4655c288b92Sdan           codeCompare(
4665c288b92Sdan               pParse, pL, pR, OP_Ne, r1, r2, dest, SQLITE_STOREP2|SQLITE_NULLEQ
4675c288b92Sdan           );
4685c288b92Sdan           sqlite3VdbeAddOp3(v, OP_If, dest, addr, 1);
4695c288b92Sdan           VdbeCoverage(v);
4705c288b92Sdan           break;
4715c288b92Sdan 
4725c288b92Sdan         case TK_EQ:
4735c288b92Sdan         case TK_NE:
4745c288b92Sdan           codeCompare(pParse, pL, pR, OP_Cmp, r1, r2, regTmp,SQLITE_STOREP2|p5);
4755c288b92Sdan           sqlite3VdbeAddOp4Int(
4765c288b92Sdan               v, OP_CmpTest, regTmp, addr, dest, pExpr->op==TK_NE
4775c288b92Sdan           );
4785c288b92Sdan           VdbeCoverage(v);
47971c57db0Sdan           break;
48071c57db0Sdan 
48171c57db0Sdan         case TK_LT:
48271c57db0Sdan         case TK_LE:
48371c57db0Sdan         case TK_GT:
48471c57db0Sdan         case TK_GE:
4855c288b92Sdan           codeCompare(pParse, pL, pR, OP_Cmp, r1, r2, dest, SQLITE_STOREP2|p5);
4865c288b92Sdan           sqlite3VdbeAddOp4Int(v, OP_CmpTest, dest, addr, 0, pExpr->op);
4875c288b92Sdan           VdbeCoverage(v);
48871c57db0Sdan           break;
48971c57db0Sdan       }
49071c57db0Sdan 
49171c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree1);
49271c57db0Sdan       sqlite3ReleaseTempReg(pParse, regFree2);
49319ff12ddSdan       if( i ) sqlite3ExprCachePop(pParse);
49471c57db0Sdan     }
4955c288b92Sdan 
4965c288b92Sdan     sqlite3ReleaseTempReg(pParse, regTmp);
49771c57db0Sdan   }
49871c57db0Sdan 
49971c57db0Sdan   sqlite3VdbeResolveLabel(v, addr);
50071c57db0Sdan }
50171c57db0Sdan 
5024b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
5034b5255acSdanielk1977 /*
5044b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
5054b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
5064b5255acSdanielk1977 ** pParse.
5074b5255acSdanielk1977 */
5087d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
5094b5255acSdanielk1977   int rc = SQLITE_OK;
5104b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
5114b5255acSdanielk1977   if( nHeight>mxHeight ){
5124b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
5134b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
5144b5255acSdanielk1977     );
5154b5255acSdanielk1977     rc = SQLITE_ERROR;
5164b5255acSdanielk1977   }
5174b5255acSdanielk1977   return rc;
5184b5255acSdanielk1977 }
5194b5255acSdanielk1977 
5204b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
5214b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
5224b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
5234b5255acSdanielk1977 ** first argument.
5244b5255acSdanielk1977 **
5254b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
5264b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
5274b5255acSdanielk1977 ** value.
5284b5255acSdanielk1977 */
5294b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
5304b5255acSdanielk1977   if( p ){
5314b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
5324b5255acSdanielk1977       *pnHeight = p->nHeight;
5334b5255acSdanielk1977     }
5344b5255acSdanielk1977   }
5354b5255acSdanielk1977 }
5364b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
5374b5255acSdanielk1977   if( p ){
5384b5255acSdanielk1977     int i;
5394b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
5404b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
5414b5255acSdanielk1977     }
5424b5255acSdanielk1977   }
5434b5255acSdanielk1977 }
5444b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
5454b5255acSdanielk1977   if( p ){
5464b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
5474b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
5484b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
5494b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
5504b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
5514b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
5524b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
5534b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
5544b5255acSdanielk1977   }
5554b5255acSdanielk1977 }
5564b5255acSdanielk1977 
5574b5255acSdanielk1977 /*
5584b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
5594b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
5604b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
5614b5255acSdanielk1977 ** has a height equal to the maximum height of any other
5624b5255acSdanielk1977 ** referenced Expr plus one.
5632308ed38Sdrh **
5642308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
5652308ed38Sdrh ** if appropriate.
5664b5255acSdanielk1977 */
5674b5255acSdanielk1977 static void exprSetHeight(Expr *p){
5684b5255acSdanielk1977   int nHeight = 0;
5694b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
5704b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
5716ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
5726ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
5732308ed38Sdrh   }else if( p->x.pList ){
5746ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
5752308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
5766ab3a2ecSdanielk1977   }
5774b5255acSdanielk1977   p->nHeight = nHeight + 1;
5784b5255acSdanielk1977 }
5794b5255acSdanielk1977 
5804b5255acSdanielk1977 /*
5814b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
5824b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
5834b5255acSdanielk1977 ** leave an error in pParse.
5842308ed38Sdrh **
5852308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
5862308ed38Sdrh ** Expr.flags.
5874b5255acSdanielk1977 */
5882308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
58974893a4cSdrh   if( pParse->nErr ) return;
5904b5255acSdanielk1977   exprSetHeight(p);
5917d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
5924b5255acSdanielk1977 }
5934b5255acSdanielk1977 
5944b5255acSdanielk1977 /*
5954b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
5964b5255acSdanielk1977 ** by the select statement passed as an argument.
5974b5255acSdanielk1977 */
5984b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
5994b5255acSdanielk1977   int nHeight = 0;
6004b5255acSdanielk1977   heightOfSelect(p, &nHeight);
6014b5255acSdanielk1977   return nHeight;
6024b5255acSdanielk1977 }
6032308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
6042308ed38Sdrh /*
6052308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
6062308ed38Sdrh ** Expr.flags.
6072308ed38Sdrh */
6082308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
6092308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
6102308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6112308ed38Sdrh   }
6122308ed38Sdrh }
6134b5255acSdanielk1977 #define exprSetHeight(y)
6144b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
6154b5255acSdanielk1977 
616be5c89acSdrh /*
617b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
618b7916a78Sdrh **
619a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
620b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
621b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
622a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
623b7916a78Sdrh **
624b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
625e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
626b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
627b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
628b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
62933e619fcSdrh **
63033e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
63133e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
63233e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
63333e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
63433e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
635a76b5dfcSdrh */
636b7916a78Sdrh Expr *sqlite3ExprAlloc(
637a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
63817435752Sdrh   int op,                 /* Expression opcode */
639b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
640b7916a78Sdrh   int dequote             /* True to dequote */
64117435752Sdrh ){
642a76b5dfcSdrh   Expr *pNew;
64333e619fcSdrh   int nExtra = 0;
644cf697396Sshane   int iValue = 0;
645b7916a78Sdrh 
646575fad65Sdrh   assert( db!=0 );
647b7916a78Sdrh   if( pToken ){
64833e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
64933e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
650b7916a78Sdrh       nExtra = pToken->n+1;
651d50ffc41Sdrh       assert( iValue>=0 );
65233e619fcSdrh     }
653a76b5dfcSdrh   }
654575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
655b7916a78Sdrh   if( pNew ){
656ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
6571bd10f8aSdrh     pNew->op = (u8)op;
658a58fdfb1Sdanielk1977     pNew->iAgg = -1;
659a76b5dfcSdrh     if( pToken ){
66033e619fcSdrh       if( nExtra==0 ){
66133e619fcSdrh         pNew->flags |= EP_IntValue;
66233e619fcSdrh         pNew->u.iValue = iValue;
66333e619fcSdrh       }else{
66433e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
665b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
666b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
66733e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
668244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
669244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
67033e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
671a34001c9Sdrh         }
672a34001c9Sdrh       }
67333e619fcSdrh     }
674b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
675b7916a78Sdrh     pNew->nHeight = 1;
676b7916a78Sdrh #endif
677a34001c9Sdrh   }
678a76b5dfcSdrh   return pNew;
679a76b5dfcSdrh }
680a76b5dfcSdrh 
681a76b5dfcSdrh /*
682b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
683b7916a78Sdrh ** already been dequoted.
684b7916a78Sdrh */
685b7916a78Sdrh Expr *sqlite3Expr(
686b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
687b7916a78Sdrh   int op,                 /* Expression opcode */
688b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
689b7916a78Sdrh ){
690b7916a78Sdrh   Token x;
691b7916a78Sdrh   x.z = zToken;
692b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
693b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
694b7916a78Sdrh }
695b7916a78Sdrh 
696b7916a78Sdrh /*
697b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
698b7916a78Sdrh **
699b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
700b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
701b7916a78Sdrh */
702b7916a78Sdrh void sqlite3ExprAttachSubtrees(
703b7916a78Sdrh   sqlite3 *db,
704b7916a78Sdrh   Expr *pRoot,
705b7916a78Sdrh   Expr *pLeft,
706b7916a78Sdrh   Expr *pRight
707b7916a78Sdrh ){
708b7916a78Sdrh   if( pRoot==0 ){
709b7916a78Sdrh     assert( db->mallocFailed );
710b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
711b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
712b7916a78Sdrh   }else{
713b7916a78Sdrh     if( pRight ){
714b7916a78Sdrh       pRoot->pRight = pRight;
715885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
716b7916a78Sdrh     }
717b7916a78Sdrh     if( pLeft ){
718b7916a78Sdrh       pRoot->pLeft = pLeft;
719885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
720b7916a78Sdrh     }
721b7916a78Sdrh     exprSetHeight(pRoot);
722b7916a78Sdrh   }
723b7916a78Sdrh }
724b7916a78Sdrh 
725b7916a78Sdrh /*
72660ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
727b7916a78Sdrh **
728bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
729bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
730bf664469Sdrh ** free the subtrees and return NULL.
731206f3d96Sdrh */
73217435752Sdrh Expr *sqlite3PExpr(
73317435752Sdrh   Parse *pParse,          /* Parsing context */
73417435752Sdrh   int op,                 /* Expression opcode */
73517435752Sdrh   Expr *pLeft,            /* Left operand */
73617435752Sdrh   Expr *pRight,           /* Right operand */
73717435752Sdrh   const Token *pToken     /* Argument token */
73817435752Sdrh ){
7395fb52caaSdrh   Expr *p;
7401167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
7415fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
7425fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
7435fb52caaSdrh   }else{
7441167d327Sdrh     p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
745b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
7465fb52caaSdrh   }
7472b359bdbSdan   if( p ) {
7482b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
7492b359bdbSdan   }
7504e0cff60Sdrh   return p;
7514e0cff60Sdrh }
7524e0cff60Sdrh 
7534e0cff60Sdrh /*
75408de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
75508de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
75608de4f79Sdrh */
75708de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
75808de4f79Sdrh   if( pExpr ){
75908de4f79Sdrh     pExpr->x.pSelect = pSelect;
76008de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
76108de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
76208de4f79Sdrh   }else{
76308de4f79Sdrh     assert( pParse->db->mallocFailed );
76408de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
76508de4f79Sdrh   }
76608de4f79Sdrh }
76708de4f79Sdrh 
76808de4f79Sdrh 
76908de4f79Sdrh /*
770991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
771991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
772991a1985Sdrh ** expression at compile-time return 0.
773991a1985Sdrh **
774991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
775991a1985Sdrh ** the expression really is always false or false (a false negative).
776991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
777991a1985Sdrh ** boolean values in different circumstances (a false positive.)
7785fb52caaSdrh **
7795fb52caaSdrh ** Note that if the expression is part of conditional for a
7805fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
7815fb52caaSdrh ** is it true or false, so always return 0.
7825fb52caaSdrh */
783991a1985Sdrh static int exprAlwaysTrue(Expr *p){
784991a1985Sdrh   int v = 0;
785991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
786991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
787991a1985Sdrh   return v!=0;
788991a1985Sdrh }
7895fb52caaSdrh static int exprAlwaysFalse(Expr *p){
7905fb52caaSdrh   int v = 0;
7915fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
7925fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
7935fb52caaSdrh   return v==0;
7945fb52caaSdrh }
7955fb52caaSdrh 
7965fb52caaSdrh /*
79791bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
79891bb0eedSdrh ** NULL, then just return the other expression.
7995fb52caaSdrh **
8005fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8015fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8025fb52caaSdrh ** a value of false.
80391bb0eedSdrh */
8041e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
80591bb0eedSdrh   if( pLeft==0 ){
80691bb0eedSdrh     return pRight;
80791bb0eedSdrh   }else if( pRight==0 ){
80891bb0eedSdrh     return pLeft;
8095fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
8105fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
8115fb52caaSdrh     sqlite3ExprDelete(db, pRight);
8125fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
81391bb0eedSdrh   }else{
814b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
815b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
816b7916a78Sdrh     return pNew;
817a76b5dfcSdrh   }
818a76b5dfcSdrh }
819a76b5dfcSdrh 
820a76b5dfcSdrh /*
821a76b5dfcSdrh ** Construct a new expression node for a function with multiple
822a76b5dfcSdrh ** arguments.
823a76b5dfcSdrh */
82417435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
825a76b5dfcSdrh   Expr *pNew;
826633e6d57Sdrh   sqlite3 *db = pParse->db;
8274b202ae2Sdanielk1977   assert( pToken );
828b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
829a76b5dfcSdrh   if( pNew==0 ){
830d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
831a76b5dfcSdrh     return 0;
832a76b5dfcSdrh   }
8336ab3a2ecSdanielk1977   pNew->x.pList = pList;
8346ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
8352308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
836a76b5dfcSdrh   return pNew;
837a76b5dfcSdrh }
838a76b5dfcSdrh 
839a76b5dfcSdrh /*
840fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
841fa6bc000Sdrh ** in the original SQL statement.
842fa6bc000Sdrh **
843fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
844fa6bc000Sdrh ** variable number.
845fa6bc000Sdrh **
846fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
847fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
848fa6bc000Sdrh ** the SQL statement comes from an external source.
849fa6bc000Sdrh **
85051f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
851fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
85260ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
853fa6bc000Sdrh ** assigned.
854fa6bc000Sdrh */
855fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
85617435752Sdrh   sqlite3 *db = pParse->db;
857b7916a78Sdrh   const char *z;
85817435752Sdrh 
859fa6bc000Sdrh   if( pExpr==0 ) return;
860c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
86133e619fcSdrh   z = pExpr->u.zToken;
862b7916a78Sdrh   assert( z!=0 );
863b7916a78Sdrh   assert( z[0]!=0 );
864b7916a78Sdrh   if( z[1]==0 ){
865fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
866b7916a78Sdrh     assert( z[0]=='?' );
8678677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
868124c0b49Sdrh   }else{
869124c0b49Sdrh     ynVar x = 0;
870124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
871124c0b49Sdrh     if( z[0]=='?' ){
872fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
873fa6bc000Sdrh       ** use it as the variable number */
874c8d735aeSdan       i64 i;
875124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
876124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
877c5499befSdrh       testcase( i==0 );
878c5499befSdrh       testcase( i==1 );
879c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
880c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
881c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
882fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
883bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
884124c0b49Sdrh         x = 0;
885fa6bc000Sdrh       }
886fa6bc000Sdrh       if( i>pParse->nVar ){
8871df2db7fSshaneh         pParse->nVar = (int)i;
888fa6bc000Sdrh       }
889fa6bc000Sdrh     }else{
89051f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
891fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
892fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
893fa6bc000Sdrh       */
894124c0b49Sdrh       ynVar i;
895124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
896503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
897124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
898fa6bc000Sdrh           break;
899fa6bc000Sdrh         }
900fa6bc000Sdrh       }
901124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
902fa6bc000Sdrh     }
903124c0b49Sdrh     if( x>0 ){
904124c0b49Sdrh       if( x>pParse->nzVar ){
905124c0b49Sdrh         char **a;
906124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
9074a642b60Sdrh         if( a==0 ){
9084a642b60Sdrh           assert( db->mallocFailed ); /* Error reported through mallocFailed */
9094a642b60Sdrh           return;
9104a642b60Sdrh         }
911124c0b49Sdrh         pParse->azVar = a;
912124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
913124c0b49Sdrh         pParse->nzVar = x;
914124c0b49Sdrh       }
915124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
916124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
917124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
918fa6bc000Sdrh       }
919fa6bc000Sdrh     }
920fa6bc000Sdrh   }
921bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
922832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
923832b2664Sdanielk1977   }
924fa6bc000Sdrh }
925fa6bc000Sdrh 
926fa6bc000Sdrh /*
927f6963f99Sdan ** Recursively delete an expression tree.
928a2e00042Sdrh */
9294f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
9304f0010b1Sdrh   assert( p!=0 );
931d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
932d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
933c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
934c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
935c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
93671c57db0Sdan     if( p->op!=TK_SELECT_COLUMN ) sqlite3ExprDelete(db, p->pLeft);
937633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
938c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
9396ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
9406ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
9416ab3a2ecSdanielk1977     }else{
9426ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
9436ab3a2ecSdanielk1977     }
9446ab3a2ecSdanielk1977   }
94533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
946633e6d57Sdrh     sqlite3DbFree(db, p);
947a2e00042Sdrh   }
94833e619fcSdrh }
9494f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
9504f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
9514f0010b1Sdrh }
952a2e00042Sdrh 
953d2687b77Sdrh /*
9546ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
9556ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
9566ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
9576ab3a2ecSdanielk1977 */
9586ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
9596ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
9606ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
9616ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
9626ab3a2ecSdanielk1977 }
9636ab3a2ecSdanielk1977 
9646ab3a2ecSdanielk1977 /*
96533e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
96633e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
96733e619fcSdrh ** how much of the tree is measured.
96833e619fcSdrh **
96933e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
97033e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
97133e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
97233e619fcSdrh **
97333e619fcSdrh ***************************************************************************
97433e619fcSdrh **
97533e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
97633e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
97733e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
97833e619fcSdrh ** The return values is always one of:
97933e619fcSdrh **
98033e619fcSdrh **      EXPR_FULLSIZE
98133e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
98233e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
98333e619fcSdrh **
98433e619fcSdrh ** The size of the structure can be found by masking the return value
98533e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
98633e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
98733e619fcSdrh **
98833e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
98933e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
99033e619fcSdrh ** During expression analysis, extra information is computed and moved into
99133e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
99233e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
99360ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
99433e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
99533e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
99633e619fcSdrh ** to enforce this constraint.
9976ab3a2ecSdanielk1977 */
9986ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
9996ab3a2ecSdanielk1977   int nSize;
100033e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1001aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1002aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
10033c19469cSdrh   if( 0==flags ){
10046ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
10056ab3a2ecSdanielk1977   }else{
1006c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
100733e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1008c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1009ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1010aecd8021Sdrh     if( p->pLeft || p->x.pList ){
101133e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
101233e619fcSdrh     }else{
1013aecd8021Sdrh       assert( p->pRight==0 );
101433e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
101533e619fcSdrh     }
10166ab3a2ecSdanielk1977   }
10176ab3a2ecSdanielk1977   return nSize;
10186ab3a2ecSdanielk1977 }
10196ab3a2ecSdanielk1977 
10206ab3a2ecSdanielk1977 /*
102133e619fcSdrh ** This function returns the space in bytes required to store the copy
102233e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
102333e619fcSdrh ** string is defined.)
10246ab3a2ecSdanielk1977 */
10256ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
102633e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
102733e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
102833e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
10296ab3a2ecSdanielk1977   }
1030bc73971dSdanielk1977   return ROUND8(nByte);
10316ab3a2ecSdanielk1977 }
10326ab3a2ecSdanielk1977 
10336ab3a2ecSdanielk1977 /*
10346ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
10356ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
10366ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
10376ab3a2ecSdanielk1977 **
10386ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
103933e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
10406ab3a2ecSdanielk1977 **
10416ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
10426ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
10436ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
10446ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
10456ab3a2ecSdanielk1977 */
10466ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
10476ab3a2ecSdanielk1977   int nByte = 0;
10486ab3a2ecSdanielk1977   if( p ){
10496ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
10506ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1051b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
10526ab3a2ecSdanielk1977     }
10536ab3a2ecSdanielk1977   }
10546ab3a2ecSdanielk1977   return nByte;
10556ab3a2ecSdanielk1977 }
10566ab3a2ecSdanielk1977 
10576ab3a2ecSdanielk1977 /*
10586ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
10596ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
106033e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
10616ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
106260ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
10636ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
10646ab3a2ecSdanielk1977 */
10653c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
10663c19469cSdrh   Expr *pNew;           /* Value to return */
10673c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
10683c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
10696ab3a2ecSdanielk1977 
10703c19469cSdrh   assert( db!=0 );
10713c19469cSdrh   assert( p );
10723c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
10733c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
10746ab3a2ecSdanielk1977 
10756ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
10766ab3a2ecSdanielk1977   if( pzBuffer ){
10776ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
107833e619fcSdrh     staticFlag = EP_Static;
10796ab3a2ecSdanielk1977   }else{
10803c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
10813c19469cSdrh     staticFlag = 0;
10826ab3a2ecSdanielk1977   }
10836ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
10846ab3a2ecSdanielk1977 
10856ab3a2ecSdanielk1977   if( pNew ){
10866ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
10876ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
10886ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
108933e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
10906ab3a2ecSdanielk1977     */
10913c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
109233e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
109333e619fcSdrh     int nToken;
109433e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
109533e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
109633e619fcSdrh     }else{
109733e619fcSdrh       nToken = 0;
109833e619fcSdrh     }
10993c19469cSdrh     if( dupFlags ){
11006ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
11016ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
11026ab3a2ecSdanielk1977     }else{
11033e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
11046ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
110572ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
11066ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
11076ab3a2ecSdanielk1977       }
110872ea29d7Sdrh     }
11096ab3a2ecSdanielk1977 
111033e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1111c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
111233e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
111333e619fcSdrh     pNew->flags |= staticFlag;
11146ab3a2ecSdanielk1977 
111533e619fcSdrh     /* Copy the p->u.zToken string, if any. */
11166ab3a2ecSdanielk1977     if( nToken ){
111733e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
111833e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
11196ab3a2ecSdanielk1977     }
11206ab3a2ecSdanielk1977 
11216ab3a2ecSdanielk1977     if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
11226ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
11236ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
11243c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
11256ab3a2ecSdanielk1977       }else{
11263c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
11276ab3a2ecSdanielk1977       }
11286ab3a2ecSdanielk1977     }
11296ab3a2ecSdanielk1977 
11306ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1131c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
11323c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
11336ab3a2ecSdanielk1977       if( ExprHasProperty(pNew, EP_Reduced) ){
11343c19469cSdrh         pNew->pLeft = p->pLeft ?
11353c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
11363c19469cSdrh         pNew->pRight = p->pRight ?
11373c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
11386ab3a2ecSdanielk1977       }
11396ab3a2ecSdanielk1977       if( pzBuffer ){
11406ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
11416ab3a2ecSdanielk1977       }
1142b7916a78Sdrh     }else{
1143c5cd1249Sdrh       if( !ExprHasProperty(p, EP_TokenOnly) ){
11446ab3a2ecSdanielk1977         pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
11456ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
11466ab3a2ecSdanielk1977       }
11476ab3a2ecSdanielk1977     }
11486ab3a2ecSdanielk1977   }
11496ab3a2ecSdanielk1977   return pNew;
11506ab3a2ecSdanielk1977 }
11516ab3a2ecSdanielk1977 
11526ab3a2ecSdanielk1977 /*
1153bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1154bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1155bfe31e7fSdan ** and the db->mallocFailed flag set.
1156bfe31e7fSdan */
1157eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1158bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
11594e9119d9Sdan   With *pRet = 0;
11604e9119d9Sdan   if( p ){
11614e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
11624e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
11634e9119d9Sdan     if( pRet ){
11644e9119d9Sdan       int i;
11654e9119d9Sdan       pRet->nCte = p->nCte;
11664e9119d9Sdan       for(i=0; i<p->nCte; i++){
11674e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
11684e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
11694e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
11704e9119d9Sdan       }
11714e9119d9Sdan     }
11724e9119d9Sdan   }
11734e9119d9Sdan   return pRet;
11744e9119d9Sdan }
1175eede6a53Sdan #else
1176eede6a53Sdan # define withDup(x,y) 0
1177eede6a53Sdan #endif
11784e9119d9Sdan 
1179a76b5dfcSdrh /*
1180ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1181ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1182ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1183ff78bd2fSdrh ** without effecting the originals.
1184ff78bd2fSdrh **
11854adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
11864adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1187ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1188ff78bd2fSdrh **
1189ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
11906ab3a2ecSdanielk1977 **
1191b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
11926ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
11936ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
11946ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1195ff78bd2fSdrh */
11966ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
119772ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
11983c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1199ff78bd2fSdrh }
12006ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1201ff78bd2fSdrh   ExprList *pNew;
1202145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1203ff78bd2fSdrh   int i;
1204575fad65Sdrh   assert( db!=0 );
1205ff78bd2fSdrh   if( p==0 ) return 0;
1206575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1207ff78bd2fSdrh   if( pNew==0 ) return 0;
1208d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
1209d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1210575fad65Sdrh   pNew->a = pItem = sqlite3DbMallocRawNN(db,  i*sizeof(p->a[0]) );
1211e0048400Sdanielk1977   if( pItem==0 ){
1212633e6d57Sdrh     sqlite3DbFree(db, pNew);
1213e0048400Sdanielk1977     return 0;
1214e0048400Sdanielk1977   }
1215145716b3Sdrh   pOldItem = p->a;
1216145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
12176ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1218b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
121917435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1220b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1221145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
12223e7bc9caSdrh     pItem->done = 0;
12232c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1224c2acc4e4Sdrh     pItem->u = pOldItem->u;
1225ff78bd2fSdrh   }
1226ff78bd2fSdrh   return pNew;
1227ff78bd2fSdrh }
122893758c8dSdanielk1977 
122993758c8dSdanielk1977 /*
123093758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
123193758c8dSdanielk1977 ** the build, then none of the following routines, except for
123293758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
123393758c8dSdanielk1977 ** called with a NULL argument.
123493758c8dSdanielk1977 */
12356a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
12366a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
12376ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1238ad3cab52Sdrh   SrcList *pNew;
1239ad3cab52Sdrh   int i;
1240113088ecSdrh   int nByte;
1241575fad65Sdrh   assert( db!=0 );
1242ad3cab52Sdrh   if( p==0 ) return 0;
1243113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1244575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1245ad3cab52Sdrh   if( pNew==0 ) return 0;
12464305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1247ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
12484efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
12494efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1250ed8a3bb1Sdrh     Table *pTab;
125141fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
125217435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
125317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
125417435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
12558a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
12564efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
12575b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
12585b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
12598a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
12608a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
12618a48b9c0Sdrh     }
12628a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
12638a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
12648a48b9c0Sdrh       pNewItem->u1.pFuncArg =
12658a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
12668a48b9c0Sdrh     }
1267ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1268ed8a3bb1Sdrh     if( pTab ){
1269ed8a3bb1Sdrh       pTab->nRef++;
1270a1cb183dSdanielk1977     }
12716ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
12726ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
127317435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
12746c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1275ad3cab52Sdrh   }
1276ad3cab52Sdrh   return pNew;
1277ad3cab52Sdrh }
127817435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1279ff78bd2fSdrh   IdList *pNew;
1280ff78bd2fSdrh   int i;
1281575fad65Sdrh   assert( db!=0 );
1282ff78bd2fSdrh   if( p==0 ) return 0;
1283575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1284ff78bd2fSdrh   if( pNew==0 ) return 0;
12856c535158Sdrh   pNew->nId = p->nId;
1286575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1287d5d56523Sdanielk1977   if( pNew->a==0 ){
1288633e6d57Sdrh     sqlite3DbFree(db, pNew);
1289d5d56523Sdanielk1977     return 0;
1290d5d56523Sdanielk1977   }
12916c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
12926c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
12936c535158Sdrh   ** on the duplicate created by this function. */
1294ff78bd2fSdrh   for(i=0; i<p->nId; i++){
12954efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
12964efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
129717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
12984efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1299ff78bd2fSdrh   }
1300ff78bd2fSdrh   return pNew;
1301ff78bd2fSdrh }
13026ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
130323b1b372Sdrh   Select *pNew, *pPrior;
1304575fad65Sdrh   assert( db!=0 );
1305ff78bd2fSdrh   if( p==0 ) return 0;
1306575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1307ff78bd2fSdrh   if( pNew==0 ) return 0;
1308b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
13096ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
13106ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
13116ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
13126ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
13136ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1314ff78bd2fSdrh   pNew->op = p->op;
131523b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
131623b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
131723b1b372Sdrh   pNew->pNext = 0;
13186ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
13196ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
132092b01d53Sdrh   pNew->iLimit = 0;
132192b01d53Sdrh   pNew->iOffset = 0;
13227d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1323b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1324b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1325ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
13264e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1327eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1328ff78bd2fSdrh   return pNew;
1329ff78bd2fSdrh }
133093758c8dSdanielk1977 #else
13316ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
133293758c8dSdanielk1977   assert( p==0 );
133393758c8dSdanielk1977   return 0;
133493758c8dSdanielk1977 }
133593758c8dSdanielk1977 #endif
1336ff78bd2fSdrh 
1337ff78bd2fSdrh 
1338ff78bd2fSdrh /*
1339a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1340a76b5dfcSdrh ** initially NULL, then create a new expression list.
1341b7916a78Sdrh **
1342b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1343b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1344b7916a78Sdrh ** that the new entry was successfully appended.
1345a76b5dfcSdrh */
134617435752Sdrh ExprList *sqlite3ExprListAppend(
134717435752Sdrh   Parse *pParse,          /* Parsing context */
134817435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1349b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
135017435752Sdrh ){
135117435752Sdrh   sqlite3 *db = pParse->db;
1352575fad65Sdrh   assert( db!=0 );
1353a76b5dfcSdrh   if( pList==0 ){
1354575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1355a76b5dfcSdrh     if( pList==0 ){
1356d5d56523Sdanielk1977       goto no_mem;
1357a76b5dfcSdrh     }
1358c263f7c4Sdrh     pList->nExpr = 0;
1359575fad65Sdrh     pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
1360d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1361d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1362d5d56523Sdanielk1977     struct ExprList_item *a;
1363d872bb18Sdrh     assert( pList->nExpr>0 );
1364d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1365d5d56523Sdanielk1977     if( a==0 ){
1366d5d56523Sdanielk1977       goto no_mem;
1367a76b5dfcSdrh     }
1368d5d56523Sdanielk1977     pList->a = a;
1369a76b5dfcSdrh   }
13704efc4754Sdrh   assert( pList->a!=0 );
1371b7916a78Sdrh   if( 1 ){
13724efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
13734efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1374e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1375a76b5dfcSdrh   }
1376a76b5dfcSdrh   return pList;
1377d5d56523Sdanielk1977 
1378d5d56523Sdanielk1977 no_mem:
1379d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1380633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1381633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1382d5d56523Sdanielk1977   return 0;
1383a76b5dfcSdrh }
1384a76b5dfcSdrh 
1385a76b5dfcSdrh /*
1386bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1387bc622bc0Sdrh */
1388bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1389bc622bc0Sdrh   if( p==0 ) return;
1390bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1391bc622bc0Sdrh   assert( p->nExpr>0 );
1392bc622bc0Sdrh   if( iSortOrder<0 ){
1393bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1394bc622bc0Sdrh     return;
1395bc622bc0Sdrh   }
1396bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1397bc622bc0Sdrh }
1398bc622bc0Sdrh 
1399bc622bc0Sdrh /*
1400b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1401b7916a78Sdrh ** on the expression list.
1402b7916a78Sdrh **
1403b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1404b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1405b7916a78Sdrh ** is set.
1406b7916a78Sdrh */
1407b7916a78Sdrh void sqlite3ExprListSetName(
1408b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1409b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1410b7916a78Sdrh   Token *pName,           /* Name to be added */
1411b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1412b7916a78Sdrh ){
1413b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1414b7916a78Sdrh   if( pList ){
1415b7916a78Sdrh     struct ExprList_item *pItem;
1416b7916a78Sdrh     assert( pList->nExpr>0 );
1417b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1418b7916a78Sdrh     assert( pItem->zName==0 );
1419b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1420244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1421b7916a78Sdrh   }
1422b7916a78Sdrh }
1423b7916a78Sdrh 
1424b7916a78Sdrh /*
1425b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1426b7916a78Sdrh ** on the expression list.
1427b7916a78Sdrh **
1428b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1429b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1430b7916a78Sdrh ** is set.
1431b7916a78Sdrh */
1432b7916a78Sdrh void sqlite3ExprListSetSpan(
1433b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1434b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1435b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1436b7916a78Sdrh ){
1437b7916a78Sdrh   sqlite3 *db = pParse->db;
1438b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1439b7916a78Sdrh   if( pList ){
1440b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1441b7916a78Sdrh     assert( pList->nExpr>0 );
1442b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1443b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1444b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1445cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1446b7916a78Sdrh   }
1447b7916a78Sdrh }
1448b7916a78Sdrh 
1449b7916a78Sdrh /*
14507a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
14517a15a4beSdanielk1977 ** leave an error message in pParse.
14527a15a4beSdanielk1977 */
14537a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
14547a15a4beSdanielk1977   Parse *pParse,
14557a15a4beSdanielk1977   ExprList *pEList,
14567a15a4beSdanielk1977   const char *zObject
14577a15a4beSdanielk1977 ){
1458b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1459c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1460c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1461b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
14627a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
14637a15a4beSdanielk1977   }
14647a15a4beSdanielk1977 }
14657a15a4beSdanielk1977 
14667a15a4beSdanielk1977 /*
1467a76b5dfcSdrh ** Delete an entire expression list.
1468a76b5dfcSdrh */
1469affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1470a76b5dfcSdrh   int i;
1471be5c89acSdrh   struct ExprList_item *pItem;
1472d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1473be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1474633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1475633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1476b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1477a76b5dfcSdrh   }
1478633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1479633e6d57Sdrh   sqlite3DbFree(db, pList);
1480a76b5dfcSdrh }
1481affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1482affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1483affa855cSdrh }
1484a76b5dfcSdrh 
1485a76b5dfcSdrh /*
14862308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
14872308ed38Sdrh ** ExprList.
1488885a5b03Sdrh */
14892308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1490885a5b03Sdrh   int i;
14912308ed38Sdrh   u32 m = 0;
14922308ed38Sdrh   if( pList ){
1493885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1494d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1495de845c2fSdrh        assert( pExpr!=0 );
1496de845c2fSdrh        m |= pExpr->flags;
1497885a5b03Sdrh     }
14982308ed38Sdrh   }
14992308ed38Sdrh   return m;
1500885a5b03Sdrh }
1501885a5b03Sdrh 
1502885a5b03Sdrh /*
1503059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1504059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1505059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1506059b2d50Sdrh ** for.
150773b211abSdrh **
15087d10d5a6Sdrh ** These callback routines are used to implement the following:
1509626a879aSdrh **
1510059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1511059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1512fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1513059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
151487abf5c0Sdrh **
1515059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1516059b2d50Sdrh ** is found to not be a constant.
151787abf5c0Sdrh **
1518feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1519059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1520059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1521feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1522feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1523feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1524feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1525feada2dfSdrh ** malformed schema error.
1526626a879aSdrh */
15277d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1528626a879aSdrh 
1529059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1530059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
15310a168377Sdrh   ** from being considered constant. */
1532059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1533059b2d50Sdrh     pWalker->eCode = 0;
15347d10d5a6Sdrh     return WRC_Abort;
15350a168377Sdrh   }
15360a168377Sdrh 
1537626a879aSdrh   switch( pExpr->op ){
1538eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1539059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1540059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1541eb55bd2fSdrh     case TK_FUNCTION:
154263f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1543b1fba286Sdrh         return WRC_Continue;
1544059b2d50Sdrh       }else{
1545059b2d50Sdrh         pWalker->eCode = 0;
1546059b2d50Sdrh         return WRC_Abort;
1547b1fba286Sdrh       }
1548626a879aSdrh     case TK_ID:
1549626a879aSdrh     case TK_COLUMN:
1550626a879aSdrh     case TK_AGG_FUNCTION:
155113449892Sdrh     case TK_AGG_COLUMN:
1552c5499befSdrh       testcase( pExpr->op==TK_ID );
1553c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1554c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1555c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1556059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1557059b2d50Sdrh         return WRC_Continue;
1558059b2d50Sdrh       }else{
1559059b2d50Sdrh         pWalker->eCode = 0;
15607d10d5a6Sdrh         return WRC_Abort;
1561059b2d50Sdrh       }
1562feada2dfSdrh     case TK_VARIABLE:
1563059b2d50Sdrh       if( pWalker->eCode==5 ){
1564feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1565feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1566feada2dfSdrh         ** of the sqlite_master table */
1567feada2dfSdrh         pExpr->op = TK_NULL;
1568059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1569feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1570feada2dfSdrh         ** sqlite3_prepare() causes an error */
1571059b2d50Sdrh         pWalker->eCode = 0;
1572feada2dfSdrh         return WRC_Abort;
1573feada2dfSdrh       }
1574feada2dfSdrh       /* Fall through */
1575626a879aSdrh     default:
1576b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1577b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
15787d10d5a6Sdrh       return WRC_Continue;
1579626a879aSdrh   }
1580626a879aSdrh }
158162c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
158262c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1583059b2d50Sdrh   pWalker->eCode = 0;
15847d10d5a6Sdrh   return WRC_Abort;
15857d10d5a6Sdrh }
1586059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
15877d10d5a6Sdrh   Walker w;
1588aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1589059b2d50Sdrh   w.eCode = initFlag;
15907d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
15917d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1592059b2d50Sdrh   w.u.iCur = iCur;
15937d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1594059b2d50Sdrh   return w.eCode;
15957d10d5a6Sdrh }
1596626a879aSdrh 
1597626a879aSdrh /*
1598059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1599eb55bd2fSdrh ** and 0 if it involves variables or function calls.
16002398937bSdrh **
16012398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
16022398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
16032398937bSdrh ** a constant.
1604fef5208cSdrh */
16054adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1606059b2d50Sdrh   return exprIsConst(p, 1, 0);
1607fef5208cSdrh }
1608fef5208cSdrh 
1609fef5208cSdrh /*
1610059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
16110a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
16120a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
16130a168377Sdrh ** an ON or USING clause.
16140a168377Sdrh */
16150a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1616059b2d50Sdrh   return exprIsConst(p, 2, 0);
16170a168377Sdrh }
16180a168377Sdrh 
16190a168377Sdrh /*
1620fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1621059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1622059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1623059b2d50Sdrh ** table other than iCur.
1624059b2d50Sdrh */
1625059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1626059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1627059b2d50Sdrh }
1628059b2d50Sdrh 
1629059b2d50Sdrh /*
1630059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1631eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1632eb55bd2fSdrh ** are any variables.
1633eb55bd2fSdrh **
1634eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1635eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1636eb55bd2fSdrh ** a constant.
1637eb55bd2fSdrh */
1638feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1639feada2dfSdrh   assert( isInit==0 || isInit==1 );
1640059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1641eb55bd2fSdrh }
1642eb55bd2fSdrh 
16435b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
16445b88bc4bSdrh /*
16455b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
16465b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
16475b88bc4bSdrh */
16485b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
16495b88bc4bSdrh   Walker w;
16505b88bc4bSdrh   memset(&w, 0, sizeof(w));
1651bec2476aSdrh   w.eCode = 1;
16525b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
16535b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
16545b88bc4bSdrh   sqlite3WalkExpr(&w, p);
165507194bffSdrh   return w.eCode==0;
16565b88bc4bSdrh }
16575b88bc4bSdrh #endif
16585b88bc4bSdrh 
1659eb55bd2fSdrh /*
166073b211abSdrh ** If the expression p codes a constant integer that is small enough
1661202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1662202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1663202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1664e4de1febSdrh */
16654adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
166692b01d53Sdrh   int rc = 0;
1667cd92e84dSdrh 
1668cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1669cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1670cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1671cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1672cd92e84dSdrh 
167392b01d53Sdrh   if( p->flags & EP_IntValue ){
167433e619fcSdrh     *pValue = p->u.iValue;
1675e4de1febSdrh     return 1;
1676e4de1febSdrh   }
167792b01d53Sdrh   switch( p->op ){
16784b59ab5eSdrh     case TK_UPLUS: {
167992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1680f6e369a1Sdrh       break;
16814b59ab5eSdrh     }
1682e4de1febSdrh     case TK_UMINUS: {
1683e4de1febSdrh       int v;
16844adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1685f6418891Smistachkin         assert( v!=(-2147483647-1) );
1686e4de1febSdrh         *pValue = -v;
168792b01d53Sdrh         rc = 1;
1688e4de1febSdrh       }
1689e4de1febSdrh       break;
1690e4de1febSdrh     }
1691e4de1febSdrh     default: break;
1692e4de1febSdrh   }
169392b01d53Sdrh   return rc;
1694e4de1febSdrh }
1695e4de1febSdrh 
1696e4de1febSdrh /*
1697039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1698039fc32eSdrh **
1699039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1700039fc32eSdrh ** to tell return TRUE.
1701039fc32eSdrh **
1702039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1703039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1704039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1705039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1706039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1707039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1708039fc32eSdrh ** TRUE.
1709039fc32eSdrh */
1710039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1711039fc32eSdrh   u8 op;
1712cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1713039fc32eSdrh   op = p->op;
1714039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1715039fc32eSdrh   switch( op ){
1716039fc32eSdrh     case TK_INTEGER:
1717039fc32eSdrh     case TK_STRING:
1718039fc32eSdrh     case TK_FLOAT:
1719039fc32eSdrh     case TK_BLOB:
1720039fc32eSdrh       return 0;
17217248a8b2Sdrh     case TK_COLUMN:
17227248a8b2Sdrh       assert( p->pTab!=0 );
172372673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
172472673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1725039fc32eSdrh     default:
1726039fc32eSdrh       return 1;
1727039fc32eSdrh   }
1728039fc32eSdrh }
1729039fc32eSdrh 
1730039fc32eSdrh /*
1731039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1732039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1733039fc32eSdrh ** argument.
1734039fc32eSdrh **
1735039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1736039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1737039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1738039fc32eSdrh ** answer.
1739039fc32eSdrh */
1740039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1741039fc32eSdrh   u8 op;
174205883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1743cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1744039fc32eSdrh   op = p->op;
1745039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1746039fc32eSdrh   switch( op ){
1747039fc32eSdrh     case TK_INTEGER: {
1748039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1749039fc32eSdrh     }
1750039fc32eSdrh     case TK_FLOAT: {
1751039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1752039fc32eSdrh     }
1753039fc32eSdrh     case TK_STRING: {
1754039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1755039fc32eSdrh     }
1756039fc32eSdrh     case TK_BLOB: {
1757039fc32eSdrh       return 1;
1758039fc32eSdrh     }
17592f2855b6Sdrh     case TK_COLUMN: {
176088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
176188376ca7Sdrh       return p->iColumn<0
17622f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
17632f2855b6Sdrh     }
1764039fc32eSdrh     default: {
1765039fc32eSdrh       return 0;
1766039fc32eSdrh     }
1767039fc32eSdrh   }
1768039fc32eSdrh }
1769039fc32eSdrh 
1770039fc32eSdrh /*
1771c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1772c4a3c779Sdrh */
17734adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
17744adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
17754adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
17764adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1777c4a3c779Sdrh   return 0;
1778c4a3c779Sdrh }
1779c4a3c779Sdrh 
17809a96b668Sdanielk1977 /*
178169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
178269c355bdSdrh ** that can be simplified to a direct table access, then return
178369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
178469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
178569c355bdSdrh ** table, then return NULL.
1786b287f4b6Sdrh */
1787b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
17887b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
178969c355bdSdrh   Select *p;
1790b287f4b6Sdrh   SrcList *pSrc;
1791b287f4b6Sdrh   ExprList *pEList;
1792b287f4b6Sdrh   Table *pTab;
1793cfbb5e82Sdan   int i;
179469c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
179569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
179669c355bdSdrh   p = pX->x.pSelect;
1797b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
17987d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1799b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1800b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
18017d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
18027d10d5a6Sdrh   }
1803b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1804b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1805b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1806b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1807b287f4b6Sdrh   pSrc = p->pSrc;
1808d1fa7bcaSdrh   assert( pSrc!=0 );
1809d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1810b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1811b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
181269c355bdSdrh   assert( pTab!=0 );
1813b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1814b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1815b287f4b6Sdrh   pEList = p->pEList;
1816cfbb5e82Sdan 
18177b35a77bSdan   /* All SELECT results must be columns. */
1818cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
1819cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
1820cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
182169c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
1822cfbb5e82Sdan   }
182369c355bdSdrh   return p;
1824b287f4b6Sdrh }
1825b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1826b287f4b6Sdrh 
1827b287f4b6Sdrh /*
18281d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
18291d8cb21fSdan ** address of the new instruction.
18301d8cb21fSdan */
18311d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
18321d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
18331d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
18341d8cb21fSdan }
18351d8cb21fSdan 
1836f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
18371d8cb21fSdan /*
18384c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
18394c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
18406be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
18416be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
18426be515ebSdrh */
18436be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
1844728e0f91Sdrh   int addr1;
18456be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
1846728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
18476be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
18486be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
18494c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
1850728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
18516be515ebSdrh }
1852f9b2e05cSdan #endif
18536be515ebSdrh 
1854bb53ecb1Sdrh 
1855bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1856bb53ecb1Sdrh /*
1857bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
1858bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
1859bb53ecb1Sdrh */
1860bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
1861bb53ecb1Sdrh   Expr *pLHS;
1862bb53ecb1Sdrh   int res;
1863bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1864bb53ecb1Sdrh   pLHS = pIn->pLeft;
1865bb53ecb1Sdrh   pIn->pLeft = 0;
1866bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
1867bb53ecb1Sdrh   pIn->pLeft = pLHS;
1868bb53ecb1Sdrh   return res;
1869bb53ecb1Sdrh }
1870bb53ecb1Sdrh #endif
1871bb53ecb1Sdrh 
18726be515ebSdrh /*
18739a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1874d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1875d4305ca6Sdrh ** might be either a list of expressions or a subquery.
18769a96b668Sdanielk1977 **
1877d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1878d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1879d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1880d4305ca6Sdrh **
18813a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
1882d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1883d4305ca6Sdrh **
1884b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
18859a96b668Sdanielk1977 **
18869a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
18871ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
18881ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
18899a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
18909a96b668Sdanielk1977 **                         populated epheremal table.
1891bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
1892bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
18939a96b668Sdanielk1977 **
1894d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1895d4305ca6Sdrh ** subquery such as:
18969a96b668Sdanielk1977 **
1897553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
18989a96b668Sdanielk1977 **
1899d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1900d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
190160ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
1902d4305ca6Sdrh ** existing table.
1903d4305ca6Sdrh **
19043a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
19053a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
19063a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
19073a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
19083a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
19093a85625dSdrh ** IN operator.
19103a85625dSdrh **
19113a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
19123a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
1913553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
1914553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
1915553168c7Sdan ** a UNIQUE constraint or index.
19160cdc022eSdanielk1977 **
19173a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
19183a85625dSdrh ** for fast set membership tests) then an epheremal table must
1919553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
1920553168c7Sdan ** index can be found with the specified <columns> as its left-most.
19210cdc022eSdanielk1977 **
1922bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1923bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
1924bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
1925bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
1926bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
1927bb53ecb1Sdrh ** of Eq or Ne comparison operations.
1928bb53ecb1Sdrh **
1929b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
19303a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
1931e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
19323a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
19330cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1934e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
1935e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
19360cdc022eSdanielk1977 **
1937e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
19386be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
19396be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
19406be515ebSdrh ** NULL values.
1941553168c7Sdan **
1942553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
1943553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
1944553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
1945553168c7Sdan ** offset of the index column that matches the i'th column returned by the
1946553168c7Sdan ** SELECT. For example, if the expression and selected index are:
1947553168c7Sdan **
1948553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
1949553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
1950553168c7Sdan **
1951553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
19529a96b668Sdanielk1977 */
1953284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
1954ba00e30aSdan int sqlite3FindInIndex(
1955ba00e30aSdan   Parse *pParse,
1956ba00e30aSdan   Expr *pX,
1957ba00e30aSdan   u32 inFlags,
1958ba00e30aSdan   int *prRhsHasNull,
1959ba00e30aSdan   int *aiMap
1960ba00e30aSdan ){
1961b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1962b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1963b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
19643a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
1965b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
19669a96b668Sdanielk1977 
19671450bc6eSdrh   assert( pX->op==TK_IN );
19683a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
19691450bc6eSdrh 
19707b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
19717b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
1972870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
19737b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
1974870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
19757b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
19767b35a77bSdan     int i;
19777b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
19787b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
19797b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
19807b35a77bSdan     }
19817b35a77bSdan     if( i==pEList->nExpr ){
19827b35a77bSdan       prRhsHasNull = 0;
19837b35a77bSdan     }
19847b35a77bSdan   }
19857b35a77bSdan 
1986b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1987b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
19887b35a77bSdan   ** ephemeral table.  */
19897b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
1990e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1991b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1992ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
1993cfbb5e82Sdan     ExprList *pEList = p->pEList;
1994cfbb5e82Sdan     int nExpr = pEList->nExpr;
1995e1fb65a0Sdanielk1977 
1996b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1997b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1998b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1999b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2000b07028f7Sdrh 
2001b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2002e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2003e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2004e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
20059a96b668Sdanielk1977 
20069a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
20079a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
20089a96b668Sdanielk1977     ** successful here.
20099a96b668Sdanielk1977     */
20109a96b668Sdanielk1977     assert(v);
2011cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
20127d176105Sdrh       int iAddr = sqlite3CodeOnce(pParse);
20137d176105Sdrh       VdbeCoverage(v);
20149a96b668Sdanielk1977 
20159a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
20169a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
20179a96b668Sdanielk1977 
20189a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
20199a96b668Sdanielk1977     }else{
2020e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2021cfbb5e82Sdan       int affinity_ok = 1;
2022cfbb5e82Sdan       int i;
2023cfbb5e82Sdan 
2024cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
2025cfbb5e82Sdan       ** comparison is the same as the affinity of each column. If
2026cfbb5e82Sdan       ** it not, it is not possible to use any index.  */
2027cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2028d66e5794Sdan         Expr *pLhs = sqlite3ExprVectorField(pX->pLeft, i);
2029cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
2030cfbb5e82Sdan         char idxaff = pTab->aCol[iCol].affinity;
2031cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
2032cfbb5e82Sdan         switch( cmpaff ){
2033cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2034cfbb5e82Sdan             break;
2035cfbb5e82Sdan           case SQLITE_AFF_TEXT:
2036cfbb5e82Sdan             affinity_ok = (idxaff==SQLITE_AFF_TEXT);
2037cfbb5e82Sdan             break;
2038cfbb5e82Sdan           default:
2039cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2040cfbb5e82Sdan         }
2041cfbb5e82Sdan       }
2042e1fb65a0Sdanielk1977 
20439a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
20449a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
2045e1fb65a0Sdanielk1977       ** to this collation sequence.  */
20469a96b668Sdanielk1977 
20479a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
2048cfbb5e82Sdan         if( pIdx->nKeyCol<nExpr ) continue;
2049cfbb5e82Sdan         if( mustBeUnique && (pIdx->nKeyCol!=nExpr || !IsUniqueIndex(pIdx)) ){
2050cfbb5e82Sdan           continue;
2051cfbb5e82Sdan         }
2052cfbb5e82Sdan 
2053cfbb5e82Sdan         for(i=0; i<nExpr; i++){
2054d66e5794Sdan           Expr *pLhs = sqlite3ExprVectorField(pX->pLeft, i);
2055cfbb5e82Sdan           Expr *pRhs = pEList->a[i].pExpr;
2056cfbb5e82Sdan           CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2057cfbb5e82Sdan           int j;
2058cfbb5e82Sdan 
205917994e3bSdan           assert( pReq || pParse->nErr );
206017994e3bSdan           if( pReq==0 ) break;
206117994e3bSdan 
2062cfbb5e82Sdan           for(j=0; j<nExpr; j++){
2063cfbb5e82Sdan             if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2064cfbb5e82Sdan             assert( pIdx->azColl[j] );
2065cfbb5e82Sdan             if( sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ) continue;
2066cfbb5e82Sdan             break;
2067cfbb5e82Sdan           }
2068cfbb5e82Sdan           if( j==nExpr ) break;
2069ba00e30aSdan           if( aiMap ) aiMap[i] = j;
2070cfbb5e82Sdan         }
2071cfbb5e82Sdan 
2072cfbb5e82Sdan         if( i==nExpr ){
20737d176105Sdrh           int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
20742ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
20752ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2076207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
20771ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
20781ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
20799a96b668Sdanielk1977 
20807b35a77bSdan           if( prRhsHasNull ){
20817b35a77bSdan             *prRhsHasNull = ++pParse->nMem;
20823480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2083cfbb5e82Sdan             i64 mask = (1<<nExpr)-1;
20843480bfdaSdan             sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2085cfbb5e82Sdan                 iTab, 0, 0, (u8*)&mask, P4_INT64);
20863480bfdaSdan #endif
20877b35a77bSdan             if( nExpr==1 ){
20886be515ebSdrh               sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
20890cdc022eSdanielk1977             }
20907b35a77bSdan           }
2091552fd454Sdrh           sqlite3VdbeJumpHere(v, iAddr);
20929a96b668Sdanielk1977         }
20939a96b668Sdanielk1977       }
20949a96b668Sdanielk1977     }
20959a96b668Sdanielk1977   }
20969a96b668Sdanielk1977 
2097bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2098bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2099bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
210071c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
210160ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2102bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2103bb53ecb1Sdrh   */
2104bb53ecb1Sdrh   if( eType==0
2105bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2106bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2107bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2108bb53ecb1Sdrh   ){
2109bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2110bb53ecb1Sdrh   }
2111bb53ecb1Sdrh 
21129a96b668Sdanielk1977   if( eType==0 ){
21134387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2114b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2115b74b1017Sdrh     */
21168e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
21170cdc022eSdanielk1977     int rMayHaveNull = 0;
211841a05b7bSdanielk1977     eType = IN_INDEX_EPH;
21193a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
21204a5acf8eSdrh       pParse->nQueryLoop = 0;
2121c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
212241a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
21230cdc022eSdanielk1977       }
2124e21a6e1dSdrh     }else if( prRhsHasNull ){
2125e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2126cf4d38aaSdrh     }
212741a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2128cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
21299a96b668Sdanielk1977   }else{
21309a96b668Sdanielk1977     pX->iTable = iTab;
21319a96b668Sdanielk1977   }
2132ba00e30aSdan 
2133ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2134ba00e30aSdan     int i, n;
2135ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2136ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2137ba00e30aSdan   }
21389a96b668Sdanielk1977   return eType;
21399a96b668Sdanielk1977 }
2140284f4acaSdanielk1977 #endif
2141626a879aSdrh 
2142f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2143553168c7Sdan /*
2144553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2145553168c7Sdan ** function allocates and returns a nul-terminated string containing
2146553168c7Sdan ** the affinities to be used for each column of the comparison.
2147553168c7Sdan **
2148553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2149553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2150553168c7Sdan */
215171c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
215271c57db0Sdan   Expr *pLeft = pExpr->pLeft;
215371c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2154553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
215571c57db0Sdan   char *zRet;
215671c57db0Sdan 
2157553168c7Sdan   assert( pExpr->op==TK_IN );
215871c57db0Sdan   zRet = sqlite3DbMallocZero(pParse->db, nVal+1);
215971c57db0Sdan   if( zRet ){
216071c57db0Sdan     int i;
216171c57db0Sdan     for(i=0; i<nVal; i++){
2162d66e5794Sdan       Expr *pA = sqlite3ExprVectorField(pLeft, i);
2163553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2164553168c7Sdan       if( pSelect ){
2165553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
216671c57db0Sdan       }else{
2167553168c7Sdan         zRet[i] = a;
216871c57db0Sdan       }
216971c57db0Sdan     }
217071c57db0Sdan     zRet[nVal] = '\0';
217171c57db0Sdan   }
217271c57db0Sdan   return zRet;
217371c57db0Sdan }
2174f9b2e05cSdan #endif
217571c57db0Sdan 
21768da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
21778da209b1Sdan /*
21788da209b1Sdan ** Load the Parse object passed as the first argument with an error
21798da209b1Sdan ** message of the form:
21808da209b1Sdan **
21818da209b1Sdan **   "sub-select returns N columns - expected M"
21828da209b1Sdan */
21838da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
21848da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
21858da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
21868da209b1Sdan }
21878da209b1Sdan #endif
21888da209b1Sdan 
2189626a879aSdrh /*
2190d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2191d4187c71Sdrh ** or IN operators.  Examples:
2192626a879aSdrh **
21939cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
21949cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
21959cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
21969cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2197fef5208cSdrh **
21989cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
21999cbe6352Sdrh ** operator or subquery.
220041a05b7bSdanielk1977 **
220141a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
220241a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
220341a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
220441a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
220541a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2206fd773cf9Sdrh **
2207fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2208fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
22093a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
22103a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
22113a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
22121450bc6eSdrh **
22131450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
22141450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
2215cce7d176Sdrh */
221651522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22171450bc6eSdrh int sqlite3CodeSubselect(
2218fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2219fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
22206be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2221fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
222241a05b7bSdanielk1977 ){
22236be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
22241450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2225b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
22261450bc6eSdrh   if( NEVER(v==0) ) return 0;
2227ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2228fc976065Sdanielk1977 
222957dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
223057dbd7b3Sdrh   ** if any of the following is true:
223157dbd7b3Sdrh   **
223257dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
223357dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
223457dbd7b3Sdrh   **    *  We are inside a trigger
223557dbd7b3Sdrh   **
223657dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
223757dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2238b3bce662Sdanielk1977   */
2239c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
22406be515ebSdrh     jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
2241b3bce662Sdanielk1977   }
2242b3bce662Sdanielk1977 
22434a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
22444a07e3dbSdan   if( pParse->explain==2 ){
224562aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
224662aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
224762aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
224862aaa6caSdrh         pParse->iNextSelectId
22494a07e3dbSdan     );
22504a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
22514a07e3dbSdan   }
22524a07e3dbSdan #endif
22534a07e3dbSdan 
2254cce7d176Sdrh   switch( pExpr->op ){
2255fef5208cSdrh     case TK_IN: {
2256b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2257d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2258323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
225971c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2260d3d39e93Sdrh 
226171c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2262553168c7Sdan       assert( !isRowid || nVal==1 );
2263e014a838Sdanielk1977 
2264e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
22658cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2266553168c7Sdan       ** filled with index keys representing the results from the
2267553168c7Sdan       ** SELECT or the <exprlist>.
2268fef5208cSdrh       **
2269e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2270e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2271e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2272e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2273e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2274e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2275e014a838Sdanielk1977       ** is used.
2276fef5208cSdrh       */
2277832508b7Sdrh       pExpr->iTable = pParse->nTab++;
227871c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
227971c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
228071c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2281e014a838Sdanielk1977 
22826ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2283e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2284e014a838Sdanielk1977         **
2285e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2286e014a838Sdanielk1977         ** table allocated and opened above.
2287e014a838Sdanielk1977         */
22884387006cSdrh         Select *pSelect = pExpr->x.pSelect;
228971c57db0Sdan         ExprList *pEList = pSelect->pEList;
22901013c932Sdrh 
229141a05b7bSdanielk1977         assert( !isRowid );
229271c57db0Sdan         if( pEList->nExpr!=nVal ){
22938da209b1Sdan           sqlite3SubselectError(pParse, pEList->nExpr, nVal);
229471c57db0Sdan         }else{
229571c57db0Sdan           SelectDest dest;
229671c57db0Sdan           int i;
22971013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
229871c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
2299e014a838Sdanielk1977           assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
23004387006cSdrh           pSelect->iLimit = 0;
23014387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2302812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
23034387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
230471c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
23052ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
23061450bc6eSdrh             return 0;
230794ccde58Sdrh           }
230871c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2309812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
23103535ec3eSdrh           assert( pEList!=0 );
23113535ec3eSdrh           assert( pEList->nExpr>0 );
23122ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
231371c57db0Sdan           for(i=0; i<nVal; i++){
2314d66e5794Sdan             Expr *p = (nVal>1) ? sqlite3ExprVectorField(pLeft, i) : pLeft;
231571c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
231671c57db0Sdan                 pParse, p, pEList->a[i].pExpr
231771c57db0Sdan             );
231871c57db0Sdan           }
231971c57db0Sdan         }
2320a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2321fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2322fef5208cSdrh         **
2323e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2324e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2325e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2326e014a838Sdanielk1977         ** a column, use numeric affinity.
2327fef5208cSdrh         */
232871c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2329e014a838Sdanielk1977         int i;
23306ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
233157dbd7b3Sdrh         struct ExprList_item *pItem;
2332ecc31805Sdrh         int r1, r2, r3;
233357dbd7b3Sdrh 
233471c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2335e014a838Sdanielk1977         if( !affinity ){
233605883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2337e014a838Sdanielk1977         }
2338323df790Sdrh         if( pKeyInfo ){
23392ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2340323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2341323df790Sdrh         }
2342e014a838Sdanielk1977 
2343e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
23442d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
23452d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
234637e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
234757dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
234857dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2349e05c929bSdrh           int iValToIns;
2350e014a838Sdanielk1977 
235157dbd7b3Sdrh           /* If the expression is not constant then we will need to
235257dbd7b3Sdrh           ** disable the test that was generated above that makes sure
235357dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
235457dbd7b3Sdrh           ** expression we need to rerun this code each time.
235557dbd7b3Sdrh           */
23566be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
23576be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
23586be515ebSdrh             jmpIfDynamic = -1;
23594794b980Sdrh           }
2360e014a838Sdanielk1977 
2361e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2362e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2363e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2364e05c929bSdrh           }else{
2365ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
236641a05b7bSdanielk1977             if( isRowid ){
2367e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2368e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2369688852abSdrh               VdbeCoverage(v);
237041a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
237141a05b7bSdanielk1977             }else{
2372ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
23733c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
23742d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2375fef5208cSdrh             }
237641a05b7bSdanielk1977           }
2377e05c929bSdrh         }
23782d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
23792d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2380fef5208cSdrh       }
2381323df790Sdrh       if( pKeyInfo ){
23822ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
238341a05b7bSdanielk1977       }
2384b3bce662Sdanielk1977       break;
2385fef5208cSdrh     }
2386fef5208cSdrh 
238751522cd3Sdrh     case TK_EXISTS:
2388fd773cf9Sdrh     case TK_SELECT:
2389fd773cf9Sdrh     default: {
2390fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
2391fef5208cSdrh       ** value of this select in a memory cell and record the number
2392fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
2393fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
2394fd773cf9Sdrh       ** and record that memory cell in iColumn.
2395fef5208cSdrh       */
2396fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
2397fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
239871c57db0Sdan       int nReg;                             /* Registers to allocate */
23991398ad36Sdrh 
2400cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2401cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2402cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
24036ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
240471c57db0Sdan 
24056ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
240671c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
240771c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
240871c57db0Sdan       pParse->nMem += nReg;
240951522cd3Sdrh       if( pExpr->op==TK_SELECT ){
24106c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
241153932ce8Sdrh         dest.iSdst = dest.iSDParm;
241271c57db0Sdan         dest.nSdst = nReg;
241371c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2414d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
241551522cd3Sdrh       }else{
24166c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
24172b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2418d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
241951522cd3Sdrh       }
2420633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2421094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2422094430ebSdrh                                   &sqlite3IntTokens[1]);
242348b5b041Sdrh       pSel->iLimit = 0;
2424772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
24257d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
24261450bc6eSdrh         return 0;
242794ccde58Sdrh       }
24282b596da8Sdrh       rReg = dest.iSDParm;
2429ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2430b3bce662Sdanielk1977       break;
243119a775c2Sdrh     }
2432cce7d176Sdrh   }
2433b3bce662Sdanielk1977 
24346be515ebSdrh   if( rHasNullFlag ){
24356be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2436b3bce662Sdanielk1977   }
24376be515ebSdrh 
24386be515ebSdrh   if( jmpIfDynamic>=0 ){
24396be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2440b3bce662Sdanielk1977   }
2441d2490904Sdrh   sqlite3ExprCachePop(pParse);
2442fc976065Sdanielk1977 
24431450bc6eSdrh   return rReg;
2444cce7d176Sdrh }
244551522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2446cce7d176Sdrh 
2447e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2448e3365e6cSdrh /*
24497b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
24507b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
24517b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
24527b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
24537b35a77bSdan */
24547b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
24557b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
24567b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
24577b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
24587b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
24597b35a77bSdan       return 1;
24607b35a77bSdan     }
24617b35a77bSdan   }else if( nVector!=1 ){
24627b35a77bSdan     if( (pIn->pLeft->flags & EP_xIsSelect) ){
24637b35a77bSdan       sqlite3SubselectError(pParse, nVector, 1);
24647b35a77bSdan     }else{
24657b35a77bSdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
24667b35a77bSdan     }
24677b35a77bSdan     return 1;
24687b35a77bSdan   }
24697b35a77bSdan   return 0;
24707b35a77bSdan }
24717b35a77bSdan #endif
24727b35a77bSdan 
24737b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
24747b35a77bSdan /*
2475e3365e6cSdrh ** Generate code for an IN expression.
2476e3365e6cSdrh **
2477e3365e6cSdrh **      x IN (SELECT ...)
2478e3365e6cSdrh **      x IN (value, value, ...)
2479e3365e6cSdrh **
2480e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
2481e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
2482e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
2483e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
2484e3365e6cSdrh ** RHS contains one or more NULL values.
2485e3365e6cSdrh **
24866be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2487e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2488e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2489e3365e6cSdrh ** within the RHS then fall through.
2490e3365e6cSdrh */
2491e3365e6cSdrh static void sqlite3ExprCodeIN(
2492e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2493e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2494e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2495e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2496e3365e6cSdrh ){
2497e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2498e3365e6cSdrh   int eType;            /* Type of the RHS */
2499e3365e6cSdrh   int r1;               /* Temporary use register */
2500e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2501ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2502ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2503ba00e30aSdan   int nVector;          /* Size of vectors for this IN(...) op */
2504ba00e30aSdan   Expr *pLeft = pExpr->pLeft;
2505ba00e30aSdan   int i;
2506e3365e6cSdrh 
25077b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2508553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2509*a48d7e77Sdrh   if( zAff==0 ) return;
2510ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2511ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2512ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2513ba00e30aSdan   );
2514*a48d7e77Sdrh   if( aiMap==0 ){
2515*a48d7e77Sdrh     sqlite3DbFree(pParse->db, zAff);
2516553168c7Sdan     return;
2517553168c7Sdan   }
25187b35a77bSdan 
2519ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2520ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2521ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2522ba00e30aSdan   ** the RHS has not yet been coded.  */
2523e3365e6cSdrh   v = pParse->pVdbe;
2524e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2525e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2526bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2527bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2528ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2529e3365e6cSdrh 
2530ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2531ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2532ba00e30aSdan   );
2533e3365e6cSdrh 
2534ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2535ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2536ba00e30aSdan   ** at r1.
2537e3365e6cSdrh   */
2538ba00e30aSdan   r1 = sqlite3GetTempRange(pParse, nVector);
2539e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2540ba00e30aSdan   if( nVector>1 && (pLeft->flags & EP_xIsSelect) ){
2541553168c7Sdan     int regSelect = sqlite3CodeSubselect(pParse, pLeft, 0, 0);
2542ba00e30aSdan     for(i=0; i<nVector; i++){
2543553168c7Sdan       sqlite3VdbeAddOp3(v, OP_Copy, regSelect+i, r1+aiMap[i], 0);
2544ba00e30aSdan     }
2545553168c7Sdan   }else{
2546553168c7Sdan     for(i=0; i<nVector; i++){
2547d66e5794Sdan       Expr *pLhs = sqlite3ExprVectorField(pLeft, i);
2548553168c7Sdan       sqlite3ExprCode(pParse, pLhs, r1+aiMap[i]);
2549ba00e30aSdan     }
2550ba00e30aSdan   }
2551e3365e6cSdrh 
2552bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2553bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2554bb53ecb1Sdrh   ** sequence of comparisons.
2555bb53ecb1Sdrh   */
2556bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2557bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2558bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2559bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2560bb53ecb1Sdrh     int r2, regToFree;
2561bb53ecb1Sdrh     int regCkNull = 0;
2562bb53ecb1Sdrh     int ii;
2563bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2564bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2565bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2566a976979bSdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
2567bb53ecb1Sdrh     }
2568bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2569bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2570a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2571bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2572bb53ecb1Sdrh       }
2573bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2574bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
25754336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
25764336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
25774336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2578ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2579bb53ecb1Sdrh       }else{
2580bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2581bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2582bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2583ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2584bb53ecb1Sdrh       }
2585bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2586bb53ecb1Sdrh     }
2587bb53ecb1Sdrh     if( regCkNull ){
2588bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2589076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2590bb53ecb1Sdrh     }
2591bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2592bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2593bb53ecb1Sdrh   }else{
2594bb53ecb1Sdrh 
25957b35a77bSdan     /* If any value on the LHS is NULL, the result of the IN(...) operator
25967b35a77bSdan     ** must be either false or NULL. If these two are handled identically,
25977b35a77bSdan     ** test the LHS for NULLs and jump directly to destIfNull if any are
25987b35a77bSdan     ** found.
25997b35a77bSdan     **
26007b35a77bSdan     ** Otherwise, if NULL and false are handled differently, and the
26017b35a77bSdan     ** IN(...) operation is not a vector operation, and the LHS of the
26027b35a77bSdan     ** operator is NULL, then the result is false if the index is
26037b35a77bSdan     ** completely empty, or NULL otherwise.  */
2604094430ebSdrh     if( destIfNull==destIfFalse ){
2605d49fd4e8Sdan       for(i=0; i<nVector; i++){
2606d66e5794Sdan         Expr *p = sqlite3ExprVectorField(pExpr->pLeft, i);
2607d49fd4e8Sdan         if( sqlite3ExprCanBeNull(p) ){
2608d49fd4e8Sdan           sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
2609d49fd4e8Sdan         }
2610d49fd4e8Sdan       }
2611d49fd4e8Sdan     }else if( nVector==1 && sqlite3ExprCanBeNull(pExpr->pLeft) ){
2612688852abSdrh       int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2613094430ebSdrh       sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2614688852abSdrh       VdbeCoverage(v);
2615076e85f5Sdrh       sqlite3VdbeGoto(v, destIfNull);
2616094430ebSdrh       sqlite3VdbeJumpHere(v, addr1);
2617094430ebSdrh     }
2618e3365e6cSdrh 
2619e3365e6cSdrh     if( eType==IN_INDEX_ROWID ){
26207b35a77bSdan       /* In this case, the RHS is the ROWID of table b-tree */
2621eeb9565aSdrh       sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, r1);
2622688852abSdrh       VdbeCoverage(v);
26237b35a77bSdan     }else{
26247b35a77bSdan       /* In this case, the RHS is an index b-tree. Apply the comparison
26257b35a77bSdan       ** affinities to each value on the LHS of the operator.  */
26267b35a77bSdan       sqlite3VdbeAddOp4(v, OP_Affinity, r1, nVector, 0, zAff, nVector);
2627ba00e30aSdan 
26287b35a77bSdan       if( nVector>1 && destIfNull!=destIfFalse ){
26297b35a77bSdan         int iIdx = pExpr->iTable;
26307b35a77bSdan         int addr;
26317b35a77bSdan         int addrNext;
26327b35a77bSdan 
26337b35a77bSdan         /* Search the index for the key. */
26347b35a77bSdan         addr = sqlite3VdbeAddOp4Int(v, OP_Found, iIdx, 0, r1, nVector);
26357b35a77bSdan 
26367b35a77bSdan         /* At this point the specified key is not present in the index,
26377b35a77bSdan         ** so the result of the IN(..) operator must be either NULL or
26387b35a77bSdan         ** 0. The vdbe code generated below figures out which.  */
26397b35a77bSdan         addrNext = 1+sqlite3VdbeAddOp2(v, OP_Rewind, iIdx, destIfFalse);
26407b35a77bSdan 
2641ba00e30aSdan         for(i=0; i<nVector; i++){
2642ba00e30aSdan           Expr *p;
2643ba00e30aSdan           CollSeq *pColl;
26447b35a77bSdan           int r2 = sqlite3GetTempReg(pParse);
2645d66e5794Sdan           p = sqlite3ExprVectorField(pLeft, i);
2646ba00e30aSdan           pColl = sqlite3ExprCollSeq(pParse, p);
2647ba00e30aSdan 
26487b35a77bSdan           sqlite3VdbeAddOp3(v, OP_Column, iIdx, i, r2);
26497b35a77bSdan           sqlite3VdbeAddOp4(v, OP_Eq, r1+i, 0, r2, (void*)pColl,P4_COLLSEQ);
26507b35a77bSdan           sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
26517b35a77bSdan           sqlite3VdbeAddOp2(v, OP_Next, iIdx, addrNext);
2652ba00e30aSdan           sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
26537b35a77bSdan           sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-3);
2654ba00e30aSdan           sqlite3ReleaseTempReg(pParse, r2);
26557b35a77bSdan         }
26567b35a77bSdan         sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2657e3365e6cSdrh 
26587b35a77bSdan         /* The key was found in the index. If it contains any NULL values,
26597b35a77bSdan         ** then the result of the IN(...) operator is NULL. Otherwise, the
26607b35a77bSdan         ** result is 1.  */
26617b35a77bSdan         sqlite3VdbeJumpHere(v, addr);
26627b35a77bSdan         for(i=0; i<nVector; i++){
2663d66e5794Sdan           Expr *p = sqlite3ExprVectorField(pExpr->pLeft, i);
26647b35a77bSdan           if( sqlite3ExprCanBeNull(p) ){
26657b35a77bSdan             sqlite3VdbeAddOp2(v, OP_IsNull, r1+aiMap[i], destIfNull);
26667b35a77bSdan           }
26677b35a77bSdan         }
26687b35a77bSdan 
26697b35a77bSdan       }else if( rRhsHasNull==0 ){
2670e3365e6cSdrh         /* This branch runs if it is known at compile time that the RHS
26717b35a77bSdan         ** cannot contain NULL values. This happens as a result
26727b35a77bSdan         ** of "NOT NULL" constraints in the database schema.
2673e3365e6cSdrh         **
2674e3365e6cSdrh         ** Also run this branch if NULL is equivalent to FALSE
26757b35a77bSdan         ** for this particular IN operator.  */
2676ba00e30aSdan         sqlite3VdbeAddOp4Int(
2677ba00e30aSdan             v, OP_NotFound, pExpr->iTable, destIfFalse, r1, nVector
2678ba00e30aSdan         );
2679688852abSdrh         VdbeCoverage(v);
2680e3365e6cSdrh       }else{
2681e3365e6cSdrh         /* In this branch, the RHS of the IN might contain a NULL and
2682e3365e6cSdrh         ** the presence of a NULL on the RHS makes a difference in the
2683e3365e6cSdrh         ** outcome.
2684e3365e6cSdrh         */
2685728e0f91Sdrh         int addr1;
2686e3365e6cSdrh 
2687e3365e6cSdrh         /* First check to see if the LHS is contained in the RHS.  If so,
26886be515ebSdrh         ** then the answer is TRUE the presence of NULLs in the RHS does
26896be515ebSdrh         ** not matter.  If the LHS is not contained in the RHS, then the
26906be515ebSdrh         ** answer is NULL if the RHS contains NULLs and the answer is
26916be515ebSdrh         ** FALSE if the RHS is NULL-free.
2692e3365e6cSdrh         */
2693728e0f91Sdrh         addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2694688852abSdrh         VdbeCoverage(v);
26956be515ebSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2696552fd454Sdrh         VdbeCoverage(v);
2697076e85f5Sdrh         sqlite3VdbeGoto(v, destIfFalse);
2698728e0f91Sdrh         sqlite3VdbeJumpHere(v, addr1);
2699e3365e6cSdrh       }
2700e3365e6cSdrh     }
2701bb53ecb1Sdrh   }
2702e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2703d2490904Sdrh   sqlite3ExprCachePop(pParse);
2704ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
2705553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
2706e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2707e3365e6cSdrh }
2708e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2709e3365e6cSdrh 
271013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2711598f1340Sdrh /*
2712598f1340Sdrh ** Generate an instruction that will put the floating point
27139cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
27140cf19ed8Sdrh **
27150cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
27160cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
27170cf19ed8Sdrh ** like the continuation of the number.
2718598f1340Sdrh */
2719b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2720fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2721598f1340Sdrh     double value;
27229339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2723d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2724598f1340Sdrh     if( negateFlag ) value = -value;
272597bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2726598f1340Sdrh   }
2727598f1340Sdrh }
272813573c71Sdrh #endif
2729598f1340Sdrh 
2730598f1340Sdrh 
2731598f1340Sdrh /*
2732fec19aadSdrh ** Generate an instruction that will put the integer describe by
27339cbf3425Sdrh ** text z[0..n-1] into register iMem.
27340cf19ed8Sdrh **
27355f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2736fec19aadSdrh */
273713573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
273813573c71Sdrh   Vdbe *v = pParse->pVdbe;
273992b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
274033e619fcSdrh     int i = pExpr->u.iValue;
2741d50ffc41Sdrh     assert( i>=0 );
274292b01d53Sdrh     if( negFlag ) i = -i;
274392b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2744fd773cf9Sdrh   }else{
27455f1d6b61Sshaneh     int c;
27465f1d6b61Sshaneh     i64 value;
2747fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2748fd773cf9Sdrh     assert( z!=0 );
27499296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
27505f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2751158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
275297bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2753fec19aadSdrh     }else{
275413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
275513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
275613573c71Sdrh #else
27571b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
27589296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
27599296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
27601b7ddc59Sdrh       }else
27611b7ddc59Sdrh #endif
27621b7ddc59Sdrh       {
2763b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
27649296c18aSdrh       }
276513573c71Sdrh #endif
2766fec19aadSdrh     }
2767fec19aadSdrh   }
2768c9cf901dSdanielk1977 }
2769fec19aadSdrh 
2770bea119cdSdrh #if defined(SQLITE_DEBUG)
2771bea119cdSdrh /*
2772bea119cdSdrh ** Verify the consistency of the column cache
2773bea119cdSdrh */
2774bea119cdSdrh static int cacheIsValid(Parse *pParse){
2775bea119cdSdrh   int i, n;
2776bea119cdSdrh   for(i=n=0; i<SQLITE_N_COLCACHE; i++){
2777bea119cdSdrh     if( pParse->aColCache[i].iReg>0 ) n++;
2778bea119cdSdrh   }
2779bea119cdSdrh   return n==pParse->nColCache;
2780bea119cdSdrh }
2781bea119cdSdrh #endif
2782bea119cdSdrh 
2783ceea3321Sdrh /*
2784ceea3321Sdrh ** Clear a cache entry.
2785ceea3321Sdrh */
2786ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2787ceea3321Sdrh   if( p->tempReg ){
2788ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2789ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2790ceea3321Sdrh     }
2791ceea3321Sdrh     p->tempReg = 0;
2792ceea3321Sdrh   }
2793bea119cdSdrh   p->iReg = 0;
2794bea119cdSdrh   pParse->nColCache--;
2795ee65eea4Sdan   assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2796ceea3321Sdrh }
2797ceea3321Sdrh 
2798ceea3321Sdrh 
2799ceea3321Sdrh /*
2800ceea3321Sdrh ** Record in the column cache that a particular column from a
2801ceea3321Sdrh ** particular table is stored in a particular register.
2802ceea3321Sdrh */
2803ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2804ceea3321Sdrh   int i;
2805ceea3321Sdrh   int minLru;
2806ceea3321Sdrh   int idxLru;
2807ceea3321Sdrh   struct yColCache *p;
2808ceea3321Sdrh 
2809ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2810ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
281120411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
281220411ea7Sdrh 
2813b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2814b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2815b6da74ebSdrh   ** with and without the column cache.
2816b6da74ebSdrh   */
28177e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2818b6da74ebSdrh 
281927ee406eSdrh   /* First replace any existing entry.
282027ee406eSdrh   **
282127ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
282227ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
282327ee406eSdrh   */
282427ee406eSdrh #ifndef NDEBUG
2825ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
282627ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2827ceea3321Sdrh   }
282827ee406eSdrh #endif
2829ceea3321Sdrh 
2830ceea3321Sdrh   /* Find an empty slot and replace it */
2831ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2832ceea3321Sdrh     if( p->iReg==0 ){
2833ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2834ceea3321Sdrh       p->iTable = iTab;
2835ceea3321Sdrh       p->iColumn = iCol;
2836ceea3321Sdrh       p->iReg = iReg;
2837ceea3321Sdrh       p->tempReg = 0;
2838ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2839bea119cdSdrh       pParse->nColCache++;
2840ee65eea4Sdan       assert( pParse->db->mallocFailed || cacheIsValid(pParse) );
2841ceea3321Sdrh       return;
2842ceea3321Sdrh     }
2843ceea3321Sdrh   }
2844ceea3321Sdrh 
2845ceea3321Sdrh   /* Replace the last recently used */
2846ceea3321Sdrh   minLru = 0x7fffffff;
2847ceea3321Sdrh   idxLru = -1;
2848ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2849ceea3321Sdrh     if( p->lru<minLru ){
2850ceea3321Sdrh       idxLru = i;
2851ceea3321Sdrh       minLru = p->lru;
2852ceea3321Sdrh     }
2853ceea3321Sdrh   }
285420411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2855ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2856ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2857ceea3321Sdrh     p->iTable = iTab;
2858ceea3321Sdrh     p->iColumn = iCol;
2859ceea3321Sdrh     p->iReg = iReg;
2860ceea3321Sdrh     p->tempReg = 0;
2861ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2862bea119cdSdrh     assert( cacheIsValid(pParse) );
2863ceea3321Sdrh     return;
2864ceea3321Sdrh   }
2865ceea3321Sdrh }
2866ceea3321Sdrh 
2867ceea3321Sdrh /*
2868f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2869f49f3523Sdrh ** Purge the range of registers from the column cache.
2870ceea3321Sdrh */
2871f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2872ceea3321Sdrh   struct yColCache *p;
2873bea119cdSdrh   if( iReg<=0 || pParse->nColCache==0 ) return;
2874bea119cdSdrh   p = &pParse->aColCache[SQLITE_N_COLCACHE-1];
2875bea119cdSdrh   while(1){
2876bea119cdSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ) cacheEntryClear(pParse, p);
2877bea119cdSdrh     if( p==pParse->aColCache ) break;
2878bea119cdSdrh     p--;
2879ceea3321Sdrh   }
2880ceea3321Sdrh }
2881ceea3321Sdrh 
2882ceea3321Sdrh /*
2883ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2884ceea3321Sdrh ** added to the column cache after this call are removed when the
2885ceea3321Sdrh ** corresponding pop occurs.
2886ceea3321Sdrh */
2887ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2888ceea3321Sdrh   pParse->iCacheLevel++;
28899ac7962aSdrh #ifdef SQLITE_DEBUG
28909ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
28919ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
28929ac7962aSdrh   }
28939ac7962aSdrh #endif
2894ceea3321Sdrh }
2895ceea3321Sdrh 
2896ceea3321Sdrh /*
2897ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2898d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
2899d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
2900ceea3321Sdrh */
2901d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
2902ceea3321Sdrh   int i;
2903ceea3321Sdrh   struct yColCache *p;
2904d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
2905d2490904Sdrh   pParse->iCacheLevel--;
29069ac7962aSdrh #ifdef SQLITE_DEBUG
29079ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
29089ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
29099ac7962aSdrh   }
29109ac7962aSdrh #endif
2911ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2912ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2913ceea3321Sdrh       cacheEntryClear(pParse, p);
2914ceea3321Sdrh     }
2915ceea3321Sdrh   }
2916ceea3321Sdrh }
2917945498f3Sdrh 
2918945498f3Sdrh /*
29195cd79239Sdrh ** When a cached column is reused, make sure that its register is
29205cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
29215cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
29225cd79239Sdrh ** get them all.
29235cd79239Sdrh */
29245cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
29255cd79239Sdrh   int i;
29265cd79239Sdrh   struct yColCache *p;
29275cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
29285cd79239Sdrh     if( p->iReg==iReg ){
29295cd79239Sdrh       p->tempReg = 0;
29305cd79239Sdrh     }
29315cd79239Sdrh   }
29325cd79239Sdrh }
29335cd79239Sdrh 
29341f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
29351f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
29361f9ca2c8Sdrh */
29371f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
29381f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
29391f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
29401f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
29411f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
29421f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
29431f9ca2c8Sdrh ){
29441f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
29454b92f98cSdrh   if( iTabCol==XN_EXPR ){
29461f9ca2c8Sdrh     assert( pIdx->aColExpr );
29471f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
29481f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
29491c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
29504b92f98cSdrh   }else{
29514b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
29524b92f98cSdrh                                     iTabCol, regOut);
29534b92f98cSdrh   }
29541f9ca2c8Sdrh }
29551f9ca2c8Sdrh 
29565cd79239Sdrh /*
29575c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
29585c092e8aSdrh */
29595c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
29605c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
29615c092e8aSdrh   Table *pTab,    /* The table containing the value */
2962313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
29635c092e8aSdrh   int iCol,       /* Index of the column to extract */
2964313619f5Sdrh   int regOut      /* Extract the value into this register */
29655c092e8aSdrh ){
29665c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
29675c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
29685c092e8aSdrh   }else{
29695c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
2970ee0ec8e1Sdrh     int x = iCol;
297135db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
2972ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2973ee0ec8e1Sdrh     }
2974ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
29755c092e8aSdrh   }
29765c092e8aSdrh   if( iCol>=0 ){
29775c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
29785c092e8aSdrh   }
29795c092e8aSdrh }
29805c092e8aSdrh 
29815c092e8aSdrh /*
2982945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2983ce78bc6eSdrh ** table pTab and store the column value in a register.
2984ce78bc6eSdrh **
2985ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
2986ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
2987ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
2988ce78bc6eSdrh ** for GetColumnToReg().
2989e55cbd72Sdrh **
2990e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2991e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2992945498f3Sdrh */
2993e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2994e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
29952133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
29962133d822Sdrh   int iColumn,     /* Index of the table column */
29972133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2998a748fdccSdrh   int iReg,        /* Store results here */
2999ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
30002133d822Sdrh ){
3001e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3002e55cbd72Sdrh   int i;
3003da250ea5Sdrh   struct yColCache *p;
3004e55cbd72Sdrh 
3005ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3006b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
3007ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
30085cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3009da250ea5Sdrh       return p->iReg;
3010e55cbd72Sdrh     }
3011e55cbd72Sdrh   }
3012e55cbd72Sdrh   assert( v!=0 );
30135c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3014a748fdccSdrh   if( p5 ){
3015a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3016a748fdccSdrh   }else{
3017ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3018a748fdccSdrh   }
3019e55cbd72Sdrh   return iReg;
3020e55cbd72Sdrh }
3021ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3022ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3023ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3024ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3025ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3026ce78bc6eSdrh   int iReg         /* Store results here */
3027ce78bc6eSdrh ){
3028ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3029ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3030ce78bc6eSdrh }
3031ce78bc6eSdrh 
3032e55cbd72Sdrh 
3033e55cbd72Sdrh /*
3034ceea3321Sdrh ** Clear all column cache entries.
3035e55cbd72Sdrh */
3036ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3037e55cbd72Sdrh   int i;
3038ceea3321Sdrh   struct yColCache *p;
3039ceea3321Sdrh 
30409ac7962aSdrh #if SQLITE_DEBUG
30419ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
30429ac7962aSdrh     printf("CLEAR\n");
30439ac7962aSdrh   }
30449ac7962aSdrh #endif
3045ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3046ceea3321Sdrh     if( p->iReg ){
3047ceea3321Sdrh       cacheEntryClear(pParse, p);
3048e55cbd72Sdrh     }
3049da250ea5Sdrh   }
3050da250ea5Sdrh }
3051e55cbd72Sdrh 
3052e55cbd72Sdrh /*
3053da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3054da250ea5Sdrh ** registers starting with iStart.
3055e55cbd72Sdrh */
3056da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3057f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3058e55cbd72Sdrh }
3059e55cbd72Sdrh 
3060e55cbd72Sdrh /*
3061b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3062b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3063e55cbd72Sdrh */
3064b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3065e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3066079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3067236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3068945498f3Sdrh }
3069945498f3Sdrh 
3070f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
307192b01d53Sdrh /*
3072652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3073652fbf55Sdrh ** is used as part of the column cache.
3074f49f3523Sdrh **
3075f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3076f49f3523Sdrh ** and does not appear in a normal build.
3077652fbf55Sdrh */
3078652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3079652fbf55Sdrh   int i;
3080ceea3321Sdrh   struct yColCache *p;
3081ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3082ceea3321Sdrh     int r = p->iReg;
3083f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3084652fbf55Sdrh   }
3085652fbf55Sdrh   return 0;
3086652fbf55Sdrh }
3087f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3088652fbf55Sdrh 
3089bea119cdSdrh 
3090652fbf55Sdrh /*
3091a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
3092a4c3c87eSdrh */
3093a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3094a4c3c87eSdrh   p->op2 = p->op;
3095a4c3c87eSdrh   p->op = TK_REGISTER;
3096a4c3c87eSdrh   p->iTable = iReg;
3097a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3098a4c3c87eSdrh }
3099a4c3c87eSdrh 
310071c57db0Sdan static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
310171c57db0Sdan 
3102a4c3c87eSdrh /*
3103cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
31042dcef11bSdrh ** expression.  Attempt to store the results in register "target".
31052dcef11bSdrh ** Return the register where results are stored.
3106389a1adbSdrh **
31078b213899Sdrh ** With this routine, there is no guarantee that results will
31082dcef11bSdrh ** be stored in target.  The result might be stored in some other
31092dcef11bSdrh ** register if it is convenient to do so.  The calling function
31102dcef11bSdrh ** must check the return code and move the results to the desired
31112dcef11bSdrh ** register.
3112cce7d176Sdrh */
3113678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
31142dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
31152dcef11bSdrh   int op;                   /* The opcode being coded */
31162dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
31172dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
31182dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
31197b35a77bSdan   int r1, r2;               /* Various register numbers */
312020411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
312110d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
312271c57db0Sdan   int p5 = 0;
3123ffe07b2dSdrh 
31249cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
312520411ea7Sdrh   if( v==0 ){
312620411ea7Sdrh     assert( pParse->db->mallocFailed );
312720411ea7Sdrh     return 0;
312820411ea7Sdrh   }
3129389a1adbSdrh 
3130389a1adbSdrh   if( pExpr==0 ){
3131389a1adbSdrh     op = TK_NULL;
3132389a1adbSdrh   }else{
3133f2bc013cSdrh     op = pExpr->op;
3134389a1adbSdrh   }
3135f2bc013cSdrh   switch( op ){
313613449892Sdrh     case TK_AGG_COLUMN: {
313713449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
313813449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
313913449892Sdrh       if( !pAggInfo->directMode ){
31409de221dfSdrh         assert( pCol->iMem>0 );
31419de221dfSdrh         inReg = pCol->iMem;
314213449892Sdrh         break;
314313449892Sdrh       }else if( pAggInfo->useSortingIdx ){
31445134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3145389a1adbSdrh                               pCol->iSorterColumn, target);
314613449892Sdrh         break;
314713449892Sdrh       }
314813449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
314913449892Sdrh     }
3150967e8b73Sdrh     case TK_COLUMN: {
3151b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3152b2b9d3d7Sdrh       if( iTab<0 ){
3153b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
3154b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3155aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
3156b2b9d3d7Sdrh           break;
3157c4a3c779Sdrh         }else{
31581f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
31591f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
31601f9ca2c8Sdrh           iTab = pParse->iSelfTab;
31612282792aSdrh         }
3162b2b9d3d7Sdrh       }
3163b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3164b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3165b2b9d3d7Sdrh                                pExpr->op2);
3166cce7d176Sdrh       break;
3167cce7d176Sdrh     }
3168cce7d176Sdrh     case TK_INTEGER: {
316913573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3170fec19aadSdrh       break;
317151e9a445Sdrh     }
317213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3173598f1340Sdrh     case TK_FLOAT: {
317433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
317533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3176598f1340Sdrh       break;
3177598f1340Sdrh     }
317813573c71Sdrh #endif
3179fec19aadSdrh     case TK_STRING: {
318033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3181076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3182cce7d176Sdrh       break;
3183cce7d176Sdrh     }
3184f0863fe5Sdrh     case TK_NULL: {
31859de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3186f0863fe5Sdrh       break;
3187f0863fe5Sdrh     }
31885338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3189c572ef7fSdanielk1977     case TK_BLOB: {
31906c8c6cecSdrh       int n;
31916c8c6cecSdrh       const char *z;
3192ca48c90fSdrh       char *zBlob;
319333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
319433e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
319533e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
319633e619fcSdrh       z = &pExpr->u.zToken[2];
3197b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3198b7916a78Sdrh       assert( z[n]=='\'' );
3199ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3200ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3201c572ef7fSdanielk1977       break;
3202c572ef7fSdanielk1977     }
32035338a5f7Sdanielk1977 #endif
320450457896Sdrh     case TK_VARIABLE: {
320533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
320633e619fcSdrh       assert( pExpr->u.zToken!=0 );
320733e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3208eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
320933e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
321004e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
321104e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
321204e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
3213895d7472Sdrh       }
321450457896Sdrh       break;
321550457896Sdrh     }
32164e0cff60Sdrh     case TK_REGISTER: {
32179de221dfSdrh       inReg = pExpr->iTable;
32184e0cff60Sdrh       break;
32194e0cff60Sdrh     }
3220487e262fSdrh #ifndef SQLITE_OMIT_CAST
3221487e262fSdrh     case TK_CAST: {
3222487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
32232dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
32241735fa88Sdrh       if( inReg!=target ){
32251735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
32261735fa88Sdrh         inReg = target;
32271735fa88Sdrh       }
32284169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
32294169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3230c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3231b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3232487e262fSdrh       break;
3233487e262fSdrh     }
3234487e262fSdrh #endif /* SQLITE_OMIT_CAST */
323571c57db0Sdan     case TK_IS:
323671c57db0Sdan     case TK_ISNOT:
323771c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
323871c57db0Sdan       p5 = SQLITE_NULLEQ;
323971c57db0Sdan       /* fall-through */
3240c9b84a1fSdrh     case TK_LT:
3241c9b84a1fSdrh     case TK_LE:
3242c9b84a1fSdrh     case TK_GT:
3243c9b84a1fSdrh     case TK_GE:
3244c9b84a1fSdrh     case TK_NE:
3245c9b84a1fSdrh     case TK_EQ: {
324671c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3247625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
324871c57db0Sdan         codeVectorCompare(pParse, pExpr, target);
324971c57db0Sdan       }else{
325071c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3251b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
325271c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
325371c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
32547d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
32557d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
32567d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
32577d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
32587d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
32597d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3260c5499befSdrh         testcase( regFree1==0 );
3261c5499befSdrh         testcase( regFree2==0 );
3262c9b84a1fSdrh       }
32636a2fe093Sdrh       break;
32646a2fe093Sdrh     }
3265cce7d176Sdrh     case TK_AND:
3266cce7d176Sdrh     case TK_OR:
3267cce7d176Sdrh     case TK_PLUS:
3268cce7d176Sdrh     case TK_STAR:
3269cce7d176Sdrh     case TK_MINUS:
3270bf4133cbSdrh     case TK_REM:
3271bf4133cbSdrh     case TK_BITAND:
3272bf4133cbSdrh     case TK_BITOR:
327317c40294Sdrh     case TK_SLASH:
3274bf4133cbSdrh     case TK_LSHIFT:
3275855eb1cfSdrh     case TK_RSHIFT:
32760040077dSdrh     case TK_CONCAT: {
32777d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
32787d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
32797d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
32807d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
32817d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
32827d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
32837d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
32847d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
32857d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
32867d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
32877d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
32882dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
32892dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
32905b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3291c5499befSdrh       testcase( regFree1==0 );
3292c5499befSdrh       testcase( regFree2==0 );
32930040077dSdrh       break;
32940040077dSdrh     }
3295cce7d176Sdrh     case TK_UMINUS: {
3296fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3297fec19aadSdrh       assert( pLeft );
329813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
329913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
330013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
330113573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
330233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
330333e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
330413573c71Sdrh #endif
33053c84ddffSdrh       }else{
330610d1edf0Sdrh         tempX.op = TK_INTEGER;
330710d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
330810d1edf0Sdrh         tempX.u.iValue = 0;
330910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3310e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
33112dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3312c5499befSdrh         testcase( regFree2==0 );
33133c84ddffSdrh       }
33149de221dfSdrh       inReg = target;
33156e142f54Sdrh       break;
33166e142f54Sdrh     }
3317bf4133cbSdrh     case TK_BITNOT:
33186e142f54Sdrh     case TK_NOT: {
33197d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
33207d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3321e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3322e99fa2afSdrh       testcase( regFree1==0 );
3323e99fa2afSdrh       inReg = target;
3324e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3325cce7d176Sdrh       break;
3326cce7d176Sdrh     }
3327cce7d176Sdrh     case TK_ISNULL:
3328cce7d176Sdrh     case TK_NOTNULL: {
33296a288a33Sdrh       int addr;
33307d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
33317d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
33329de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
33332dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3334c5499befSdrh       testcase( regFree1==0 );
33352dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
33367d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
33377d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3338a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
33396a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3340a37cdde0Sdanielk1977       break;
3341f2bc013cSdrh     }
33422282792aSdrh     case TK_AGG_FUNCTION: {
334313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
33447e56e711Sdrh       if( pInfo==0 ){
334533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
334633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
33477e56e711Sdrh       }else{
33489de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
33497e56e711Sdrh       }
33502282792aSdrh       break;
33512282792aSdrh     }
3352cce7d176Sdrh     case TK_FUNCTION: {
335312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
335412ffee8cSdrh       int nFarg;             /* Number of function arguments */
335512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
335612ffee8cSdrh       const char *zId;       /* The function name */
3357693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
335812ffee8cSdrh       int i;                 /* Loop counter */
335912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
336012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
336117435752Sdrh 
33626ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3363c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
336412ffee8cSdrh         pFarg = 0;
336512ffee8cSdrh       }else{
336612ffee8cSdrh         pFarg = pExpr->x.pList;
336712ffee8cSdrh       }
336812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
336933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
337033e619fcSdrh       zId = pExpr->u.zToken;
337180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3372cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3373cc15313cSdrh       if( pDef==0 && pParse->explain ){
3374cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3375cc15313cSdrh       }
3376cc15313cSdrh #endif
33772d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
337880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3379feb306f5Sdrh         break;
3380feb306f5Sdrh       }
3381ae6bb957Sdrh 
3382ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
338360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3384ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3385ae6bb957Sdrh       */
3386d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3387ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3388ae6bb957Sdrh         assert( nFarg>=2 );
3389ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3390ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3391ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3392688852abSdrh           VdbeCoverage(v);
3393f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3394ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3395ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3396d2490904Sdrh           sqlite3ExprCachePop(pParse);
3397ae6bb957Sdrh         }
3398ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3399ae6bb957Sdrh         break;
3400ae6bb957Sdrh       }
3401ae6bb957Sdrh 
3402cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3403cca9f3d2Sdrh       ** of the first argument.
3404cca9f3d2Sdrh       */
3405cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3406cca9f3d2Sdrh         assert( nFarg>=1 );
34075f02ab09Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3408cca9f3d2Sdrh         break;
3409cca9f3d2Sdrh       }
3410ae6bb957Sdrh 
3411d1a01edaSdrh       for(i=0; i<nFarg; i++){
3412d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3413693e6719Sdrh           testcase( i==31 );
3414693e6719Sdrh           constMask |= MASKBIT32(i);
3415d1a01edaSdrh         }
3416d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3417d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3418d1a01edaSdrh         }
3419d1a01edaSdrh       }
342012ffee8cSdrh       if( pFarg ){
3421d1a01edaSdrh         if( constMask ){
3422d1a01edaSdrh           r1 = pParse->nMem+1;
3423d1a01edaSdrh           pParse->nMem += nFarg;
3424d1a01edaSdrh         }else{
342512ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3426d1a01edaSdrh         }
3427a748fdccSdrh 
3428a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3429a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3430a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3431a748fdccSdrh         ** loading.
3432a748fdccSdrh         */
3433d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
34344e245a4cSdrh           u8 exprOp;
3435a748fdccSdrh           assert( nFarg==1 );
3436a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
34374e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
34384e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3439a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3440a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3441b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3442b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3443b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3444a748fdccSdrh           }
3445a748fdccSdrh         }
3446a748fdccSdrh 
3447d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
34485579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3449d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3450d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3451892d3179Sdrh       }else{
345212ffee8cSdrh         r1 = 0;
3453892d3179Sdrh       }
3454b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3455a43fa227Sdrh       /* Possibly overload the function if the first argument is
3456a43fa227Sdrh       ** a virtual table column.
3457a43fa227Sdrh       **
3458a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3459a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3460a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3461a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3462a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3463a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3464a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3465a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3466a43fa227Sdrh       */
346712ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
346812ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
346912ffee8cSdrh       }else if( nFarg>0 ){
347012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3471b7f6f68fSdrh       }
3472b7f6f68fSdrh #endif
3473d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
34748b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
347566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3476682f68b0Sdanielk1977       }
34779c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
347866a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
347912ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3480d1a01edaSdrh       if( nFarg && constMask==0 ){
348112ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
34822dcef11bSdrh       }
34836ec2733bSdrh       break;
34846ec2733bSdrh     }
3485fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3486fe2093d7Sdrh     case TK_EXISTS:
348719a775c2Sdrh     case TK_SELECT: {
34888da209b1Sdan       int nCol;
3489c5499befSdrh       testcase( op==TK_EXISTS );
3490c5499befSdrh       testcase( op==TK_SELECT );
34918da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
34928da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
34938da209b1Sdan       }else{
34941450bc6eSdrh         inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
34958da209b1Sdan       }
349619a775c2Sdrh       break;
349719a775c2Sdrh     }
3498fef5208cSdrh     case TK_IN: {
3499e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3500e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3501e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3502e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
350366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3504e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3505e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3506e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3507fef5208cSdrh       break;
3508fef5208cSdrh     }
3509e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3510e3365e6cSdrh 
3511e3365e6cSdrh 
35122dcef11bSdrh     /*
35132dcef11bSdrh     **    x BETWEEN y AND z
35142dcef11bSdrh     **
35152dcef11bSdrh     ** This is equivalent to
35162dcef11bSdrh     **
35172dcef11bSdrh     **    x>=y AND x<=z
35182dcef11bSdrh     **
35192dcef11bSdrh     ** X is stored in pExpr->pLeft.
35202dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
35212dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
35222dcef11bSdrh     */
3523fef5208cSdrh     case TK_BETWEEN: {
352471c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3525fef5208cSdrh       break;
3526fef5208cSdrh     }
352794fa9c41Sdrh     case TK_SPAN:
3528ae80ddeaSdrh     case TK_COLLATE:
35294f07e5fbSdrh     case TK_UPLUS: {
35302dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3531a2e00042Sdrh       break;
3532a2e00042Sdrh     }
35332dcef11bSdrh 
3534165921a7Sdan     case TK_TRIGGER: {
353565a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
353665a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
353765a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
353865a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
353965a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
354065a7cd16Sdan       ** read the rowid field.
354165a7cd16Sdan       **
354265a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
354365a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
354465a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
354565a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
354665a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
354765a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
354865a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
354965a7cd16Sdan       ** example, if the table on which triggers are being fired is
355065a7cd16Sdan       ** declared as:
355165a7cd16Sdan       **
355265a7cd16Sdan       **   CREATE TABLE t1(a, b);
355365a7cd16Sdan       **
355465a7cd16Sdan       ** Then p1 is interpreted as follows:
355565a7cd16Sdan       **
355665a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
355765a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
355865a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
355965a7cd16Sdan       */
35602832ad42Sdan       Table *pTab = pExpr->pTab;
356165a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
356265a7cd16Sdan 
356365a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
356465a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
356565a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
356665a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
356765a7cd16Sdan 
356865a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
356976d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3570165921a7Sdan         (pExpr->iTable ? "new" : "old"),
357176d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
357276d462eeSdan         target
3573165921a7Sdan       ));
357465a7cd16Sdan 
357544dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
357665a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3577113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3578113762a2Sdrh       **
3579113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3580113762a2Sdrh       ** floating point when extracting it from the record.  */
35812832ad42Sdan       if( pExpr->iColumn>=0
35822832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
35832832ad42Sdan       ){
35842832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
35852832ad42Sdan       }
358644dbca83Sdrh #endif
3587165921a7Sdan       break;
3588165921a7Sdan     }
3589165921a7Sdan 
359071c57db0Sdan     case TK_VECTOR: {
3591d49fd4e8Sdan       sqlite3ErrorMsg(pParse, "invalid use of row value");
359271c57db0Sdan       break;
359371c57db0Sdan     }
359471c57db0Sdan 
35952dcef11bSdrh     /*
35962dcef11bSdrh     ** Form A:
35972dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
35982dcef11bSdrh     **
35992dcef11bSdrh     ** Form B:
36002dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
36012dcef11bSdrh     **
36022dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
36032dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
36042dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
36052dcef11bSdrh     **
36062dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3607c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3608c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3609c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
36102dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
36112dcef11bSdrh     **
36122dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
36132dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
36142dcef11bSdrh     ** no ELSE term, NULL.
36152dcef11bSdrh     */
361633cd4909Sdrh     default: assert( op==TK_CASE ); {
36172dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
36182dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
36192dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
36202dcef11bSdrh       int i;                            /* Loop counter */
36212dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
36222dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
36232dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
36242dcef11bSdrh       Expr *pX;                         /* The X expression */
36251bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3626ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
362717a7f8ddSdrh 
36286ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
36296ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
36306ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3631be5c89acSdrh       aListelem = pEList->a;
3632be5c89acSdrh       nExpr = pEList->nExpr;
36332dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
36342dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
363510d1edf0Sdrh         tempX = *pX;
363633cd4909Sdrh         testcase( pX->op==TK_COLUMN );
363710d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
3638c5499befSdrh         testcase( regFree1==0 );
36392dcef11bSdrh         opCompare.op = TK_EQ;
364010d1edf0Sdrh         opCompare.pLeft = &tempX;
36412dcef11bSdrh         pTest = &opCompare;
36428b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
36438b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
36448b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
36458b1db07fSdrh         ** purposes and possibly overwritten.  */
36468b1db07fSdrh         regFree1 = 0;
3647cce7d176Sdrh       }
3648c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3649ceea3321Sdrh         sqlite3ExprCachePush(pParse);
36502dcef11bSdrh         if( pX ){
36511bd10f8aSdrh           assert( pTest!=0 );
36522dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3653f5905aa7Sdrh         }else{
36542dcef11bSdrh           pTest = aListelem[i].pExpr;
365517a7f8ddSdrh         }
36562dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
365733cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
36582dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3659c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
36609de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3661076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3662d2490904Sdrh         sqlite3ExprCachePop(pParse);
36632dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3664f570f011Sdrh       }
3665c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3666ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3667c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3668d2490904Sdrh         sqlite3ExprCachePop(pParse);
366917a7f8ddSdrh       }else{
36709de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
367117a7f8ddSdrh       }
3672c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
3673c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
36742dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
36756f34903eSdanielk1977       break;
36766f34903eSdanielk1977     }
36775338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
36786f34903eSdanielk1977     case TK_RAISE: {
3679165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3680165921a7Sdan            || pExpr->affinity==OE_Abort
3681165921a7Sdan            || pExpr->affinity==OE_Fail
3682165921a7Sdan            || pExpr->affinity==OE_Ignore
3683165921a7Sdan       );
3684e0af83acSdan       if( !pParse->pTriggerTab ){
3685e0af83acSdan         sqlite3ErrorMsg(pParse,
3686e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3687e0af83acSdan         return 0;
3688e0af83acSdan       }
3689e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3690e0af83acSdan         sqlite3MayAbort(pParse);
3691e0af83acSdan       }
369233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3693e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3694e0af83acSdan         sqlite3VdbeAddOp4(
3695e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3696688852abSdrh         VdbeCoverage(v);
3697e0af83acSdan       }else{
3698433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3699f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3700e0af83acSdan       }
3701e0af83acSdan 
3702ffe07b2dSdrh       break;
370317a7f8ddSdrh     }
37045338a5f7Sdanielk1977 #endif
3705ffe07b2dSdrh   }
37062dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
37072dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
37082dcef11bSdrh   return inReg;
37095b6afba9Sdrh }
37102dcef11bSdrh 
37112dcef11bSdrh /*
3712d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3713d1a01edaSdrh */
3714d673cddaSdrh void sqlite3ExprCodeAtInit(
3715d673cddaSdrh   Parse *pParse,    /* Parsing context */
3716d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3717d673cddaSdrh   int regDest,      /* Store the value in this register */
3718d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3719d673cddaSdrh ){
3720d1a01edaSdrh   ExprList *p;
3721d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3722d1a01edaSdrh   p = pParse->pConstExpr;
3723d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3724d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3725d673cddaSdrh   if( p ){
3726d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3727d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3728d673cddaSdrh      pItem->reusable = reusable;
3729d673cddaSdrh   }
3730d1a01edaSdrh   pParse->pConstExpr = p;
3731d1a01edaSdrh }
3732d1a01edaSdrh 
3733d1a01edaSdrh /*
37342dcef11bSdrh ** Generate code to evaluate an expression and store the results
37352dcef11bSdrh ** into a register.  Return the register number where the results
37362dcef11bSdrh ** are stored.
37372dcef11bSdrh **
37382dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3739678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
37402dcef11bSdrh ** a temporary, then set *pReg to zero.
3741f30a969bSdrh **
3742f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3743f30a969bSdrh ** code to fill the register in the initialization section of the
3744f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
37452dcef11bSdrh */
37462dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3747f30a969bSdrh   int r2;
3748f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3749d9f158e7Sdrh   if( ConstFactorOk(pParse)
3750f30a969bSdrh    && pExpr->op!=TK_REGISTER
3751f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3752f30a969bSdrh   ){
3753f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3754f30a969bSdrh     int i;
3755f30a969bSdrh     *pReg  = 0;
3756f30a969bSdrh     if( p ){
3757d673cddaSdrh       struct ExprList_item *pItem;
3758d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3759d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3760d673cddaSdrh           return pItem->u.iConstExprReg;
3761f30a969bSdrh         }
3762f30a969bSdrh       }
3763f30a969bSdrh     }
3764f30a969bSdrh     r2 = ++pParse->nMem;
3765d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3766f30a969bSdrh   }else{
37672dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3768f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
37692dcef11bSdrh     if( r2==r1 ){
37702dcef11bSdrh       *pReg = r1;
37712dcef11bSdrh     }else{
37722dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
37732dcef11bSdrh       *pReg = 0;
37742dcef11bSdrh     }
3775f30a969bSdrh   }
37762dcef11bSdrh   return r2;
37772dcef11bSdrh }
37782dcef11bSdrh 
37792dcef11bSdrh /*
37802dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
37812dcef11bSdrh ** results in register target.  The results are guaranteed to appear
37822dcef11bSdrh ** in register target.
37832dcef11bSdrh */
378405a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
37859cbf3425Sdrh   int inReg;
37869cbf3425Sdrh 
37879cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3788ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3789ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3790ebc16717Sdrh   }else{
37919cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
37921c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
37930e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
37949cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
379517a7f8ddSdrh     }
3796ebc16717Sdrh   }
3797cce7d176Sdrh }
3798cce7d176Sdrh 
3799cce7d176Sdrh /*
38001c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
38011c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
38021c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
38031c75c9d7Sdrh */
38041c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
38051c75c9d7Sdrh   sqlite3 *db = pParse->db;
38061c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
38071c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
38081c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
38091c75c9d7Sdrh }
38101c75c9d7Sdrh 
38111c75c9d7Sdrh /*
381205a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
381305a86c5cSdrh ** results in register target.  The results are guaranteed to appear
381405a86c5cSdrh ** in register target.  If the expression is constant, then this routine
381505a86c5cSdrh ** might choose to code the expression at initialization time.
381605a86c5cSdrh */
381705a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
381805a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
381905a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
382005a86c5cSdrh   }else{
382105a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
382205a86c5cSdrh   }
3823cce7d176Sdrh }
3824cce7d176Sdrh 
3825cce7d176Sdrh /*
382660ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
3827de4fcfddSdrh ** in register target.
382825303780Sdrh **
38292dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
38302dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
38312dcef11bSdrh ** the result is a copy of the cache register.
38322dcef11bSdrh **
38332dcef11bSdrh ** This routine is used for expressions that are used multiple
38342dcef11bSdrh ** times.  They are evaluated once and the results of the expression
38352dcef11bSdrh ** are reused.
383625303780Sdrh */
383705a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
383825303780Sdrh   Vdbe *v = pParse->pVdbe;
383925303780Sdrh   int iMem;
384005a86c5cSdrh 
384105a86c5cSdrh   assert( target>0 );
384205a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
384305a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
38442dcef11bSdrh   iMem = ++pParse->nMem;
384505a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3846a4c3c87eSdrh   exprToRegister(pExpr, iMem);
384725303780Sdrh }
38487e02e5e6Sdrh 
3849678ccce8Sdrh /*
3850268380caSdrh ** Generate code that pushes the value of every element of the given
38519cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3852268380caSdrh **
3853892d3179Sdrh ** Return the number of elements evaluated.
3854d1a01edaSdrh **
3855d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
3856d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
3857d1a01edaSdrh **
3858d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3859d1a01edaSdrh ** factored out into initialization code.
3860b0df9634Sdrh **
3861b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
3862b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
3863b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
3864268380caSdrh */
38654adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3866268380caSdrh   Parse *pParse,     /* Parsing context */
3867389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3868191b54cbSdrh   int target,        /* Where to write results */
38695579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
3870d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
3871268380caSdrh ){
3872268380caSdrh   struct ExprList_item *pItem;
38735579d59fSdrh   int i, j, n;
3874d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
38755579d59fSdrh   Vdbe *v = pParse->pVdbe;
38769d8b3072Sdrh   assert( pList!=0 );
38779cbf3425Sdrh   assert( target>0 );
3878d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3879268380caSdrh   n = pList->nExpr;
3880d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
3881191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
38827445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
38835579d59fSdrh     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
38845579d59fSdrh       sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
38855579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
3886d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
3887d1a01edaSdrh     }else{
38887445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3889746fd9ccSdrh       if( inReg!=target+i ){
38904eded604Sdrh         VdbeOp *pOp;
38914eded604Sdrh         if( copyOp==OP_Copy
38924eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
38934eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
38944eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
38954eded604Sdrh         ){
38964eded604Sdrh           pOp->p3++;
38974eded604Sdrh         }else{
38984eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
38994eded604Sdrh         }
3900d1a01edaSdrh       }
3901d176611bSdrh     }
3902268380caSdrh   }
3903f9b596ebSdrh   return n;
3904268380caSdrh }
3905268380caSdrh 
3906268380caSdrh /*
390736c563a2Sdrh ** Generate code for a BETWEEN operator.
390836c563a2Sdrh **
390936c563a2Sdrh **    x BETWEEN y AND z
391036c563a2Sdrh **
391136c563a2Sdrh ** The above is equivalent to
391236c563a2Sdrh **
391336c563a2Sdrh **    x>=y AND x<=z
391436c563a2Sdrh **
391536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
391660ec914cSpeter.d.reid ** elimination of x.
391736c563a2Sdrh */
391836c563a2Sdrh static void exprCodeBetween(
391936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
392036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
392136c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
392271c57db0Sdan   void (*xJumpIf)(Parse*,Expr*,int,int),
392336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
392436c563a2Sdrh ){
392536c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
392636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
392736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
392836c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
392936c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
393036c563a2Sdrh 
393171c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
393271c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
393371c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
393471c57db0Sdan 
393536c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
393636c563a2Sdrh   exprX = *pExpr->pLeft;
393736c563a2Sdrh   exprAnd.op = TK_AND;
393836c563a2Sdrh   exprAnd.pLeft = &compLeft;
393936c563a2Sdrh   exprAnd.pRight = &compRight;
394036c563a2Sdrh   compLeft.op = TK_GE;
394136c563a2Sdrh   compLeft.pLeft = &exprX;
394236c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
394336c563a2Sdrh   compRight.op = TK_LE;
394436c563a2Sdrh   compRight.pLeft = &exprX;
394536c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
3946625015e0Sdan   if( sqlite3ExprIsVector(&exprX)==0 ){
3947a4c3c87eSdrh     exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
394871c57db0Sdan   }
394971c57db0Sdan   if( xJumpIf ){
395071c57db0Sdan     xJumpIf(pParse, &exprAnd, dest, jumpIfNull);
395136c563a2Sdrh   }else{
395271c57db0Sdan     exprX.flags |= EP_FromJoin;
395371c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
395436c563a2Sdrh   }
395536c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
395636c563a2Sdrh 
395736c563a2Sdrh   /* Ensure adequate test coverage */
395836c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
395936c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
396036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
396136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
396236c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
396336c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
396436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
396536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
396636c563a2Sdrh }
396736c563a2Sdrh 
396836c563a2Sdrh /*
3969cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3970cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3971cce7d176Sdrh ** continues straight thru if the expression is false.
3972f5905aa7Sdrh **
3973f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
397435573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3975f2bc013cSdrh **
3976f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3977f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3978f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3979f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3980f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3981cce7d176Sdrh */
39824adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3983cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3984cce7d176Sdrh   int op = 0;
39852dcef11bSdrh   int regFree1 = 0;
39862dcef11bSdrh   int regFree2 = 0;
39872dcef11bSdrh   int r1, r2;
39882dcef11bSdrh 
398935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
399048864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
399133cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3992f2bc013cSdrh   op = pExpr->op;
39937b35a77bSdan   switch( op ){
3994cce7d176Sdrh     case TK_AND: {
39954adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3996c5499befSdrh       testcase( jumpIfNull==0 );
399735573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
399854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
39994adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
40004adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4001d2490904Sdrh       sqlite3ExprCachePop(pParse);
4002cce7d176Sdrh       break;
4003cce7d176Sdrh     }
4004cce7d176Sdrh     case TK_OR: {
4005c5499befSdrh       testcase( jumpIfNull==0 );
40064adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
400754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
40084adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4009d2490904Sdrh       sqlite3ExprCachePop(pParse);
4010cce7d176Sdrh       break;
4011cce7d176Sdrh     }
4012cce7d176Sdrh     case TK_NOT: {
4013c5499befSdrh       testcase( jumpIfNull==0 );
40144adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4015cce7d176Sdrh       break;
4016cce7d176Sdrh     }
4017de845c2fSdrh     case TK_IS:
4018de845c2fSdrh     case TK_ISNOT:
4019de845c2fSdrh       testcase( op==TK_IS );
4020de845c2fSdrh       testcase( op==TK_ISNOT );
4021de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4022de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4023de845c2fSdrh       /* Fall thru */
4024cce7d176Sdrh     case TK_LT:
4025cce7d176Sdrh     case TK_LE:
4026cce7d176Sdrh     case TK_GT:
4027cce7d176Sdrh     case TK_GE:
4028cce7d176Sdrh     case TK_NE:
40290ac65892Sdrh     case TK_EQ: {
4030625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4031c5499befSdrh       testcase( jumpIfNull==0 );
4032b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4033b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
403435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
40352dcef11bSdrh                   r1, r2, dest, jumpIfNull);
40367d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
40377d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
40387d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
40397d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4040de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4041de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4042de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4043de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4044de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4045de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
40466a2fe093Sdrh       testcase( regFree1==0 );
40476a2fe093Sdrh       testcase( regFree2==0 );
40486a2fe093Sdrh       break;
40496a2fe093Sdrh     }
4050cce7d176Sdrh     case TK_ISNULL:
4051cce7d176Sdrh     case TK_NOTNULL: {
40527d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
40537d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
40542dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
40552dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
40567d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
40577d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4058c5499befSdrh       testcase( regFree1==0 );
4059cce7d176Sdrh       break;
4060cce7d176Sdrh     }
4061fef5208cSdrh     case TK_BETWEEN: {
40625c03f30aSdrh       testcase( jumpIfNull==0 );
406371c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4064fef5208cSdrh       break;
4065fef5208cSdrh     }
4066bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4067e3365e6cSdrh     case TK_IN: {
4068e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4069e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4070e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4071076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4072e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4073e3365e6cSdrh       break;
4074e3365e6cSdrh     }
4075bb201344Sshaneh #endif
4076cce7d176Sdrh     default: {
40777b35a77bSdan     default_expr:
4078991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4079076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4080991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4081991a1985Sdrh         /* No-op */
4082991a1985Sdrh       }else{
40832dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
40842dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4085688852abSdrh         VdbeCoverage(v);
4086c5499befSdrh         testcase( regFree1==0 );
4087c5499befSdrh         testcase( jumpIfNull==0 );
4088991a1985Sdrh       }
4089cce7d176Sdrh       break;
4090cce7d176Sdrh     }
4091cce7d176Sdrh   }
40922dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
40932dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4094cce7d176Sdrh }
4095cce7d176Sdrh 
4096cce7d176Sdrh /*
409766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4098cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4099cce7d176Sdrh ** continues straight thru if the expression is true.
4100f5905aa7Sdrh **
4101f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
410235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
410335573356Sdrh ** is 0.
4104cce7d176Sdrh */
41054adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4106cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4107cce7d176Sdrh   int op = 0;
41082dcef11bSdrh   int regFree1 = 0;
41092dcef11bSdrh   int regFree2 = 0;
41102dcef11bSdrh   int r1, r2;
41112dcef11bSdrh 
411235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
411348864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
411433cd4909Sdrh   if( pExpr==0 )    return;
4115f2bc013cSdrh 
4116f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4117f2bc013cSdrh   **
4118f2bc013cSdrh   **       pExpr->op            op
4119f2bc013cSdrh   **       ---------          ----------
4120f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4121f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4122f2bc013cSdrh   **       TK_NE              OP_Eq
4123f2bc013cSdrh   **       TK_EQ              OP_Ne
4124f2bc013cSdrh   **       TK_GT              OP_Le
4125f2bc013cSdrh   **       TK_LE              OP_Gt
4126f2bc013cSdrh   **       TK_GE              OP_Lt
4127f2bc013cSdrh   **       TK_LT              OP_Ge
4128f2bc013cSdrh   **
4129f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4130f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4131f2bc013cSdrh   ** can compute the mapping above using the following expression.
4132f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4133f2bc013cSdrh   */
4134f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4135f2bc013cSdrh 
4136f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4137f2bc013cSdrh   */
4138f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4139f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4140f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4141f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4142f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4143f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4144f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4145f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4146f2bc013cSdrh 
4147ba00e30aSdan   switch( pExpr->op ){
4148cce7d176Sdrh     case TK_AND: {
4149c5499befSdrh       testcase( jumpIfNull==0 );
41504adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
415154e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41524adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4153d2490904Sdrh       sqlite3ExprCachePop(pParse);
4154cce7d176Sdrh       break;
4155cce7d176Sdrh     }
4156cce7d176Sdrh     case TK_OR: {
41574adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4158c5499befSdrh       testcase( jumpIfNull==0 );
415935573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
416054e2adb5Sdrh       sqlite3ExprCachePush(pParse);
41614adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
41624adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4163d2490904Sdrh       sqlite3ExprCachePop(pParse);
4164cce7d176Sdrh       break;
4165cce7d176Sdrh     }
4166cce7d176Sdrh     case TK_NOT: {
41675c03f30aSdrh       testcase( jumpIfNull==0 );
41684adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4169cce7d176Sdrh       break;
4170cce7d176Sdrh     }
4171de845c2fSdrh     case TK_IS:
4172de845c2fSdrh     case TK_ISNOT:
4173de845c2fSdrh       testcase( pExpr->op==TK_IS );
4174de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4175de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4176de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4177de845c2fSdrh       /* Fall thru */
4178cce7d176Sdrh     case TK_LT:
4179cce7d176Sdrh     case TK_LE:
4180cce7d176Sdrh     case TK_GT:
4181cce7d176Sdrh     case TK_GE:
4182cce7d176Sdrh     case TK_NE:
4183cce7d176Sdrh     case TK_EQ: {
4184625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4185c5499befSdrh       testcase( jumpIfNull==0 );
4186b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4187b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
418835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
41892dcef11bSdrh                   r1, r2, dest, jumpIfNull);
41907d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41917d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41927d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41937d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4194de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4195de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4196de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4197de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4198de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4199de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
42006a2fe093Sdrh       testcase( regFree1==0 );
42016a2fe093Sdrh       testcase( regFree2==0 );
42026a2fe093Sdrh       break;
42036a2fe093Sdrh     }
4204cce7d176Sdrh     case TK_ISNULL:
4205cce7d176Sdrh     case TK_NOTNULL: {
42062dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42072dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
42087d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
42097d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4210c5499befSdrh       testcase( regFree1==0 );
4211cce7d176Sdrh       break;
4212cce7d176Sdrh     }
4213fef5208cSdrh     case TK_BETWEEN: {
42145c03f30aSdrh       testcase( jumpIfNull==0 );
421571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4216fef5208cSdrh       break;
4217fef5208cSdrh     }
4218bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4219e3365e6cSdrh     case TK_IN: {
4220e3365e6cSdrh       if( jumpIfNull ){
4221e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4222e3365e6cSdrh       }else{
4223e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4224e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4225e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4226e3365e6cSdrh       }
4227e3365e6cSdrh       break;
4228e3365e6cSdrh     }
4229bb201344Sshaneh #endif
4230cce7d176Sdrh     default: {
4231ba00e30aSdan     default_expr:
4232991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4233076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4234991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4235991a1985Sdrh         /* no-op */
4236991a1985Sdrh       }else{
42372dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
42382dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4239688852abSdrh         VdbeCoverage(v);
4240c5499befSdrh         testcase( regFree1==0 );
4241c5499befSdrh         testcase( jumpIfNull==0 );
4242991a1985Sdrh       }
4243cce7d176Sdrh       break;
4244cce7d176Sdrh     }
4245cce7d176Sdrh   }
42462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42472dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4248cce7d176Sdrh }
42492282792aSdrh 
42502282792aSdrh /*
425172bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
425272bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
425372bc8208Sdrh ** ensures that the original pExpr is unchanged.
425472bc8208Sdrh */
425572bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
425672bc8208Sdrh   sqlite3 *db = pParse->db;
425772bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
425872bc8208Sdrh   if( db->mallocFailed==0 ){
425972bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
426072bc8208Sdrh   }
426172bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
426272bc8208Sdrh }
426372bc8208Sdrh 
426472bc8208Sdrh 
426572bc8208Sdrh /*
42661d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
42671d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
42681d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
42691d9da70aSdrh ** other than the top-level COLLATE operator.
4270d40aab0eSdrh **
4271619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4272619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4273619a1305Sdrh **
427466518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
427566518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
427666518ca7Sdrh **
42771d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4278d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
42791d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
42801d9da70aSdrh ** returns 2, then you do not really know for certain if the two
42811d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4282d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
42831d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4284d40aab0eSdrh ** just might result in some slightly slower code.  But returning
42851d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
42862282792aSdrh */
4287619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
428810d1edf0Sdrh   u32 combinedFlags;
42894b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
42901d9da70aSdrh     return pB==pA ? 0 : 2;
42912282792aSdrh   }
429210d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
429310d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
429410d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
429510d1edf0Sdrh       return 0;
429610d1edf0Sdrh     }
42971d9da70aSdrh     return 2;
42986ab3a2ecSdanielk1977   }
4299c2acc4e4Sdrh   if( pA->op!=pB->op ){
4300619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
4301ae80ddeaSdrh       return 1;
4302ae80ddeaSdrh     }
4303619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
4304ae80ddeaSdrh       return 1;
4305ae80ddeaSdrh     }
4306ae80ddeaSdrh     return 2;
4307ae80ddeaSdrh   }
43082edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4309390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4310390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4311390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
431210d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
431310d1edf0Sdrh     }
431410d1edf0Sdrh   }
431510d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
431685f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
431710d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4318619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
4319619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
4320619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
43217693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4322619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
432366518ca7Sdrh       if( pA->iTable!=pB->iTable
432485f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
43251d9da70aSdrh     }
43261d9da70aSdrh   }
43272646da7eSdrh   return 0;
43282646da7eSdrh }
43292282792aSdrh 
43308c6f666bSdrh /*
43318c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
43328c6f666bSdrh ** non-zero if they differ in any way.
43338c6f666bSdrh **
4334619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4335619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4336619a1305Sdrh **
43378c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
43388c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
43398c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
43408c6f666bSdrh ** a malfunction will result.
43418c6f666bSdrh **
43428c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
43438c6f666bSdrh ** always differs from a non-NULL pointer.
43448c6f666bSdrh */
4345619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
43468c6f666bSdrh   int i;
43478c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
43488c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
43498c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
43508c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
43518c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
43528c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
43538c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
4354619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
43558c6f666bSdrh   }
43568c6f666bSdrh   return 0;
43578c6f666bSdrh }
435813449892Sdrh 
43592282792aSdrh /*
43604bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
43614bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
43624bd5f73fSdrh ** be false.  Examples:
43634bd5f73fSdrh **
4364619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
43654bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4366619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
43674bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4368619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4369619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4370619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
43714bd5f73fSdrh **
43724bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
43734bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
43744bd5f73fSdrh **
43754bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
43764bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
43774bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
43784bd5f73fSdrh */
43794bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
4380619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
4381619a1305Sdrh     return 1;
4382619a1305Sdrh   }
4383619a1305Sdrh   if( pE2->op==TK_OR
4384619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
4385619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
4386619a1305Sdrh   ){
4387619a1305Sdrh     return 1;
4388619a1305Sdrh   }
4389619a1305Sdrh   if( pE2->op==TK_NOTNULL
4390619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
4391619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
4392619a1305Sdrh   ){
4393619a1305Sdrh     return 1;
4394619a1305Sdrh   }
4395619a1305Sdrh   return 0;
43964bd5f73fSdrh }
43974bd5f73fSdrh 
43984bd5f73fSdrh /*
4399030796dfSdrh ** An instance of the following structure is used by the tree walker
44002409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
44012409f8a1Sdrh ** index only, without having to do a search for the corresponding
44022409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
44032409f8a1Sdrh ** is the cursor for the table.
44042409f8a1Sdrh */
44052409f8a1Sdrh struct IdxCover {
44062409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
44072409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
44082409f8a1Sdrh };
44092409f8a1Sdrh 
44102409f8a1Sdrh /*
44112409f8a1Sdrh ** Check to see if there are references to columns in table
44122409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
44132409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
44142409f8a1Sdrh */
44152409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
44162409f8a1Sdrh   if( pExpr->op==TK_COLUMN
44172409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
44182409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
44192409f8a1Sdrh   ){
44202409f8a1Sdrh     pWalker->eCode = 1;
44212409f8a1Sdrh     return WRC_Abort;
44222409f8a1Sdrh   }
44232409f8a1Sdrh   return WRC_Continue;
44242409f8a1Sdrh }
44252409f8a1Sdrh 
44262409f8a1Sdrh /*
4427e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4428e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4429e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4430e604ec0bSdrh ** that are not found in the index pIdx.
44312409f8a1Sdrh **
44322409f8a1Sdrh ** An index covering an expression means that the expression can be
44332409f8a1Sdrh ** evaluated using only the index and without having to lookup the
44342409f8a1Sdrh ** corresponding table entry.
44352409f8a1Sdrh */
44362409f8a1Sdrh int sqlite3ExprCoveredByIndex(
44372409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
44382409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
44392409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
44402409f8a1Sdrh ){
44412409f8a1Sdrh   Walker w;
44422409f8a1Sdrh   struct IdxCover xcov;
44432409f8a1Sdrh   memset(&w, 0, sizeof(w));
44442409f8a1Sdrh   xcov.iCur = iCur;
44452409f8a1Sdrh   xcov.pIdx = pIdx;
44462409f8a1Sdrh   w.xExprCallback = exprIdxCover;
44472409f8a1Sdrh   w.u.pIdxCover = &xcov;
44482409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
44492409f8a1Sdrh   return !w.eCode;
44502409f8a1Sdrh }
44512409f8a1Sdrh 
44522409f8a1Sdrh 
44532409f8a1Sdrh /*
44542409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4455030796dfSdrh ** to count references to table columns in the arguments of an
4456ed551b95Sdrh ** aggregate function, in order to implement the
4457ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4458374fdce4Sdrh */
4459030796dfSdrh struct SrcCount {
4460030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4461030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4462030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4463030796dfSdrh };
4464030796dfSdrh 
4465030796dfSdrh /*
4466030796dfSdrh ** Count the number of references to columns.
4467030796dfSdrh */
4468030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4469fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4470fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4471fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4472fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4473fb0a6081Sdrh   ** NEVER() will need to be removed. */
4474fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4475374fdce4Sdrh     int i;
4476030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4477030796dfSdrh     SrcList *pSrc = p->pSrc;
4478655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4479655814d2Sdrh     for(i=0; i<nSrc; i++){
4480030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4481374fdce4Sdrh     }
4482655814d2Sdrh     if( i<nSrc ){
4483030796dfSdrh       p->nThis++;
4484374fdce4Sdrh     }else{
4485030796dfSdrh       p->nOther++;
4486374fdce4Sdrh     }
4487374fdce4Sdrh   }
4488030796dfSdrh   return WRC_Continue;
4489030796dfSdrh }
4490374fdce4Sdrh 
4491374fdce4Sdrh /*
4492030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4493030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4494030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4495030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4496374fdce4Sdrh */
4497030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4498374fdce4Sdrh   Walker w;
4499030796dfSdrh   struct SrcCount cnt;
4500374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4501374fdce4Sdrh   memset(&w, 0, sizeof(w));
4502030796dfSdrh   w.xExprCallback = exprSrcCount;
4503030796dfSdrh   w.u.pSrcCount = &cnt;
4504030796dfSdrh   cnt.pSrc = pSrcList;
4505030796dfSdrh   cnt.nThis = 0;
4506030796dfSdrh   cnt.nOther = 0;
4507030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4508030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4509374fdce4Sdrh }
4510374fdce4Sdrh 
4511374fdce4Sdrh /*
451213449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
451313449892Sdrh ** the new element.  Return a negative number if malloc fails.
45142282792aSdrh */
451517435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
451613449892Sdrh   int i;
4517cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
451817435752Sdrh        db,
4519cf643729Sdrh        pInfo->aCol,
4520cf643729Sdrh        sizeof(pInfo->aCol[0]),
4521cf643729Sdrh        &pInfo->nColumn,
4522cf643729Sdrh        &i
4523cf643729Sdrh   );
452413449892Sdrh   return i;
45252282792aSdrh }
452613449892Sdrh 
452713449892Sdrh /*
452813449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
452913449892Sdrh ** the new element.  Return a negative number if malloc fails.
453013449892Sdrh */
453117435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
453213449892Sdrh   int i;
4533cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
453417435752Sdrh        db,
4535cf643729Sdrh        pInfo->aFunc,
4536cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4537cf643729Sdrh        &pInfo->nFunc,
4538cf643729Sdrh        &i
4539cf643729Sdrh   );
454013449892Sdrh   return i;
45412282792aSdrh }
45422282792aSdrh 
45432282792aSdrh /*
45447d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
45457d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4546626a879aSdrh ** for additional information.
45472282792aSdrh */
45487d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
45492282792aSdrh   int i;
45507d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4551a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4552a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
455313449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
455413449892Sdrh 
45552282792aSdrh   switch( pExpr->op ){
455689c69d00Sdrh     case TK_AGG_COLUMN:
4557967e8b73Sdrh     case TK_COLUMN: {
45588b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
45598b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
456013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
456113449892Sdrh       ** clause of the aggregate query */
456220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
456313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
456413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
456513449892Sdrh           struct AggInfo_col *pCol;
4566c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
456713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
456813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
456913449892Sdrh             ** that is in the FROM clause of the aggregate query.
457013449892Sdrh             **
457113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
457213449892Sdrh             ** is not an entry there already.
457313449892Sdrh             */
45747f906d63Sdrh             int k;
457513449892Sdrh             pCol = pAggInfo->aCol;
45767f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
457713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
457813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
45792282792aSdrh                 break;
45802282792aSdrh               }
45812282792aSdrh             }
45821e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
45831e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
45841e536953Sdanielk1977             ){
45857f906d63Sdrh               pCol = &pAggInfo->aCol[k];
45860817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
458713449892Sdrh               pCol->iTable = pExpr->iTable;
458813449892Sdrh               pCol->iColumn = pExpr->iColumn;
45890a07c107Sdrh               pCol->iMem = ++pParse->nMem;
459013449892Sdrh               pCol->iSorterColumn = -1;
45915774b806Sdrh               pCol->pExpr = pExpr;
459213449892Sdrh               if( pAggInfo->pGroupBy ){
459313449892Sdrh                 int j, n;
459413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
459513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
459613449892Sdrh                 n = pGB->nExpr;
459713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
459813449892Sdrh                   Expr *pE = pTerm->pExpr;
459913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
460013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
460113449892Sdrh                     pCol->iSorterColumn = j;
460213449892Sdrh                     break;
46032282792aSdrh                   }
460413449892Sdrh                 }
460513449892Sdrh               }
460613449892Sdrh               if( pCol->iSorterColumn<0 ){
460713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
460813449892Sdrh               }
460913449892Sdrh             }
461013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
461113449892Sdrh             ** because it was there before or because we just created it).
461213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
461313449892Sdrh             ** pAggInfo->aCol[] entry.
461413449892Sdrh             */
4615ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
461613449892Sdrh             pExpr->pAggInfo = pAggInfo;
461713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4618cf697396Sshane             pExpr->iAgg = (i16)k;
461913449892Sdrh             break;
462013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
462113449892Sdrh         } /* end loop over pSrcList */
4622a58fdfb1Sdanielk1977       }
46237d10d5a6Sdrh       return WRC_Prune;
46242282792aSdrh     }
46252282792aSdrh     case TK_AGG_FUNCTION: {
46263a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4627ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
46283a8c4be7Sdrh       ){
462913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
463013449892Sdrh         ** function that is already in the pAggInfo structure
463113449892Sdrh         */
463213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
463313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4634619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
46352282792aSdrh             break;
46362282792aSdrh           }
46372282792aSdrh         }
463813449892Sdrh         if( i>=pAggInfo->nFunc ){
463913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
464013449892Sdrh           */
464114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
46421e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
464313449892Sdrh           if( i>=0 ){
46446ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
464513449892Sdrh             pItem = &pAggInfo->aFunc[i];
464613449892Sdrh             pItem->pExpr = pExpr;
46470a07c107Sdrh             pItem->iMem = ++pParse->nMem;
464833e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
464913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
465080738d9cSdrh                    pExpr->u.zToken,
46516ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4652fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4653fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4654fd357974Sdrh             }else{
4655fd357974Sdrh               pItem->iDistinct = -1;
4656fd357974Sdrh             }
46572282792aSdrh           }
465813449892Sdrh         }
465913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
466013449892Sdrh         */
4661c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4662ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4663cf697396Sshane         pExpr->iAgg = (i16)i;
466413449892Sdrh         pExpr->pAggInfo = pAggInfo;
46653a8c4be7Sdrh         return WRC_Prune;
46666e83a57fSdrh       }else{
46676e83a57fSdrh         return WRC_Continue;
46686e83a57fSdrh       }
46692282792aSdrh     }
4670a58fdfb1Sdanielk1977   }
46717d10d5a6Sdrh   return WRC_Continue;
46727d10d5a6Sdrh }
46737d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4674d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4675d5a336efSdrh   UNUSED_PARAMETER(pSelect);
46767d10d5a6Sdrh   return WRC_Continue;
4677a58fdfb1Sdanielk1977 }
4678626a879aSdrh 
4679626a879aSdrh /*
4680e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4681e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4682e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4683e8abb4caSdrh ** necessary.
4684626a879aSdrh **
4685626a879aSdrh ** This routine should only be called after the expression has been
46867d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4687626a879aSdrh */
4688d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
46897d10d5a6Sdrh   Walker w;
4690374fdce4Sdrh   memset(&w, 0, sizeof(w));
46917d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
46927d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
46937d10d5a6Sdrh   w.u.pNC = pNC;
469420bc393cSdrh   assert( pNC->pSrcList!=0 );
46957d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
46962282792aSdrh }
46975d9a4af9Sdrh 
46985d9a4af9Sdrh /*
46995d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
47005d9a4af9Sdrh ** expression list.  Return the number of errors.
47015d9a4af9Sdrh **
47025d9a4af9Sdrh ** If an error is found, the analysis is cut short.
47035d9a4af9Sdrh */
4704d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
47055d9a4af9Sdrh   struct ExprList_item *pItem;
47065d9a4af9Sdrh   int i;
47075d9a4af9Sdrh   if( pList ){
4708d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4709d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
47105d9a4af9Sdrh     }
47115d9a4af9Sdrh   }
47125d9a4af9Sdrh }
4713892d3179Sdrh 
4714892d3179Sdrh /*
4715ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4716892d3179Sdrh */
4717892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4718e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4719892d3179Sdrh     return ++pParse->nMem;
4720892d3179Sdrh   }
47212f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4722892d3179Sdrh }
4723ceea3321Sdrh 
4724ceea3321Sdrh /*
4725ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4726ceea3321Sdrh ** purpose.
4727ceea3321Sdrh **
4728ceea3321Sdrh ** If a register is currently being used by the column cache, then
472960ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4730ceea3321Sdrh ** the register becomes stale.
4731ceea3321Sdrh */
4732892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
47332dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4734ceea3321Sdrh     int i;
4735ceea3321Sdrh     struct yColCache *p;
4736ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4737ceea3321Sdrh       if( p->iReg==iReg ){
4738ceea3321Sdrh         p->tempReg = 1;
4739ceea3321Sdrh         return;
4740ceea3321Sdrh       }
4741ceea3321Sdrh     }
4742892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4743892d3179Sdrh   }
4744892d3179Sdrh }
4745892d3179Sdrh 
4746892d3179Sdrh /*
4747892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4748892d3179Sdrh */
4749892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4750e55cbd72Sdrh   int i, n;
4751892d3179Sdrh   i = pParse->iRangeReg;
4752e55cbd72Sdrh   n = pParse->nRangeReg;
4753f49f3523Sdrh   if( nReg<=n ){
4754f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4755892d3179Sdrh     pParse->iRangeReg += nReg;
4756892d3179Sdrh     pParse->nRangeReg -= nReg;
4757892d3179Sdrh   }else{
4758892d3179Sdrh     i = pParse->nMem+1;
4759892d3179Sdrh     pParse->nMem += nReg;
4760892d3179Sdrh   }
4761892d3179Sdrh   return i;
4762892d3179Sdrh }
4763892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4764f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4765892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4766892d3179Sdrh     pParse->nRangeReg = nReg;
4767892d3179Sdrh     pParse->iRangeReg = iReg;
4768892d3179Sdrh   }
4769892d3179Sdrh }
4770cdc69557Sdrh 
4771cdc69557Sdrh /*
4772cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4773cdc69557Sdrh */
4774cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4775cdc69557Sdrh   pParse->nTempReg = 0;
4776cdc69557Sdrh   pParse->nRangeReg = 0;
4777cdc69557Sdrh }
4778bb9b5f26Sdrh 
4779bb9b5f26Sdrh /*
4780bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
4781bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
4782bb9b5f26Sdrh ** statements.
4783bb9b5f26Sdrh */
4784bb9b5f26Sdrh #ifdef SQLITE_DEBUG
4785bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
4786bb9b5f26Sdrh   int i;
4787bb9b5f26Sdrh   if( pParse->nRangeReg>0
4788bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
4789bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
4790bb9b5f26Sdrh   ){
4791bb9b5f26Sdrh      return 0;
4792bb9b5f26Sdrh   }
4793bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
4794bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
4795bb9b5f26Sdrh       return 0;
4796bb9b5f26Sdrh     }
4797bb9b5f26Sdrh   }
4798bb9b5f26Sdrh   return 1;
4799bb9b5f26Sdrh }
4800bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
4801