xref: /sqlite-3.40.0/src/expr.c (revision bea119cd)
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 
3124b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
3134b5255acSdanielk1977 /*
3144b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
3154b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
3164b5255acSdanielk1977 ** pParse.
3174b5255acSdanielk1977 */
3187d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
3194b5255acSdanielk1977   int rc = SQLITE_OK;
3204b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
3214b5255acSdanielk1977   if( nHeight>mxHeight ){
3224b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
3234b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
3244b5255acSdanielk1977     );
3254b5255acSdanielk1977     rc = SQLITE_ERROR;
3264b5255acSdanielk1977   }
3274b5255acSdanielk1977   return rc;
3284b5255acSdanielk1977 }
3294b5255acSdanielk1977 
3304b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
3314b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
3324b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
3334b5255acSdanielk1977 ** first argument.
3344b5255acSdanielk1977 **
3354b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
3364b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
3374b5255acSdanielk1977 ** value.
3384b5255acSdanielk1977 */
3394b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
3404b5255acSdanielk1977   if( p ){
3414b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
3424b5255acSdanielk1977       *pnHeight = p->nHeight;
3434b5255acSdanielk1977     }
3444b5255acSdanielk1977   }
3454b5255acSdanielk1977 }
3464b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3474b5255acSdanielk1977   if( p ){
3484b5255acSdanielk1977     int i;
3494b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3504b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3514b5255acSdanielk1977     }
3524b5255acSdanielk1977   }
3534b5255acSdanielk1977 }
3544b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3554b5255acSdanielk1977   if( p ){
3564b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3574b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3584b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3594b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3604b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3614b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3624b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3634b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3644b5255acSdanielk1977   }
3654b5255acSdanielk1977 }
3664b5255acSdanielk1977 
3674b5255acSdanielk1977 /*
3684b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3694b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3704b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3714b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3724b5255acSdanielk1977 ** referenced Expr plus one.
3732308ed38Sdrh **
3742308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
3752308ed38Sdrh ** if appropriate.
3764b5255acSdanielk1977 */
3774b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3784b5255acSdanielk1977   int nHeight = 0;
3794b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3804b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3816ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3826ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3832308ed38Sdrh   }else if( p->x.pList ){
3846ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3852308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
3866ab3a2ecSdanielk1977   }
3874b5255acSdanielk1977   p->nHeight = nHeight + 1;
3884b5255acSdanielk1977 }
3894b5255acSdanielk1977 
3904b5255acSdanielk1977 /*
3914b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3924b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3934b5255acSdanielk1977 ** leave an error in pParse.
3942308ed38Sdrh **
3952308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
3962308ed38Sdrh ** Expr.flags.
3974b5255acSdanielk1977 */
3982308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
39974893a4cSdrh   if( pParse->nErr ) return;
4004b5255acSdanielk1977   exprSetHeight(p);
4017d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
4024b5255acSdanielk1977 }
4034b5255acSdanielk1977 
4044b5255acSdanielk1977 /*
4054b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
4064b5255acSdanielk1977 ** by the select statement passed as an argument.
4074b5255acSdanielk1977 */
4084b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
4094b5255acSdanielk1977   int nHeight = 0;
4104b5255acSdanielk1977   heightOfSelect(p, &nHeight);
4114b5255acSdanielk1977   return nHeight;
4124b5255acSdanielk1977 }
4132308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
4142308ed38Sdrh /*
4152308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
4162308ed38Sdrh ** Expr.flags.
4172308ed38Sdrh */
4182308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
4192308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
4202308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
4212308ed38Sdrh   }
4222308ed38Sdrh }
4234b5255acSdanielk1977 #define exprSetHeight(y)
4244b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
4254b5255acSdanielk1977 
426be5c89acSdrh /*
427b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
428b7916a78Sdrh **
429a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
430b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
431b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
432a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
433b7916a78Sdrh **
434b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
435e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
436b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
437b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
438b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
43933e619fcSdrh **
44033e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
44133e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
44233e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
44333e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
44433e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
445a76b5dfcSdrh */
446b7916a78Sdrh Expr *sqlite3ExprAlloc(
447a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
44817435752Sdrh   int op,                 /* Expression opcode */
449b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
450b7916a78Sdrh   int dequote             /* True to dequote */
45117435752Sdrh ){
452a76b5dfcSdrh   Expr *pNew;
45333e619fcSdrh   int nExtra = 0;
454cf697396Sshane   int iValue = 0;
455b7916a78Sdrh 
456575fad65Sdrh   assert( db!=0 );
457b7916a78Sdrh   if( pToken ){
45833e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
45933e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
460b7916a78Sdrh       nExtra = pToken->n+1;
461d50ffc41Sdrh       assert( iValue>=0 );
46233e619fcSdrh     }
463a76b5dfcSdrh   }
464575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
465b7916a78Sdrh   if( pNew ){
466ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
4671bd10f8aSdrh     pNew->op = (u8)op;
468a58fdfb1Sdanielk1977     pNew->iAgg = -1;
469a76b5dfcSdrh     if( pToken ){
47033e619fcSdrh       if( nExtra==0 ){
47133e619fcSdrh         pNew->flags |= EP_IntValue;
47233e619fcSdrh         pNew->u.iValue = iValue;
47333e619fcSdrh       }else{
474d9da78a2Sdrh         int c;
47533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
476b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
477b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
47833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
479b7916a78Sdrh         if( dequote && nExtra>=3
480d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
48133e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
48224fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
483a34001c9Sdrh         }
484a34001c9Sdrh       }
48533e619fcSdrh     }
486b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
487b7916a78Sdrh     pNew->nHeight = 1;
488b7916a78Sdrh #endif
489a34001c9Sdrh   }
490a76b5dfcSdrh   return pNew;
491a76b5dfcSdrh }
492a76b5dfcSdrh 
493a76b5dfcSdrh /*
494b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
495b7916a78Sdrh ** already been dequoted.
496b7916a78Sdrh */
497b7916a78Sdrh Expr *sqlite3Expr(
498b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
499b7916a78Sdrh   int op,                 /* Expression opcode */
500b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
501b7916a78Sdrh ){
502b7916a78Sdrh   Token x;
503b7916a78Sdrh   x.z = zToken;
504b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
505b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
506b7916a78Sdrh }
507b7916a78Sdrh 
508b7916a78Sdrh /*
509b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
510b7916a78Sdrh **
511b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
512b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
513b7916a78Sdrh */
514b7916a78Sdrh void sqlite3ExprAttachSubtrees(
515b7916a78Sdrh   sqlite3 *db,
516b7916a78Sdrh   Expr *pRoot,
517b7916a78Sdrh   Expr *pLeft,
518b7916a78Sdrh   Expr *pRight
519b7916a78Sdrh ){
520b7916a78Sdrh   if( pRoot==0 ){
521b7916a78Sdrh     assert( db->mallocFailed );
522b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
523b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
524b7916a78Sdrh   }else{
525b7916a78Sdrh     if( pRight ){
526b7916a78Sdrh       pRoot->pRight = pRight;
527885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
528b7916a78Sdrh     }
529b7916a78Sdrh     if( pLeft ){
530b7916a78Sdrh       pRoot->pLeft = pLeft;
531885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
532b7916a78Sdrh     }
533b7916a78Sdrh     exprSetHeight(pRoot);
534b7916a78Sdrh   }
535b7916a78Sdrh }
536b7916a78Sdrh 
537b7916a78Sdrh /*
53860ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
539b7916a78Sdrh **
540bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
541bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
542bf664469Sdrh ** free the subtrees and return NULL.
543206f3d96Sdrh */
54417435752Sdrh Expr *sqlite3PExpr(
54517435752Sdrh   Parse *pParse,          /* Parsing context */
54617435752Sdrh   int op,                 /* Expression opcode */
54717435752Sdrh   Expr *pLeft,            /* Left operand */
54817435752Sdrh   Expr *pRight,           /* Right operand */
54917435752Sdrh   const Token *pToken     /* Argument token */
55017435752Sdrh ){
5515fb52caaSdrh   Expr *p;
5521167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
5535fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
5545fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
5555fb52caaSdrh   }else{
5561167d327Sdrh     p = sqlite3ExprAlloc(pParse->db, op & TKFLG_MASK, pToken, 1);
557b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
5585fb52caaSdrh   }
5592b359bdbSdan   if( p ) {
5602b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
5612b359bdbSdan   }
5624e0cff60Sdrh   return p;
5634e0cff60Sdrh }
5644e0cff60Sdrh 
5654e0cff60Sdrh /*
56608de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
56708de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
56808de4f79Sdrh */
56908de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
57008de4f79Sdrh   if( pExpr ){
57108de4f79Sdrh     pExpr->x.pSelect = pSelect;
57208de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
57308de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
57408de4f79Sdrh   }else{
57508de4f79Sdrh     assert( pParse->db->mallocFailed );
57608de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
57708de4f79Sdrh   }
57808de4f79Sdrh }
57908de4f79Sdrh 
58008de4f79Sdrh 
58108de4f79Sdrh /*
582991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
583991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
584991a1985Sdrh ** expression at compile-time return 0.
585991a1985Sdrh **
586991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
587991a1985Sdrh ** the expression really is always false or false (a false negative).
588991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
589991a1985Sdrh ** boolean values in different circumstances (a false positive.)
5905fb52caaSdrh **
5915fb52caaSdrh ** Note that if the expression is part of conditional for a
5925fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5935fb52caaSdrh ** is it true or false, so always return 0.
5945fb52caaSdrh */
595991a1985Sdrh static int exprAlwaysTrue(Expr *p){
596991a1985Sdrh   int v = 0;
597991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
598991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
599991a1985Sdrh   return v!=0;
600991a1985Sdrh }
6015fb52caaSdrh static int exprAlwaysFalse(Expr *p){
6025fb52caaSdrh   int v = 0;
6035fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
6045fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
6055fb52caaSdrh   return v==0;
6065fb52caaSdrh }
6075fb52caaSdrh 
6085fb52caaSdrh /*
60991bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
61091bb0eedSdrh ** NULL, then just return the other expression.
6115fb52caaSdrh **
6125fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
6135fb52caaSdrh ** of returning an AND expression, just return a constant expression with
6145fb52caaSdrh ** a value of false.
61591bb0eedSdrh */
6161e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
61791bb0eedSdrh   if( pLeft==0 ){
61891bb0eedSdrh     return pRight;
61991bb0eedSdrh   }else if( pRight==0 ){
62091bb0eedSdrh     return pLeft;
6215fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
6225fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
6235fb52caaSdrh     sqlite3ExprDelete(db, pRight);
6245fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
62591bb0eedSdrh   }else{
626b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
627b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
628b7916a78Sdrh     return pNew;
629a76b5dfcSdrh   }
630a76b5dfcSdrh }
631a76b5dfcSdrh 
632a76b5dfcSdrh /*
633a76b5dfcSdrh ** Construct a new expression node for a function with multiple
634a76b5dfcSdrh ** arguments.
635a76b5dfcSdrh */
63617435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
637a76b5dfcSdrh   Expr *pNew;
638633e6d57Sdrh   sqlite3 *db = pParse->db;
6394b202ae2Sdanielk1977   assert( pToken );
640b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
641a76b5dfcSdrh   if( pNew==0 ){
642d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
643a76b5dfcSdrh     return 0;
644a76b5dfcSdrh   }
6456ab3a2ecSdanielk1977   pNew->x.pList = pList;
6466ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
6472308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
648a76b5dfcSdrh   return pNew;
649a76b5dfcSdrh }
650a76b5dfcSdrh 
651a76b5dfcSdrh /*
652fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
653fa6bc000Sdrh ** in the original SQL statement.
654fa6bc000Sdrh **
655fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
656fa6bc000Sdrh ** variable number.
657fa6bc000Sdrh **
658fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
659fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
660fa6bc000Sdrh ** the SQL statement comes from an external source.
661fa6bc000Sdrh **
66251f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
663fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
66460ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
665fa6bc000Sdrh ** assigned.
666fa6bc000Sdrh */
667fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
66817435752Sdrh   sqlite3 *db = pParse->db;
669b7916a78Sdrh   const char *z;
67017435752Sdrh 
671fa6bc000Sdrh   if( pExpr==0 ) return;
672c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
67333e619fcSdrh   z = pExpr->u.zToken;
674b7916a78Sdrh   assert( z!=0 );
675b7916a78Sdrh   assert( z[0]!=0 );
676b7916a78Sdrh   if( z[1]==0 ){
677fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
678b7916a78Sdrh     assert( z[0]=='?' );
6798677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
680124c0b49Sdrh   }else{
681124c0b49Sdrh     ynVar x = 0;
682124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
683124c0b49Sdrh     if( z[0]=='?' ){
684fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
685fa6bc000Sdrh       ** use it as the variable number */
686c8d735aeSdan       i64 i;
687124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
688124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
689c5499befSdrh       testcase( i==0 );
690c5499befSdrh       testcase( i==1 );
691c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
692c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
693c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
694fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
695bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
696124c0b49Sdrh         x = 0;
697fa6bc000Sdrh       }
698fa6bc000Sdrh       if( i>pParse->nVar ){
6991df2db7fSshaneh         pParse->nVar = (int)i;
700fa6bc000Sdrh       }
701fa6bc000Sdrh     }else{
70251f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
703fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
704fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
705fa6bc000Sdrh       */
706124c0b49Sdrh       ynVar i;
707124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
708503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
709124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
710fa6bc000Sdrh           break;
711fa6bc000Sdrh         }
712fa6bc000Sdrh       }
713124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
714fa6bc000Sdrh     }
715124c0b49Sdrh     if( x>0 ){
716124c0b49Sdrh       if( x>pParse->nzVar ){
717124c0b49Sdrh         char **a;
718124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
7194a642b60Sdrh         if( a==0 ){
7204a642b60Sdrh           assert( db->mallocFailed ); /* Error reported through mallocFailed */
7214a642b60Sdrh           return;
7224a642b60Sdrh         }
723124c0b49Sdrh         pParse->azVar = a;
724124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
725124c0b49Sdrh         pParse->nzVar = x;
726124c0b49Sdrh       }
727124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
728124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
729124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
730fa6bc000Sdrh       }
731fa6bc000Sdrh     }
732fa6bc000Sdrh   }
733bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
734832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
735832b2664Sdanielk1977   }
736fa6bc000Sdrh }
737fa6bc000Sdrh 
738fa6bc000Sdrh /*
739f6963f99Sdan ** Recursively delete an expression tree.
740a2e00042Sdrh */
7414f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
7424f0010b1Sdrh   assert( p!=0 );
743d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
744d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
745c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
746c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
747c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
748633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
749633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
750c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
7516ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
7526ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
7536ab3a2ecSdanielk1977     }else{
7546ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
7556ab3a2ecSdanielk1977     }
7566ab3a2ecSdanielk1977   }
75733e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
758633e6d57Sdrh     sqlite3DbFree(db, p);
759a2e00042Sdrh   }
76033e619fcSdrh }
7614f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
7624f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
7634f0010b1Sdrh }
764a2e00042Sdrh 
765d2687b77Sdrh /*
7666ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
7676ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
7686ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
7696ab3a2ecSdanielk1977 */
7706ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
7716ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
7726ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
7736ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
7746ab3a2ecSdanielk1977 }
7756ab3a2ecSdanielk1977 
7766ab3a2ecSdanielk1977 /*
77733e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
77833e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
77933e619fcSdrh ** how much of the tree is measured.
78033e619fcSdrh **
78133e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
78233e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
78333e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
78433e619fcSdrh **
78533e619fcSdrh ***************************************************************************
78633e619fcSdrh **
78733e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
78833e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
78933e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
79033e619fcSdrh ** The return values is always one of:
79133e619fcSdrh **
79233e619fcSdrh **      EXPR_FULLSIZE
79333e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
79433e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
79533e619fcSdrh **
79633e619fcSdrh ** The size of the structure can be found by masking the return value
79733e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
79833e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
79933e619fcSdrh **
80033e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
80133e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
80233e619fcSdrh ** During expression analysis, extra information is computed and moved into
80333e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
80433e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
80560ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
80633e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
80733e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
80833e619fcSdrh ** to enforce this constraint.
8096ab3a2ecSdanielk1977 */
8106ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
8116ab3a2ecSdanielk1977   int nSize;
81233e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
813aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
814aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
8153c19469cSdrh   if( 0==flags ){
8166ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
8176ab3a2ecSdanielk1977   }else{
818c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
81933e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
820c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
821ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
822aecd8021Sdrh     if( p->pLeft || p->x.pList ){
82333e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
82433e619fcSdrh     }else{
825aecd8021Sdrh       assert( p->pRight==0 );
82633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
82733e619fcSdrh     }
8286ab3a2ecSdanielk1977   }
8296ab3a2ecSdanielk1977   return nSize;
8306ab3a2ecSdanielk1977 }
8316ab3a2ecSdanielk1977 
8326ab3a2ecSdanielk1977 /*
83333e619fcSdrh ** This function returns the space in bytes required to store the copy
83433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
83533e619fcSdrh ** string is defined.)
8366ab3a2ecSdanielk1977 */
8376ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
83833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
83933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
84033e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
8416ab3a2ecSdanielk1977   }
842bc73971dSdanielk1977   return ROUND8(nByte);
8436ab3a2ecSdanielk1977 }
8446ab3a2ecSdanielk1977 
8456ab3a2ecSdanielk1977 /*
8466ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
8476ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
8486ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
8496ab3a2ecSdanielk1977 **
8506ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
85133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
8526ab3a2ecSdanielk1977 **
8536ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
8546ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
8556ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
8566ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
8576ab3a2ecSdanielk1977 */
8586ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
8596ab3a2ecSdanielk1977   int nByte = 0;
8606ab3a2ecSdanielk1977   if( p ){
8616ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
8626ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
863b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
8646ab3a2ecSdanielk1977     }
8656ab3a2ecSdanielk1977   }
8666ab3a2ecSdanielk1977   return nByte;
8676ab3a2ecSdanielk1977 }
8686ab3a2ecSdanielk1977 
8696ab3a2ecSdanielk1977 /*
8706ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
8716ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
87233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
8736ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
87460ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
8756ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
8766ab3a2ecSdanielk1977 */
8773c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
8783c19469cSdrh   Expr *pNew;           /* Value to return */
8793c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
8803c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
8816ab3a2ecSdanielk1977 
8823c19469cSdrh   assert( db!=0 );
8833c19469cSdrh   assert( p );
8843c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
8853c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
8866ab3a2ecSdanielk1977 
8876ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
8886ab3a2ecSdanielk1977   if( pzBuffer ){
8896ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
89033e619fcSdrh     staticFlag = EP_Static;
8916ab3a2ecSdanielk1977   }else{
8923c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
8933c19469cSdrh     staticFlag = 0;
8946ab3a2ecSdanielk1977   }
8956ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
8966ab3a2ecSdanielk1977 
8976ab3a2ecSdanielk1977   if( pNew ){
8986ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
8996ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
9006ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
90133e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
9026ab3a2ecSdanielk1977     */
9033c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
90433e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
90533e619fcSdrh     int nToken;
90633e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
90733e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
90833e619fcSdrh     }else{
90933e619fcSdrh       nToken = 0;
91033e619fcSdrh     }
9113c19469cSdrh     if( dupFlags ){
9126ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
9136ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
9146ab3a2ecSdanielk1977     }else{
9153e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
9166ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
91772ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
9186ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
9196ab3a2ecSdanielk1977       }
92072ea29d7Sdrh     }
9216ab3a2ecSdanielk1977 
92233e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
923c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
92433e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
92533e619fcSdrh     pNew->flags |= staticFlag;
9266ab3a2ecSdanielk1977 
92733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
9286ab3a2ecSdanielk1977     if( nToken ){
92933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
93033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
9316ab3a2ecSdanielk1977     }
9326ab3a2ecSdanielk1977 
9336ab3a2ecSdanielk1977     if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
9346ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
9356ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
9363c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
9376ab3a2ecSdanielk1977       }else{
9383c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
9396ab3a2ecSdanielk1977       }
9406ab3a2ecSdanielk1977     }
9416ab3a2ecSdanielk1977 
9426ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
943c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
9443c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
9456ab3a2ecSdanielk1977       if( ExprHasProperty(pNew, EP_Reduced) ){
9463c19469cSdrh         pNew->pLeft = p->pLeft ?
9473c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
9483c19469cSdrh         pNew->pRight = p->pRight ?
9493c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
9506ab3a2ecSdanielk1977       }
9516ab3a2ecSdanielk1977       if( pzBuffer ){
9526ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
9536ab3a2ecSdanielk1977       }
954b7916a78Sdrh     }else{
955c5cd1249Sdrh       if( !ExprHasProperty(p, EP_TokenOnly) ){
9566ab3a2ecSdanielk1977         pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
9576ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
9586ab3a2ecSdanielk1977       }
9596ab3a2ecSdanielk1977     }
9606ab3a2ecSdanielk1977   }
9616ab3a2ecSdanielk1977   return pNew;
9626ab3a2ecSdanielk1977 }
9636ab3a2ecSdanielk1977 
9646ab3a2ecSdanielk1977 /*
965bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
966bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
967bfe31e7fSdan ** and the db->mallocFailed flag set.
968bfe31e7fSdan */
969eede6a53Sdan #ifndef SQLITE_OMIT_CTE
970bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
9714e9119d9Sdan   With *pRet = 0;
9724e9119d9Sdan   if( p ){
9734e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
9744e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
9754e9119d9Sdan     if( pRet ){
9764e9119d9Sdan       int i;
9774e9119d9Sdan       pRet->nCte = p->nCte;
9784e9119d9Sdan       for(i=0; i<p->nCte; i++){
9794e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
9804e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
9814e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
9824e9119d9Sdan       }
9834e9119d9Sdan     }
9844e9119d9Sdan   }
9854e9119d9Sdan   return pRet;
9864e9119d9Sdan }
987eede6a53Sdan #else
988eede6a53Sdan # define withDup(x,y) 0
989eede6a53Sdan #endif
9904e9119d9Sdan 
991a76b5dfcSdrh /*
992ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
993ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
994ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
995ff78bd2fSdrh ** without effecting the originals.
996ff78bd2fSdrh **
9974adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
9984adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
999ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1000ff78bd2fSdrh **
1001ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
10026ab3a2ecSdanielk1977 **
1003b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
10046ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
10056ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
10066ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1007ff78bd2fSdrh */
10086ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
100972ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
10103c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1011ff78bd2fSdrh }
10126ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1013ff78bd2fSdrh   ExprList *pNew;
1014145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1015ff78bd2fSdrh   int i;
1016575fad65Sdrh   assert( db!=0 );
1017ff78bd2fSdrh   if( p==0 ) return 0;
1018575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1019ff78bd2fSdrh   if( pNew==0 ) return 0;
1020d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
1021d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
1022575fad65Sdrh   pNew->a = pItem = sqlite3DbMallocRawNN(db,  i*sizeof(p->a[0]) );
1023e0048400Sdanielk1977   if( pItem==0 ){
1024633e6d57Sdrh     sqlite3DbFree(db, pNew);
1025e0048400Sdanielk1977     return 0;
1026e0048400Sdanielk1977   }
1027145716b3Sdrh   pOldItem = p->a;
1028145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
10296ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1030b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
103117435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1032b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1033145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
10343e7bc9caSdrh     pItem->done = 0;
10352c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1036c2acc4e4Sdrh     pItem->u = pOldItem->u;
1037ff78bd2fSdrh   }
1038ff78bd2fSdrh   return pNew;
1039ff78bd2fSdrh }
104093758c8dSdanielk1977 
104193758c8dSdanielk1977 /*
104293758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
104393758c8dSdanielk1977 ** the build, then none of the following routines, except for
104493758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
104593758c8dSdanielk1977 ** called with a NULL argument.
104693758c8dSdanielk1977 */
10476a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
10486a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
10496ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1050ad3cab52Sdrh   SrcList *pNew;
1051ad3cab52Sdrh   int i;
1052113088ecSdrh   int nByte;
1053575fad65Sdrh   assert( db!=0 );
1054ad3cab52Sdrh   if( p==0 ) return 0;
1055113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1056575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1057ad3cab52Sdrh   if( pNew==0 ) return 0;
10584305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1059ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
10604efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
10614efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1062ed8a3bb1Sdrh     Table *pTab;
106341fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
106417435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
106517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
106617435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
10678a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
10684efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
10695b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
10705b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
10718a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
10728a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
10738a48b9c0Sdrh     }
10748a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
10758a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
10768a48b9c0Sdrh       pNewItem->u1.pFuncArg =
10778a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
10788a48b9c0Sdrh     }
1079ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1080ed8a3bb1Sdrh     if( pTab ){
1081ed8a3bb1Sdrh       pTab->nRef++;
1082a1cb183dSdanielk1977     }
10836ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
10846ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
108517435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
10866c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1087ad3cab52Sdrh   }
1088ad3cab52Sdrh   return pNew;
1089ad3cab52Sdrh }
109017435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1091ff78bd2fSdrh   IdList *pNew;
1092ff78bd2fSdrh   int i;
1093575fad65Sdrh   assert( db!=0 );
1094ff78bd2fSdrh   if( p==0 ) return 0;
1095575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1096ff78bd2fSdrh   if( pNew==0 ) return 0;
10976c535158Sdrh   pNew->nId = p->nId;
1098575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1099d5d56523Sdanielk1977   if( pNew->a==0 ){
1100633e6d57Sdrh     sqlite3DbFree(db, pNew);
1101d5d56523Sdanielk1977     return 0;
1102d5d56523Sdanielk1977   }
11036c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
11046c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
11056c535158Sdrh   ** on the duplicate created by this function. */
1106ff78bd2fSdrh   for(i=0; i<p->nId; i++){
11074efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
11084efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
110917435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
11104efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1111ff78bd2fSdrh   }
1112ff78bd2fSdrh   return pNew;
1113ff78bd2fSdrh }
11146ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
111523b1b372Sdrh   Select *pNew, *pPrior;
1116575fad65Sdrh   assert( db!=0 );
1117ff78bd2fSdrh   if( p==0 ) return 0;
1118575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1119ff78bd2fSdrh   if( pNew==0 ) return 0;
1120b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
11216ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
11226ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
11236ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
11246ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
11256ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1126ff78bd2fSdrh   pNew->op = p->op;
112723b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
112823b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
112923b1b372Sdrh   pNew->pNext = 0;
11306ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
11316ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
113292b01d53Sdrh   pNew->iLimit = 0;
113392b01d53Sdrh   pNew->iOffset = 0;
11347d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1135b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1136b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1137ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
11384e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1139eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1140ff78bd2fSdrh   return pNew;
1141ff78bd2fSdrh }
114293758c8dSdanielk1977 #else
11436ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
114493758c8dSdanielk1977   assert( p==0 );
114593758c8dSdanielk1977   return 0;
114693758c8dSdanielk1977 }
114793758c8dSdanielk1977 #endif
1148ff78bd2fSdrh 
1149ff78bd2fSdrh 
1150ff78bd2fSdrh /*
1151a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1152a76b5dfcSdrh ** initially NULL, then create a new expression list.
1153b7916a78Sdrh **
1154b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1155b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1156b7916a78Sdrh ** that the new entry was successfully appended.
1157a76b5dfcSdrh */
115817435752Sdrh ExprList *sqlite3ExprListAppend(
115917435752Sdrh   Parse *pParse,          /* Parsing context */
116017435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1161b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
116217435752Sdrh ){
116317435752Sdrh   sqlite3 *db = pParse->db;
1164575fad65Sdrh   assert( db!=0 );
1165a76b5dfcSdrh   if( pList==0 ){
1166575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1167a76b5dfcSdrh     if( pList==0 ){
1168d5d56523Sdanielk1977       goto no_mem;
1169a76b5dfcSdrh     }
1170c263f7c4Sdrh     pList->nExpr = 0;
1171575fad65Sdrh     pList->a = sqlite3DbMallocRawNN(db, sizeof(pList->a[0]));
1172d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1173d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1174d5d56523Sdanielk1977     struct ExprList_item *a;
1175d872bb18Sdrh     assert( pList->nExpr>0 );
1176d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1177d5d56523Sdanielk1977     if( a==0 ){
1178d5d56523Sdanielk1977       goto no_mem;
1179a76b5dfcSdrh     }
1180d5d56523Sdanielk1977     pList->a = a;
1181a76b5dfcSdrh   }
11824efc4754Sdrh   assert( pList->a!=0 );
1183b7916a78Sdrh   if( 1 ){
11844efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
11854efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1186e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1187a76b5dfcSdrh   }
1188a76b5dfcSdrh   return pList;
1189d5d56523Sdanielk1977 
1190d5d56523Sdanielk1977 no_mem:
1191d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1192633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1193633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1194d5d56523Sdanielk1977   return 0;
1195a76b5dfcSdrh }
1196a76b5dfcSdrh 
1197a76b5dfcSdrh /*
1198bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1199bc622bc0Sdrh */
1200bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1201bc622bc0Sdrh   if( p==0 ) return;
1202bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1203bc622bc0Sdrh   assert( p->nExpr>0 );
1204bc622bc0Sdrh   if( iSortOrder<0 ){
1205bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1206bc622bc0Sdrh     return;
1207bc622bc0Sdrh   }
1208bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1209bc622bc0Sdrh }
1210bc622bc0Sdrh 
1211bc622bc0Sdrh /*
1212b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1213b7916a78Sdrh ** on the expression list.
1214b7916a78Sdrh **
1215b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1216b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1217b7916a78Sdrh ** is set.
1218b7916a78Sdrh */
1219b7916a78Sdrh void sqlite3ExprListSetName(
1220b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1221b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1222b7916a78Sdrh   Token *pName,           /* Name to be added */
1223b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1224b7916a78Sdrh ){
1225b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1226b7916a78Sdrh   if( pList ){
1227b7916a78Sdrh     struct ExprList_item *pItem;
1228b7916a78Sdrh     assert( pList->nExpr>0 );
1229b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1230b7916a78Sdrh     assert( pItem->zName==0 );
1231b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1232b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1233b7916a78Sdrh   }
1234b7916a78Sdrh }
1235b7916a78Sdrh 
1236b7916a78Sdrh /*
1237b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1238b7916a78Sdrh ** on the expression list.
1239b7916a78Sdrh **
1240b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1241b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1242b7916a78Sdrh ** is set.
1243b7916a78Sdrh */
1244b7916a78Sdrh void sqlite3ExprListSetSpan(
1245b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1246b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1247b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1248b7916a78Sdrh ){
1249b7916a78Sdrh   sqlite3 *db = pParse->db;
1250b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1251b7916a78Sdrh   if( pList ){
1252b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1253b7916a78Sdrh     assert( pList->nExpr>0 );
1254b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1255b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1256b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1257cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1258b7916a78Sdrh   }
1259b7916a78Sdrh }
1260b7916a78Sdrh 
1261b7916a78Sdrh /*
12627a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
12637a15a4beSdanielk1977 ** leave an error message in pParse.
12647a15a4beSdanielk1977 */
12657a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
12667a15a4beSdanielk1977   Parse *pParse,
12677a15a4beSdanielk1977   ExprList *pEList,
12687a15a4beSdanielk1977   const char *zObject
12697a15a4beSdanielk1977 ){
1270b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1271c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1272c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1273b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
12747a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
12757a15a4beSdanielk1977   }
12767a15a4beSdanielk1977 }
12777a15a4beSdanielk1977 
12787a15a4beSdanielk1977 /*
1279a76b5dfcSdrh ** Delete an entire expression list.
1280a76b5dfcSdrh */
1281633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1282a76b5dfcSdrh   int i;
1283be5c89acSdrh   struct ExprList_item *pItem;
1284a76b5dfcSdrh   if( pList==0 ) return;
1285d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1286be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1287633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1288633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1289b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1290a76b5dfcSdrh   }
1291633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1292633e6d57Sdrh   sqlite3DbFree(db, pList);
1293a76b5dfcSdrh }
1294a76b5dfcSdrh 
1295a76b5dfcSdrh /*
12962308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
12972308ed38Sdrh ** ExprList.
1298885a5b03Sdrh */
12992308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1300885a5b03Sdrh   int i;
13012308ed38Sdrh   u32 m = 0;
13022308ed38Sdrh   if( pList ){
1303885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1304d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
1305de845c2fSdrh        assert( pExpr!=0 );
1306de845c2fSdrh        m |= pExpr->flags;
1307885a5b03Sdrh     }
13082308ed38Sdrh   }
13092308ed38Sdrh   return m;
1310885a5b03Sdrh }
1311885a5b03Sdrh 
1312885a5b03Sdrh /*
1313059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1314059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1315059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1316059b2d50Sdrh ** for.
131773b211abSdrh **
13187d10d5a6Sdrh ** These callback routines are used to implement the following:
1319626a879aSdrh **
1320059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1321059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1322fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1323059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
132487abf5c0Sdrh **
1325059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1326059b2d50Sdrh ** is found to not be a constant.
132787abf5c0Sdrh **
1328feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1329059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1330059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1331feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1332feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1333feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1334feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1335feada2dfSdrh ** malformed schema error.
1336626a879aSdrh */
13377d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1338626a879aSdrh 
1339059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1340059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
13410a168377Sdrh   ** from being considered constant. */
1342059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1343059b2d50Sdrh     pWalker->eCode = 0;
13447d10d5a6Sdrh     return WRC_Abort;
13450a168377Sdrh   }
13460a168377Sdrh 
1347626a879aSdrh   switch( pExpr->op ){
1348eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1349059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1350059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1351eb55bd2fSdrh     case TK_FUNCTION:
135263f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1353b1fba286Sdrh         return WRC_Continue;
1354059b2d50Sdrh       }else{
1355059b2d50Sdrh         pWalker->eCode = 0;
1356059b2d50Sdrh         return WRC_Abort;
1357b1fba286Sdrh       }
1358626a879aSdrh     case TK_ID:
1359626a879aSdrh     case TK_COLUMN:
1360626a879aSdrh     case TK_AGG_FUNCTION:
136113449892Sdrh     case TK_AGG_COLUMN:
1362c5499befSdrh       testcase( pExpr->op==TK_ID );
1363c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1364c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1365c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1366059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1367059b2d50Sdrh         return WRC_Continue;
1368059b2d50Sdrh       }else{
1369059b2d50Sdrh         pWalker->eCode = 0;
13707d10d5a6Sdrh         return WRC_Abort;
1371059b2d50Sdrh       }
1372feada2dfSdrh     case TK_VARIABLE:
1373059b2d50Sdrh       if( pWalker->eCode==5 ){
1374feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1375feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1376feada2dfSdrh         ** of the sqlite_master table */
1377feada2dfSdrh         pExpr->op = TK_NULL;
1378059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1379feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1380feada2dfSdrh         ** sqlite3_prepare() causes an error */
1381059b2d50Sdrh         pWalker->eCode = 0;
1382feada2dfSdrh         return WRC_Abort;
1383feada2dfSdrh       }
1384feada2dfSdrh       /* Fall through */
1385626a879aSdrh     default:
1386b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1387b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
13887d10d5a6Sdrh       return WRC_Continue;
1389626a879aSdrh   }
1390626a879aSdrh }
139162c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
139262c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1393059b2d50Sdrh   pWalker->eCode = 0;
13947d10d5a6Sdrh   return WRC_Abort;
13957d10d5a6Sdrh }
1396059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
13977d10d5a6Sdrh   Walker w;
1398aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1399059b2d50Sdrh   w.eCode = initFlag;
14007d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
14017d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1402059b2d50Sdrh   w.u.iCur = iCur;
14037d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1404059b2d50Sdrh   return w.eCode;
14057d10d5a6Sdrh }
1406626a879aSdrh 
1407626a879aSdrh /*
1408059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1409eb55bd2fSdrh ** and 0 if it involves variables or function calls.
14102398937bSdrh **
14112398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
14122398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
14132398937bSdrh ** a constant.
1414fef5208cSdrh */
14154adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1416059b2d50Sdrh   return exprIsConst(p, 1, 0);
1417fef5208cSdrh }
1418fef5208cSdrh 
1419fef5208cSdrh /*
1420059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
14210a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
14220a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
14230a168377Sdrh ** an ON or USING clause.
14240a168377Sdrh */
14250a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1426059b2d50Sdrh   return exprIsConst(p, 2, 0);
14270a168377Sdrh }
14280a168377Sdrh 
14290a168377Sdrh /*
1430fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1431059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1432059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1433059b2d50Sdrh ** table other than iCur.
1434059b2d50Sdrh */
1435059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1436059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1437059b2d50Sdrh }
1438059b2d50Sdrh 
1439059b2d50Sdrh /*
1440059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1441eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1442eb55bd2fSdrh ** are any variables.
1443eb55bd2fSdrh **
1444eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1445eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1446eb55bd2fSdrh ** a constant.
1447eb55bd2fSdrh */
1448feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1449feada2dfSdrh   assert( isInit==0 || isInit==1 );
1450059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1451eb55bd2fSdrh }
1452eb55bd2fSdrh 
14535b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
14545b88bc4bSdrh /*
14555b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
14565b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
14575b88bc4bSdrh */
14585b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
14595b88bc4bSdrh   Walker w;
14605b88bc4bSdrh   memset(&w, 0, sizeof(w));
1461bec2476aSdrh   w.eCode = 1;
14625b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
14635b88bc4bSdrh   w.xSelectCallback = selectNodeIsConstant;
14645b88bc4bSdrh   sqlite3WalkExpr(&w, p);
146507194bffSdrh   return w.eCode==0;
14665b88bc4bSdrh }
14675b88bc4bSdrh #endif
14685b88bc4bSdrh 
1469eb55bd2fSdrh /*
147073b211abSdrh ** If the expression p codes a constant integer that is small enough
1471202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1472202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1473202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1474e4de1febSdrh */
14754adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
147692b01d53Sdrh   int rc = 0;
1477cd92e84dSdrh 
1478cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1479cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1480cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1481cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1482cd92e84dSdrh 
148392b01d53Sdrh   if( p->flags & EP_IntValue ){
148433e619fcSdrh     *pValue = p->u.iValue;
1485e4de1febSdrh     return 1;
1486e4de1febSdrh   }
148792b01d53Sdrh   switch( p->op ){
14884b59ab5eSdrh     case TK_UPLUS: {
148992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1490f6e369a1Sdrh       break;
14914b59ab5eSdrh     }
1492e4de1febSdrh     case TK_UMINUS: {
1493e4de1febSdrh       int v;
14944adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1495f6418891Smistachkin         assert( v!=(-2147483647-1) );
1496e4de1febSdrh         *pValue = -v;
149792b01d53Sdrh         rc = 1;
1498e4de1febSdrh       }
1499e4de1febSdrh       break;
1500e4de1febSdrh     }
1501e4de1febSdrh     default: break;
1502e4de1febSdrh   }
150392b01d53Sdrh   return rc;
1504e4de1febSdrh }
1505e4de1febSdrh 
1506e4de1febSdrh /*
1507039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1508039fc32eSdrh **
1509039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1510039fc32eSdrh ** to tell return TRUE.
1511039fc32eSdrh **
1512039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1513039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1514039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1515039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1516039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1517039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1518039fc32eSdrh ** TRUE.
1519039fc32eSdrh */
1520039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1521039fc32eSdrh   u8 op;
1522cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1523039fc32eSdrh   op = p->op;
1524039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1525039fc32eSdrh   switch( op ){
1526039fc32eSdrh     case TK_INTEGER:
1527039fc32eSdrh     case TK_STRING:
1528039fc32eSdrh     case TK_FLOAT:
1529039fc32eSdrh     case TK_BLOB:
1530039fc32eSdrh       return 0;
15317248a8b2Sdrh     case TK_COLUMN:
15327248a8b2Sdrh       assert( p->pTab!=0 );
153372673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
153472673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1535039fc32eSdrh     default:
1536039fc32eSdrh       return 1;
1537039fc32eSdrh   }
1538039fc32eSdrh }
1539039fc32eSdrh 
1540039fc32eSdrh /*
1541039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1542039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1543039fc32eSdrh ** argument.
1544039fc32eSdrh **
1545039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1546039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1547039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1548039fc32eSdrh ** answer.
1549039fc32eSdrh */
1550039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1551039fc32eSdrh   u8 op;
155205883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1553cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1554039fc32eSdrh   op = p->op;
1555039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1556039fc32eSdrh   switch( op ){
1557039fc32eSdrh     case TK_INTEGER: {
1558039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1559039fc32eSdrh     }
1560039fc32eSdrh     case TK_FLOAT: {
1561039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1562039fc32eSdrh     }
1563039fc32eSdrh     case TK_STRING: {
1564039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1565039fc32eSdrh     }
1566039fc32eSdrh     case TK_BLOB: {
1567039fc32eSdrh       return 1;
1568039fc32eSdrh     }
15692f2855b6Sdrh     case TK_COLUMN: {
157088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
157188376ca7Sdrh       return p->iColumn<0
15722f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
15732f2855b6Sdrh     }
1574039fc32eSdrh     default: {
1575039fc32eSdrh       return 0;
1576039fc32eSdrh     }
1577039fc32eSdrh   }
1578039fc32eSdrh }
1579039fc32eSdrh 
1580039fc32eSdrh /*
1581c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1582c4a3c779Sdrh */
15834adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
15844adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
15854adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
15864adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1587c4a3c779Sdrh   return 0;
1588c4a3c779Sdrh }
1589c4a3c779Sdrh 
15909a96b668Sdanielk1977 /*
159169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
159269c355bdSdrh ** that can be simplified to a direct table access, then return
159369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
159469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
159569c355bdSdrh ** table, then return NULL.
1596b287f4b6Sdrh */
1597b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
159869c355bdSdrh static Select *isCandidateForInOpt(Expr *pX){
159969c355bdSdrh   Select *p;
1600b287f4b6Sdrh   SrcList *pSrc;
1601b287f4b6Sdrh   ExprList *pEList;
160269c355bdSdrh   Expr *pRes;
1603b287f4b6Sdrh   Table *pTab;
160469c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
160569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
160669c355bdSdrh   p = pX->x.pSelect;
1607b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
16087d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1609b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1610b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
16117d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
16127d10d5a6Sdrh   }
1613b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1614b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1615b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1616b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1617b287f4b6Sdrh   pSrc = p->pSrc;
1618d1fa7bcaSdrh   assert( pSrc!=0 );
1619d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1620b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1621b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
162269c355bdSdrh   assert( pTab!=0 );
1623b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1624b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1625b287f4b6Sdrh   pEList = p->pEList;
1626b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
162790730c9eSdrh   pRes = pEList->a[0].pExpr;
162890730c9eSdrh   if( pRes->op!=TK_COLUMN ) return 0;    /* Result is a column */
162969c355bdSdrh   assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
163069c355bdSdrh   return p;
1631b287f4b6Sdrh }
1632b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1633b287f4b6Sdrh 
1634b287f4b6Sdrh /*
16351d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
16361d8cb21fSdan ** address of the new instruction.
16371d8cb21fSdan */
16381d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
16391d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
16401d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
16411d8cb21fSdan }
16421d8cb21fSdan 
16431d8cb21fSdan /*
16444c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
16454c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
16466be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
16476be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
16486be515ebSdrh */
16496be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
1650728e0f91Sdrh   int addr1;
16516be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
1652728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
16536be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
16546be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
16554c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
1656728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
16576be515ebSdrh }
16586be515ebSdrh 
1659bb53ecb1Sdrh 
1660bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1661bb53ecb1Sdrh /*
1662bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
1663bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
1664bb53ecb1Sdrh */
1665bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
1666bb53ecb1Sdrh   Expr *pLHS;
1667bb53ecb1Sdrh   int res;
1668bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1669bb53ecb1Sdrh   pLHS = pIn->pLeft;
1670bb53ecb1Sdrh   pIn->pLeft = 0;
1671bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
1672bb53ecb1Sdrh   pIn->pLeft = pLHS;
1673bb53ecb1Sdrh   return res;
1674bb53ecb1Sdrh }
1675bb53ecb1Sdrh #endif
1676bb53ecb1Sdrh 
16776be515ebSdrh /*
16789a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1679d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1680d4305ca6Sdrh ** might be either a list of expressions or a subquery.
16819a96b668Sdanielk1977 **
1682d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1683d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1684d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1685d4305ca6Sdrh **
16863a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
1687d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1688d4305ca6Sdrh **
1689b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
16909a96b668Sdanielk1977 **
16919a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
16921ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
16931ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
16949a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
16959a96b668Sdanielk1977 **                         populated epheremal table.
1696bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
1697bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
16989a96b668Sdanielk1977 **
1699d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1700d4305ca6Sdrh ** subquery such as:
17019a96b668Sdanielk1977 **
17029a96b668Sdanielk1977 **     SELECT <column> FROM <table>
17039a96b668Sdanielk1977 **
1704d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1705d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
170660ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
1707d4305ca6Sdrh ** existing table.
1708d4305ca6Sdrh **
17093a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
17103a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
17113a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
17123a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
17133a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
17143a85625dSdrh ** IN operator.
17153a85625dSdrh **
17163a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
17173a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
17183a85625dSdrh ** An epheremal table must be used unless the selected <column> is guaranteed
17199a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1720b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
17210cdc022eSdanielk1977 **
17223a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
17233a85625dSdrh ** for fast set membership tests) then an epheremal table must
17240cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
17250cdc022eSdanielk1977 ** be found with <column> as its left-most column.
17260cdc022eSdanielk1977 **
1727bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1728bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
1729bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
1730bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
1731bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
1732bb53ecb1Sdrh ** of Eq or Ne comparison operations.
1733bb53ecb1Sdrh **
1734b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
17353a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
1736e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
17373a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
17380cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1739e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
1740e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
17410cdc022eSdanielk1977 **
1742e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
17436be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
17446be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
17456be515ebSdrh ** NULL values.
17469a96b668Sdanielk1977 */
1747284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
1748e21a6e1dSdrh int sqlite3FindInIndex(Parse *pParse, Expr *pX, u32 inFlags, int *prRhsHasNull){
1749b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1750b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1751b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
17523a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
1753b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
17549a96b668Sdanielk1977 
17551450bc6eSdrh   assert( pX->op==TK_IN );
17563a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
17571450bc6eSdrh 
1758b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1759b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1760b74b1017Sdrh   ** ephemeral table.
17619a96b668Sdanielk1977   */
176269c355bdSdrh   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
1763e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1764b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1765b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1766bbbdc83bSdrh     i16 iCol;                              /* Index of column <column> */
1767bbbdc83bSdrh     i16 iDb;                               /* Database idx for pTab */
1768e1fb65a0Sdanielk1977 
1769b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1770b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1771b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1772b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1773b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1774bbbdc83bSdrh     iCol = (i16)pExpr->iColumn;
1775b07028f7Sdrh 
1776b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
1777e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1778e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1779e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
17809a96b668Sdanielk1977 
17819a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
17829a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
17839a96b668Sdanielk1977     ** successful here.
17849a96b668Sdanielk1977     */
17859a96b668Sdanielk1977     assert(v);
17869a96b668Sdanielk1977     if( iCol<0 ){
17877d176105Sdrh       int iAddr = sqlite3CodeOnce(pParse);
17887d176105Sdrh       VdbeCoverage(v);
17899a96b668Sdanielk1977 
17909a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
17919a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
17929a96b668Sdanielk1977 
17939a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
17949a96b668Sdanielk1977     }else{
1795e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1796e1fb65a0Sdanielk1977 
17979a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
17989a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1799e1fb65a0Sdanielk1977       ** to this collation sequence.  */
18009a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
18019a96b668Sdanielk1977 
18029a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
18039a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
18049a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
18059a96b668Sdanielk1977       */
1806dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
18079a96b668Sdanielk1977 
18089a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
18099a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1810b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
18115f1d1d9cSdrh          && (!mustBeUnique || (pIdx->nKeyCol==1 && IsUniqueIndex(pIdx)))
18129a96b668Sdanielk1977         ){
18137d176105Sdrh           int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
18142ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
18152ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1816207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
18171ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
18181ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
18199a96b668Sdanielk1977 
1820e21a6e1dSdrh           if( prRhsHasNull && !pTab->aCol[iCol].notNull ){
1821e21a6e1dSdrh             *prRhsHasNull = ++pParse->nMem;
18226be515ebSdrh             sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
18230cdc022eSdanielk1977           }
1824552fd454Sdrh           sqlite3VdbeJumpHere(v, iAddr);
18259a96b668Sdanielk1977         }
18269a96b668Sdanielk1977       }
18279a96b668Sdanielk1977     }
18289a96b668Sdanielk1977   }
18299a96b668Sdanielk1977 
1830bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
1831bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
1832bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
1833bb53ecb1Sdrh   ** and the RHS is not contant or has two or fewer terms,
183460ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
1835bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
1836bb53ecb1Sdrh   */
1837bb53ecb1Sdrh   if( eType==0
1838bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
1839bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
1840bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
1841bb53ecb1Sdrh   ){
1842bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
1843bb53ecb1Sdrh   }
1844bb53ecb1Sdrh 
1845bb53ecb1Sdrh 
18469a96b668Sdanielk1977   if( eType==0 ){
18474387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
1848b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1849b74b1017Sdrh     */
18508e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
18510cdc022eSdanielk1977     int rMayHaveNull = 0;
185241a05b7bSdanielk1977     eType = IN_INDEX_EPH;
18533a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
18544a5acf8eSdrh       pParse->nQueryLoop = 0;
1855c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
185641a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
18570cdc022eSdanielk1977       }
1858e21a6e1dSdrh     }else if( prRhsHasNull ){
1859e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
1860cf4d38aaSdrh     }
186141a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1862cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
18639a96b668Sdanielk1977   }else{
18649a96b668Sdanielk1977     pX->iTable = iTab;
18659a96b668Sdanielk1977   }
18669a96b668Sdanielk1977   return eType;
18679a96b668Sdanielk1977 }
1868284f4acaSdanielk1977 #endif
1869626a879aSdrh 
1870626a879aSdrh /*
1871d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1872d4187c71Sdrh ** or IN operators.  Examples:
1873626a879aSdrh **
18749cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
18759cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
18769cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
18779cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1878fef5208cSdrh **
18799cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
18809cbe6352Sdrh ** operator or subquery.
188141a05b7bSdanielk1977 **
188241a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
188341a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
188441a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
188541a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
188641a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1887fd773cf9Sdrh **
1888fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1889fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
18903a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
18913a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
18923a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
18931450bc6eSdrh **
18941450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
18951450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1896cce7d176Sdrh */
189751522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
18981450bc6eSdrh int sqlite3CodeSubselect(
1899fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1900fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
19016be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
1902fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
190341a05b7bSdanielk1977 ){
19046be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
19051450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1906b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
19071450bc6eSdrh   if( NEVER(v==0) ) return 0;
1908ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1909fc976065Sdanielk1977 
191057dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
191157dbd7b3Sdrh   ** if any of the following is true:
191257dbd7b3Sdrh   **
191357dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
191457dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
191557dbd7b3Sdrh   **    *  We are inside a trigger
191657dbd7b3Sdrh   **
191757dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
191857dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1919b3bce662Sdanielk1977   */
1920c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
19216be515ebSdrh     jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
1922b3bce662Sdanielk1977   }
1923b3bce662Sdanielk1977 
19244a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
19254a07e3dbSdan   if( pParse->explain==2 ){
192662aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
192762aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
192862aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
192962aaa6caSdrh         pParse->iNextSelectId
19304a07e3dbSdan     );
19314a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
19324a07e3dbSdan   }
19334a07e3dbSdan #endif
19344a07e3dbSdan 
1935cce7d176Sdrh   switch( pExpr->op ){
1936fef5208cSdrh     case TK_IN: {
1937d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1938b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1939d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1940323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
1941d3d39e93Sdrh 
194241a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1943e014a838Sdanielk1977 
1944e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
19458cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1946e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1947e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1948fef5208cSdrh       **
1949e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1950e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1951e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1952e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1953e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1954e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1955e014a838Sdanielk1977       ** is used.
1956fef5208cSdrh       */
1957832508b7Sdrh       pExpr->iTable = pParse->nTab++;
195841a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1959ad124329Sdrh       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
1960e014a838Sdanielk1977 
19616ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1962e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1963e014a838Sdanielk1977         **
1964e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1965e014a838Sdanielk1977         ** table allocated and opened above.
1966e014a838Sdanielk1977         */
19674387006cSdrh         Select *pSelect = pExpr->x.pSelect;
19681013c932Sdrh         SelectDest dest;
1969be5c89acSdrh         ExprList *pEList;
19701013c932Sdrh 
197141a05b7bSdanielk1977         assert( !isRowid );
19721013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
19732b596da8Sdrh         dest.affSdst = (u8)affinity;
1974e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
19754387006cSdrh         pSelect->iLimit = 0;
19764387006cSdrh         testcase( pSelect->selFlags & SF_Distinct );
1977812ea833Sdrh         testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
19784387006cSdrh         if( sqlite3Select(pParse, pSelect, &dest) ){
19792ec2fb22Sdrh           sqlite3KeyInfoUnref(pKeyInfo);
19801450bc6eSdrh           return 0;
198194ccde58Sdrh         }
19824387006cSdrh         pEList = pSelect->pEList;
1983812ea833Sdrh         assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
19843535ec3eSdrh         assert( pEList!=0 );
19853535ec3eSdrh         assert( pEList->nExpr>0 );
19862ec2fb22Sdrh         assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
1987323df790Sdrh         pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1988be5c89acSdrh                                                          pEList->a[0].pExpr);
1989a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1990fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1991fef5208cSdrh         **
1992e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1993e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1994e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1995e014a838Sdanielk1977         ** a column, use numeric affinity.
1996fef5208cSdrh         */
1997e014a838Sdanielk1977         int i;
19986ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
199957dbd7b3Sdrh         struct ExprList_item *pItem;
2000ecc31805Sdrh         int r1, r2, r3;
200157dbd7b3Sdrh 
2002e014a838Sdanielk1977         if( !affinity ){
200305883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2004e014a838Sdanielk1977         }
2005323df790Sdrh         if( pKeyInfo ){
20062ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2007323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2008323df790Sdrh         }
2009e014a838Sdanielk1977 
2010e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
20112d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
20122d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
201337e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
201457dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
201557dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2016e05c929bSdrh           int iValToIns;
2017e014a838Sdanielk1977 
201857dbd7b3Sdrh           /* If the expression is not constant then we will need to
201957dbd7b3Sdrh           ** disable the test that was generated above that makes sure
202057dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
202157dbd7b3Sdrh           ** expression we need to rerun this code each time.
202257dbd7b3Sdrh           */
20236be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
20246be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
20256be515ebSdrh             jmpIfDynamic = -1;
20264794b980Sdrh           }
2027e014a838Sdanielk1977 
2028e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2029e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2030e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2031e05c929bSdrh           }else{
2032ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
203341a05b7bSdanielk1977             if( isRowid ){
2034e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2035e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2036688852abSdrh               VdbeCoverage(v);
203741a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
203841a05b7bSdanielk1977             }else{
2039ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
20403c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
20412d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
2042fef5208cSdrh             }
204341a05b7bSdanielk1977           }
2044e05c929bSdrh         }
20452d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
20462d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2047fef5208cSdrh       }
2048323df790Sdrh       if( pKeyInfo ){
20492ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
205041a05b7bSdanielk1977       }
2051b3bce662Sdanielk1977       break;
2052fef5208cSdrh     }
2053fef5208cSdrh 
205451522cd3Sdrh     case TK_EXISTS:
2055fd773cf9Sdrh     case TK_SELECT:
2056fd773cf9Sdrh     default: {
2057fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
2058fef5208cSdrh       ** value of this select in a memory cell and record the number
2059fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
2060fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
2061fd773cf9Sdrh       ** and record that memory cell in iColumn.
2062fef5208cSdrh       */
2063fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
2064fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
20651398ad36Sdrh 
2066cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2067cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2068cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2069cf697396Sshane 
20706ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
20716ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
20721013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
207351522cd3Sdrh       if( pExpr->op==TK_SELECT ){
20746c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
207553932ce8Sdrh         dest.iSdst = dest.iSDParm;
20762b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
2077d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
207851522cd3Sdrh       }else{
20796c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
20802b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2081d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
208251522cd3Sdrh       }
2083633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2084094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2085094430ebSdrh                                   &sqlite3IntTokens[1]);
208648b5b041Sdrh       pSel->iLimit = 0;
2087772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
20887d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
20891450bc6eSdrh         return 0;
209094ccde58Sdrh       }
20912b596da8Sdrh       rReg = dest.iSDParm;
2092ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2093b3bce662Sdanielk1977       break;
209419a775c2Sdrh     }
2095cce7d176Sdrh   }
2096b3bce662Sdanielk1977 
20976be515ebSdrh   if( rHasNullFlag ){
20986be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2099b3bce662Sdanielk1977   }
21006be515ebSdrh 
21016be515ebSdrh   if( jmpIfDynamic>=0 ){
21026be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2103b3bce662Sdanielk1977   }
2104d2490904Sdrh   sqlite3ExprCachePop(pParse);
2105fc976065Sdanielk1977 
21061450bc6eSdrh   return rReg;
2107cce7d176Sdrh }
210851522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2109cce7d176Sdrh 
2110e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2111e3365e6cSdrh /*
2112e3365e6cSdrh ** Generate code for an IN expression.
2113e3365e6cSdrh **
2114e3365e6cSdrh **      x IN (SELECT ...)
2115e3365e6cSdrh **      x IN (value, value, ...)
2116e3365e6cSdrh **
2117e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
2118e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
2119e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
2120e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
2121e3365e6cSdrh ** RHS contains one or more NULL values.
2122e3365e6cSdrh **
21236be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2124e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2125e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2126e3365e6cSdrh ** within the RHS then fall through.
2127e3365e6cSdrh */
2128e3365e6cSdrh static void sqlite3ExprCodeIN(
2129e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2130e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2131e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2132e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2133e3365e6cSdrh ){
2134e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2135e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
2136e3365e6cSdrh   int eType;            /* Type of the RHS */
2137e3365e6cSdrh   int r1;               /* Temporary use register */
2138e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2139e3365e6cSdrh 
2140e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
2141e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
2142e3365e6cSdrh   */
2143e3365e6cSdrh   v = pParse->pVdbe;
2144e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2145e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2146bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2147bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
21483a85625dSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull);
2149e3365e6cSdrh 
2150e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
2151e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
2152e3365e6cSdrh   ** P4 of OP_MakeRecord.
2153e3365e6cSdrh   */
2154e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
2155e3365e6cSdrh 
2156e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
2157e3365e6cSdrh   */
2158e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2159e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
2160e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
2161e3365e6cSdrh 
2162bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2163bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2164bb53ecb1Sdrh   ** sequence of comparisons.
2165bb53ecb1Sdrh   */
2166bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2167bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2168bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2169bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2170bb53ecb1Sdrh     int r2, regToFree;
2171bb53ecb1Sdrh     int regCkNull = 0;
2172bb53ecb1Sdrh     int ii;
2173bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2174bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2175bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2176a976979bSdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
2177bb53ecb1Sdrh     }
2178bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2179bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2180a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2181bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2182bb53ecb1Sdrh       }
2183bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2184bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
21854336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
21864336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
21874336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2188bb53ecb1Sdrh         sqlite3VdbeChangeP5(v, affinity);
2189bb53ecb1Sdrh       }else{
2190bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2191bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2192bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2193bb53ecb1Sdrh         sqlite3VdbeChangeP5(v, affinity | SQLITE_JUMPIFNULL);
2194bb53ecb1Sdrh       }
2195bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2196bb53ecb1Sdrh     }
2197bb53ecb1Sdrh     if( regCkNull ){
2198bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2199076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2200bb53ecb1Sdrh     }
2201bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2202bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2203bb53ecb1Sdrh   }else{
2204bb53ecb1Sdrh 
2205094430ebSdrh     /* If the LHS is NULL, then the result is either false or NULL depending
2206094430ebSdrh     ** on whether the RHS is empty or not, respectively.
2207094430ebSdrh     */
22087248a8b2Sdrh     if( sqlite3ExprCanBeNull(pExpr->pLeft) ){
2209094430ebSdrh       if( destIfNull==destIfFalse ){
2210094430ebSdrh         /* Shortcut for the common case where the false and NULL outcomes are
2211094430ebSdrh         ** the same. */
2212688852abSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull); VdbeCoverage(v);
2213094430ebSdrh       }else{
2214688852abSdrh         int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2215094430ebSdrh         sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2216688852abSdrh         VdbeCoverage(v);
2217076e85f5Sdrh         sqlite3VdbeGoto(v, destIfNull);
2218094430ebSdrh         sqlite3VdbeJumpHere(v, addr1);
2219094430ebSdrh       }
22207248a8b2Sdrh     }
2221e3365e6cSdrh 
2222e3365e6cSdrh     if( eType==IN_INDEX_ROWID ){
2223e3365e6cSdrh       /* In this case, the RHS is the ROWID of table b-tree
2224e3365e6cSdrh       */
2225688852abSdrh       sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse); VdbeCoverage(v);
2226e3365e6cSdrh       sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
2227688852abSdrh       VdbeCoverage(v);
2228e3365e6cSdrh     }else{
2229e3365e6cSdrh       /* In this case, the RHS is an index b-tree.
2230e3365e6cSdrh       */
22318cff69dfSdrh       sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
2232e3365e6cSdrh 
2233e3365e6cSdrh       /* If the set membership test fails, then the result of the
2234e3365e6cSdrh       ** "x IN (...)" expression must be either 0 or NULL. If the set
2235e3365e6cSdrh       ** contains no NULL values, then the result is 0. If the set
2236e3365e6cSdrh       ** contains one or more NULL values, then the result of the
2237e3365e6cSdrh       ** expression is also NULL.
2238e3365e6cSdrh       */
2239e80c9b9aSdrh       assert( destIfFalse!=destIfNull || rRhsHasNull==0 );
2240e80c9b9aSdrh       if( rRhsHasNull==0 ){
2241e3365e6cSdrh         /* This branch runs if it is known at compile time that the RHS
2242e3365e6cSdrh         ** cannot contain NULL values. This happens as the result
2243e3365e6cSdrh         ** of a "NOT NULL" constraint in the database schema.
2244e3365e6cSdrh         **
2245e3365e6cSdrh         ** Also run this branch if NULL is equivalent to FALSE
2246e3365e6cSdrh         ** for this particular IN operator.
2247e3365e6cSdrh         */
22488cff69dfSdrh         sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
2249688852abSdrh         VdbeCoverage(v);
2250e3365e6cSdrh       }else{
2251e3365e6cSdrh         /* In this branch, the RHS of the IN might contain a NULL and
2252e3365e6cSdrh         ** the presence of a NULL on the RHS makes a difference in the
2253e3365e6cSdrh         ** outcome.
2254e3365e6cSdrh         */
2255728e0f91Sdrh         int addr1;
2256e3365e6cSdrh 
2257e3365e6cSdrh         /* First check to see if the LHS is contained in the RHS.  If so,
22586be515ebSdrh         ** then the answer is TRUE the presence of NULLs in the RHS does
22596be515ebSdrh         ** not matter.  If the LHS is not contained in the RHS, then the
22606be515ebSdrh         ** answer is NULL if the RHS contains NULLs and the answer is
22616be515ebSdrh         ** FALSE if the RHS is NULL-free.
2262e3365e6cSdrh         */
2263728e0f91Sdrh         addr1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2264688852abSdrh         VdbeCoverage(v);
22656be515ebSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2266552fd454Sdrh         VdbeCoverage(v);
2267076e85f5Sdrh         sqlite3VdbeGoto(v, destIfFalse);
2268728e0f91Sdrh         sqlite3VdbeJumpHere(v, addr1);
2269e3365e6cSdrh       }
2270e3365e6cSdrh     }
2271bb53ecb1Sdrh   }
2272e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2273d2490904Sdrh   sqlite3ExprCachePop(pParse);
2274e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2275e3365e6cSdrh }
2276e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2277e3365e6cSdrh 
227813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2279598f1340Sdrh /*
2280598f1340Sdrh ** Generate an instruction that will put the floating point
22819cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
22820cf19ed8Sdrh **
22830cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
22840cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
22850cf19ed8Sdrh ** like the continuation of the number.
2286598f1340Sdrh */
2287b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2288fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2289598f1340Sdrh     double value;
22909339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2291d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2292598f1340Sdrh     if( negateFlag ) value = -value;
229397bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2294598f1340Sdrh   }
2295598f1340Sdrh }
229613573c71Sdrh #endif
2297598f1340Sdrh 
2298598f1340Sdrh 
2299598f1340Sdrh /*
2300fec19aadSdrh ** Generate an instruction that will put the integer describe by
23019cbf3425Sdrh ** text z[0..n-1] into register iMem.
23020cf19ed8Sdrh **
23035f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2304fec19aadSdrh */
230513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
230613573c71Sdrh   Vdbe *v = pParse->pVdbe;
230792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
230833e619fcSdrh     int i = pExpr->u.iValue;
2309d50ffc41Sdrh     assert( i>=0 );
231092b01d53Sdrh     if( negFlag ) i = -i;
231192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2312fd773cf9Sdrh   }else{
23135f1d6b61Sshaneh     int c;
23145f1d6b61Sshaneh     i64 value;
2315fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2316fd773cf9Sdrh     assert( z!=0 );
23179296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
23185f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2319158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
232097bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2321fec19aadSdrh     }else{
232213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
232313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
232413573c71Sdrh #else
23251b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
23269296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
23279296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
23281b7ddc59Sdrh       }else
23291b7ddc59Sdrh #endif
23301b7ddc59Sdrh       {
2331b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
23329296c18aSdrh       }
233313573c71Sdrh #endif
2334fec19aadSdrh     }
2335fec19aadSdrh   }
2336c9cf901dSdanielk1977 }
2337fec19aadSdrh 
2338*bea119cdSdrh #if defined(SQLITE_DEBUG)
2339*bea119cdSdrh /*
2340*bea119cdSdrh ** Verify the consistency of the column cache
2341*bea119cdSdrh */
2342*bea119cdSdrh static int cacheIsValid(Parse *pParse){
2343*bea119cdSdrh   int i, n;
2344*bea119cdSdrh   for(i=n=0; i<SQLITE_N_COLCACHE; i++){
2345*bea119cdSdrh     if( pParse->aColCache[i].iReg>0 ) n++;
2346*bea119cdSdrh   }
2347*bea119cdSdrh   return n==pParse->nColCache;
2348*bea119cdSdrh }
2349*bea119cdSdrh #endif
2350*bea119cdSdrh 
2351ceea3321Sdrh /*
2352ceea3321Sdrh ** Clear a cache entry.
2353ceea3321Sdrh */
2354ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2355ceea3321Sdrh   if( p->tempReg ){
2356ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2357ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2358ceea3321Sdrh     }
2359ceea3321Sdrh     p->tempReg = 0;
2360ceea3321Sdrh   }
2361*bea119cdSdrh   p->iReg = 0;
2362*bea119cdSdrh   pParse->nColCache--;
2363*bea119cdSdrh   assert( cacheIsValid(pParse) );
2364ceea3321Sdrh }
2365ceea3321Sdrh 
2366ceea3321Sdrh 
2367ceea3321Sdrh /*
2368ceea3321Sdrh ** Record in the column cache that a particular column from a
2369ceea3321Sdrh ** particular table is stored in a particular register.
2370ceea3321Sdrh */
2371ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2372ceea3321Sdrh   int i;
2373ceea3321Sdrh   int minLru;
2374ceea3321Sdrh   int idxLru;
2375ceea3321Sdrh   struct yColCache *p;
2376ceea3321Sdrh 
2377ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2378ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
237920411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
238020411ea7Sdrh 
2381b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2382b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2383b6da74ebSdrh   ** with and without the column cache.
2384b6da74ebSdrh   */
23857e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2386b6da74ebSdrh 
238727ee406eSdrh   /* First replace any existing entry.
238827ee406eSdrh   **
238927ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
239027ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
239127ee406eSdrh   */
239227ee406eSdrh #ifndef NDEBUG
2393ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
239427ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2395ceea3321Sdrh   }
239627ee406eSdrh #endif
2397ceea3321Sdrh 
2398ceea3321Sdrh   /* Find an empty slot and replace it */
2399ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2400ceea3321Sdrh     if( p->iReg==0 ){
2401ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2402ceea3321Sdrh       p->iTable = iTab;
2403ceea3321Sdrh       p->iColumn = iCol;
2404ceea3321Sdrh       p->iReg = iReg;
2405ceea3321Sdrh       p->tempReg = 0;
2406ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2407*bea119cdSdrh       pParse->nColCache++;
2408*bea119cdSdrh       assert( cacheIsValid(pParse) );
2409ceea3321Sdrh       return;
2410ceea3321Sdrh     }
2411ceea3321Sdrh   }
2412ceea3321Sdrh 
2413ceea3321Sdrh   /* Replace the last recently used */
2414ceea3321Sdrh   minLru = 0x7fffffff;
2415ceea3321Sdrh   idxLru = -1;
2416ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2417ceea3321Sdrh     if( p->lru<minLru ){
2418ceea3321Sdrh       idxLru = i;
2419ceea3321Sdrh       minLru = p->lru;
2420ceea3321Sdrh     }
2421ceea3321Sdrh   }
242220411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2423ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2424ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2425ceea3321Sdrh     p->iTable = iTab;
2426ceea3321Sdrh     p->iColumn = iCol;
2427ceea3321Sdrh     p->iReg = iReg;
2428ceea3321Sdrh     p->tempReg = 0;
2429ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2430*bea119cdSdrh     assert( cacheIsValid(pParse) );
2431ceea3321Sdrh     return;
2432ceea3321Sdrh   }
2433ceea3321Sdrh }
2434ceea3321Sdrh 
2435ceea3321Sdrh /*
2436f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2437f49f3523Sdrh ** Purge the range of registers from the column cache.
2438ceea3321Sdrh */
2439f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2440ceea3321Sdrh   struct yColCache *p;
2441*bea119cdSdrh   if( iReg<=0 || pParse->nColCache==0 ) return;
2442*bea119cdSdrh   p = &pParse->aColCache[SQLITE_N_COLCACHE-1];
2443*bea119cdSdrh   while(1){
2444*bea119cdSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ) cacheEntryClear(pParse, p);
2445*bea119cdSdrh     if( p==pParse->aColCache ) break;
2446*bea119cdSdrh     p--;
2447ceea3321Sdrh   }
2448ceea3321Sdrh }
2449ceea3321Sdrh 
2450ceea3321Sdrh /*
2451ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2452ceea3321Sdrh ** added to the column cache after this call are removed when the
2453ceea3321Sdrh ** corresponding pop occurs.
2454ceea3321Sdrh */
2455ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2456ceea3321Sdrh   pParse->iCacheLevel++;
24579ac7962aSdrh #ifdef SQLITE_DEBUG
24589ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
24599ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
24609ac7962aSdrh   }
24619ac7962aSdrh #endif
2462ceea3321Sdrh }
2463ceea3321Sdrh 
2464ceea3321Sdrh /*
2465ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2466d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
2467d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
2468ceea3321Sdrh */
2469d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
2470ceea3321Sdrh   int i;
2471ceea3321Sdrh   struct yColCache *p;
2472d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
2473d2490904Sdrh   pParse->iCacheLevel--;
24749ac7962aSdrh #ifdef SQLITE_DEBUG
24759ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
24769ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
24779ac7962aSdrh   }
24789ac7962aSdrh #endif
2479ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2480ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2481ceea3321Sdrh       cacheEntryClear(pParse, p);
2482ceea3321Sdrh     }
2483ceea3321Sdrh   }
2484ceea3321Sdrh }
2485945498f3Sdrh 
2486945498f3Sdrh /*
24875cd79239Sdrh ** When a cached column is reused, make sure that its register is
24885cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
24895cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
24905cd79239Sdrh ** get them all.
24915cd79239Sdrh */
24925cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
24935cd79239Sdrh   int i;
24945cd79239Sdrh   struct yColCache *p;
24955cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
24965cd79239Sdrh     if( p->iReg==iReg ){
24975cd79239Sdrh       p->tempReg = 0;
24985cd79239Sdrh     }
24995cd79239Sdrh   }
25005cd79239Sdrh }
25015cd79239Sdrh 
25021f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
25031f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
25041f9ca2c8Sdrh */
25051f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
25061f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
25071f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
25081f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
25091f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
25101f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
25111f9ca2c8Sdrh ){
25121f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
25134b92f98cSdrh   if( iTabCol==XN_EXPR ){
25141f9ca2c8Sdrh     assert( pIdx->aColExpr );
25151f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
25161f9ca2c8Sdrh     pParse->iSelfTab = iTabCur;
25171c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
25184b92f98cSdrh   }else{
25194b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
25204b92f98cSdrh                                     iTabCol, regOut);
25214b92f98cSdrh   }
25221f9ca2c8Sdrh }
25231f9ca2c8Sdrh 
25245cd79239Sdrh /*
25255c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
25265c092e8aSdrh */
25275c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
25285c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
25295c092e8aSdrh   Table *pTab,    /* The table containing the value */
2530313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
25315c092e8aSdrh   int iCol,       /* Index of the column to extract */
2532313619f5Sdrh   int regOut      /* Extract the value into this register */
25335c092e8aSdrh ){
25345c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
25355c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
25365c092e8aSdrh   }else{
25375c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
2538ee0ec8e1Sdrh     int x = iCol;
2539ee0ec8e1Sdrh     if( !HasRowid(pTab) ){
2540ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2541ee0ec8e1Sdrh     }
2542ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
25435c092e8aSdrh   }
25445c092e8aSdrh   if( iCol>=0 ){
25455c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
25465c092e8aSdrh   }
25475c092e8aSdrh }
25485c092e8aSdrh 
25495c092e8aSdrh /*
2550945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2551ce78bc6eSdrh ** table pTab and store the column value in a register.
2552ce78bc6eSdrh **
2553ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
2554ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
2555ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
2556ce78bc6eSdrh ** for GetColumnToReg().
2557e55cbd72Sdrh **
2558e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2559e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2560945498f3Sdrh */
2561e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2562e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
25632133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
25642133d822Sdrh   int iColumn,     /* Index of the table column */
25652133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2566a748fdccSdrh   int iReg,        /* Store results here */
2567ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
25682133d822Sdrh ){
2569e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2570e55cbd72Sdrh   int i;
2571da250ea5Sdrh   struct yColCache *p;
2572e55cbd72Sdrh 
2573ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2574b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2575ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
25765cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2577da250ea5Sdrh       return p->iReg;
2578e55cbd72Sdrh     }
2579e55cbd72Sdrh   }
2580e55cbd72Sdrh   assert( v!=0 );
25815c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2582a748fdccSdrh   if( p5 ){
2583a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2584a748fdccSdrh   }else{
2585ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2586a748fdccSdrh   }
2587e55cbd72Sdrh   return iReg;
2588e55cbd72Sdrh }
2589ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
2590ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
2591ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
2592ce78bc6eSdrh   int iColumn,     /* Index of the table column */
2593ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
2594ce78bc6eSdrh   int iReg         /* Store results here */
2595ce78bc6eSdrh ){
2596ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
2597ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
2598ce78bc6eSdrh }
2599ce78bc6eSdrh 
2600e55cbd72Sdrh 
2601e55cbd72Sdrh /*
2602ceea3321Sdrh ** Clear all column cache entries.
2603e55cbd72Sdrh */
2604ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2605e55cbd72Sdrh   int i;
2606ceea3321Sdrh   struct yColCache *p;
2607ceea3321Sdrh 
26089ac7962aSdrh #if SQLITE_DEBUG
26099ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
26109ac7962aSdrh     printf("CLEAR\n");
26119ac7962aSdrh   }
26129ac7962aSdrh #endif
2613ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2614ceea3321Sdrh     if( p->iReg ){
2615ceea3321Sdrh       cacheEntryClear(pParse, p);
2616e55cbd72Sdrh     }
2617da250ea5Sdrh   }
2618da250ea5Sdrh }
2619e55cbd72Sdrh 
2620e55cbd72Sdrh /*
2621da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2622da250ea5Sdrh ** registers starting with iStart.
2623e55cbd72Sdrh */
2624da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2625f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2626e55cbd72Sdrh }
2627e55cbd72Sdrh 
2628e55cbd72Sdrh /*
2629b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2630b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2631e55cbd72Sdrh */
2632b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2633e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2634079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
2635236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
2636945498f3Sdrh }
2637945498f3Sdrh 
2638f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
263992b01d53Sdrh /*
2640652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2641652fbf55Sdrh ** is used as part of the column cache.
2642f49f3523Sdrh **
2643f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2644f49f3523Sdrh ** and does not appear in a normal build.
2645652fbf55Sdrh */
2646652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2647652fbf55Sdrh   int i;
2648ceea3321Sdrh   struct yColCache *p;
2649ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2650ceea3321Sdrh     int r = p->iReg;
2651f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2652652fbf55Sdrh   }
2653652fbf55Sdrh   return 0;
2654652fbf55Sdrh }
2655f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2656652fbf55Sdrh 
2657*bea119cdSdrh 
2658652fbf55Sdrh /*
2659a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
2660a4c3c87eSdrh */
2661a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
2662a4c3c87eSdrh   p->op2 = p->op;
2663a4c3c87eSdrh   p->op = TK_REGISTER;
2664a4c3c87eSdrh   p->iTable = iReg;
2665a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
2666a4c3c87eSdrh }
2667a4c3c87eSdrh 
2668a4c3c87eSdrh /*
2669cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
26702dcef11bSdrh ** expression.  Attempt to store the results in register "target".
26712dcef11bSdrh ** Return the register where results are stored.
2672389a1adbSdrh **
26738b213899Sdrh ** With this routine, there is no guarantee that results will
26742dcef11bSdrh ** be stored in target.  The result might be stored in some other
26752dcef11bSdrh ** register if it is convenient to do so.  The calling function
26762dcef11bSdrh ** must check the return code and move the results to the desired
26772dcef11bSdrh ** register.
2678cce7d176Sdrh */
2679678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
26802dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
26812dcef11bSdrh   int op;                   /* The opcode being coded */
26822dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
26832dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
26842dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2685678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
268620411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
268710d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
2688ffe07b2dSdrh 
26899cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
269020411ea7Sdrh   if( v==0 ){
269120411ea7Sdrh     assert( pParse->db->mallocFailed );
269220411ea7Sdrh     return 0;
269320411ea7Sdrh   }
2694389a1adbSdrh 
2695389a1adbSdrh   if( pExpr==0 ){
2696389a1adbSdrh     op = TK_NULL;
2697389a1adbSdrh   }else{
2698f2bc013cSdrh     op = pExpr->op;
2699389a1adbSdrh   }
2700f2bc013cSdrh   switch( op ){
270113449892Sdrh     case TK_AGG_COLUMN: {
270213449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
270313449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
270413449892Sdrh       if( !pAggInfo->directMode ){
27059de221dfSdrh         assert( pCol->iMem>0 );
27069de221dfSdrh         inReg = pCol->iMem;
270713449892Sdrh         break;
270813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
27095134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2710389a1adbSdrh                               pCol->iSorterColumn, target);
271113449892Sdrh         break;
271213449892Sdrh       }
271313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
271413449892Sdrh     }
2715967e8b73Sdrh     case TK_COLUMN: {
2716b2b9d3d7Sdrh       int iTab = pExpr->iTable;
2717b2b9d3d7Sdrh       if( iTab<0 ){
2718b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
2719b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
2720aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
2721b2b9d3d7Sdrh           break;
2722c4a3c779Sdrh         }else{
27231f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
27241f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
27251f9ca2c8Sdrh           iTab = pParse->iSelfTab;
27262282792aSdrh         }
2727b2b9d3d7Sdrh       }
2728b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2729b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
2730b2b9d3d7Sdrh                                pExpr->op2);
2731cce7d176Sdrh       break;
2732cce7d176Sdrh     }
2733cce7d176Sdrh     case TK_INTEGER: {
273413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2735fec19aadSdrh       break;
273651e9a445Sdrh     }
273713573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2738598f1340Sdrh     case TK_FLOAT: {
273933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
274033e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2741598f1340Sdrh       break;
2742598f1340Sdrh     }
274313573c71Sdrh #endif
2744fec19aadSdrh     case TK_STRING: {
274533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2746076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
2747cce7d176Sdrh       break;
2748cce7d176Sdrh     }
2749f0863fe5Sdrh     case TK_NULL: {
27509de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2751f0863fe5Sdrh       break;
2752f0863fe5Sdrh     }
27535338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2754c572ef7fSdanielk1977     case TK_BLOB: {
27556c8c6cecSdrh       int n;
27566c8c6cecSdrh       const char *z;
2757ca48c90fSdrh       char *zBlob;
275833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
275933e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
276033e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
276133e619fcSdrh       z = &pExpr->u.zToken[2];
2762b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2763b7916a78Sdrh       assert( z[n]=='\'' );
2764ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2765ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2766c572ef7fSdanielk1977       break;
2767c572ef7fSdanielk1977     }
27685338a5f7Sdanielk1977 #endif
276950457896Sdrh     case TK_VARIABLE: {
277033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
277133e619fcSdrh       assert( pExpr->u.zToken!=0 );
277233e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2773eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
277433e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
277504e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
277604e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
277704e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2778895d7472Sdrh       }
277950457896Sdrh       break;
278050457896Sdrh     }
27814e0cff60Sdrh     case TK_REGISTER: {
27829de221dfSdrh       inReg = pExpr->iTable;
27834e0cff60Sdrh       break;
27844e0cff60Sdrh     }
2785487e262fSdrh #ifndef SQLITE_OMIT_CAST
2786487e262fSdrh     case TK_CAST: {
2787487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
27882dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
27891735fa88Sdrh       if( inReg!=target ){
27901735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
27911735fa88Sdrh         inReg = target;
27921735fa88Sdrh       }
27934169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
27944169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
2795c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2796b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2797487e262fSdrh       break;
2798487e262fSdrh     }
2799487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2800c9b84a1fSdrh     case TK_LT:
2801c9b84a1fSdrh     case TK_LE:
2802c9b84a1fSdrh     case TK_GT:
2803c9b84a1fSdrh     case TK_GE:
2804c9b84a1fSdrh     case TK_NE:
2805c9b84a1fSdrh     case TK_EQ: {
2806b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2807b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
280835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
280935573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
28107d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
28117d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
28127d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
28137d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
28147d176105Sdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
28157d176105Sdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
2816c5499befSdrh       testcase( regFree1==0 );
2817c5499befSdrh       testcase( regFree2==0 );
2818a37cdde0Sdanielk1977       break;
2819c9b84a1fSdrh     }
28206a2fe093Sdrh     case TK_IS:
28216a2fe093Sdrh     case TK_ISNOT: {
28226a2fe093Sdrh       testcase( op==TK_IS );
28236a2fe093Sdrh       testcase( op==TK_ISNOT );
2824b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2825b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
28266a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
28276a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
28286a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
28297d176105Sdrh       VdbeCoverageIf(v, op==TK_EQ);
28307d176105Sdrh       VdbeCoverageIf(v, op==TK_NE);
28316a2fe093Sdrh       testcase( regFree1==0 );
28326a2fe093Sdrh       testcase( regFree2==0 );
28336a2fe093Sdrh       break;
28346a2fe093Sdrh     }
2835cce7d176Sdrh     case TK_AND:
2836cce7d176Sdrh     case TK_OR:
2837cce7d176Sdrh     case TK_PLUS:
2838cce7d176Sdrh     case TK_STAR:
2839cce7d176Sdrh     case TK_MINUS:
2840bf4133cbSdrh     case TK_REM:
2841bf4133cbSdrh     case TK_BITAND:
2842bf4133cbSdrh     case TK_BITOR:
284317c40294Sdrh     case TK_SLASH:
2844bf4133cbSdrh     case TK_LSHIFT:
2845855eb1cfSdrh     case TK_RSHIFT:
28460040077dSdrh     case TK_CONCAT: {
28477d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
28487d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
28497d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
28507d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
28517d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
28527d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
28537d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
28547d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
28557d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
28567d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
28577d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
28582dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
28592dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
28605b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2861c5499befSdrh       testcase( regFree1==0 );
2862c5499befSdrh       testcase( regFree2==0 );
28630040077dSdrh       break;
28640040077dSdrh     }
2865cce7d176Sdrh     case TK_UMINUS: {
2866fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2867fec19aadSdrh       assert( pLeft );
286813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
286913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
287013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
287113573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
287233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
287333e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
287413573c71Sdrh #endif
28753c84ddffSdrh       }else{
287610d1edf0Sdrh         tempX.op = TK_INTEGER;
287710d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
287810d1edf0Sdrh         tempX.u.iValue = 0;
287910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
2880e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
28812dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2882c5499befSdrh         testcase( regFree2==0 );
28833c84ddffSdrh       }
28849de221dfSdrh       inReg = target;
28856e142f54Sdrh       break;
28866e142f54Sdrh     }
2887bf4133cbSdrh     case TK_BITNOT:
28886e142f54Sdrh     case TK_NOT: {
28897d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
28907d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
2891e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2892e99fa2afSdrh       testcase( regFree1==0 );
2893e99fa2afSdrh       inReg = target;
2894e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2895cce7d176Sdrh       break;
2896cce7d176Sdrh     }
2897cce7d176Sdrh     case TK_ISNULL:
2898cce7d176Sdrh     case TK_NOTNULL: {
28996a288a33Sdrh       int addr;
29007d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
29017d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
29029de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
29032dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2904c5499befSdrh       testcase( regFree1==0 );
29052dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
29067d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
29077d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
2908a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
29096a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2910a37cdde0Sdanielk1977       break;
2911f2bc013cSdrh     }
29122282792aSdrh     case TK_AGG_FUNCTION: {
291313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
29147e56e711Sdrh       if( pInfo==0 ){
291533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
291633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
29177e56e711Sdrh       }else{
29189de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
29197e56e711Sdrh       }
29202282792aSdrh       break;
29212282792aSdrh     }
2922cce7d176Sdrh     case TK_FUNCTION: {
292312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
292412ffee8cSdrh       int nFarg;             /* Number of function arguments */
292512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
292612ffee8cSdrh       const char *zId;       /* The function name */
2927693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
292812ffee8cSdrh       int i;                 /* Loop counter */
292912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
293012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
293117435752Sdrh 
29326ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2933c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
293412ffee8cSdrh         pFarg = 0;
293512ffee8cSdrh       }else{
293612ffee8cSdrh         pFarg = pExpr->x.pList;
293712ffee8cSdrh       }
293812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
293933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
294033e619fcSdrh       zId = pExpr->u.zToken;
294180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
29422d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
294380738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
2944feb306f5Sdrh         break;
2945feb306f5Sdrh       }
2946ae6bb957Sdrh 
2947ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
294860ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
2949ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2950ae6bb957Sdrh       */
2951d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
2952ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2953ae6bb957Sdrh         assert( nFarg>=2 );
2954ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2955ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2956ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2957688852abSdrh           VdbeCoverage(v);
2958f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2959ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2960ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2961d2490904Sdrh           sqlite3ExprCachePop(pParse);
2962ae6bb957Sdrh         }
2963ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2964ae6bb957Sdrh         break;
2965ae6bb957Sdrh       }
2966ae6bb957Sdrh 
2967cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
2968cca9f3d2Sdrh       ** of the first argument.
2969cca9f3d2Sdrh       */
2970cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2971cca9f3d2Sdrh         assert( nFarg>=1 );
29725f02ab09Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
2973cca9f3d2Sdrh         break;
2974cca9f3d2Sdrh       }
2975ae6bb957Sdrh 
2976d1a01edaSdrh       for(i=0; i<nFarg; i++){
2977d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
2978693e6719Sdrh           testcase( i==31 );
2979693e6719Sdrh           constMask |= MASKBIT32(i);
2980d1a01edaSdrh         }
2981d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2982d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2983d1a01edaSdrh         }
2984d1a01edaSdrh       }
298512ffee8cSdrh       if( pFarg ){
2986d1a01edaSdrh         if( constMask ){
2987d1a01edaSdrh           r1 = pParse->nMem+1;
2988d1a01edaSdrh           pParse->nMem += nFarg;
2989d1a01edaSdrh         }else{
299012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
2991d1a01edaSdrh         }
2992a748fdccSdrh 
2993a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2994a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2995a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2996a748fdccSdrh         ** loading.
2997a748fdccSdrh         */
2998d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
29994e245a4cSdrh           u8 exprOp;
3000a748fdccSdrh           assert( nFarg==1 );
3001a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
30024e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
30034e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3004a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3005a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3006b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3007b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3008b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3009a748fdccSdrh           }
3010a748fdccSdrh         }
3011a748fdccSdrh 
3012d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
30135579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3014d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3015d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3016892d3179Sdrh       }else{
301712ffee8cSdrh         r1 = 0;
3018892d3179Sdrh       }
3019b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3020a43fa227Sdrh       /* Possibly overload the function if the first argument is
3021a43fa227Sdrh       ** a virtual table column.
3022a43fa227Sdrh       **
3023a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3024a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3025a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3026a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3027a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3028a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3029a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3030a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3031a43fa227Sdrh       */
303212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
303312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
303412ffee8cSdrh       }else if( nFarg>0 ){
303512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3036b7f6f68fSdrh       }
3037b7f6f68fSdrh #endif
3038d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
30398b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
304066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3041682f68b0Sdanielk1977       }
30429c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
304366a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
304412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3045d1a01edaSdrh       if( nFarg && constMask==0 ){
304612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
30472dcef11bSdrh       }
30486ec2733bSdrh       break;
30496ec2733bSdrh     }
3050fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3051fe2093d7Sdrh     case TK_EXISTS:
305219a775c2Sdrh     case TK_SELECT: {
3053c5499befSdrh       testcase( op==TK_EXISTS );
3054c5499befSdrh       testcase( op==TK_SELECT );
30551450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
305619a775c2Sdrh       break;
305719a775c2Sdrh     }
3058fef5208cSdrh     case TK_IN: {
3059e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3060e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3061e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3062e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
306366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3064e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3065e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3066e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3067fef5208cSdrh       break;
3068fef5208cSdrh     }
3069e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3070e3365e6cSdrh 
3071e3365e6cSdrh 
30722dcef11bSdrh     /*
30732dcef11bSdrh     **    x BETWEEN y AND z
30742dcef11bSdrh     **
30752dcef11bSdrh     ** This is equivalent to
30762dcef11bSdrh     **
30772dcef11bSdrh     **    x>=y AND x<=z
30782dcef11bSdrh     **
30792dcef11bSdrh     ** X is stored in pExpr->pLeft.
30802dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
30812dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
30822dcef11bSdrh     */
3083fef5208cSdrh     case TK_BETWEEN: {
3084be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
30856ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
3086be5c89acSdrh       Expr *pRight = pLItem->pExpr;
308735573356Sdrh 
3088b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3089b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
3090c5499befSdrh       testcase( regFree1==0 );
3091c5499befSdrh       testcase( regFree2==0 );
30922dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
3093678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
309435573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
30957d176105Sdrh                   r1, r2, r3, SQLITE_STOREP2);  VdbeCoverage(v);
3096be5c89acSdrh       pLItem++;
3097be5c89acSdrh       pRight = pLItem->pExpr;
30982dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
30992dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
3100c5499befSdrh       testcase( regFree2==0 );
3101678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
3102688852abSdrh       VdbeCoverage(v);
3103678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
31042dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
3105678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
3106fef5208cSdrh       break;
3107fef5208cSdrh     }
310894fa9c41Sdrh     case TK_SPAN:
3109ae80ddeaSdrh     case TK_COLLATE:
31104f07e5fbSdrh     case TK_UPLUS: {
31112dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3112a2e00042Sdrh       break;
3113a2e00042Sdrh     }
31142dcef11bSdrh 
3115165921a7Sdan     case TK_TRIGGER: {
311665a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
311765a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
311865a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
311965a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
312065a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
312165a7cd16Sdan       ** read the rowid field.
312265a7cd16Sdan       **
312365a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
312465a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
312565a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
312665a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
312765a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
312865a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
312965a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
313065a7cd16Sdan       ** example, if the table on which triggers are being fired is
313165a7cd16Sdan       ** declared as:
313265a7cd16Sdan       **
313365a7cd16Sdan       **   CREATE TABLE t1(a, b);
313465a7cd16Sdan       **
313565a7cd16Sdan       ** Then p1 is interpreted as follows:
313665a7cd16Sdan       **
313765a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
313865a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
313965a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
314065a7cd16Sdan       */
31412832ad42Sdan       Table *pTab = pExpr->pTab;
314265a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
314365a7cd16Sdan 
314465a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
314565a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
314665a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
314765a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
314865a7cd16Sdan 
314965a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
315076d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3151165921a7Sdan         (pExpr->iTable ? "new" : "old"),
315276d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
315376d462eeSdan         target
3154165921a7Sdan       ));
315565a7cd16Sdan 
315644dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
315765a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3158113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3159113762a2Sdrh       **
3160113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3161113762a2Sdrh       ** floating point when extracting it from the record.  */
31622832ad42Sdan       if( pExpr->iColumn>=0
31632832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
31642832ad42Sdan       ){
31652832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
31662832ad42Sdan       }
316744dbca83Sdrh #endif
3168165921a7Sdan       break;
3169165921a7Sdan     }
3170165921a7Sdan 
3171165921a7Sdan 
31722dcef11bSdrh     /*
31732dcef11bSdrh     ** Form A:
31742dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
31752dcef11bSdrh     **
31762dcef11bSdrh     ** Form B:
31772dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
31782dcef11bSdrh     **
31792dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
31802dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
31812dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
31822dcef11bSdrh     **
31832dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3184c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3185c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3186c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
31872dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
31882dcef11bSdrh     **
31892dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
31902dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
31912dcef11bSdrh     ** no ELSE term, NULL.
31922dcef11bSdrh     */
319333cd4909Sdrh     default: assert( op==TK_CASE ); {
31942dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
31952dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
31962dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
31972dcef11bSdrh       int i;                            /* Loop counter */
31982dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
31992dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
32002dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
32012dcef11bSdrh       Expr *pX;                         /* The X expression */
32021bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3203ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
320417a7f8ddSdrh 
32056ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
32066ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
32076ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3208be5c89acSdrh       aListelem = pEList->a;
3209be5c89acSdrh       nExpr = pEList->nExpr;
32102dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
32112dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
321210d1edf0Sdrh         tempX = *pX;
321333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
321410d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
3215c5499befSdrh         testcase( regFree1==0 );
32162dcef11bSdrh         opCompare.op = TK_EQ;
321710d1edf0Sdrh         opCompare.pLeft = &tempX;
32182dcef11bSdrh         pTest = &opCompare;
32198b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
32208b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
32218b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
32228b1db07fSdrh         ** purposes and possibly overwritten.  */
32238b1db07fSdrh         regFree1 = 0;
3224cce7d176Sdrh       }
3225c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3226ceea3321Sdrh         sqlite3ExprCachePush(pParse);
32272dcef11bSdrh         if( pX ){
32281bd10f8aSdrh           assert( pTest!=0 );
32292dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3230f5905aa7Sdrh         }else{
32312dcef11bSdrh           pTest = aListelem[i].pExpr;
323217a7f8ddSdrh         }
32332dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
323433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
32352dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3236c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
32379de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3238076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
3239d2490904Sdrh         sqlite3ExprCachePop(pParse);
32402dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3241f570f011Sdrh       }
3242c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3243ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3244c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3245d2490904Sdrh         sqlite3ExprCachePop(pParse);
324617a7f8ddSdrh       }else{
32479de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
324817a7f8ddSdrh       }
3249c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
3250c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
32512dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
32526f34903eSdanielk1977       break;
32536f34903eSdanielk1977     }
32545338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
32556f34903eSdanielk1977     case TK_RAISE: {
3256165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3257165921a7Sdan            || pExpr->affinity==OE_Abort
3258165921a7Sdan            || pExpr->affinity==OE_Fail
3259165921a7Sdan            || pExpr->affinity==OE_Ignore
3260165921a7Sdan       );
3261e0af83acSdan       if( !pParse->pTriggerTab ){
3262e0af83acSdan         sqlite3ErrorMsg(pParse,
3263e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3264e0af83acSdan         return 0;
3265e0af83acSdan       }
3266e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3267e0af83acSdan         sqlite3MayAbort(pParse);
3268e0af83acSdan       }
326933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3270e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3271e0af83acSdan         sqlite3VdbeAddOp4(
3272e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3273688852abSdrh         VdbeCoverage(v);
3274e0af83acSdan       }else{
3275433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3276f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3277e0af83acSdan       }
3278e0af83acSdan 
3279ffe07b2dSdrh       break;
328017a7f8ddSdrh     }
32815338a5f7Sdanielk1977 #endif
3282ffe07b2dSdrh   }
32832dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
32842dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
32852dcef11bSdrh   return inReg;
32865b6afba9Sdrh }
32872dcef11bSdrh 
32882dcef11bSdrh /*
3289d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3290d1a01edaSdrh */
3291d673cddaSdrh void sqlite3ExprCodeAtInit(
3292d673cddaSdrh   Parse *pParse,    /* Parsing context */
3293d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3294d673cddaSdrh   int regDest,      /* Store the value in this register */
3295d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3296d673cddaSdrh ){
3297d1a01edaSdrh   ExprList *p;
3298d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3299d1a01edaSdrh   p = pParse->pConstExpr;
3300d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3301d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3302d673cddaSdrh   if( p ){
3303d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3304d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3305d673cddaSdrh      pItem->reusable = reusable;
3306d673cddaSdrh   }
3307d1a01edaSdrh   pParse->pConstExpr = p;
3308d1a01edaSdrh }
3309d1a01edaSdrh 
3310d1a01edaSdrh /*
33112dcef11bSdrh ** Generate code to evaluate an expression and store the results
33122dcef11bSdrh ** into a register.  Return the register number where the results
33132dcef11bSdrh ** are stored.
33142dcef11bSdrh **
33152dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3316678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
33172dcef11bSdrh ** a temporary, then set *pReg to zero.
3318f30a969bSdrh **
3319f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3320f30a969bSdrh ** code to fill the register in the initialization section of the
3321f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
33222dcef11bSdrh */
33232dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3324f30a969bSdrh   int r2;
3325f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3326d9f158e7Sdrh   if( ConstFactorOk(pParse)
3327f30a969bSdrh    && pExpr->op!=TK_REGISTER
3328f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3329f30a969bSdrh   ){
3330f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3331f30a969bSdrh     int i;
3332f30a969bSdrh     *pReg  = 0;
3333f30a969bSdrh     if( p ){
3334d673cddaSdrh       struct ExprList_item *pItem;
3335d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3336d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3337d673cddaSdrh           return pItem->u.iConstExprReg;
3338f30a969bSdrh         }
3339f30a969bSdrh       }
3340f30a969bSdrh     }
3341f30a969bSdrh     r2 = ++pParse->nMem;
3342d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3343f30a969bSdrh   }else{
33442dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3345f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
33462dcef11bSdrh     if( r2==r1 ){
33472dcef11bSdrh       *pReg = r1;
33482dcef11bSdrh     }else{
33492dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
33502dcef11bSdrh       *pReg = 0;
33512dcef11bSdrh     }
3352f30a969bSdrh   }
33532dcef11bSdrh   return r2;
33542dcef11bSdrh }
33552dcef11bSdrh 
33562dcef11bSdrh /*
33572dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
33582dcef11bSdrh ** results in register target.  The results are guaranteed to appear
33592dcef11bSdrh ** in register target.
33602dcef11bSdrh */
336105a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
33629cbf3425Sdrh   int inReg;
33639cbf3425Sdrh 
33649cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3365ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3366ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3367ebc16717Sdrh   }else{
33689cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
33691c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
33700e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
33719cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
337217a7f8ddSdrh     }
3373ebc16717Sdrh   }
3374cce7d176Sdrh }
3375cce7d176Sdrh 
3376cce7d176Sdrh /*
33771c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
33781c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
33791c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
33801c75c9d7Sdrh */
33811c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
33821c75c9d7Sdrh   sqlite3 *db = pParse->db;
33831c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
33841c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
33851c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
33861c75c9d7Sdrh }
33871c75c9d7Sdrh 
33881c75c9d7Sdrh /*
338905a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
339005a86c5cSdrh ** results in register target.  The results are guaranteed to appear
339105a86c5cSdrh ** in register target.  If the expression is constant, then this routine
339205a86c5cSdrh ** might choose to code the expression at initialization time.
339305a86c5cSdrh */
339405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
339505a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
339605a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
339705a86c5cSdrh   }else{
339805a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
339905a86c5cSdrh   }
3400cce7d176Sdrh }
3401cce7d176Sdrh 
3402cce7d176Sdrh /*
340360ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
3404de4fcfddSdrh ** in register target.
340525303780Sdrh **
34062dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
34072dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
34082dcef11bSdrh ** the result is a copy of the cache register.
34092dcef11bSdrh **
34102dcef11bSdrh ** This routine is used for expressions that are used multiple
34112dcef11bSdrh ** times.  They are evaluated once and the results of the expression
34122dcef11bSdrh ** are reused.
341325303780Sdrh */
341405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
341525303780Sdrh   Vdbe *v = pParse->pVdbe;
341625303780Sdrh   int iMem;
341705a86c5cSdrh 
341805a86c5cSdrh   assert( target>0 );
341905a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
342005a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
34212dcef11bSdrh   iMem = ++pParse->nMem;
342205a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3423a4c3c87eSdrh   exprToRegister(pExpr, iMem);
342425303780Sdrh }
34257e02e5e6Sdrh 
3426678ccce8Sdrh /*
3427268380caSdrh ** Generate code that pushes the value of every element of the given
34289cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3429268380caSdrh **
3430892d3179Sdrh ** Return the number of elements evaluated.
3431d1a01edaSdrh **
3432d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
3433d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
3434d1a01edaSdrh **
3435d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3436d1a01edaSdrh ** factored out into initialization code.
3437b0df9634Sdrh **
3438b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
3439b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
3440b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
3441268380caSdrh */
34424adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3443268380caSdrh   Parse *pParse,     /* Parsing context */
3444389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3445191b54cbSdrh   int target,        /* Where to write results */
34465579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
3447d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
3448268380caSdrh ){
3449268380caSdrh   struct ExprList_item *pItem;
34505579d59fSdrh   int i, j, n;
3451d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
34525579d59fSdrh   Vdbe *v = pParse->pVdbe;
34539d8b3072Sdrh   assert( pList!=0 );
34549cbf3425Sdrh   assert( target>0 );
3455d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3456268380caSdrh   n = pList->nExpr;
3457d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
3458191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34597445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
34605579d59fSdrh     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pList->a[i].u.x.iOrderByCol)>0 ){
34615579d59fSdrh       sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
34625579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
3463d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
3464d1a01edaSdrh     }else{
34657445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3466746fd9ccSdrh       if( inReg!=target+i ){
34674eded604Sdrh         VdbeOp *pOp;
34684eded604Sdrh         if( copyOp==OP_Copy
34694eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
34704eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
34714eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
34724eded604Sdrh         ){
34734eded604Sdrh           pOp->p3++;
34744eded604Sdrh         }else{
34754eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
34764eded604Sdrh         }
3477d1a01edaSdrh       }
3478d176611bSdrh     }
3479268380caSdrh   }
3480f9b596ebSdrh   return n;
3481268380caSdrh }
3482268380caSdrh 
3483268380caSdrh /*
348436c563a2Sdrh ** Generate code for a BETWEEN operator.
348536c563a2Sdrh **
348636c563a2Sdrh **    x BETWEEN y AND z
348736c563a2Sdrh **
348836c563a2Sdrh ** The above is equivalent to
348936c563a2Sdrh **
349036c563a2Sdrh **    x>=y AND x<=z
349136c563a2Sdrh **
349236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
349360ec914cSpeter.d.reid ** elimination of x.
349436c563a2Sdrh */
349536c563a2Sdrh static void exprCodeBetween(
349636c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
349736c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
349836c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
349936c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
350036c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
350136c563a2Sdrh ){
350236c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
350336c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
350436c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
350536c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
350636c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
350736c563a2Sdrh 
350836c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
350936c563a2Sdrh   exprX = *pExpr->pLeft;
351036c563a2Sdrh   exprAnd.op = TK_AND;
351136c563a2Sdrh   exprAnd.pLeft = &compLeft;
351236c563a2Sdrh   exprAnd.pRight = &compRight;
351336c563a2Sdrh   compLeft.op = TK_GE;
351436c563a2Sdrh   compLeft.pLeft = &exprX;
351536c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
351636c563a2Sdrh   compRight.op = TK_LE;
351736c563a2Sdrh   compRight.pLeft = &exprX;
351836c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
3519a4c3c87eSdrh   exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
352036c563a2Sdrh   if( jumpIfTrue ){
352136c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
352236c563a2Sdrh   }else{
352336c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
352436c563a2Sdrh   }
352536c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
352636c563a2Sdrh 
352736c563a2Sdrh   /* Ensure adequate test coverage */
352836c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
352936c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
353036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
353136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
353236c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
353336c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
353436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
353536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
353636c563a2Sdrh }
353736c563a2Sdrh 
353836c563a2Sdrh /*
3539cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3540cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3541cce7d176Sdrh ** continues straight thru if the expression is false.
3542f5905aa7Sdrh **
3543f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
354435573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3545f2bc013cSdrh **
3546f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3547f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3548f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3549f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3550f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3551cce7d176Sdrh */
35524adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3553cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3554cce7d176Sdrh   int op = 0;
35552dcef11bSdrh   int regFree1 = 0;
35562dcef11bSdrh   int regFree2 = 0;
35572dcef11bSdrh   int r1, r2;
35582dcef11bSdrh 
355935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
356048864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
356133cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3562f2bc013cSdrh   op = pExpr->op;
3563f2bc013cSdrh   switch( op ){
3564cce7d176Sdrh     case TK_AND: {
35654adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3566c5499befSdrh       testcase( jumpIfNull==0 );
356735573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
356854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
35694adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35704adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3571d2490904Sdrh       sqlite3ExprCachePop(pParse);
3572cce7d176Sdrh       break;
3573cce7d176Sdrh     }
3574cce7d176Sdrh     case TK_OR: {
3575c5499befSdrh       testcase( jumpIfNull==0 );
35764adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
357754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
35784adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3579d2490904Sdrh       sqlite3ExprCachePop(pParse);
3580cce7d176Sdrh       break;
3581cce7d176Sdrh     }
3582cce7d176Sdrh     case TK_NOT: {
3583c5499befSdrh       testcase( jumpIfNull==0 );
35844adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3585cce7d176Sdrh       break;
3586cce7d176Sdrh     }
3587de845c2fSdrh     case TK_IS:
3588de845c2fSdrh     case TK_ISNOT:
3589de845c2fSdrh       testcase( op==TK_IS );
3590de845c2fSdrh       testcase( op==TK_ISNOT );
3591de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
3592de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
3593de845c2fSdrh       /* Fall thru */
3594cce7d176Sdrh     case TK_LT:
3595cce7d176Sdrh     case TK_LE:
3596cce7d176Sdrh     case TK_GT:
3597cce7d176Sdrh     case TK_GE:
3598cce7d176Sdrh     case TK_NE:
35990ac65892Sdrh     case TK_EQ: {
3600c5499befSdrh       testcase( jumpIfNull==0 );
3601b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3602b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
360335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36042dcef11bSdrh                   r1, r2, dest, jumpIfNull);
36057d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36067d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36077d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36087d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3609de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
3610de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
3611de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
3612de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
3613de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
3614de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
36156a2fe093Sdrh       testcase( regFree1==0 );
36166a2fe093Sdrh       testcase( regFree2==0 );
36176a2fe093Sdrh       break;
36186a2fe093Sdrh     }
3619cce7d176Sdrh     case TK_ISNULL:
3620cce7d176Sdrh     case TK_NOTNULL: {
36217d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
36227d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
36232dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36242dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
36257d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
36267d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3627c5499befSdrh       testcase( regFree1==0 );
3628cce7d176Sdrh       break;
3629cce7d176Sdrh     }
3630fef5208cSdrh     case TK_BETWEEN: {
36315c03f30aSdrh       testcase( jumpIfNull==0 );
363236c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3633fef5208cSdrh       break;
3634fef5208cSdrh     }
3635bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3636e3365e6cSdrh     case TK_IN: {
3637e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3638e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3639e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3640076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
3641e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3642e3365e6cSdrh       break;
3643e3365e6cSdrh     }
3644bb201344Sshaneh #endif
3645cce7d176Sdrh     default: {
3646991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
3647076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
3648991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
3649991a1985Sdrh         /* No-op */
3650991a1985Sdrh       }else{
36512dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
36522dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3653688852abSdrh         VdbeCoverage(v);
3654c5499befSdrh         testcase( regFree1==0 );
3655c5499befSdrh         testcase( jumpIfNull==0 );
3656991a1985Sdrh       }
3657cce7d176Sdrh       break;
3658cce7d176Sdrh     }
3659cce7d176Sdrh   }
36602dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
36612dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3662cce7d176Sdrh }
3663cce7d176Sdrh 
3664cce7d176Sdrh /*
366566b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3666cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3667cce7d176Sdrh ** continues straight thru if the expression is true.
3668f5905aa7Sdrh **
3669f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
367035573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
367135573356Sdrh ** is 0.
3672cce7d176Sdrh */
36734adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3674cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3675cce7d176Sdrh   int op = 0;
36762dcef11bSdrh   int regFree1 = 0;
36772dcef11bSdrh   int regFree2 = 0;
36782dcef11bSdrh   int r1, r2;
36792dcef11bSdrh 
368035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
368148864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
368233cd4909Sdrh   if( pExpr==0 )    return;
3683f2bc013cSdrh 
3684f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3685f2bc013cSdrh   **
3686f2bc013cSdrh   **       pExpr->op            op
3687f2bc013cSdrh   **       ---------          ----------
3688f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3689f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3690f2bc013cSdrh   **       TK_NE              OP_Eq
3691f2bc013cSdrh   **       TK_EQ              OP_Ne
3692f2bc013cSdrh   **       TK_GT              OP_Le
3693f2bc013cSdrh   **       TK_LE              OP_Gt
3694f2bc013cSdrh   **       TK_GE              OP_Lt
3695f2bc013cSdrh   **       TK_LT              OP_Ge
3696f2bc013cSdrh   **
3697f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3698f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3699f2bc013cSdrh   ** can compute the mapping above using the following expression.
3700f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3701f2bc013cSdrh   */
3702f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3703f2bc013cSdrh 
3704f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3705f2bc013cSdrh   */
3706f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3707f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3708f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3709f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3710f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3711f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3712f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3713f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3714f2bc013cSdrh 
3715cce7d176Sdrh   switch( pExpr->op ){
3716cce7d176Sdrh     case TK_AND: {
3717c5499befSdrh       testcase( jumpIfNull==0 );
37184adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
371954e2adb5Sdrh       sqlite3ExprCachePush(pParse);
37204adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3721d2490904Sdrh       sqlite3ExprCachePop(pParse);
3722cce7d176Sdrh       break;
3723cce7d176Sdrh     }
3724cce7d176Sdrh     case TK_OR: {
37254adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3726c5499befSdrh       testcase( jumpIfNull==0 );
372735573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
372854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
37294adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
37304adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3731d2490904Sdrh       sqlite3ExprCachePop(pParse);
3732cce7d176Sdrh       break;
3733cce7d176Sdrh     }
3734cce7d176Sdrh     case TK_NOT: {
37355c03f30aSdrh       testcase( jumpIfNull==0 );
37364adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3737cce7d176Sdrh       break;
3738cce7d176Sdrh     }
3739de845c2fSdrh     case TK_IS:
3740de845c2fSdrh     case TK_ISNOT:
3741de845c2fSdrh       testcase( pExpr->op==TK_IS );
3742de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
3743de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
3744de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
3745de845c2fSdrh       /* Fall thru */
3746cce7d176Sdrh     case TK_LT:
3747cce7d176Sdrh     case TK_LE:
3748cce7d176Sdrh     case TK_GT:
3749cce7d176Sdrh     case TK_GE:
3750cce7d176Sdrh     case TK_NE:
3751cce7d176Sdrh     case TK_EQ: {
3752c5499befSdrh       testcase( jumpIfNull==0 );
3753b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3754b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
375535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37562dcef11bSdrh                   r1, r2, dest, jumpIfNull);
37577d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
37587d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
37597d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
37607d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3761de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
3762de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
3763de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
3764de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
3765de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
3766de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
37676a2fe093Sdrh       testcase( regFree1==0 );
37686a2fe093Sdrh       testcase( regFree2==0 );
37696a2fe093Sdrh       break;
37706a2fe093Sdrh     }
3771cce7d176Sdrh     case TK_ISNULL:
3772cce7d176Sdrh     case TK_NOTNULL: {
37732dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37742dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
37757d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
37767d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
3777c5499befSdrh       testcase( regFree1==0 );
3778cce7d176Sdrh       break;
3779cce7d176Sdrh     }
3780fef5208cSdrh     case TK_BETWEEN: {
37815c03f30aSdrh       testcase( jumpIfNull==0 );
378236c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3783fef5208cSdrh       break;
3784fef5208cSdrh     }
3785bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3786e3365e6cSdrh     case TK_IN: {
3787e3365e6cSdrh       if( jumpIfNull ){
3788e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3789e3365e6cSdrh       }else{
3790e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3791e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3792e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3793e3365e6cSdrh       }
3794e3365e6cSdrh       break;
3795e3365e6cSdrh     }
3796bb201344Sshaneh #endif
3797cce7d176Sdrh     default: {
3798991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
3799076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
3800991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
3801991a1985Sdrh         /* no-op */
3802991a1985Sdrh       }else{
38032dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
38042dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3805688852abSdrh         VdbeCoverage(v);
3806c5499befSdrh         testcase( regFree1==0 );
3807c5499befSdrh         testcase( jumpIfNull==0 );
3808991a1985Sdrh       }
3809cce7d176Sdrh       break;
3810cce7d176Sdrh     }
3811cce7d176Sdrh   }
38122dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
38132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3814cce7d176Sdrh }
38152282792aSdrh 
38162282792aSdrh /*
381772bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
381872bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
381972bc8208Sdrh ** ensures that the original pExpr is unchanged.
382072bc8208Sdrh */
382172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
382272bc8208Sdrh   sqlite3 *db = pParse->db;
382372bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
382472bc8208Sdrh   if( db->mallocFailed==0 ){
382572bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
382672bc8208Sdrh   }
382772bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
382872bc8208Sdrh }
382972bc8208Sdrh 
383072bc8208Sdrh 
383172bc8208Sdrh /*
38321d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
38331d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
38341d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
38351d9da70aSdrh ** other than the top-level COLLATE operator.
3836d40aab0eSdrh **
3837619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3838619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3839619a1305Sdrh **
384066518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
384166518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
384266518ca7Sdrh **
38431d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3844d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
38451d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
38461d9da70aSdrh ** returns 2, then you do not really know for certain if the two
38471d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3848d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
38491d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3850d40aab0eSdrh ** just might result in some slightly slower code.  But returning
38511d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
38522282792aSdrh */
3853619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
385410d1edf0Sdrh   u32 combinedFlags;
38554b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
38561d9da70aSdrh     return pB==pA ? 0 : 2;
38572282792aSdrh   }
385810d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
385910d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
386010d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
386110d1edf0Sdrh       return 0;
386210d1edf0Sdrh     }
38631d9da70aSdrh     return 2;
38646ab3a2ecSdanielk1977   }
3865c2acc4e4Sdrh   if( pA->op!=pB->op ){
3866619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
3867ae80ddeaSdrh       return 1;
3868ae80ddeaSdrh     }
3869619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
3870ae80ddeaSdrh       return 1;
3871ae80ddeaSdrh     }
3872ae80ddeaSdrh     return 2;
3873ae80ddeaSdrh   }
38742edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
3875390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
3876390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
3877390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
387810d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
387910d1edf0Sdrh     }
388010d1edf0Sdrh   }
388110d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
388285f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
388310d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
3884619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3885619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3886619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
38877693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
3888619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
388966518ca7Sdrh       if( pA->iTable!=pB->iTable
389085f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
38911d9da70aSdrh     }
38921d9da70aSdrh   }
38932646da7eSdrh   return 0;
38942646da7eSdrh }
38952282792aSdrh 
38968c6f666bSdrh /*
38978c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
38988c6f666bSdrh ** non-zero if they differ in any way.
38998c6f666bSdrh **
3900619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3901619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3902619a1305Sdrh **
39038c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
39048c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
39058c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
39068c6f666bSdrh ** a malfunction will result.
39078c6f666bSdrh **
39088c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
39098c6f666bSdrh ** always differs from a non-NULL pointer.
39108c6f666bSdrh */
3911619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
39128c6f666bSdrh   int i;
39138c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
39148c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
39158c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
39168c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
39178c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
39188c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
39198c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
3920619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
39218c6f666bSdrh   }
39228c6f666bSdrh   return 0;
39238c6f666bSdrh }
392413449892Sdrh 
39252282792aSdrh /*
39264bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
39274bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
39284bd5f73fSdrh ** be false.  Examples:
39294bd5f73fSdrh **
3930619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
39314bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
3932619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
39334bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
3934619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
3935619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
3936619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
39374bd5f73fSdrh **
39384bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
39394bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
39404bd5f73fSdrh **
39414bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
39424bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
39434bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
39444bd5f73fSdrh */
39454bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
3946619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3947619a1305Sdrh     return 1;
3948619a1305Sdrh   }
3949619a1305Sdrh   if( pE2->op==TK_OR
3950619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3951619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3952619a1305Sdrh   ){
3953619a1305Sdrh     return 1;
3954619a1305Sdrh   }
3955619a1305Sdrh   if( pE2->op==TK_NOTNULL
3956619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3957619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3958619a1305Sdrh   ){
3959619a1305Sdrh     return 1;
3960619a1305Sdrh   }
3961619a1305Sdrh   return 0;
39624bd5f73fSdrh }
39634bd5f73fSdrh 
39644bd5f73fSdrh /*
3965030796dfSdrh ** An instance of the following structure is used by the tree walker
3966030796dfSdrh ** to count references to table columns in the arguments of an
3967ed551b95Sdrh ** aggregate function, in order to implement the
3968ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3969374fdce4Sdrh */
3970030796dfSdrh struct SrcCount {
3971030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3972030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3973030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3974030796dfSdrh };
3975030796dfSdrh 
3976030796dfSdrh /*
3977030796dfSdrh ** Count the number of references to columns.
3978030796dfSdrh */
3979030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3980fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3981fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3982fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3983fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3984fb0a6081Sdrh   ** NEVER() will need to be removed. */
3985fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3986374fdce4Sdrh     int i;
3987030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3988030796dfSdrh     SrcList *pSrc = p->pSrc;
3989655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
3990655814d2Sdrh     for(i=0; i<nSrc; i++){
3991030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3992374fdce4Sdrh     }
3993655814d2Sdrh     if( i<nSrc ){
3994030796dfSdrh       p->nThis++;
3995374fdce4Sdrh     }else{
3996030796dfSdrh       p->nOther++;
3997374fdce4Sdrh     }
3998374fdce4Sdrh   }
3999030796dfSdrh   return WRC_Continue;
4000030796dfSdrh }
4001374fdce4Sdrh 
4002374fdce4Sdrh /*
4003030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
4004030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
4005030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
4006030796dfSdrh ** references columns but not columns of tables found in pSrcList.
4007374fdce4Sdrh */
4008030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
4009374fdce4Sdrh   Walker w;
4010030796dfSdrh   struct SrcCount cnt;
4011374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
4012374fdce4Sdrh   memset(&w, 0, sizeof(w));
4013030796dfSdrh   w.xExprCallback = exprSrcCount;
4014030796dfSdrh   w.u.pSrcCount = &cnt;
4015030796dfSdrh   cnt.pSrc = pSrcList;
4016030796dfSdrh   cnt.nThis = 0;
4017030796dfSdrh   cnt.nOther = 0;
4018030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4019030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4020374fdce4Sdrh }
4021374fdce4Sdrh 
4022374fdce4Sdrh /*
402313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
402413449892Sdrh ** the new element.  Return a negative number if malloc fails.
40252282792aSdrh */
402617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
402713449892Sdrh   int i;
4028cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
402917435752Sdrh        db,
4030cf643729Sdrh        pInfo->aCol,
4031cf643729Sdrh        sizeof(pInfo->aCol[0]),
4032cf643729Sdrh        &pInfo->nColumn,
4033cf643729Sdrh        &i
4034cf643729Sdrh   );
403513449892Sdrh   return i;
40362282792aSdrh }
403713449892Sdrh 
403813449892Sdrh /*
403913449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
404013449892Sdrh ** the new element.  Return a negative number if malloc fails.
404113449892Sdrh */
404217435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
404313449892Sdrh   int i;
4044cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
404517435752Sdrh        db,
4046cf643729Sdrh        pInfo->aFunc,
4047cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4048cf643729Sdrh        &pInfo->nFunc,
4049cf643729Sdrh        &i
4050cf643729Sdrh   );
405113449892Sdrh   return i;
40522282792aSdrh }
40532282792aSdrh 
40542282792aSdrh /*
40557d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
40567d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4057626a879aSdrh ** for additional information.
40582282792aSdrh */
40597d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
40602282792aSdrh   int i;
40617d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4062a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4063a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
406413449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
406513449892Sdrh 
40662282792aSdrh   switch( pExpr->op ){
406789c69d00Sdrh     case TK_AGG_COLUMN:
4068967e8b73Sdrh     case TK_COLUMN: {
40698b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
40708b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
407113449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
407213449892Sdrh       ** clause of the aggregate query */
407320bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
407413449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
407513449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
407613449892Sdrh           struct AggInfo_col *pCol;
4077c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
407813449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
407913449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
408013449892Sdrh             ** that is in the FROM clause of the aggregate query.
408113449892Sdrh             **
408213449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
408313449892Sdrh             ** is not an entry there already.
408413449892Sdrh             */
40857f906d63Sdrh             int k;
408613449892Sdrh             pCol = pAggInfo->aCol;
40877f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
408813449892Sdrh               if( pCol->iTable==pExpr->iTable &&
408913449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
40902282792aSdrh                 break;
40912282792aSdrh               }
40922282792aSdrh             }
40931e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
40941e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
40951e536953Sdanielk1977             ){
40967f906d63Sdrh               pCol = &pAggInfo->aCol[k];
40970817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
409813449892Sdrh               pCol->iTable = pExpr->iTable;
409913449892Sdrh               pCol->iColumn = pExpr->iColumn;
41000a07c107Sdrh               pCol->iMem = ++pParse->nMem;
410113449892Sdrh               pCol->iSorterColumn = -1;
41025774b806Sdrh               pCol->pExpr = pExpr;
410313449892Sdrh               if( pAggInfo->pGroupBy ){
410413449892Sdrh                 int j, n;
410513449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
410613449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
410713449892Sdrh                 n = pGB->nExpr;
410813449892Sdrh                 for(j=0; j<n; j++, pTerm++){
410913449892Sdrh                   Expr *pE = pTerm->pExpr;
411013449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
411113449892Sdrh                       pE->iColumn==pExpr->iColumn ){
411213449892Sdrh                     pCol->iSorterColumn = j;
411313449892Sdrh                     break;
41142282792aSdrh                   }
411513449892Sdrh                 }
411613449892Sdrh               }
411713449892Sdrh               if( pCol->iSorterColumn<0 ){
411813449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
411913449892Sdrh               }
412013449892Sdrh             }
412113449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
412213449892Sdrh             ** because it was there before or because we just created it).
412313449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
412413449892Sdrh             ** pAggInfo->aCol[] entry.
412513449892Sdrh             */
4126ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
412713449892Sdrh             pExpr->pAggInfo = pAggInfo;
412813449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4129cf697396Sshane             pExpr->iAgg = (i16)k;
413013449892Sdrh             break;
413113449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
413213449892Sdrh         } /* end loop over pSrcList */
4133a58fdfb1Sdanielk1977       }
41347d10d5a6Sdrh       return WRC_Prune;
41352282792aSdrh     }
41362282792aSdrh     case TK_AGG_FUNCTION: {
41373a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4138ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
41393a8c4be7Sdrh       ){
414013449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
414113449892Sdrh         ** function that is already in the pAggInfo structure
414213449892Sdrh         */
414313449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
414413449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4145619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
41462282792aSdrh             break;
41472282792aSdrh           }
41482282792aSdrh         }
414913449892Sdrh         if( i>=pAggInfo->nFunc ){
415013449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
415113449892Sdrh           */
415214db2665Sdanielk1977           u8 enc = ENC(pParse->db);
41531e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
415413449892Sdrh           if( i>=0 ){
41556ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
415613449892Sdrh             pItem = &pAggInfo->aFunc[i];
415713449892Sdrh             pItem->pExpr = pExpr;
41580a07c107Sdrh             pItem->iMem = ++pParse->nMem;
415933e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
416013449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
416180738d9cSdrh                    pExpr->u.zToken,
41626ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4163fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4164fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4165fd357974Sdrh             }else{
4166fd357974Sdrh               pItem->iDistinct = -1;
4167fd357974Sdrh             }
41682282792aSdrh           }
416913449892Sdrh         }
417013449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
417113449892Sdrh         */
4172c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4173ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4174cf697396Sshane         pExpr->iAgg = (i16)i;
417513449892Sdrh         pExpr->pAggInfo = pAggInfo;
41763a8c4be7Sdrh         return WRC_Prune;
41776e83a57fSdrh       }else{
41786e83a57fSdrh         return WRC_Continue;
41796e83a57fSdrh       }
41802282792aSdrh     }
4181a58fdfb1Sdanielk1977   }
41827d10d5a6Sdrh   return WRC_Continue;
41837d10d5a6Sdrh }
41847d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4185d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4186d5a336efSdrh   UNUSED_PARAMETER(pSelect);
41877d10d5a6Sdrh   return WRC_Continue;
4188a58fdfb1Sdanielk1977 }
4189626a879aSdrh 
4190626a879aSdrh /*
4191e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4192e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4193e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4194e8abb4caSdrh ** necessary.
4195626a879aSdrh **
4196626a879aSdrh ** This routine should only be called after the expression has been
41977d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4198626a879aSdrh */
4199d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
42007d10d5a6Sdrh   Walker w;
4201374fdce4Sdrh   memset(&w, 0, sizeof(w));
42027d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
42037d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
42047d10d5a6Sdrh   w.u.pNC = pNC;
420520bc393cSdrh   assert( pNC->pSrcList!=0 );
42067d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
42072282792aSdrh }
42085d9a4af9Sdrh 
42095d9a4af9Sdrh /*
42105d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
42115d9a4af9Sdrh ** expression list.  Return the number of errors.
42125d9a4af9Sdrh **
42135d9a4af9Sdrh ** If an error is found, the analysis is cut short.
42145d9a4af9Sdrh */
4215d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
42165d9a4af9Sdrh   struct ExprList_item *pItem;
42175d9a4af9Sdrh   int i;
42185d9a4af9Sdrh   if( pList ){
4219d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4220d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
42215d9a4af9Sdrh     }
42225d9a4af9Sdrh   }
42235d9a4af9Sdrh }
4224892d3179Sdrh 
4225892d3179Sdrh /*
4226ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4227892d3179Sdrh */
4228892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4229e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4230892d3179Sdrh     return ++pParse->nMem;
4231892d3179Sdrh   }
42322f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4233892d3179Sdrh }
4234ceea3321Sdrh 
4235ceea3321Sdrh /*
4236ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4237ceea3321Sdrh ** purpose.
4238ceea3321Sdrh **
4239ceea3321Sdrh ** If a register is currently being used by the column cache, then
424060ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4241ceea3321Sdrh ** the register becomes stale.
4242ceea3321Sdrh */
4243892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
42442dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4245ceea3321Sdrh     int i;
4246ceea3321Sdrh     struct yColCache *p;
4247ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4248ceea3321Sdrh       if( p->iReg==iReg ){
4249ceea3321Sdrh         p->tempReg = 1;
4250ceea3321Sdrh         return;
4251ceea3321Sdrh       }
4252ceea3321Sdrh     }
4253892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4254892d3179Sdrh   }
4255892d3179Sdrh }
4256892d3179Sdrh 
4257892d3179Sdrh /*
4258892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4259892d3179Sdrh */
4260892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4261e55cbd72Sdrh   int i, n;
4262892d3179Sdrh   i = pParse->iRangeReg;
4263e55cbd72Sdrh   n = pParse->nRangeReg;
4264f49f3523Sdrh   if( nReg<=n ){
4265f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4266892d3179Sdrh     pParse->iRangeReg += nReg;
4267892d3179Sdrh     pParse->nRangeReg -= nReg;
4268892d3179Sdrh   }else{
4269892d3179Sdrh     i = pParse->nMem+1;
4270892d3179Sdrh     pParse->nMem += nReg;
4271892d3179Sdrh   }
4272892d3179Sdrh   return i;
4273892d3179Sdrh }
4274892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4275f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4276892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4277892d3179Sdrh     pParse->nRangeReg = nReg;
4278892d3179Sdrh     pParse->iRangeReg = iReg;
4279892d3179Sdrh   }
4280892d3179Sdrh }
4281cdc69557Sdrh 
4282cdc69557Sdrh /*
4283cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4284cdc69557Sdrh */
4285cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4286cdc69557Sdrh   pParse->nTempReg = 0;
4287cdc69557Sdrh   pParse->nRangeReg = 0;
4288cdc69557Sdrh }
4289bb9b5f26Sdrh 
4290bb9b5f26Sdrh /*
4291bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
4292bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
4293bb9b5f26Sdrh ** statements.
4294bb9b5f26Sdrh */
4295bb9b5f26Sdrh #ifdef SQLITE_DEBUG
4296bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
4297bb9b5f26Sdrh   int i;
4298bb9b5f26Sdrh   if( pParse->nRangeReg>0
4299bb9b5f26Sdrh    && pParse->iRangeReg+pParse->nRangeReg<iLast
4300bb9b5f26Sdrh    && pParse->iRangeReg>=iFirst
4301bb9b5f26Sdrh   ){
4302bb9b5f26Sdrh      return 0;
4303bb9b5f26Sdrh   }
4304bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
4305bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
4306bb9b5f26Sdrh       return 0;
4307bb9b5f26Sdrh     }
4308bb9b5f26Sdrh   }
4309bb9b5f26Sdrh   return 1;
4310bb9b5f26Sdrh }
4311bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
4312