xref: /sqlite-3.40.0/src/expr.c (revision 8b1db07f)
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 **
25e014a838Sdanielk1977 ** i.e. the WHERE clause expresssions 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){
34487e262fSdrh   int op = pExpr->op;
35487e262fSdrh   if( op==TK_SELECT ){
366ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
376ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
38a37cdde0Sdanielk1977   }
39487e262fSdrh #ifndef SQLITE_OMIT_CAST
40487e262fSdrh   if( op==TK_CAST ){
4133e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
4233e619fcSdrh     return sqlite3AffinityType(pExpr->u.zToken);
43487e262fSdrh   }
44487e262fSdrh #endif
45259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
46259a455fSdanielk1977    && pExpr->pTab!=0
47259a455fSdanielk1977   ){
487d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
497d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
507d10d5a6Sdrh     int j = pExpr->iColumn;
517d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
527d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
537d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
547d10d5a6Sdrh   }
55a37cdde0Sdanielk1977   return pExpr->affinity;
56a37cdde0Sdanielk1977 }
57a37cdde0Sdanielk1977 
5853db1458Sdrh /*
598342e49fSdrh ** Set the explicit collating sequence for an expression to the
608342e49fSdrh ** collating sequence supplied in the second argument.
618342e49fSdrh */
628342e49fSdrh Expr *sqlite3ExprSetColl(Expr *pExpr, CollSeq *pColl){
638342e49fSdrh   if( pExpr && pColl ){
648342e49fSdrh     pExpr->pColl = pColl;
658342e49fSdrh     pExpr->flags |= EP_ExpCollate;
668342e49fSdrh   }
678342e49fSdrh   return pExpr;
688342e49fSdrh }
698342e49fSdrh 
708342e49fSdrh /*
718b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
728b4c40d8Sdrh ** sequence named by pToken.   Return a pointer to the revised expression.
73a34001c9Sdrh ** The collating sequence is marked as "explicit" using the EP_ExpCollate
74a34001c9Sdrh ** flag.  An explicit collating sequence will override implicit
75a34001c9Sdrh ** collating sequences.
768b4c40d8Sdrh */
778342e49fSdrh Expr *sqlite3ExprSetCollByToken(Parse *pParse, Expr *pExpr, Token *pCollName){
7839002505Sdanielk1977   char *zColl = 0;            /* Dequoted name of collation sequence */
798b4c40d8Sdrh   CollSeq *pColl;
80633e6d57Sdrh   sqlite3 *db = pParse->db;
817d10d5a6Sdrh   zColl = sqlite3NameFromToken(db, pCollName);
82c4a64facSdrh   pColl = sqlite3LocateCollSeq(pParse, zColl);
838342e49fSdrh   sqlite3ExprSetColl(pExpr, pColl);
84633e6d57Sdrh   sqlite3DbFree(db, zColl);
858b4c40d8Sdrh   return pExpr;
868b4c40d8Sdrh }
878b4c40d8Sdrh 
888b4c40d8Sdrh /*
890202b29eSdanielk1977 ** Return the default collation sequence for the expression pExpr. If
900202b29eSdanielk1977 ** there is no default collation type, return 0.
910202b29eSdanielk1977 */
927cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
937cedc8d4Sdanielk1977   CollSeq *pColl = 0;
947d10d5a6Sdrh   Expr *p = pExpr;
9551f49f17Sdrh   while( ALWAYS(p) ){
967e09fe0bSdrh     int op;
977d10d5a6Sdrh     pColl = p->pColl;
987d10d5a6Sdrh     if( pColl ) break;
997d10d5a6Sdrh     op = p->op;
10076d462eeSdan     if( p->pTab!=0 && (
10176d462eeSdan         op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER || op==TK_TRIGGER
10276d462eeSdan     )){
1037d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1047d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1057d10d5a6Sdrh       const char *zColl;
1067d10d5a6Sdrh       int j = p->iColumn;
1077d10d5a6Sdrh       if( j>=0 ){
1087d10d5a6Sdrh         sqlite3 *db = pParse->db;
1097d10d5a6Sdrh         zColl = p->pTab->aCol[j].zColl;
110c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1117d10d5a6Sdrh         pExpr->pColl = pColl;
1120202b29eSdanielk1977       }
1137d10d5a6Sdrh       break;
1147d10d5a6Sdrh     }
1157d10d5a6Sdrh     if( op!=TK_CAST && op!=TK_UPLUS ){
1167d10d5a6Sdrh       break;
1177d10d5a6Sdrh     }
1187d10d5a6Sdrh     p = p->pLeft;
1190202b29eSdanielk1977   }
1207cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1217cedc8d4Sdanielk1977     pColl = 0;
1227cedc8d4Sdanielk1977   }
1237cedc8d4Sdanielk1977   return pColl;
1240202b29eSdanielk1977 }
1250202b29eSdanielk1977 
1260202b29eSdanielk1977 /*
127626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
128626a879aSdrh ** type affinity of the other operand.  This routine returns the
12953db1458Sdrh ** type affinity that should be used for the comparison operator.
13053db1458Sdrh */
131e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
132bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
133e014a838Sdanielk1977   if( aff1 && aff2 ){
1348df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1358df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
136e014a838Sdanielk1977     */
1378a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
138e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
139e014a838Sdanielk1977     }else{
140e014a838Sdanielk1977       return SQLITE_AFF_NONE;
141e014a838Sdanielk1977     }
142e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1435f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1445f6a87b3Sdrh     ** results directly.
145e014a838Sdanielk1977     */
1465f6a87b3Sdrh     return SQLITE_AFF_NONE;
147e014a838Sdanielk1977   }else{
148e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
149fe05af87Sdrh     assert( aff1==0 || aff2==0 );
150e014a838Sdanielk1977     return (aff1 + aff2);
151e014a838Sdanielk1977   }
152e014a838Sdanielk1977 }
153e014a838Sdanielk1977 
15453db1458Sdrh /*
15553db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
15653db1458Sdrh ** be applied to both operands prior to doing the comparison.
15753db1458Sdrh */
158e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
159e014a838Sdanielk1977   char aff;
160e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
161e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
1626a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
163e014a838Sdanielk1977   assert( pExpr->pLeft );
164bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
165e014a838Sdanielk1977   if( pExpr->pRight ){
166e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1676ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1686ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
1696ab3a2ecSdanielk1977   }else if( !aff ){
170de087bd5Sdrh     aff = SQLITE_AFF_NONE;
171e014a838Sdanielk1977   }
172e014a838Sdanielk1977   return aff;
173e014a838Sdanielk1977 }
174e014a838Sdanielk1977 
175e014a838Sdanielk1977 /*
176e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
177e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
178e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
179e014a838Sdanielk1977 ** the comparison in pExpr.
180e014a838Sdanielk1977 */
181e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
182e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
1838a51256cSdrh   switch( aff ){
1848a51256cSdrh     case SQLITE_AFF_NONE:
1858a51256cSdrh       return 1;
1868a51256cSdrh     case SQLITE_AFF_TEXT:
1878a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
1888a51256cSdrh     default:
1898a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
1908a51256cSdrh   }
191e014a838Sdanielk1977 }
192e014a838Sdanielk1977 
193a37cdde0Sdanielk1977 /*
19435573356Sdrh ** Return the P5 value that should be used for a binary comparison
195a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
196a37cdde0Sdanielk1977 */
19735573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
19835573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
1991bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
20035573356Sdrh   return aff;
201a37cdde0Sdanielk1977 }
202a37cdde0Sdanielk1977 
203a2e00042Sdrh /*
2040202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2050202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2060202b29eSdanielk1977 **
2070202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2080202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2090202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2100202b29eSdanielk1977 ** type.
211bcbb04e5Sdanielk1977 **
212bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
213bcbb04e5Sdanielk1977 ** it is not considered.
2140202b29eSdanielk1977 */
215bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
216bcbb04e5Sdanielk1977   Parse *pParse,
217bcbb04e5Sdanielk1977   Expr *pLeft,
218bcbb04e5Sdanielk1977   Expr *pRight
219bcbb04e5Sdanielk1977 ){
220ec41ddacSdrh   CollSeq *pColl;
221ec41ddacSdrh   assert( pLeft );
222ec41ddacSdrh   if( pLeft->flags & EP_ExpCollate ){
223ec41ddacSdrh     assert( pLeft->pColl );
224ec41ddacSdrh     pColl = pLeft->pColl;
225bcbb04e5Sdanielk1977   }else if( pRight && pRight->flags & EP_ExpCollate ){
226ec41ddacSdrh     assert( pRight->pColl );
227ec41ddacSdrh     pColl = pRight->pColl;
228ec41ddacSdrh   }else{
229ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2300202b29eSdanielk1977     if( !pColl ){
2317cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2320202b29eSdanielk1977     }
233ec41ddacSdrh   }
2340202b29eSdanielk1977   return pColl;
2350202b29eSdanielk1977 }
2360202b29eSdanielk1977 
2370202b29eSdanielk1977 /*
238be5c89acSdrh ** Generate code for a comparison operator.
239be5c89acSdrh */
240be5c89acSdrh static int codeCompare(
241be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
242be5c89acSdrh   Expr *pLeft,      /* The left operand */
243be5c89acSdrh   Expr *pRight,     /* The right operand */
244be5c89acSdrh   int opcode,       /* The comparison opcode */
24535573356Sdrh   int in1, int in2, /* Register holding operands */
246be5c89acSdrh   int dest,         /* Jump here if true.  */
247be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
248be5c89acSdrh ){
24935573356Sdrh   int p5;
25035573356Sdrh   int addr;
25135573356Sdrh   CollSeq *p4;
25235573356Sdrh 
25335573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
25435573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
25535573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
25635573356Sdrh                            (void*)p4, P4_COLLSEQ);
2571bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
25835573356Sdrh   return addr;
259be5c89acSdrh }
260be5c89acSdrh 
2614b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2624b5255acSdanielk1977 /*
2634b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2644b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2654b5255acSdanielk1977 ** pParse.
2664b5255acSdanielk1977 */
2677d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2684b5255acSdanielk1977   int rc = SQLITE_OK;
2694b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
2704b5255acSdanielk1977   if( nHeight>mxHeight ){
2714b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
2724b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
2734b5255acSdanielk1977     );
2744b5255acSdanielk1977     rc = SQLITE_ERROR;
2754b5255acSdanielk1977   }
2764b5255acSdanielk1977   return rc;
2774b5255acSdanielk1977 }
2784b5255acSdanielk1977 
2794b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
2804b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
2814b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
2824b5255acSdanielk1977 ** first argument.
2834b5255acSdanielk1977 **
2844b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
2854b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
2864b5255acSdanielk1977 ** value.
2874b5255acSdanielk1977 */
2884b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
2894b5255acSdanielk1977   if( p ){
2904b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
2914b5255acSdanielk1977       *pnHeight = p->nHeight;
2924b5255acSdanielk1977     }
2934b5255acSdanielk1977   }
2944b5255acSdanielk1977 }
2954b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
2964b5255acSdanielk1977   if( p ){
2974b5255acSdanielk1977     int i;
2984b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
2994b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3004b5255acSdanielk1977     }
3014b5255acSdanielk1977   }
3024b5255acSdanielk1977 }
3034b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3044b5255acSdanielk1977   if( p ){
3054b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3064b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3074b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3084b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3094b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3104b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3114b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3124b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3134b5255acSdanielk1977   }
3144b5255acSdanielk1977 }
3154b5255acSdanielk1977 
3164b5255acSdanielk1977 /*
3174b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3184b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3194b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3204b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3214b5255acSdanielk1977 ** referenced Expr plus one.
3224b5255acSdanielk1977 */
3234b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3244b5255acSdanielk1977   int nHeight = 0;
3254b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3264b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3276ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3286ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3296ab3a2ecSdanielk1977   }else{
3306ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3316ab3a2ecSdanielk1977   }
3324b5255acSdanielk1977   p->nHeight = nHeight + 1;
3334b5255acSdanielk1977 }
3344b5255acSdanielk1977 
3354b5255acSdanielk1977 /*
3364b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3374b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3384b5255acSdanielk1977 ** leave an error in pParse.
3394b5255acSdanielk1977 */
3404b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3414b5255acSdanielk1977   exprSetHeight(p);
3427d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3434b5255acSdanielk1977 }
3444b5255acSdanielk1977 
3454b5255acSdanielk1977 /*
3464b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3474b5255acSdanielk1977 ** by the select statement passed as an argument.
3484b5255acSdanielk1977 */
3494b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3504b5255acSdanielk1977   int nHeight = 0;
3514b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3524b5255acSdanielk1977   return nHeight;
3534b5255acSdanielk1977 }
3544b5255acSdanielk1977 #else
3554b5255acSdanielk1977   #define exprSetHeight(y)
3564b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3574b5255acSdanielk1977 
358be5c89acSdrh /*
359b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
360b7916a78Sdrh **
361a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
362b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
363b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
364a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
365b7916a78Sdrh **
366b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
367b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
368b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
369b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
370b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
37133e619fcSdrh **
37233e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
37333e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
37433e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
37533e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
37633e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
377a76b5dfcSdrh */
378b7916a78Sdrh Expr *sqlite3ExprAlloc(
379a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
38017435752Sdrh   int op,                 /* Expression opcode */
381b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
382b7916a78Sdrh   int dequote             /* True to dequote */
38317435752Sdrh ){
384a76b5dfcSdrh   Expr *pNew;
38533e619fcSdrh   int nExtra = 0;
386cf697396Sshane   int iValue = 0;
387b7916a78Sdrh 
388b7916a78Sdrh   if( pToken ){
38933e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
39033e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
391b7916a78Sdrh       nExtra = pToken->n+1;
39233e619fcSdrh     }
393a76b5dfcSdrh   }
394b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
395b7916a78Sdrh   if( pNew ){
3961bd10f8aSdrh     pNew->op = (u8)op;
397a58fdfb1Sdanielk1977     pNew->iAgg = -1;
398a76b5dfcSdrh     if( pToken ){
39933e619fcSdrh       if( nExtra==0 ){
40033e619fcSdrh         pNew->flags |= EP_IntValue;
40133e619fcSdrh         pNew->u.iValue = iValue;
40233e619fcSdrh       }else{
403d9da78a2Sdrh         int c;
40433e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
40533e619fcSdrh         memcpy(pNew->u.zToken, pToken->z, pToken->n);
40633e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
407b7916a78Sdrh         if( dequote && nExtra>=3
408d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
40933e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
41024fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
411a34001c9Sdrh         }
412a34001c9Sdrh       }
41333e619fcSdrh     }
414b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
415b7916a78Sdrh     pNew->nHeight = 1;
416b7916a78Sdrh #endif
417a34001c9Sdrh   }
418a76b5dfcSdrh   return pNew;
419a76b5dfcSdrh }
420a76b5dfcSdrh 
421a76b5dfcSdrh /*
422b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
423b7916a78Sdrh ** already been dequoted.
424b7916a78Sdrh */
425b7916a78Sdrh Expr *sqlite3Expr(
426b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
427b7916a78Sdrh   int op,                 /* Expression opcode */
428b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
429b7916a78Sdrh ){
430b7916a78Sdrh   Token x;
431b7916a78Sdrh   x.z = zToken;
432b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
433b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
434b7916a78Sdrh }
435b7916a78Sdrh 
436b7916a78Sdrh /*
437b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
438b7916a78Sdrh **
439b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
440b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
441b7916a78Sdrh */
442b7916a78Sdrh void sqlite3ExprAttachSubtrees(
443b7916a78Sdrh   sqlite3 *db,
444b7916a78Sdrh   Expr *pRoot,
445b7916a78Sdrh   Expr *pLeft,
446b7916a78Sdrh   Expr *pRight
447b7916a78Sdrh ){
448b7916a78Sdrh   if( pRoot==0 ){
449b7916a78Sdrh     assert( db->mallocFailed );
450b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
451b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
452b7916a78Sdrh   }else{
453b7916a78Sdrh     if( pRight ){
454b7916a78Sdrh       pRoot->pRight = pRight;
455b7916a78Sdrh       if( pRight->flags & EP_ExpCollate ){
456b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
457b7916a78Sdrh         pRoot->pColl = pRight->pColl;
458b7916a78Sdrh       }
459b7916a78Sdrh     }
460b7916a78Sdrh     if( pLeft ){
461b7916a78Sdrh       pRoot->pLeft = pLeft;
462b7916a78Sdrh       if( pLeft->flags & EP_ExpCollate ){
463b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
464b7916a78Sdrh         pRoot->pColl = pLeft->pColl;
465b7916a78Sdrh       }
466b7916a78Sdrh     }
467b7916a78Sdrh     exprSetHeight(pRoot);
468b7916a78Sdrh   }
469b7916a78Sdrh }
470b7916a78Sdrh 
471b7916a78Sdrh /*
472bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
473b7916a78Sdrh **
474bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
475bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
476bf664469Sdrh ** free the subtrees and return NULL.
477206f3d96Sdrh */
47817435752Sdrh Expr *sqlite3PExpr(
47917435752Sdrh   Parse *pParse,          /* Parsing context */
48017435752Sdrh   int op,                 /* Expression opcode */
48117435752Sdrh   Expr *pLeft,            /* Left operand */
48217435752Sdrh   Expr *pRight,           /* Right operand */
48317435752Sdrh   const Token *pToken     /* Argument token */
48417435752Sdrh ){
485b7916a78Sdrh   Expr *p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
486b7916a78Sdrh   sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
4874e0cff60Sdrh   return p;
4884e0cff60Sdrh }
4894e0cff60Sdrh 
4904e0cff60Sdrh /*
49191bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
49291bb0eedSdrh ** NULL, then just return the other expression.
49391bb0eedSdrh */
4941e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
49591bb0eedSdrh   if( pLeft==0 ){
49691bb0eedSdrh     return pRight;
49791bb0eedSdrh   }else if( pRight==0 ){
49891bb0eedSdrh     return pLeft;
49991bb0eedSdrh   }else{
500b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
501b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
502b7916a78Sdrh     return pNew;
503a76b5dfcSdrh   }
504a76b5dfcSdrh }
505a76b5dfcSdrh 
506a76b5dfcSdrh /*
507a76b5dfcSdrh ** Construct a new expression node for a function with multiple
508a76b5dfcSdrh ** arguments.
509a76b5dfcSdrh */
51017435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
511a76b5dfcSdrh   Expr *pNew;
512633e6d57Sdrh   sqlite3 *db = pParse->db;
5134b202ae2Sdanielk1977   assert( pToken );
514b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
515a76b5dfcSdrh   if( pNew==0 ){
516d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
517a76b5dfcSdrh     return 0;
518a76b5dfcSdrh   }
5196ab3a2ecSdanielk1977   pNew->x.pList = pList;
5206ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5214b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
522a76b5dfcSdrh   return pNew;
523a76b5dfcSdrh }
524a76b5dfcSdrh 
525a76b5dfcSdrh /*
526fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
527fa6bc000Sdrh ** in the original SQL statement.
528fa6bc000Sdrh **
529fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
530fa6bc000Sdrh ** variable number.
531fa6bc000Sdrh **
532fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
533fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
534fa6bc000Sdrh ** the SQL statement comes from an external source.
535fa6bc000Sdrh **
53651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
537fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
538fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
539fa6bc000Sdrh ** assigned.
540fa6bc000Sdrh */
541fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
54217435752Sdrh   sqlite3 *db = pParse->db;
543b7916a78Sdrh   const char *z;
54417435752Sdrh 
545fa6bc000Sdrh   if( pExpr==0 ) return;
54633e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
54733e619fcSdrh   z = pExpr->u.zToken;
548b7916a78Sdrh   assert( z!=0 );
549b7916a78Sdrh   assert( z[0]!=0 );
550b7916a78Sdrh   if( z[1]==0 ){
551fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
552b7916a78Sdrh     assert( z[0]=='?' );
5538677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
554b7916a78Sdrh   }else if( z[0]=='?' ){
555fa6bc000Sdrh     /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
556fa6bc000Sdrh     ** use it as the variable number */
557c8d735aeSdan     i64 i;
558c8d735aeSdan     int bOk = sqlite3Atoi64(&z[1], &i);
5598677d308Sdrh     pExpr->iColumn = (ynVar)i;
560c5499befSdrh     testcase( i==0 );
561c5499befSdrh     testcase( i==1 );
562c5499befSdrh     testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
563c5499befSdrh     testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
564c8d735aeSdan     if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
565fa6bc000Sdrh       sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
566bb4957f8Sdrh           db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
567fa6bc000Sdrh     }
568fa6bc000Sdrh     if( i>pParse->nVar ){
5691df2db7fSshaneh       pParse->nVar = (int)i;
570fa6bc000Sdrh     }
571fa6bc000Sdrh   }else{
57251f49f17Sdrh     /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
573fa6bc000Sdrh     ** number as the prior appearance of the same name, or if the name
574fa6bc000Sdrh     ** has never appeared before, reuse the same variable number
575fa6bc000Sdrh     */
5761bd10f8aSdrh     int i;
5771bd10f8aSdrh     u32 n;
578b7916a78Sdrh     n = sqlite3Strlen30(z);
579fa6bc000Sdrh     for(i=0; i<pParse->nVarExpr; i++){
58051f49f17Sdrh       Expr *pE = pParse->apVarExpr[i];
58151f49f17Sdrh       assert( pE!=0 );
58233e619fcSdrh       if( memcmp(pE->u.zToken, z, n)==0 && pE->u.zToken[n]==0 ){
583937d0deaSdan         pExpr->iColumn = pE->iColumn;
584fa6bc000Sdrh         break;
585fa6bc000Sdrh       }
586fa6bc000Sdrh     }
587fa6bc000Sdrh     if( i>=pParse->nVarExpr ){
5888677d308Sdrh       pExpr->iColumn = (ynVar)(++pParse->nVar);
589fa6bc000Sdrh       if( pParse->nVarExpr>=pParse->nVarExprAlloc-1 ){
590fa6bc000Sdrh         pParse->nVarExprAlloc += pParse->nVarExprAlloc + 10;
59117435752Sdrh         pParse->apVarExpr =
59217435752Sdrh             sqlite3DbReallocOrFree(
59317435752Sdrh               db,
59417435752Sdrh               pParse->apVarExpr,
59517435752Sdrh               pParse->nVarExprAlloc*sizeof(pParse->apVarExpr[0])
59617435752Sdrh             );
597fa6bc000Sdrh       }
59817435752Sdrh       if( !db->mallocFailed ){
599fa6bc000Sdrh         assert( pParse->apVarExpr!=0 );
600fa6bc000Sdrh         pParse->apVarExpr[pParse->nVarExpr++] = pExpr;
601fa6bc000Sdrh       }
602fa6bc000Sdrh     }
603fa6bc000Sdrh   }
604bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
605832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
606832b2664Sdanielk1977   }
607fa6bc000Sdrh }
608fa6bc000Sdrh 
609fa6bc000Sdrh /*
610f6963f99Sdan ** Recursively delete an expression tree.
611a2e00042Sdrh */
612f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
613f6963f99Sdan   if( p==0 ) return;
614b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
615633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
616633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
61733e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
61833e619fcSdrh       sqlite3DbFree(db, p->u.zToken);
6196ab3a2ecSdanielk1977     }
6206ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6216ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6226ab3a2ecSdanielk1977     }else{
6236ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6246ab3a2ecSdanielk1977     }
6256ab3a2ecSdanielk1977   }
62633e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
627633e6d57Sdrh     sqlite3DbFree(db, p);
628a2e00042Sdrh   }
62933e619fcSdrh }
630a2e00042Sdrh 
631d2687b77Sdrh /*
6326ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6336ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6346ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6356ab3a2ecSdanielk1977 */
6366ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6376ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6386ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6396ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6406ab3a2ecSdanielk1977 }
6416ab3a2ecSdanielk1977 
6426ab3a2ecSdanielk1977 /*
64333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
64433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
64533e619fcSdrh ** how much of the tree is measured.
64633e619fcSdrh **
64733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
64833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
64933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
65033e619fcSdrh **
65133e619fcSdrh ***************************************************************************
65233e619fcSdrh **
65333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
65433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
65533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
65633e619fcSdrh ** The return values is always one of:
65733e619fcSdrh **
65833e619fcSdrh **      EXPR_FULLSIZE
65933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
66033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
66133e619fcSdrh **
66233e619fcSdrh ** The size of the structure can be found by masking the return value
66333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
66433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
66533e619fcSdrh **
66633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
66733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
66833e619fcSdrh ** During expression analysis, extra information is computed and moved into
66933e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
67033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
67133e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
67233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
67333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
67433e619fcSdrh ** to enforce this constraint.
6756ab3a2ecSdanielk1977 */
6766ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
6776ab3a2ecSdanielk1977   int nSize;
67833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
6796ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
6806ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
6816ab3a2ecSdanielk1977   }else{
68233e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
68333e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
68433e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
68533e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
68633e619fcSdrh     if( p->pLeft || p->pRight || p->pColl || p->x.pList ){
68733e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
68833e619fcSdrh     }else{
68933e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
69033e619fcSdrh     }
6916ab3a2ecSdanielk1977   }
6926ab3a2ecSdanielk1977   return nSize;
6936ab3a2ecSdanielk1977 }
6946ab3a2ecSdanielk1977 
6956ab3a2ecSdanielk1977 /*
69633e619fcSdrh ** This function returns the space in bytes required to store the copy
69733e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
69833e619fcSdrh ** string is defined.)
6996ab3a2ecSdanielk1977 */
7006ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
70133e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
70233e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
70333e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7046ab3a2ecSdanielk1977   }
705bc73971dSdanielk1977   return ROUND8(nByte);
7066ab3a2ecSdanielk1977 }
7076ab3a2ecSdanielk1977 
7086ab3a2ecSdanielk1977 /*
7096ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7106ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7116ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7126ab3a2ecSdanielk1977 **
7136ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
71433e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7156ab3a2ecSdanielk1977 **
7166ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7176ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7186ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7196ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7206ab3a2ecSdanielk1977 */
7216ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7226ab3a2ecSdanielk1977   int nByte = 0;
7236ab3a2ecSdanielk1977   if( p ){
7246ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7256ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
726b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7276ab3a2ecSdanielk1977     }
7286ab3a2ecSdanielk1977   }
7296ab3a2ecSdanielk1977   return nByte;
7306ab3a2ecSdanielk1977 }
7316ab3a2ecSdanielk1977 
7326ab3a2ecSdanielk1977 /*
7336ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7346ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
73533e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7366ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7376ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7386ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7396ab3a2ecSdanielk1977 */
7406ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7416ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7426ab3a2ecSdanielk1977   if( p ){
7436ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7446ab3a2ecSdanielk1977     u8 *zAlloc;
74533e619fcSdrh     u32 staticFlag = 0;
7466ab3a2ecSdanielk1977 
7476ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7486ab3a2ecSdanielk1977 
7496ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7506ab3a2ecSdanielk1977     if( pzBuffer ){
7516ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
75233e619fcSdrh       staticFlag = EP_Static;
7536ab3a2ecSdanielk1977     }else{
7546ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7556ab3a2ecSdanielk1977     }
7566ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7576ab3a2ecSdanielk1977 
7586ab3a2ecSdanielk1977     if( pNew ){
7596ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7606ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
7616ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
76233e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
7636ab3a2ecSdanielk1977       */
76433e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
76533e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
76633e619fcSdrh       int nToken;
76733e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
76833e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
76933e619fcSdrh       }else{
77033e619fcSdrh         nToken = 0;
77133e619fcSdrh       }
7726ab3a2ecSdanielk1977       if( isReduced ){
7736ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
7746ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
7756ab3a2ecSdanielk1977       }else{
7766ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
7776ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
7786ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
7796ab3a2ecSdanielk1977       }
7806ab3a2ecSdanielk1977 
78133e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
78233e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
78333e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
78433e619fcSdrh       pNew->flags |= staticFlag;
7856ab3a2ecSdanielk1977 
78633e619fcSdrh       /* Copy the p->u.zToken string, if any. */
7876ab3a2ecSdanielk1977       if( nToken ){
78833e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
78933e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
7906ab3a2ecSdanielk1977       }
7916ab3a2ecSdanielk1977 
7926ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
7936ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
7946ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
7956ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
7966ab3a2ecSdanielk1977         }else{
7976ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
7986ab3a2ecSdanielk1977         }
7996ab3a2ecSdanielk1977       }
8006ab3a2ecSdanielk1977 
8016ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
802b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8036ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8046ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8056ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8066ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8076ab3a2ecSdanielk1977         }
8086ab3a2ecSdanielk1977         if( pzBuffer ){
8096ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8106ab3a2ecSdanielk1977         }
811b7916a78Sdrh       }else{
812b7916a78Sdrh         pNew->flags2 = 0;
813b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8146ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8156ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8166ab3a2ecSdanielk1977         }
8176ab3a2ecSdanielk1977       }
818b7916a78Sdrh 
819b7916a78Sdrh     }
8206ab3a2ecSdanielk1977   }
8216ab3a2ecSdanielk1977   return pNew;
8226ab3a2ecSdanielk1977 }
8236ab3a2ecSdanielk1977 
8246ab3a2ecSdanielk1977 /*
825ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
826ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
827ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
828ff78bd2fSdrh ** without effecting the originals.
829ff78bd2fSdrh **
8304adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8314adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
832ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
833ff78bd2fSdrh **
834ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8356ab3a2ecSdanielk1977 **
836b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8376ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8386ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8396ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
840ff78bd2fSdrh */
8416ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8426ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
843ff78bd2fSdrh }
8446ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
845ff78bd2fSdrh   ExprList *pNew;
846145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
847ff78bd2fSdrh   int i;
848ff78bd2fSdrh   if( p==0 ) return 0;
84917435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
850ff78bd2fSdrh   if( pNew==0 ) return 0;
85131dad9daSdanielk1977   pNew->iECursor = 0;
8524305d103Sdrh   pNew->nExpr = pNew->nAlloc = p->nExpr;
85317435752Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  p->nExpr*sizeof(p->a[0]) );
854e0048400Sdanielk1977   if( pItem==0 ){
855633e6d57Sdrh     sqlite3DbFree(db, pNew);
856e0048400Sdanielk1977     return 0;
857e0048400Sdanielk1977   }
858145716b3Sdrh   pOldItem = p->a;
859145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
8606ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
861b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
86217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
863b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
864145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
8653e7bc9caSdrh     pItem->done = 0;
8667d10d5a6Sdrh     pItem->iCol = pOldItem->iCol;
8678b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
868ff78bd2fSdrh   }
869ff78bd2fSdrh   return pNew;
870ff78bd2fSdrh }
87193758c8dSdanielk1977 
87293758c8dSdanielk1977 /*
87393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
87493758c8dSdanielk1977 ** the build, then none of the following routines, except for
87593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
87693758c8dSdanielk1977 ** called with a NULL argument.
87793758c8dSdanielk1977 */
8786a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
8796a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
8806ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
881ad3cab52Sdrh   SrcList *pNew;
882ad3cab52Sdrh   int i;
883113088ecSdrh   int nByte;
884ad3cab52Sdrh   if( p==0 ) return 0;
885113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
88617435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
887ad3cab52Sdrh   if( pNew==0 ) return 0;
8884305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
889ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
8904efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
8914efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
892ed8a3bb1Sdrh     Table *pTab;
89317435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
89417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
89517435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
8964efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
8974efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
8981787ccabSdanielk1977     pNewItem->isPopulated = pOldItem->isPopulated;
89985574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
90085574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
90185574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
902ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
903ed8a3bb1Sdrh     if( pTab ){
904ed8a3bb1Sdrh       pTab->nRef++;
905a1cb183dSdanielk1977     }
9066ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9076ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
90817435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9096c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
910ad3cab52Sdrh   }
911ad3cab52Sdrh   return pNew;
912ad3cab52Sdrh }
91317435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
914ff78bd2fSdrh   IdList *pNew;
915ff78bd2fSdrh   int i;
916ff78bd2fSdrh   if( p==0 ) return 0;
91717435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
918ff78bd2fSdrh   if( pNew==0 ) return 0;
9194305d103Sdrh   pNew->nId = pNew->nAlloc = p->nId;
92017435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
921d5d56523Sdanielk1977   if( pNew->a==0 ){
922633e6d57Sdrh     sqlite3DbFree(db, pNew);
923d5d56523Sdanielk1977     return 0;
924d5d56523Sdanielk1977   }
925ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9264efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9274efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
92817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9294efc4754Sdrh     pNewItem->idx = pOldItem->idx;
930ff78bd2fSdrh   }
931ff78bd2fSdrh   return pNew;
932ff78bd2fSdrh }
9336ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
934ff78bd2fSdrh   Select *pNew;
935ff78bd2fSdrh   if( p==0 ) return 0;
93617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
937ff78bd2fSdrh   if( pNew==0 ) return 0;
938b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9396ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9406ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9416ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9426ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9436ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
944ff78bd2fSdrh   pNew->op = p->op;
9456ab3a2ecSdanielk1977   pNew->pPrior = sqlite3SelectDup(db, p->pPrior, flags);
9466ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9476ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
94892b01d53Sdrh   pNew->iLimit = 0;
94992b01d53Sdrh   pNew->iOffset = 0;
9507d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
9510342b1f5Sdrh   pNew->pRightmost = 0;
952b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
953b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
954b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
955ff78bd2fSdrh   return pNew;
956ff78bd2fSdrh }
95793758c8dSdanielk1977 #else
9586ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
95993758c8dSdanielk1977   assert( p==0 );
96093758c8dSdanielk1977   return 0;
96193758c8dSdanielk1977 }
96293758c8dSdanielk1977 #endif
963ff78bd2fSdrh 
964ff78bd2fSdrh 
965ff78bd2fSdrh /*
966a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
967a76b5dfcSdrh ** initially NULL, then create a new expression list.
968b7916a78Sdrh **
969b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
970b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
971b7916a78Sdrh ** that the new entry was successfully appended.
972a76b5dfcSdrh */
97317435752Sdrh ExprList *sqlite3ExprListAppend(
97417435752Sdrh   Parse *pParse,          /* Parsing context */
97517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
976b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
97717435752Sdrh ){
97817435752Sdrh   sqlite3 *db = pParse->db;
979a76b5dfcSdrh   if( pList==0 ){
98017435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
981a76b5dfcSdrh     if( pList==0 ){
982d5d56523Sdanielk1977       goto no_mem;
983a76b5dfcSdrh     }
9844efc4754Sdrh     assert( pList->nAlloc==0 );
985a76b5dfcSdrh   }
9864305d103Sdrh   if( pList->nAlloc<=pList->nExpr ){
987d5d56523Sdanielk1977     struct ExprList_item *a;
988d5d56523Sdanielk1977     int n = pList->nAlloc*2 + 4;
98926783a58Sdanielk1977     a = sqlite3DbRealloc(db, pList->a, n*sizeof(pList->a[0]));
990d5d56523Sdanielk1977     if( a==0 ){
991d5d56523Sdanielk1977       goto no_mem;
992a76b5dfcSdrh     }
993d5d56523Sdanielk1977     pList->a = a;
9946a1e071fSdrh     pList->nAlloc = sqlite3DbMallocSize(db, a)/sizeof(a[0]);
995a76b5dfcSdrh   }
9964efc4754Sdrh   assert( pList->a!=0 );
997b7916a78Sdrh   if( 1 ){
9984efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
9994efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1000e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1001a76b5dfcSdrh   }
1002a76b5dfcSdrh   return pList;
1003d5d56523Sdanielk1977 
1004d5d56523Sdanielk1977 no_mem:
1005d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1006633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1007633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1008d5d56523Sdanielk1977   return 0;
1009a76b5dfcSdrh }
1010a76b5dfcSdrh 
1011a76b5dfcSdrh /*
1012b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1013b7916a78Sdrh ** on the expression list.
1014b7916a78Sdrh **
1015b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1016b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1017b7916a78Sdrh ** is set.
1018b7916a78Sdrh */
1019b7916a78Sdrh void sqlite3ExprListSetName(
1020b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1021b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1022b7916a78Sdrh   Token *pName,           /* Name to be added */
1023b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1024b7916a78Sdrh ){
1025b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1026b7916a78Sdrh   if( pList ){
1027b7916a78Sdrh     struct ExprList_item *pItem;
1028b7916a78Sdrh     assert( pList->nExpr>0 );
1029b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1030b7916a78Sdrh     assert( pItem->zName==0 );
1031b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1032b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1033b7916a78Sdrh   }
1034b7916a78Sdrh }
1035b7916a78Sdrh 
1036b7916a78Sdrh /*
1037b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1038b7916a78Sdrh ** on the expression list.
1039b7916a78Sdrh **
1040b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1041b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1042b7916a78Sdrh ** is set.
1043b7916a78Sdrh */
1044b7916a78Sdrh void sqlite3ExprListSetSpan(
1045b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1046b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1047b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1048b7916a78Sdrh ){
1049b7916a78Sdrh   sqlite3 *db = pParse->db;
1050b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1051b7916a78Sdrh   if( pList ){
1052b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1053b7916a78Sdrh     assert( pList->nExpr>0 );
1054b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1055b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1056b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1057cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1058b7916a78Sdrh   }
1059b7916a78Sdrh }
1060b7916a78Sdrh 
1061b7916a78Sdrh /*
10627a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
10637a15a4beSdanielk1977 ** leave an error message in pParse.
10647a15a4beSdanielk1977 */
10657a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
10667a15a4beSdanielk1977   Parse *pParse,
10677a15a4beSdanielk1977   ExprList *pEList,
10687a15a4beSdanielk1977   const char *zObject
10697a15a4beSdanielk1977 ){
1070b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1071c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1072c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1073b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
10747a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
10757a15a4beSdanielk1977   }
10767a15a4beSdanielk1977 }
10777a15a4beSdanielk1977 
10787a15a4beSdanielk1977 /*
1079a76b5dfcSdrh ** Delete an entire expression list.
1080a76b5dfcSdrh */
1081633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1082a76b5dfcSdrh   int i;
1083be5c89acSdrh   struct ExprList_item *pItem;
1084a76b5dfcSdrh   if( pList==0 ) return;
10851bdd9b57Sdrh   assert( pList->a!=0 || (pList->nExpr==0 && pList->nAlloc==0) );
10861bdd9b57Sdrh   assert( pList->nExpr<=pList->nAlloc );
1087be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1088633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1089633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1090b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1091a76b5dfcSdrh   }
1092633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1093633e6d57Sdrh   sqlite3DbFree(db, pList);
1094a76b5dfcSdrh }
1095a76b5dfcSdrh 
1096a76b5dfcSdrh /*
10977d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
10987d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
10997d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11007d10d5a6Sdrh ** not constant.
110173b211abSdrh **
11027d10d5a6Sdrh ** These callback routines are used to implement the following:
1103626a879aSdrh **
11047d10d5a6Sdrh **     sqlite3ExprIsConstant()
11057d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11067d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
110787abf5c0Sdrh **
1108626a879aSdrh */
11097d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1110626a879aSdrh 
11117d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11120a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11130a168377Sdrh   ** from being considered constant. */
11147d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11157d10d5a6Sdrh     pWalker->u.i = 0;
11167d10d5a6Sdrh     return WRC_Abort;
11170a168377Sdrh   }
11180a168377Sdrh 
1119626a879aSdrh   switch( pExpr->op ){
1120eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11217d10d5a6Sdrh     ** and pWalker->u.i==2 */
1122eb55bd2fSdrh     case TK_FUNCTION:
11237d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1124eb55bd2fSdrh       /* Fall through */
1125626a879aSdrh     case TK_ID:
1126626a879aSdrh     case TK_COLUMN:
1127626a879aSdrh     case TK_AGG_FUNCTION:
112813449892Sdrh     case TK_AGG_COLUMN:
1129c5499befSdrh       testcase( pExpr->op==TK_ID );
1130c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1131c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1132c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11337d10d5a6Sdrh       pWalker->u.i = 0;
11347d10d5a6Sdrh       return WRC_Abort;
1135626a879aSdrh     default:
1136b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1137b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
11387d10d5a6Sdrh       return WRC_Continue;
1139626a879aSdrh   }
1140626a879aSdrh }
114162c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
114262c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11437d10d5a6Sdrh   pWalker->u.i = 0;
11447d10d5a6Sdrh   return WRC_Abort;
11457d10d5a6Sdrh }
11467d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11477d10d5a6Sdrh   Walker w;
11487d10d5a6Sdrh   w.u.i = initFlag;
11497d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11507d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11517d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11527d10d5a6Sdrh   return w.u.i;
11537d10d5a6Sdrh }
1154626a879aSdrh 
1155626a879aSdrh /*
1156fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1157eb55bd2fSdrh ** and 0 if it involves variables or function calls.
11582398937bSdrh **
11592398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
11602398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
11612398937bSdrh ** a constant.
1162fef5208cSdrh */
11634adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
11647d10d5a6Sdrh   return exprIsConst(p, 1);
1165fef5208cSdrh }
1166fef5208cSdrh 
1167fef5208cSdrh /*
1168eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
11690a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
11700a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
11710a168377Sdrh ** an ON or USING clause.
11720a168377Sdrh */
11730a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
11747d10d5a6Sdrh   return exprIsConst(p, 3);
11750a168377Sdrh }
11760a168377Sdrh 
11770a168377Sdrh /*
11780a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1179eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1180eb55bd2fSdrh ** are any variables.
1181eb55bd2fSdrh **
1182eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1183eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1184eb55bd2fSdrh ** a constant.
1185eb55bd2fSdrh */
1186eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
11877d10d5a6Sdrh   return exprIsConst(p, 2);
1188eb55bd2fSdrh }
1189eb55bd2fSdrh 
1190eb55bd2fSdrh /*
119173b211abSdrh ** If the expression p codes a constant integer that is small enough
1192202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1193202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1194202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1195e4de1febSdrh */
11964adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
119792b01d53Sdrh   int rc = 0;
119892b01d53Sdrh   if( p->flags & EP_IntValue ){
119933e619fcSdrh     *pValue = p->u.iValue;
1200e4de1febSdrh     return 1;
1201e4de1febSdrh   }
120292b01d53Sdrh   switch( p->op ){
120392b01d53Sdrh     case TK_INTEGER: {
120433e619fcSdrh       rc = sqlite3GetInt32(p->u.zToken, pValue);
120533e619fcSdrh       assert( rc==0 );
1206202b2df7Sdrh       break;
1207202b2df7Sdrh     }
12084b59ab5eSdrh     case TK_UPLUS: {
120992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1210f6e369a1Sdrh       break;
12114b59ab5eSdrh     }
1212e4de1febSdrh     case TK_UMINUS: {
1213e4de1febSdrh       int v;
12144adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1215e4de1febSdrh         *pValue = -v;
121692b01d53Sdrh         rc = 1;
1217e4de1febSdrh       }
1218e4de1febSdrh       break;
1219e4de1febSdrh     }
1220e4de1febSdrh     default: break;
1221e4de1febSdrh   }
122292b01d53Sdrh   if( rc ){
122333e619fcSdrh     assert( ExprHasAnyProperty(p, EP_Reduced|EP_TokenOnly)
122433e619fcSdrh                || (p->flags2 & EP2_MallocedToken)==0 );
122592b01d53Sdrh     p->op = TK_INTEGER;
122692b01d53Sdrh     p->flags |= EP_IntValue;
122733e619fcSdrh     p->u.iValue = *pValue;
122892b01d53Sdrh   }
122992b01d53Sdrh   return rc;
1230e4de1febSdrh }
1231e4de1febSdrh 
1232e4de1febSdrh /*
1233039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1234039fc32eSdrh **
1235039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1236039fc32eSdrh ** to tell return TRUE.
1237039fc32eSdrh **
1238039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1239039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1240039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1241039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1242039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1243039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1244039fc32eSdrh ** TRUE.
1245039fc32eSdrh */
1246039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1247039fc32eSdrh   u8 op;
1248cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1249039fc32eSdrh   op = p->op;
1250039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1251039fc32eSdrh   switch( op ){
1252039fc32eSdrh     case TK_INTEGER:
1253039fc32eSdrh     case TK_STRING:
1254039fc32eSdrh     case TK_FLOAT:
1255039fc32eSdrh     case TK_BLOB:
1256039fc32eSdrh       return 0;
1257039fc32eSdrh     default:
1258039fc32eSdrh       return 1;
1259039fc32eSdrh   }
1260039fc32eSdrh }
1261039fc32eSdrh 
1262039fc32eSdrh /*
12632f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
12642f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
12652f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
12662f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
12672f2855b6Sdrh ** can be omitted.
12682f2855b6Sdrh */
12692f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
12702f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
12712f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
12722f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
12732f2855b6Sdrh   int iDest           /* Jump here if the value is null */
12742f2855b6Sdrh ){
12752f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
12762f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
12772f2855b6Sdrh   }
12782f2855b6Sdrh }
12792f2855b6Sdrh 
12802f2855b6Sdrh /*
1281039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1282039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1283039fc32eSdrh ** argument.
1284039fc32eSdrh **
1285039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1286039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1287039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1288039fc32eSdrh ** answer.
1289039fc32eSdrh */
1290039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1291039fc32eSdrh   u8 op;
1292039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1293cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1294039fc32eSdrh   op = p->op;
1295039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1296039fc32eSdrh   switch( op ){
1297039fc32eSdrh     case TK_INTEGER: {
1298039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1299039fc32eSdrh     }
1300039fc32eSdrh     case TK_FLOAT: {
1301039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1302039fc32eSdrh     }
1303039fc32eSdrh     case TK_STRING: {
1304039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1305039fc32eSdrh     }
1306039fc32eSdrh     case TK_BLOB: {
1307039fc32eSdrh       return 1;
1308039fc32eSdrh     }
13092f2855b6Sdrh     case TK_COLUMN: {
131088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
131188376ca7Sdrh       return p->iColumn<0
13122f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
13132f2855b6Sdrh     }
1314039fc32eSdrh     default: {
1315039fc32eSdrh       return 0;
1316039fc32eSdrh     }
1317039fc32eSdrh   }
1318039fc32eSdrh }
1319039fc32eSdrh 
1320039fc32eSdrh /*
1321c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1322c4a3c779Sdrh */
13234adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
13244adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
13254adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
13264adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1327c4a3c779Sdrh   return 0;
1328c4a3c779Sdrh }
1329c4a3c779Sdrh 
13309a96b668Sdanielk1977 /*
1331b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1332b74b1017Sdrh ** query of the form
1333b287f4b6Sdrh **
1334b74b1017Sdrh **       x IN (SELECT ...)
1335b287f4b6Sdrh **
1336b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1337b74b1017Sdrh ** routine.
1338b74b1017Sdrh **
1339b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1340b74b1017Sdrh ** errors have been found.
1341b287f4b6Sdrh */
1342b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1343b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1344b287f4b6Sdrh   SrcList *pSrc;
1345b287f4b6Sdrh   ExprList *pEList;
1346b287f4b6Sdrh   Table *pTab;
1347b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1348b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
13497d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1350b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1351b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
13527d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
13537d10d5a6Sdrh   }
1354b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1355b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1356b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1357b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1358b287f4b6Sdrh   pSrc = p->pSrc;
1359d1fa7bcaSdrh   assert( pSrc!=0 );
1360d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1361b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1362b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1363b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1364b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1365b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1366b287f4b6Sdrh   pEList = p->pEList;
1367b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1368b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1369b287f4b6Sdrh   return 1;
1370b287f4b6Sdrh }
1371b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1372b287f4b6Sdrh 
1373b287f4b6Sdrh /*
13749a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
13759a96b668Sdanielk1977 ** It's job is to find or create a b-tree structure that may be used
13769a96b668Sdanielk1977 ** either to test for membership of the (...) set or to iterate through
137785b623f2Sdrh ** its members, skipping duplicates.
13789a96b668Sdanielk1977 **
1379b74b1017Sdrh ** The index of the cursor opened on the b-tree (database table, database index
13809a96b668Sdanielk1977 ** or ephermal table) is stored in pX->iTable before this function returns.
1381b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
13829a96b668Sdanielk1977 **
13839a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
13842d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
13859a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
13869a96b668Sdanielk1977 **                    populated epheremal table.
13879a96b668Sdanielk1977 **
1388b74b1017Sdrh ** An existing b-tree may only be used if the SELECT is of the simple
13899a96b668Sdanielk1977 ** form:
13909a96b668Sdanielk1977 **
13919a96b668Sdanielk1977 **     SELECT <column> FROM <table>
13929a96b668Sdanielk1977 **
1393b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
13949a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
13959a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
13969a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1397b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
13980cdc022eSdanielk1977 **
1399b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
14000cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
14010cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
14020cdc022eSdanielk1977 ** be found with <column> as its left-most column.
14030cdc022eSdanielk1977 **
1404b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
14050cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
14060cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1407e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
14080cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1409e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
14100cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
14110cdc022eSdanielk1977 **
14120cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1413e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1414e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1415b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1416e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1417b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
14180cdc022eSdanielk1977 **
14190cdc022eSdanielk1977 **   if( register==NULL ){
14200cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
14210cdc022eSdanielk1977 **     register = 1
14220cdc022eSdanielk1977 **   }
14230cdc022eSdanielk1977 **
14240cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
14250cdc022eSdanielk1977 ** test more often than is necessary.
14269a96b668Sdanielk1977 */
1427284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
14280cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1429b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1430b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1431b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1432b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
14339a96b668Sdanielk1977 
14341450bc6eSdrh   assert( pX->op==TK_IN );
14351450bc6eSdrh 
1436b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1437b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1438b74b1017Sdrh   ** ephemeral table.
14399a96b668Sdanielk1977   */
14406ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1441fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1442e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1443e1fb65a0Sdanielk1977     Expr *pExpr = p->pEList->a[0].pExpr;   /* Expression <column> */
1444e1fb65a0Sdanielk1977     int iCol = pExpr->iColumn;             /* Index of column <column> */
1445e1fb65a0Sdanielk1977     Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
1446e1fb65a0Sdanielk1977     Table *pTab = p->pSrc->a[0].pTab;      /* Table <table>. */
1447e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1448e1fb65a0Sdanielk1977 
1449e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1450e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1451e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1452e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
14539a96b668Sdanielk1977 
14549a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
14559a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
14569a96b668Sdanielk1977     ** successful here.
14579a96b668Sdanielk1977     */
14589a96b668Sdanielk1977     assert(v);
14599a96b668Sdanielk1977     if( iCol<0 ){
14600a07c107Sdrh       int iMem = ++pParse->nMem;
14619a96b668Sdanielk1977       int iAddr;
14629a96b668Sdanielk1977 
1463892d3179Sdrh       iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14644c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14659a96b668Sdanielk1977 
14669a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
14679a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
14689a96b668Sdanielk1977 
14699a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
14709a96b668Sdanielk1977     }else{
1471e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1472e1fb65a0Sdanielk1977 
14739a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
14749a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1475e1fb65a0Sdanielk1977       ** to this collation sequence.  */
14769a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
14779a96b668Sdanielk1977 
14789a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
14799a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
14809a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
14819a96b668Sdanielk1977       */
14829a96b668Sdanielk1977       char aff = comparisonAffinity(pX);
14839a96b668Sdanielk1977       int affinity_ok = (pTab->aCol[iCol].affinity==aff||aff==SQLITE_AFF_NONE);
14849a96b668Sdanielk1977 
14859a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
14869a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1487b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
14889a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
14899a96b668Sdanielk1977         ){
14900a07c107Sdrh           int iMem = ++pParse->nMem;
14919a96b668Sdanielk1977           int iAddr;
14929a96b668Sdanielk1977           char *pKey;
14939a96b668Sdanielk1977 
14949a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
1495892d3179Sdrh           iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14964c583128Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14979a96b668Sdanielk1977 
1498207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
149966a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1500207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
15019a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
15029a96b668Sdanielk1977 
15039a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
15040cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
15050cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
15060cdc022eSdanielk1977           }
15079a96b668Sdanielk1977         }
15089a96b668Sdanielk1977       }
15099a96b668Sdanielk1977     }
15109a96b668Sdanielk1977   }
15119a96b668Sdanielk1977 
15129a96b668Sdanielk1977   if( eType==0 ){
15131450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1514b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1515b74b1017Sdrh     */
1516cf4d38aaSdrh     double savedNQueryLoop = pParse->nQueryLoop;
15170cdc022eSdanielk1977     int rMayHaveNull = 0;
151841a05b7bSdanielk1977     eType = IN_INDEX_EPH;
15190cdc022eSdanielk1977     if( prNotFound ){
15200cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1521cf4d38aaSdrh     }else{
1522cf4d38aaSdrh       testcase( pParse->nQueryLoop>(double)1 );
1523cf4d38aaSdrh       pParse->nQueryLoop = (double)1;
1524cf4d38aaSdrh       if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
152541a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
15260cdc022eSdanielk1977       }
1527cf4d38aaSdrh     }
152841a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1529cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
15309a96b668Sdanielk1977   }else{
15319a96b668Sdanielk1977     pX->iTable = iTab;
15329a96b668Sdanielk1977   }
15339a96b668Sdanielk1977   return eType;
15349a96b668Sdanielk1977 }
1535284f4acaSdanielk1977 #endif
1536626a879aSdrh 
1537626a879aSdrh /*
1538d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1539d4187c71Sdrh ** or IN operators.  Examples:
1540626a879aSdrh **
15419cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
15429cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
15439cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
15449cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1545fef5208cSdrh **
15469cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
15479cbe6352Sdrh ** operator or subquery.
154841a05b7bSdanielk1977 **
154941a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
155041a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
155141a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
155241a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
155341a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1554fd773cf9Sdrh **
1555fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1556fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1557fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1558fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1559fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1560fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1561fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1562fd773cf9Sdrh **
1563fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1564fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1565fd773cf9Sdrh ** registers to indicate the presense or absence of NULLs on the RHS.
15661450bc6eSdrh **
15671450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
15681450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1569cce7d176Sdrh */
157051522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
15711450bc6eSdrh int sqlite3CodeSubselect(
1572fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1573fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1574fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1575fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
157641a05b7bSdanielk1977 ){
157757dbd7b3Sdrh   int testAddr = 0;                       /* One-time test address */
15781450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1579b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
15801450bc6eSdrh   if( NEVER(v==0) ) return 0;
1581ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1582fc976065Sdanielk1977 
158357dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
158457dbd7b3Sdrh   ** if any of the following is true:
158557dbd7b3Sdrh   **
158657dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
158757dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
158857dbd7b3Sdrh   **    *  We are inside a trigger
158957dbd7b3Sdrh   **
159057dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
159157dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1592b3bce662Sdanielk1977   */
1593165921a7Sdan   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) && !pParse->pTriggerTab ){
15940a07c107Sdrh     int mem = ++pParse->nMem;
1595892d3179Sdrh     sqlite3VdbeAddOp1(v, OP_If, mem);
1596892d3179Sdrh     testAddr = sqlite3VdbeAddOp2(v, OP_Integer, 1, mem);
159717435752Sdrh     assert( testAddr>0 || pParse->db->mallocFailed );
1598b3bce662Sdanielk1977   }
1599b3bce662Sdanielk1977 
1600cce7d176Sdrh   switch( pExpr->op ){
1601fef5208cSdrh     case TK_IN: {
1602d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1603d4187c71Sdrh       KeyInfo keyInfo;            /* Keyinfo for the generated table */
1604b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1605d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1606d3d39e93Sdrh 
16070cdc022eSdanielk1977       if( rMayHaveNull ){
16080cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
16090cdc022eSdanielk1977       }
16100cdc022eSdanielk1977 
161141a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1612e014a838Sdanielk1977 
1613e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
16148cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1615e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1616e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1617fef5208cSdrh       **
1618e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1619e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1620e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1621e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1622e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1623e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1624e014a838Sdanielk1977       ** is used.
1625fef5208cSdrh       */
1626832508b7Sdrh       pExpr->iTable = pParse->nTab++;
162741a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1628d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1629d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1630d3d39e93Sdrh       keyInfo.nField = 1;
1631e014a838Sdanielk1977 
16326ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1633e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1634e014a838Sdanielk1977         **
1635e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1636e014a838Sdanielk1977         ** table allocated and opened above.
1637e014a838Sdanielk1977         */
16381013c932Sdrh         SelectDest dest;
1639be5c89acSdrh         ExprList *pEList;
16401013c932Sdrh 
164141a05b7bSdanielk1977         assert( !isRowid );
16421013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
16431bd10f8aSdrh         dest.affinity = (u8)affinity;
1644e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
16456ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
16461450bc6eSdrh           return 0;
164794ccde58Sdrh         }
16486ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1649fd773cf9Sdrh         if( ALWAYS(pEList!=0 && pEList->nExpr>0) ){
1650bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1651be5c89acSdrh               pEList->a[0].pExpr);
16520202b29eSdanielk1977         }
1653a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1654fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1655fef5208cSdrh         **
1656e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1657e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1658e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1659e014a838Sdanielk1977         ** a column, use numeric affinity.
1660fef5208cSdrh         */
1661e014a838Sdanielk1977         int i;
16626ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
166357dbd7b3Sdrh         struct ExprList_item *pItem;
1664ecc31805Sdrh         int r1, r2, r3;
166557dbd7b3Sdrh 
1666e014a838Sdanielk1977         if( !affinity ){
16678159a35fSdrh           affinity = SQLITE_AFF_NONE;
1668e014a838Sdanielk1977         }
16697d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1670e014a838Sdanielk1977 
1671e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
16722d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
16732d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
16744e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
167557dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
167657dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1677e05c929bSdrh           int iValToIns;
1678e014a838Sdanielk1977 
167957dbd7b3Sdrh           /* If the expression is not constant then we will need to
168057dbd7b3Sdrh           ** disable the test that was generated above that makes sure
168157dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
168257dbd7b3Sdrh           ** expression we need to rerun this code each time.
168357dbd7b3Sdrh           */
1684892d3179Sdrh           if( testAddr && !sqlite3ExprIsConstant(pE2) ){
1685892d3179Sdrh             sqlite3VdbeChangeToNoop(v, testAddr-1, 2);
168657dbd7b3Sdrh             testAddr = 0;
16874794b980Sdrh           }
1688e014a838Sdanielk1977 
1689e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1690e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1691e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1692e05c929bSdrh           }else{
1693ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
169441a05b7bSdanielk1977             if( isRowid ){
1695e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1696e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
169741a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
169841a05b7bSdanielk1977             }else{
1699ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
17003c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
17012d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1702fef5208cSdrh             }
170341a05b7bSdanielk1977           }
1704e05c929bSdrh         }
17052d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
17062d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1707fef5208cSdrh       }
170841a05b7bSdanielk1977       if( !isRowid ){
170966a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
171041a05b7bSdanielk1977       }
1711b3bce662Sdanielk1977       break;
1712fef5208cSdrh     }
1713fef5208cSdrh 
171451522cd3Sdrh     case TK_EXISTS:
1715fd773cf9Sdrh     case TK_SELECT:
1716fd773cf9Sdrh     default: {
1717fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1718fef5208cSdrh       ** value of this select in a memory cell and record the number
1719fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1720fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1721fd773cf9Sdrh       ** and record that memory cell in iColumn.
1722fef5208cSdrh       */
1723fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1724fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
17251398ad36Sdrh 
1726cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1727cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1728cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1729cf697396Sshane 
17306ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
17316ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
17321013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
173351522cd3Sdrh       if( pExpr->op==TK_SELECT ){
17346c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
17354c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iParm);
1736d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
173751522cd3Sdrh       }else{
17386c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
17394c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iParm);
1740d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
174151522cd3Sdrh       }
1742633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1743094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1744094430ebSdrh                                   &sqlite3IntTokens[1]);
17457d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
17461450bc6eSdrh         return 0;
174794ccde58Sdrh       }
17481450bc6eSdrh       rReg = dest.iParm;
174933e619fcSdrh       ExprSetIrreducible(pExpr);
1750b3bce662Sdanielk1977       break;
175119a775c2Sdrh     }
1752cce7d176Sdrh   }
1753b3bce662Sdanielk1977 
175457dbd7b3Sdrh   if( testAddr ){
1755892d3179Sdrh     sqlite3VdbeJumpHere(v, testAddr-1);
1756b3bce662Sdanielk1977   }
1757ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1758fc976065Sdanielk1977 
17591450bc6eSdrh   return rReg;
1760cce7d176Sdrh }
176151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1762cce7d176Sdrh 
1763e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1764e3365e6cSdrh /*
1765e3365e6cSdrh ** Generate code for an IN expression.
1766e3365e6cSdrh **
1767e3365e6cSdrh **      x IN (SELECT ...)
1768e3365e6cSdrh **      x IN (value, value, ...)
1769e3365e6cSdrh **
1770e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1771e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1772e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1773e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1774e3365e6cSdrh ** RHS contains one or more NULL values.
1775e3365e6cSdrh **
1776e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1777e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1778e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1779e3365e6cSdrh ** within the RHS then fall through.
1780e3365e6cSdrh */
1781e3365e6cSdrh static void sqlite3ExprCodeIN(
1782e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1783e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1784e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1785e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1786e3365e6cSdrh ){
1787e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1788e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1789e3365e6cSdrh   int eType;            /* Type of the RHS */
1790e3365e6cSdrh   int r1;               /* Temporary use register */
1791e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1792e3365e6cSdrh 
1793e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1794e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1795e3365e6cSdrh   */
1796e3365e6cSdrh   v = pParse->pVdbe;
1797e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1798e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1799e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1800e3365e6cSdrh 
1801e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1802e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1803e3365e6cSdrh   ** P4 of OP_MakeRecord.
1804e3365e6cSdrh   */
1805e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1806e3365e6cSdrh 
1807e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1808e3365e6cSdrh   */
1809e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1810e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1811e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1812e3365e6cSdrh 
1813094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1814094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1815094430ebSdrh   */
1816094430ebSdrh   if( destIfNull==destIfFalse ){
1817094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1818094430ebSdrh     ** the same. */
1819094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1820094430ebSdrh   }else{
1821094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1822094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1823094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1824094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1825094430ebSdrh   }
1826e3365e6cSdrh 
1827e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1828e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1829e3365e6cSdrh     */
1830e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1831e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1832e3365e6cSdrh   }else{
1833e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1834e3365e6cSdrh     */
18358cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1836e3365e6cSdrh 
1837e3365e6cSdrh     /* If the set membership test fails, then the result of the
1838e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1839e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1840e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1841e3365e6cSdrh     ** expression is also NULL.
1842e3365e6cSdrh     */
1843e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1844e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1845e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1846e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1847e3365e6cSdrh       **
1848e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1849e3365e6cSdrh       ** for this particular IN operator.
1850e3365e6cSdrh       */
18518cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1852e3365e6cSdrh 
1853e3365e6cSdrh     }else{
1854e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1855e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1856e3365e6cSdrh       ** outcome.
1857e3365e6cSdrh       */
1858e3365e6cSdrh       int j1, j2, j3;
1859e3365e6cSdrh 
1860e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1861e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1862e3365e6cSdrh       ** over all of the code that follows.
1863e3365e6cSdrh       */
18648cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
1865e3365e6cSdrh 
1866e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1867e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1868e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1869e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1870e3365e6cSdrh       ** jump to destIfFalse.
1871e3365e6cSdrh       */
1872e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
18738cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
1874e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1875e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1876e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1877e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1878e3365e6cSdrh 
1879e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1880e3365e6cSdrh       ** the RHS contains a NULL
1881e3365e6cSdrh       */
1882e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1883e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1884e3365e6cSdrh 
1885e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1886e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1887e3365e6cSdrh       */
1888e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1889e3365e6cSdrh     }
1890e3365e6cSdrh   }
1891e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
1892e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
1893e3365e6cSdrh   VdbeComment((v, "end IN expr"));
1894e3365e6cSdrh }
1895e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
1896e3365e6cSdrh 
1897cce7d176Sdrh /*
1898598f1340Sdrh ** Duplicate an 8-byte value
1899598f1340Sdrh */
1900598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1901598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1902598f1340Sdrh   if( out ){
1903598f1340Sdrh     memcpy(out, in, 8);
1904598f1340Sdrh   }
1905598f1340Sdrh   return out;
1906598f1340Sdrh }
1907598f1340Sdrh 
190813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
1909598f1340Sdrh /*
1910598f1340Sdrh ** Generate an instruction that will put the floating point
19119cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
19120cf19ed8Sdrh **
19130cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
19140cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
19150cf19ed8Sdrh ** like the continuation of the number.
1916598f1340Sdrh */
1917b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1918fd773cf9Sdrh   if( ALWAYS(z!=0) ){
1919598f1340Sdrh     double value;
1920598f1340Sdrh     char *zV;
1921598f1340Sdrh     sqlite3AtoF(z, &value);
1922d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
1923598f1340Sdrh     if( negateFlag ) value = -value;
1924598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
19259de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
1926598f1340Sdrh   }
1927598f1340Sdrh }
192813573c71Sdrh #endif
1929598f1340Sdrh 
1930598f1340Sdrh 
1931598f1340Sdrh /*
1932fec19aadSdrh ** Generate an instruction that will put the integer describe by
19339cbf3425Sdrh ** text z[0..n-1] into register iMem.
19340cf19ed8Sdrh **
19350cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
19360cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
19370cf19ed8Sdrh ** like the continuation of the number.
1938fec19aadSdrh */
193913573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
194013573c71Sdrh   Vdbe *v = pParse->pVdbe;
194192b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
194233e619fcSdrh     int i = pExpr->u.iValue;
194392b01d53Sdrh     if( negFlag ) i = -i;
194492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
1945fd773cf9Sdrh   }else{
1946fd773cf9Sdrh     const char *z = pExpr->u.zToken;
1947fd773cf9Sdrh     assert( z!=0 );
1948fd773cf9Sdrh     if( sqlite3FitsIn64Bits(z, negFlag) ){
1949598f1340Sdrh       i64 value;
1950598f1340Sdrh       char *zV;
1951598f1340Sdrh       sqlite3Atoi64(z, &value);
19529de221dfSdrh       if( negFlag ) value = -value;
1953598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
19549de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
1955fec19aadSdrh     }else{
195613573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
195713573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
195813573c71Sdrh #else
1959b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
196013573c71Sdrh #endif
1961fec19aadSdrh     }
1962fec19aadSdrh   }
1963c9cf901dSdanielk1977 }
1964fec19aadSdrh 
1965ceea3321Sdrh /*
1966ceea3321Sdrh ** Clear a cache entry.
1967ceea3321Sdrh */
1968ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
1969ceea3321Sdrh   if( p->tempReg ){
1970ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
1971ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
1972ceea3321Sdrh     }
1973ceea3321Sdrh     p->tempReg = 0;
1974ceea3321Sdrh   }
1975ceea3321Sdrh }
1976ceea3321Sdrh 
1977ceea3321Sdrh 
1978ceea3321Sdrh /*
1979ceea3321Sdrh ** Record in the column cache that a particular column from a
1980ceea3321Sdrh ** particular table is stored in a particular register.
1981ceea3321Sdrh */
1982ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
1983ceea3321Sdrh   int i;
1984ceea3321Sdrh   int minLru;
1985ceea3321Sdrh   int idxLru;
1986ceea3321Sdrh   struct yColCache *p;
1987ceea3321Sdrh 
198820411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
198920411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
199020411ea7Sdrh 
1991b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
1992b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
1993b6da74ebSdrh   ** with and without the column cache.
1994b6da74ebSdrh   */
1995b6da74ebSdrh   if( pParse->db->flags & SQLITE_ColumnCache ) return;
1996b6da74ebSdrh 
199727ee406eSdrh   /* First replace any existing entry.
199827ee406eSdrh   **
199927ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
200027ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
200127ee406eSdrh   */
200227ee406eSdrh #ifndef NDEBUG
2003ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
200427ee406eSdrh #if 0 /* This code wold remove the entry from the cache if it existed */
2005ceea3321Sdrh     if( p->iReg && p->iTable==iTab && p->iColumn==iCol ){
2006ceea3321Sdrh       cacheEntryClear(pParse, p);
2007ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2008ceea3321Sdrh       p->iReg = iReg;
2009ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2010ceea3321Sdrh       return;
2011ceea3321Sdrh     }
201227ee406eSdrh #endif
201327ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2014ceea3321Sdrh   }
201527ee406eSdrh #endif
2016ceea3321Sdrh 
2017ceea3321Sdrh   /* Find an empty slot and replace it */
2018ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2019ceea3321Sdrh     if( p->iReg==0 ){
2020ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2021ceea3321Sdrh       p->iTable = iTab;
2022ceea3321Sdrh       p->iColumn = iCol;
2023ceea3321Sdrh       p->iReg = iReg;
2024ceea3321Sdrh       p->tempReg = 0;
2025ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2026ceea3321Sdrh       return;
2027ceea3321Sdrh     }
2028ceea3321Sdrh   }
2029ceea3321Sdrh 
2030ceea3321Sdrh   /* Replace the last recently used */
2031ceea3321Sdrh   minLru = 0x7fffffff;
2032ceea3321Sdrh   idxLru = -1;
2033ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2034ceea3321Sdrh     if( p->lru<minLru ){
2035ceea3321Sdrh       idxLru = i;
2036ceea3321Sdrh       minLru = p->lru;
2037ceea3321Sdrh     }
2038ceea3321Sdrh   }
203920411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2040ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2041ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2042ceea3321Sdrh     p->iTable = iTab;
2043ceea3321Sdrh     p->iColumn = iCol;
2044ceea3321Sdrh     p->iReg = iReg;
2045ceea3321Sdrh     p->tempReg = 0;
2046ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2047ceea3321Sdrh     return;
2048ceea3321Sdrh   }
2049ceea3321Sdrh }
2050ceea3321Sdrh 
2051ceea3321Sdrh /*
2052f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2053f49f3523Sdrh ** Purge the range of registers from the column cache.
2054ceea3321Sdrh */
2055f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2056ceea3321Sdrh   int i;
2057f49f3523Sdrh   int iLast = iReg + nReg - 1;
2058ceea3321Sdrh   struct yColCache *p;
2059ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2060f49f3523Sdrh     int r = p->iReg;
2061f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2062ceea3321Sdrh       cacheEntryClear(pParse, p);
2063ceea3321Sdrh       p->iReg = 0;
2064ceea3321Sdrh     }
2065ceea3321Sdrh   }
2066ceea3321Sdrh }
2067ceea3321Sdrh 
2068ceea3321Sdrh /*
2069ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2070ceea3321Sdrh ** added to the column cache after this call are removed when the
2071ceea3321Sdrh ** corresponding pop occurs.
2072ceea3321Sdrh */
2073ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2074ceea3321Sdrh   pParse->iCacheLevel++;
2075ceea3321Sdrh }
2076ceea3321Sdrh 
2077ceea3321Sdrh /*
2078ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2079ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2080ceea3321Sdrh ** to the state it was in N Pushes ago.
2081ceea3321Sdrh */
2082ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2083ceea3321Sdrh   int i;
2084ceea3321Sdrh   struct yColCache *p;
2085ceea3321Sdrh   assert( N>0 );
2086ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2087ceea3321Sdrh   pParse->iCacheLevel -= N;
2088ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2089ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2090ceea3321Sdrh       cacheEntryClear(pParse, p);
2091ceea3321Sdrh       p->iReg = 0;
2092ceea3321Sdrh     }
2093ceea3321Sdrh   }
2094ceea3321Sdrh }
2095945498f3Sdrh 
2096945498f3Sdrh /*
20975cd79239Sdrh ** When a cached column is reused, make sure that its register is
20985cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
20995cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
21005cd79239Sdrh ** get them all.
21015cd79239Sdrh */
21025cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
21035cd79239Sdrh   int i;
21045cd79239Sdrh   struct yColCache *p;
21055cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
21065cd79239Sdrh     if( p->iReg==iReg ){
21075cd79239Sdrh       p->tempReg = 0;
21085cd79239Sdrh     }
21095cd79239Sdrh   }
21105cd79239Sdrh }
21115cd79239Sdrh 
21125cd79239Sdrh /*
21135c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
21145c092e8aSdrh */
21155c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
21165c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
21175c092e8aSdrh   Table *pTab,    /* The table containing the value */
21185c092e8aSdrh   int iTabCur,    /* The cursor for this table */
21195c092e8aSdrh   int iCol,       /* Index of the column to extract */
21205c092e8aSdrh   int regOut      /* Extract the valud into this register */
21215c092e8aSdrh ){
21225c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
21235c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
21245c092e8aSdrh   }else{
21255c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
21265c092e8aSdrh     sqlite3VdbeAddOp3(v, op, iTabCur, iCol, regOut);
21275c092e8aSdrh   }
21285c092e8aSdrh   if( iCol>=0 ){
21295c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
21305c092e8aSdrh   }
21315c092e8aSdrh }
21325c092e8aSdrh 
21335c092e8aSdrh /*
2134945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2135e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2136e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2137e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2138e55cbd72Sdrh **
2139e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2140e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2141945498f3Sdrh */
2142e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2143e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
21442133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
21452133d822Sdrh   int iColumn,     /* Index of the table column */
21462133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2147b6da74ebSdrh   int iReg         /* Store results here */
21482133d822Sdrh ){
2149e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2150e55cbd72Sdrh   int i;
2151da250ea5Sdrh   struct yColCache *p;
2152e55cbd72Sdrh 
2153ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2154b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2155ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
21565cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2157da250ea5Sdrh       return p->iReg;
2158e55cbd72Sdrh     }
2159e55cbd72Sdrh   }
2160e55cbd72Sdrh   assert( v!=0 );
21615c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2162ceea3321Sdrh   sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2163e55cbd72Sdrh   return iReg;
2164e55cbd72Sdrh }
2165e55cbd72Sdrh 
2166e55cbd72Sdrh /*
2167ceea3321Sdrh ** Clear all column cache entries.
2168e55cbd72Sdrh */
2169ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2170e55cbd72Sdrh   int i;
2171ceea3321Sdrh   struct yColCache *p;
2172ceea3321Sdrh 
2173ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2174ceea3321Sdrh     if( p->iReg ){
2175ceea3321Sdrh       cacheEntryClear(pParse, p);
2176ceea3321Sdrh       p->iReg = 0;
2177e55cbd72Sdrh     }
2178da250ea5Sdrh   }
2179da250ea5Sdrh }
2180e55cbd72Sdrh 
2181e55cbd72Sdrh /*
2182da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2183da250ea5Sdrh ** registers starting with iStart.
2184e55cbd72Sdrh */
2185da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2186f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2187e55cbd72Sdrh }
2188e55cbd72Sdrh 
2189e55cbd72Sdrh /*
2190b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2191b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2192e55cbd72Sdrh */
2193b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2194e55cbd72Sdrh   int i;
2195ceea3321Sdrh   struct yColCache *p;
219620411ea7Sdrh   if( NEVER(iFrom==iTo) ) return;
2197b21e7c70Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
2198ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2199ceea3321Sdrh     int x = p->iReg;
2200b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2201ceea3321Sdrh       p->iReg += iTo-iFrom;
2202e55cbd72Sdrh     }
2203e55cbd72Sdrh   }
2204945498f3Sdrh }
2205945498f3Sdrh 
2206fec19aadSdrh /*
220792b01d53Sdrh ** Generate code to copy content from registers iFrom...iFrom+nReg-1
220892b01d53Sdrh ** over to iTo..iTo+nReg-1.
220992b01d53Sdrh */
221092b01d53Sdrh void sqlite3ExprCodeCopy(Parse *pParse, int iFrom, int iTo, int nReg){
221192b01d53Sdrh   int i;
221220411ea7Sdrh   if( NEVER(iFrom==iTo) ) return;
221392b01d53Sdrh   for(i=0; i<nReg; i++){
221492b01d53Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, iFrom+i, iTo+i);
221592b01d53Sdrh   }
221692b01d53Sdrh }
221792b01d53Sdrh 
2218f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
221992b01d53Sdrh /*
2220652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2221652fbf55Sdrh ** is used as part of the column cache.
2222f49f3523Sdrh **
2223f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2224f49f3523Sdrh ** and does not appear in a normal build.
2225652fbf55Sdrh */
2226652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2227652fbf55Sdrh   int i;
2228ceea3321Sdrh   struct yColCache *p;
2229ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2230ceea3321Sdrh     int r = p->iReg;
2231f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2232652fbf55Sdrh   }
2233652fbf55Sdrh   return 0;
2234652fbf55Sdrh }
2235f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2236652fbf55Sdrh 
2237652fbf55Sdrh /*
2238cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
22392dcef11bSdrh ** expression.  Attempt to store the results in register "target".
22402dcef11bSdrh ** Return the register where results are stored.
2241389a1adbSdrh **
22428b213899Sdrh ** With this routine, there is no guarantee that results will
22432dcef11bSdrh ** be stored in target.  The result might be stored in some other
22442dcef11bSdrh ** register if it is convenient to do so.  The calling function
22452dcef11bSdrh ** must check the return code and move the results to the desired
22462dcef11bSdrh ** register.
2247cce7d176Sdrh */
2248678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
22492dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
22502dcef11bSdrh   int op;                   /* The opcode being coded */
22512dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
22522dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
22532dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2254678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
225520411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2256ffe07b2dSdrh 
22579cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
225820411ea7Sdrh   if( v==0 ){
225920411ea7Sdrh     assert( pParse->db->mallocFailed );
226020411ea7Sdrh     return 0;
226120411ea7Sdrh   }
2262389a1adbSdrh 
2263389a1adbSdrh   if( pExpr==0 ){
2264389a1adbSdrh     op = TK_NULL;
2265389a1adbSdrh   }else{
2266f2bc013cSdrh     op = pExpr->op;
2267389a1adbSdrh   }
2268f2bc013cSdrh   switch( op ){
226913449892Sdrh     case TK_AGG_COLUMN: {
227013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
227113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
227213449892Sdrh       if( !pAggInfo->directMode ){
22739de221dfSdrh         assert( pCol->iMem>0 );
22749de221dfSdrh         inReg = pCol->iMem;
227513449892Sdrh         break;
227613449892Sdrh       }else if( pAggInfo->useSortingIdx ){
2277389a1adbSdrh         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdx,
2278389a1adbSdrh                               pCol->iSorterColumn, target);
227913449892Sdrh         break;
228013449892Sdrh       }
228113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
228213449892Sdrh     }
2283967e8b73Sdrh     case TK_COLUMN: {
2284ffe07b2dSdrh       if( pExpr->iTable<0 ){
2285ffe07b2dSdrh         /* This only happens when coding check constraints */
2286aa9b8963Sdrh         assert( pParse->ckBase>0 );
2287aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2288c4a3c779Sdrh       }else{
2289e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2290b6da74ebSdrh                                  pExpr->iColumn, pExpr->iTable, target);
22912282792aSdrh       }
2292cce7d176Sdrh       break;
2293cce7d176Sdrh     }
2294cce7d176Sdrh     case TK_INTEGER: {
229513573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2296fec19aadSdrh       break;
229751e9a445Sdrh     }
229813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2299598f1340Sdrh     case TK_FLOAT: {
230033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
230133e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2302598f1340Sdrh       break;
2303598f1340Sdrh     }
230413573c71Sdrh #endif
2305fec19aadSdrh     case TK_STRING: {
230633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
230733e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2308cce7d176Sdrh       break;
2309cce7d176Sdrh     }
2310f0863fe5Sdrh     case TK_NULL: {
23119de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2312f0863fe5Sdrh       break;
2313f0863fe5Sdrh     }
23145338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2315c572ef7fSdanielk1977     case TK_BLOB: {
23166c8c6cecSdrh       int n;
23176c8c6cecSdrh       const char *z;
2318ca48c90fSdrh       char *zBlob;
231933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
232033e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
232133e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
232233e619fcSdrh       z = &pExpr->u.zToken[2];
2323b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2324b7916a78Sdrh       assert( z[n]=='\'' );
2325ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2326ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2327c572ef7fSdanielk1977       break;
2328c572ef7fSdanielk1977     }
23295338a5f7Sdanielk1977 #endif
233050457896Sdrh     case TK_VARIABLE: {
233133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
233233e619fcSdrh       assert( pExpr->u.zToken!=0 );
233333e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2334eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
233533e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
233633e619fcSdrh         sqlite3VdbeChangeP4(v, -1, pExpr->u.zToken, 0);
2337895d7472Sdrh       }
233850457896Sdrh       break;
233950457896Sdrh     }
23404e0cff60Sdrh     case TK_REGISTER: {
23419de221dfSdrh       inReg = pExpr->iTable;
23424e0cff60Sdrh       break;
23434e0cff60Sdrh     }
23448b213899Sdrh     case TK_AS: {
23457445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
23468b213899Sdrh       break;
23478b213899Sdrh     }
2348487e262fSdrh #ifndef SQLITE_OMIT_CAST
2349487e262fSdrh     case TK_CAST: {
2350487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2351f0113000Sdanielk1977       int aff, to_op;
23522dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
235333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
235433e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2355f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2356f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2357f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2358f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2359f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2360f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2361c5499befSdrh       testcase( to_op==OP_ToText );
2362c5499befSdrh       testcase( to_op==OP_ToBlob );
2363c5499befSdrh       testcase( to_op==OP_ToNumeric );
2364c5499befSdrh       testcase( to_op==OP_ToInt );
2365c5499befSdrh       testcase( to_op==OP_ToReal );
23661735fa88Sdrh       if( inReg!=target ){
23671735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
23681735fa88Sdrh         inReg = target;
23691735fa88Sdrh       }
23702dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2371c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2372b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2373487e262fSdrh       break;
2374487e262fSdrh     }
2375487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2376c9b84a1fSdrh     case TK_LT:
2377c9b84a1fSdrh     case TK_LE:
2378c9b84a1fSdrh     case TK_GT:
2379c9b84a1fSdrh     case TK_GE:
2380c9b84a1fSdrh     case TK_NE:
2381c9b84a1fSdrh     case TK_EQ: {
2382f2bc013cSdrh       assert( TK_LT==OP_Lt );
2383f2bc013cSdrh       assert( TK_LE==OP_Le );
2384f2bc013cSdrh       assert( TK_GT==OP_Gt );
2385f2bc013cSdrh       assert( TK_GE==OP_Ge );
2386f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2387f2bc013cSdrh       assert( TK_NE==OP_Ne );
2388c5499befSdrh       testcase( op==TK_LT );
2389c5499befSdrh       testcase( op==TK_LE );
2390c5499befSdrh       testcase( op==TK_GT );
2391c5499befSdrh       testcase( op==TK_GE );
2392c5499befSdrh       testcase( op==TK_EQ );
2393c5499befSdrh       testcase( op==TK_NE );
2394b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2395b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
239635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
239735573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2398c5499befSdrh       testcase( regFree1==0 );
2399c5499befSdrh       testcase( regFree2==0 );
2400a37cdde0Sdanielk1977       break;
2401c9b84a1fSdrh     }
24026a2fe093Sdrh     case TK_IS:
24036a2fe093Sdrh     case TK_ISNOT: {
24046a2fe093Sdrh       testcase( op==TK_IS );
24056a2fe093Sdrh       testcase( op==TK_ISNOT );
2406b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2407b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24086a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
24096a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
24106a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
24116a2fe093Sdrh       testcase( regFree1==0 );
24126a2fe093Sdrh       testcase( regFree2==0 );
24136a2fe093Sdrh       break;
24146a2fe093Sdrh     }
2415cce7d176Sdrh     case TK_AND:
2416cce7d176Sdrh     case TK_OR:
2417cce7d176Sdrh     case TK_PLUS:
2418cce7d176Sdrh     case TK_STAR:
2419cce7d176Sdrh     case TK_MINUS:
2420bf4133cbSdrh     case TK_REM:
2421bf4133cbSdrh     case TK_BITAND:
2422bf4133cbSdrh     case TK_BITOR:
242317c40294Sdrh     case TK_SLASH:
2424bf4133cbSdrh     case TK_LSHIFT:
2425855eb1cfSdrh     case TK_RSHIFT:
24260040077dSdrh     case TK_CONCAT: {
2427f2bc013cSdrh       assert( TK_AND==OP_And );
2428f2bc013cSdrh       assert( TK_OR==OP_Or );
2429f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2430f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2431f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2432f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2433f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2434f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2435f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2436f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2437f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2438c5499befSdrh       testcase( op==TK_AND );
2439c5499befSdrh       testcase( op==TK_OR );
2440c5499befSdrh       testcase( op==TK_PLUS );
2441c5499befSdrh       testcase( op==TK_MINUS );
2442c5499befSdrh       testcase( op==TK_REM );
2443c5499befSdrh       testcase( op==TK_BITAND );
2444c5499befSdrh       testcase( op==TK_BITOR );
2445c5499befSdrh       testcase( op==TK_SLASH );
2446c5499befSdrh       testcase( op==TK_LSHIFT );
2447c5499befSdrh       testcase( op==TK_RSHIFT );
2448c5499befSdrh       testcase( op==TK_CONCAT );
24492dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
24502dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24515b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2452c5499befSdrh       testcase( regFree1==0 );
2453c5499befSdrh       testcase( regFree2==0 );
24540040077dSdrh       break;
24550040077dSdrh     }
2456cce7d176Sdrh     case TK_UMINUS: {
2457fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2458fec19aadSdrh       assert( pLeft );
245913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
246013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
246113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
246213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
246333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
246433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
246513573c71Sdrh #endif
24663c84ddffSdrh       }else{
24672dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
24683c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2469e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
24702dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2471c5499befSdrh         testcase( regFree2==0 );
24723c84ddffSdrh       }
24739de221dfSdrh       inReg = target;
24746e142f54Sdrh       break;
24756e142f54Sdrh     }
2476bf4133cbSdrh     case TK_BITNOT:
24776e142f54Sdrh     case TK_NOT: {
2478f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2479f2bc013cSdrh       assert( TK_NOT==OP_Not );
2480c5499befSdrh       testcase( op==TK_BITNOT );
2481c5499befSdrh       testcase( op==TK_NOT );
2482e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2483e99fa2afSdrh       testcase( regFree1==0 );
2484e99fa2afSdrh       inReg = target;
2485e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2486cce7d176Sdrh       break;
2487cce7d176Sdrh     }
2488cce7d176Sdrh     case TK_ISNULL:
2489cce7d176Sdrh     case TK_NOTNULL: {
24906a288a33Sdrh       int addr;
2491f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2492f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2493c5499befSdrh       testcase( op==TK_ISNULL );
2494c5499befSdrh       testcase( op==TK_NOTNULL );
24959de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
24962dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2497c5499befSdrh       testcase( regFree1==0 );
24982dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
24999de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
25006a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2501a37cdde0Sdanielk1977       break;
2502f2bc013cSdrh     }
25032282792aSdrh     case TK_AGG_FUNCTION: {
250413449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
25057e56e711Sdrh       if( pInfo==0 ){
250633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
250733e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
25087e56e711Sdrh       }else{
25099de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
25107e56e711Sdrh       }
25112282792aSdrh       break;
25122282792aSdrh     }
2513b71090fdSdrh     case TK_CONST_FUNC:
2514cce7d176Sdrh     case TK_FUNCTION: {
251512ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
251612ffee8cSdrh       int nFarg;             /* Number of function arguments */
251712ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
251812ffee8cSdrh       int nId;               /* Length of the function name in bytes */
251912ffee8cSdrh       const char *zId;       /* The function name */
252012ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
252112ffee8cSdrh       int i;                 /* Loop counter */
252212ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
252312ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
252417435752Sdrh 
25256ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2526c5499befSdrh       testcase( op==TK_CONST_FUNC );
2527c5499befSdrh       testcase( op==TK_FUNCTION );
2528b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
252912ffee8cSdrh         pFarg = 0;
253012ffee8cSdrh       }else{
253112ffee8cSdrh         pFarg = pExpr->x.pList;
253212ffee8cSdrh       }
253312ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
253433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
253533e619fcSdrh       zId = pExpr->u.zToken;
2536b7916a78Sdrh       nId = sqlite3Strlen30(zId);
253712ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2538feb306f5Sdrh       if( pDef==0 ){
2539feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2540feb306f5Sdrh         break;
2541feb306f5Sdrh       }
2542ae6bb957Sdrh 
2543ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2544ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2545ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2546ae6bb957Sdrh       */
2547ae6bb957Sdrh       if( pDef->flags & SQLITE_FUNC_COALESCE ){
2548ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2549ae6bb957Sdrh         assert( nFarg>=2 );
2550ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2551ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2552ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2553f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2554ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2555ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2556ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2557ae6bb957Sdrh         }
2558ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2559ae6bb957Sdrh         break;
2560ae6bb957Sdrh       }
2561ae6bb957Sdrh 
2562ae6bb957Sdrh 
256312ffee8cSdrh       if( pFarg ){
256412ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2565d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
256612ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2567d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2568892d3179Sdrh       }else{
256912ffee8cSdrh         r1 = 0;
2570892d3179Sdrh       }
2571b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2572a43fa227Sdrh       /* Possibly overload the function if the first argument is
2573a43fa227Sdrh       ** a virtual table column.
2574a43fa227Sdrh       **
2575a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2576a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2577a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2578a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2579a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2580a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2581a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2582a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2583a43fa227Sdrh       */
258412ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
258512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
258612ffee8cSdrh       }else if( nFarg>0 ){
258712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2588b7f6f68fSdrh       }
2589b7f6f68fSdrh #endif
2590f7bca574Sdrh       for(i=0; i<nFarg; i++){
2591f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
259213449892Sdrh           constMask |= (1<<i);
2593d02eb1fdSdanielk1977         }
2594e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
259512ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2596dc1bdc4fSdanielk1977         }
2597dc1bdc4fSdanielk1977       }
2598e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
25998b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
260066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2601682f68b0Sdanielk1977       }
26022dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
260366a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
260412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
260512ffee8cSdrh       if( nFarg ){
260612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
26072dcef11bSdrh       }
26086ec2733bSdrh       break;
26096ec2733bSdrh     }
2610fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2611fe2093d7Sdrh     case TK_EXISTS:
261219a775c2Sdrh     case TK_SELECT: {
2613c5499befSdrh       testcase( op==TK_EXISTS );
2614c5499befSdrh       testcase( op==TK_SELECT );
26151450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
261619a775c2Sdrh       break;
261719a775c2Sdrh     }
2618fef5208cSdrh     case TK_IN: {
2619e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2620e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2621e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2622e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
262366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2624e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2625e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2626e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2627fef5208cSdrh       break;
2628fef5208cSdrh     }
2629e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2630e3365e6cSdrh 
2631e3365e6cSdrh 
26322dcef11bSdrh     /*
26332dcef11bSdrh     **    x BETWEEN y AND z
26342dcef11bSdrh     **
26352dcef11bSdrh     ** This is equivalent to
26362dcef11bSdrh     **
26372dcef11bSdrh     **    x>=y AND x<=z
26382dcef11bSdrh     **
26392dcef11bSdrh     ** X is stored in pExpr->pLeft.
26402dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
26412dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
26422dcef11bSdrh     */
2643fef5208cSdrh     case TK_BETWEEN: {
2644be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
26456ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2646be5c89acSdrh       Expr *pRight = pLItem->pExpr;
264735573356Sdrh 
2648b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2649b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2650c5499befSdrh       testcase( regFree1==0 );
2651c5499befSdrh       testcase( regFree2==0 );
26522dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2653678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
265435573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
265535573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2656be5c89acSdrh       pLItem++;
2657be5c89acSdrh       pRight = pLItem->pExpr;
26582dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
26592dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2660c5499befSdrh       testcase( regFree2==0 );
2661678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2662678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
26632dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2664678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2665fef5208cSdrh       break;
2666fef5208cSdrh     }
26674f07e5fbSdrh     case TK_UPLUS: {
26682dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2669a2e00042Sdrh       break;
2670a2e00042Sdrh     }
26712dcef11bSdrh 
2672165921a7Sdan     case TK_TRIGGER: {
267365a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
267465a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
267565a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
267665a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
267765a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
267865a7cd16Sdan       ** read the rowid field.
267965a7cd16Sdan       **
268065a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
268165a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
268265a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
268365a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
268465a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
268565a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
268665a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
268765a7cd16Sdan       ** example, if the table on which triggers are being fired is
268865a7cd16Sdan       ** declared as:
268965a7cd16Sdan       **
269065a7cd16Sdan       **   CREATE TABLE t1(a, b);
269165a7cd16Sdan       **
269265a7cd16Sdan       ** Then p1 is interpreted as follows:
269365a7cd16Sdan       **
269465a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
269565a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
269665a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
269765a7cd16Sdan       */
26982832ad42Sdan       Table *pTab = pExpr->pTab;
269965a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
270065a7cd16Sdan 
270165a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
270265a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
270365a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
270465a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
270565a7cd16Sdan 
270665a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
270776d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2708165921a7Sdan         (pExpr->iTable ? "new" : "old"),
270976d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
271076d462eeSdan         target
2711165921a7Sdan       ));
271265a7cd16Sdan 
271344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
271465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
271565a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
27162832ad42Sdan       if( pExpr->iColumn>=0
27172832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
27182832ad42Sdan       ){
27192832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
27202832ad42Sdan       }
272144dbca83Sdrh #endif
2722165921a7Sdan       break;
2723165921a7Sdan     }
2724165921a7Sdan 
2725165921a7Sdan 
27262dcef11bSdrh     /*
27272dcef11bSdrh     ** Form A:
27282dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
27292dcef11bSdrh     **
27302dcef11bSdrh     ** Form B:
27312dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
27322dcef11bSdrh     **
27332dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
27342dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
27352dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
27362dcef11bSdrh     **
27372dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
27382dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
27392dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
27402dcef11bSdrh     ** exprssion is NULL.
27412dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
27422dcef11bSdrh     **
27432dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
27442dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
27452dcef11bSdrh     ** no ELSE term, NULL.
27462dcef11bSdrh     */
274733cd4909Sdrh     default: assert( op==TK_CASE ); {
27482dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
27492dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
27502dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
27512dcef11bSdrh       int i;                            /* Loop counter */
27522dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
27532dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
27542dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
27552dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
27562dcef11bSdrh       Expr *pX;                         /* The X expression */
27571bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2758ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
275917a7f8ddSdrh 
27606ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
27616ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
27626ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
27636ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2764be5c89acSdrh       aListelem = pEList->a;
2765be5c89acSdrh       nExpr = pEList->nExpr;
27662dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
27672dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
27682dcef11bSdrh         cacheX = *pX;
276933cd4909Sdrh         testcase( pX->op==TK_COLUMN );
277033cd4909Sdrh         testcase( pX->op==TK_REGISTER );
27712dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2772c5499befSdrh         testcase( regFree1==0 );
27732dcef11bSdrh         cacheX.op = TK_REGISTER;
27742dcef11bSdrh         opCompare.op = TK_EQ;
27752dcef11bSdrh         opCompare.pLeft = &cacheX;
27762dcef11bSdrh         pTest = &opCompare;
2777*8b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
2778*8b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
2779*8b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
2780*8b1db07fSdrh         ** purposes and possibly overwritten.  */
2781*8b1db07fSdrh         regFree1 = 0;
2782cce7d176Sdrh       }
2783f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2784ceea3321Sdrh         sqlite3ExprCachePush(pParse);
27852dcef11bSdrh         if( pX ){
27861bd10f8aSdrh           assert( pTest!=0 );
27872dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2788f5905aa7Sdrh         }else{
27892dcef11bSdrh           pTest = aListelem[i].pExpr;
279017a7f8ddSdrh         }
27912dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
279233cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
27932dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2794c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2795c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
27969de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
27972dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2798ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
27992dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2800f570f011Sdrh       }
280117a7f8ddSdrh       if( pExpr->pRight ){
2802ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28039de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2804ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
280517a7f8ddSdrh       }else{
28069de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
280717a7f8ddSdrh       }
2808c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2809c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
28102dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
28116f34903eSdanielk1977       break;
28126f34903eSdanielk1977     }
28135338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
28146f34903eSdanielk1977     case TK_RAISE: {
2815165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2816165921a7Sdan            || pExpr->affinity==OE_Abort
2817165921a7Sdan            || pExpr->affinity==OE_Fail
2818165921a7Sdan            || pExpr->affinity==OE_Ignore
2819165921a7Sdan       );
2820e0af83acSdan       if( !pParse->pTriggerTab ){
2821e0af83acSdan         sqlite3ErrorMsg(pParse,
2822e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2823e0af83acSdan         return 0;
2824e0af83acSdan       }
2825e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2826e0af83acSdan         sqlite3MayAbort(pParse);
2827e0af83acSdan       }
282833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2829e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2830e0af83acSdan         sqlite3VdbeAddOp4(
2831e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2832e0af83acSdan       }else{
2833e0af83acSdan         sqlite3HaltConstraint(pParse, pExpr->affinity, pExpr->u.zToken, 0);
2834e0af83acSdan       }
2835e0af83acSdan 
2836ffe07b2dSdrh       break;
283717a7f8ddSdrh     }
28385338a5f7Sdanielk1977 #endif
2839ffe07b2dSdrh   }
28402dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
28412dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
28422dcef11bSdrh   return inReg;
28435b6afba9Sdrh }
28442dcef11bSdrh 
28452dcef11bSdrh /*
28462dcef11bSdrh ** Generate code to evaluate an expression and store the results
28472dcef11bSdrh ** into a register.  Return the register number where the results
28482dcef11bSdrh ** are stored.
28492dcef11bSdrh **
28502dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2851678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
28522dcef11bSdrh ** a temporary, then set *pReg to zero.
28532dcef11bSdrh */
28542dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
28552dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
28562dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
28572dcef11bSdrh   if( r2==r1 ){
28582dcef11bSdrh     *pReg = r1;
28592dcef11bSdrh   }else{
28602dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
28612dcef11bSdrh     *pReg = 0;
28622dcef11bSdrh   }
28632dcef11bSdrh   return r2;
28642dcef11bSdrh }
28652dcef11bSdrh 
28662dcef11bSdrh /*
28672dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
28682dcef11bSdrh ** results in register target.  The results are guaranteed to appear
28692dcef11bSdrh ** in register target.
28702dcef11bSdrh */
28712dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
28729cbf3425Sdrh   int inReg;
28739cbf3425Sdrh 
28749cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
2875ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
2876ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
2877ebc16717Sdrh   }else{
28789cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
28790e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
28800e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
28819cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
288217a7f8ddSdrh     }
2883ebc16717Sdrh   }
2884389a1adbSdrh   return target;
2885cce7d176Sdrh }
2886cce7d176Sdrh 
2887cce7d176Sdrh /*
28882dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2889de4fcfddSdrh ** in register target.
289025303780Sdrh **
28912dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
28922dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
28932dcef11bSdrh ** the result is a copy of the cache register.
28942dcef11bSdrh **
28952dcef11bSdrh ** This routine is used for expressions that are used multiple
28962dcef11bSdrh ** times.  They are evaluated once and the results of the expression
28972dcef11bSdrh ** are reused.
289825303780Sdrh */
28992dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
290025303780Sdrh   Vdbe *v = pParse->pVdbe;
29012dcef11bSdrh   int inReg;
29022dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2903de4fcfddSdrh   assert( target>0 );
290420bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
290520bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
290620bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
290720bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
290820bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
290920bc393cSdrh   ** modifications or enhancements. */
291020bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
291125303780Sdrh     int iMem;
29122dcef11bSdrh     iMem = ++pParse->nMem;
29132dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
29142dcef11bSdrh     pExpr->iTable = iMem;
2915937d0deaSdan     pExpr->op2 = pExpr->op;
291625303780Sdrh     pExpr->op = TK_REGISTER;
291725303780Sdrh   }
29182dcef11bSdrh   return inReg;
291925303780Sdrh }
29202dcef11bSdrh 
2921678ccce8Sdrh /*
292247de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
292347de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
292447de955eSdrh **
292547de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
292647de955eSdrh **
292747de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
292847de955eSdrh **       or OP_Variable that does not need to be placed in a
292947de955eSdrh **       specific register.
293047de955eSdrh **
293147de955eSdrh ** There is no point in factoring out single-instruction constant
293247de955eSdrh ** expressions that need to be placed in a particular register.
293347de955eSdrh ** We could factor them out, but then we would end up adding an
293447de955eSdrh ** OP_SCopy instruction to move the value into the correct register
293547de955eSdrh ** later.  We might as well just use the original instruction and
293647de955eSdrh ** avoid the OP_SCopy.
293747de955eSdrh */
293847de955eSdrh static int isAppropriateForFactoring(Expr *p){
293947de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
294047de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
294147de955eSdrh   }
294247de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
294347de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
294447de955eSdrh   }
294547de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
294647de955eSdrh   switch( p->op ){
294747de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
294847de955eSdrh     case TK_BLOB:
294947de955eSdrh #endif
295047de955eSdrh     case TK_VARIABLE:
295147de955eSdrh     case TK_INTEGER:
295247de955eSdrh     case TK_FLOAT:
295347de955eSdrh     case TK_NULL:
295447de955eSdrh     case TK_STRING: {
295547de955eSdrh       testcase( p->op==TK_BLOB );
295647de955eSdrh       testcase( p->op==TK_VARIABLE );
295747de955eSdrh       testcase( p->op==TK_INTEGER );
295847de955eSdrh       testcase( p->op==TK_FLOAT );
295947de955eSdrh       testcase( p->op==TK_NULL );
296047de955eSdrh       testcase( p->op==TK_STRING );
296147de955eSdrh       /* Single-instruction constants with a fixed destination are
296247de955eSdrh       ** better done in-line.  If we factor them, they will just end
296347de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
296447de955eSdrh       ** register. */
296547de955eSdrh       return 0;
296647de955eSdrh     }
296747de955eSdrh     case TK_UMINUS: {
296847de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
296947de955eSdrh         return 0;
297047de955eSdrh       }
297147de955eSdrh       break;
297247de955eSdrh     }
297347de955eSdrh     default: {
297447de955eSdrh       break;
297547de955eSdrh     }
297647de955eSdrh   }
297747de955eSdrh   return 1;
297847de955eSdrh }
297947de955eSdrh 
298047de955eSdrh /*
298147de955eSdrh ** If pExpr is a constant expression that is appropriate for
298247de955eSdrh ** factoring out of a loop, then evaluate the expression
2983678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
2984678ccce8Sdrh ** expression.
2985678ccce8Sdrh */
29867d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
29877d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
298847de955eSdrh   switch( pExpr->op ){
2989e05c929bSdrh     case TK_IN:
299047de955eSdrh     case TK_REGISTER: {
299133cd4909Sdrh       return WRC_Prune;
2992678ccce8Sdrh     }
299347de955eSdrh     case TK_FUNCTION:
299447de955eSdrh     case TK_AGG_FUNCTION:
299547de955eSdrh     case TK_CONST_FUNC: {
299647de955eSdrh       /* The arguments to a function have a fixed destination.
299747de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
299847de955eSdrh       ** instructions.
299947de955eSdrh       */
30006ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
30016ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
300247de955eSdrh       if( pList ){
300347de955eSdrh         int i = pList->nExpr;
300447de955eSdrh         struct ExprList_item *pItem = pList->a;
300547de955eSdrh         for(; i>0; i--, pItem++){
300633cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
300747de955eSdrh         }
300847de955eSdrh       }
300947de955eSdrh       break;
301047de955eSdrh     }
301147de955eSdrh   }
301247de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
3013678ccce8Sdrh     int r1 = ++pParse->nMem;
3014678ccce8Sdrh     int r2;
3015678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
301633cd4909Sdrh     if( NEVER(r1!=r2) ) sqlite3ReleaseTempReg(pParse, r1);
3017fcd4a150Sdan     pExpr->op2 = pExpr->op;
3018678ccce8Sdrh     pExpr->op = TK_REGISTER;
3019678ccce8Sdrh     pExpr->iTable = r2;
30207d10d5a6Sdrh     return WRC_Prune;
3021678ccce8Sdrh   }
30227d10d5a6Sdrh   return WRC_Continue;
3023678ccce8Sdrh }
3024678ccce8Sdrh 
3025678ccce8Sdrh /*
3026678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3027678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3028678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3029678ccce8Sdrh */
3030678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
30317d10d5a6Sdrh   Walker w;
30327d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
30337d10d5a6Sdrh   w.xSelectCallback = 0;
30347d10d5a6Sdrh   w.pParse = pParse;
30357d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3036678ccce8Sdrh }
3037678ccce8Sdrh 
303825303780Sdrh 
303925303780Sdrh /*
3040268380caSdrh ** Generate code that pushes the value of every element of the given
30419cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3042268380caSdrh **
3043892d3179Sdrh ** Return the number of elements evaluated.
3044268380caSdrh */
30454adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3046268380caSdrh   Parse *pParse,     /* Parsing context */
3047389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3048191b54cbSdrh   int target,        /* Where to write results */
3049d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3050268380caSdrh ){
3051268380caSdrh   struct ExprList_item *pItem;
30529cbf3425Sdrh   int i, n;
30539d8b3072Sdrh   assert( pList!=0 );
30549cbf3425Sdrh   assert( target>0 );
3055268380caSdrh   n = pList->nExpr;
3056191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
30577445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
30587445ffe2Sdrh     int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
30597445ffe2Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
30607445ffe2Sdrh     if( inReg!=target+i && pParse->pVdbe ){
30617445ffe2Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, doHardCopy ? OP_Copy : OP_SCopy,
30627445ffe2Sdrh                         inReg, target+i);
3063d176611bSdrh     }
3064268380caSdrh   }
3065f9b596ebSdrh   return n;
3066268380caSdrh }
3067268380caSdrh 
3068268380caSdrh /*
306936c563a2Sdrh ** Generate code for a BETWEEN operator.
307036c563a2Sdrh **
307136c563a2Sdrh **    x BETWEEN y AND z
307236c563a2Sdrh **
307336c563a2Sdrh ** The above is equivalent to
307436c563a2Sdrh **
307536c563a2Sdrh **    x>=y AND x<=z
307636c563a2Sdrh **
307736c563a2Sdrh ** Code it as such, taking care to do the common subexpression
307836c563a2Sdrh ** elementation of x.
307936c563a2Sdrh */
308036c563a2Sdrh static void exprCodeBetween(
308136c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
308236c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
308336c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
308436c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
308536c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
308636c563a2Sdrh ){
308736c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
308836c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
308936c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
309036c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
309136c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
309236c563a2Sdrh 
309336c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
309436c563a2Sdrh   exprX = *pExpr->pLeft;
309536c563a2Sdrh   exprAnd.op = TK_AND;
309636c563a2Sdrh   exprAnd.pLeft = &compLeft;
309736c563a2Sdrh   exprAnd.pRight = &compRight;
309836c563a2Sdrh   compLeft.op = TK_GE;
309936c563a2Sdrh   compLeft.pLeft = &exprX;
310036c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
310136c563a2Sdrh   compRight.op = TK_LE;
310236c563a2Sdrh   compRight.pLeft = &exprX;
310336c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
310436c563a2Sdrh   exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
310536c563a2Sdrh   exprX.op = TK_REGISTER;
310636c563a2Sdrh   if( jumpIfTrue ){
310736c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
310836c563a2Sdrh   }else{
310936c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
311036c563a2Sdrh   }
311136c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
311236c563a2Sdrh 
311336c563a2Sdrh   /* Ensure adequate test coverage */
311436c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
311536c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
311636c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
311736c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
311836c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
311936c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
312036c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
312136c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
312236c563a2Sdrh }
312336c563a2Sdrh 
312436c563a2Sdrh /*
3125cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3126cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3127cce7d176Sdrh ** continues straight thru if the expression is false.
3128f5905aa7Sdrh **
3129f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
313035573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3131f2bc013cSdrh **
3132f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3133f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3134f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3135f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3136f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3137cce7d176Sdrh */
31384adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3139cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3140cce7d176Sdrh   int op = 0;
31412dcef11bSdrh   int regFree1 = 0;
31422dcef11bSdrh   int regFree2 = 0;
31432dcef11bSdrh   int r1, r2;
31442dcef11bSdrh 
314535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
314633cd4909Sdrh   if( NEVER(v==0) )     return;  /* Existance of VDBE checked by caller */
314733cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3148f2bc013cSdrh   op = pExpr->op;
3149f2bc013cSdrh   switch( op ){
3150cce7d176Sdrh     case TK_AND: {
31514adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3152c5499befSdrh       testcase( jumpIfNull==0 );
3153ceea3321Sdrh       sqlite3ExprCachePush(pParse);
315435573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
31554adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
31564adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3157ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3158cce7d176Sdrh       break;
3159cce7d176Sdrh     }
3160cce7d176Sdrh     case TK_OR: {
3161c5499befSdrh       testcase( jumpIfNull==0 );
31624adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
31634adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3164cce7d176Sdrh       break;
3165cce7d176Sdrh     }
3166cce7d176Sdrh     case TK_NOT: {
3167c5499befSdrh       testcase( jumpIfNull==0 );
31684adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3169cce7d176Sdrh       break;
3170cce7d176Sdrh     }
3171cce7d176Sdrh     case TK_LT:
3172cce7d176Sdrh     case TK_LE:
3173cce7d176Sdrh     case TK_GT:
3174cce7d176Sdrh     case TK_GE:
3175cce7d176Sdrh     case TK_NE:
31760ac65892Sdrh     case TK_EQ: {
3177f2bc013cSdrh       assert( TK_LT==OP_Lt );
3178f2bc013cSdrh       assert( TK_LE==OP_Le );
3179f2bc013cSdrh       assert( TK_GT==OP_Gt );
3180f2bc013cSdrh       assert( TK_GE==OP_Ge );
3181f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3182f2bc013cSdrh       assert( TK_NE==OP_Ne );
3183c5499befSdrh       testcase( op==TK_LT );
3184c5499befSdrh       testcase( op==TK_LE );
3185c5499befSdrh       testcase( op==TK_GT );
3186c5499befSdrh       testcase( op==TK_GE );
3187c5499befSdrh       testcase( op==TK_EQ );
3188c5499befSdrh       testcase( op==TK_NE );
3189c5499befSdrh       testcase( jumpIfNull==0 );
3190b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3191b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
319235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
31932dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3194c5499befSdrh       testcase( regFree1==0 );
3195c5499befSdrh       testcase( regFree2==0 );
3196cce7d176Sdrh       break;
3197cce7d176Sdrh     }
31986a2fe093Sdrh     case TK_IS:
31996a2fe093Sdrh     case TK_ISNOT: {
32006a2fe093Sdrh       testcase( op==TK_IS );
32016a2fe093Sdrh       testcase( op==TK_ISNOT );
3202b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3203b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
32046a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
32056a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
32066a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
32076a2fe093Sdrh       testcase( regFree1==0 );
32086a2fe093Sdrh       testcase( regFree2==0 );
32096a2fe093Sdrh       break;
32106a2fe093Sdrh     }
3211cce7d176Sdrh     case TK_ISNULL:
3212cce7d176Sdrh     case TK_NOTNULL: {
3213f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3214f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3215c5499befSdrh       testcase( op==TK_ISNULL );
3216c5499befSdrh       testcase( op==TK_NOTNULL );
32172dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
32182dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3219c5499befSdrh       testcase( regFree1==0 );
3220cce7d176Sdrh       break;
3221cce7d176Sdrh     }
3222fef5208cSdrh     case TK_BETWEEN: {
32235c03f30aSdrh       testcase( jumpIfNull==0 );
322436c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3225fef5208cSdrh       break;
3226fef5208cSdrh     }
3227e3365e6cSdrh     case TK_IN: {
3228e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3229e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3230e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3231e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3232e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3233e3365e6cSdrh       break;
3234e3365e6cSdrh     }
3235cce7d176Sdrh     default: {
32362dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
32372dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3238c5499befSdrh       testcase( regFree1==0 );
3239c5499befSdrh       testcase( jumpIfNull==0 );
3240cce7d176Sdrh       break;
3241cce7d176Sdrh     }
3242cce7d176Sdrh   }
32432dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
32442dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3245cce7d176Sdrh }
3246cce7d176Sdrh 
3247cce7d176Sdrh /*
324866b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3249cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3250cce7d176Sdrh ** continues straight thru if the expression is true.
3251f5905aa7Sdrh **
3252f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
325335573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
325435573356Sdrh ** is 0.
3255cce7d176Sdrh */
32564adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3257cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3258cce7d176Sdrh   int op = 0;
32592dcef11bSdrh   int regFree1 = 0;
32602dcef11bSdrh   int regFree2 = 0;
32612dcef11bSdrh   int r1, r2;
32622dcef11bSdrh 
326335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
326433cd4909Sdrh   if( NEVER(v==0) ) return; /* Existance of VDBE checked by caller */
326533cd4909Sdrh   if( pExpr==0 )    return;
3266f2bc013cSdrh 
3267f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3268f2bc013cSdrh   **
3269f2bc013cSdrh   **       pExpr->op            op
3270f2bc013cSdrh   **       ---------          ----------
3271f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3272f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3273f2bc013cSdrh   **       TK_NE              OP_Eq
3274f2bc013cSdrh   **       TK_EQ              OP_Ne
3275f2bc013cSdrh   **       TK_GT              OP_Le
3276f2bc013cSdrh   **       TK_LE              OP_Gt
3277f2bc013cSdrh   **       TK_GE              OP_Lt
3278f2bc013cSdrh   **       TK_LT              OP_Ge
3279f2bc013cSdrh   **
3280f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3281f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3282f2bc013cSdrh   ** can compute the mapping above using the following expression.
3283f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3284f2bc013cSdrh   */
3285f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3286f2bc013cSdrh 
3287f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3288f2bc013cSdrh   */
3289f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3290f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3291f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3292f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3293f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3294f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3295f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3296f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3297f2bc013cSdrh 
3298cce7d176Sdrh   switch( pExpr->op ){
3299cce7d176Sdrh     case TK_AND: {
3300c5499befSdrh       testcase( jumpIfNull==0 );
33014adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
33024adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3303cce7d176Sdrh       break;
3304cce7d176Sdrh     }
3305cce7d176Sdrh     case TK_OR: {
33064adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3307c5499befSdrh       testcase( jumpIfNull==0 );
3308ceea3321Sdrh       sqlite3ExprCachePush(pParse);
330935573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
33104adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
33114adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3312ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3313cce7d176Sdrh       break;
3314cce7d176Sdrh     }
3315cce7d176Sdrh     case TK_NOT: {
33165c03f30aSdrh       testcase( jumpIfNull==0 );
33174adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3318cce7d176Sdrh       break;
3319cce7d176Sdrh     }
3320cce7d176Sdrh     case TK_LT:
3321cce7d176Sdrh     case TK_LE:
3322cce7d176Sdrh     case TK_GT:
3323cce7d176Sdrh     case TK_GE:
3324cce7d176Sdrh     case TK_NE:
3325cce7d176Sdrh     case TK_EQ: {
3326c5499befSdrh       testcase( op==TK_LT );
3327c5499befSdrh       testcase( op==TK_LE );
3328c5499befSdrh       testcase( op==TK_GT );
3329c5499befSdrh       testcase( op==TK_GE );
3330c5499befSdrh       testcase( op==TK_EQ );
3331c5499befSdrh       testcase( op==TK_NE );
3332c5499befSdrh       testcase( jumpIfNull==0 );
3333b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3334b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
333535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
33362dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3337c5499befSdrh       testcase( regFree1==0 );
3338c5499befSdrh       testcase( regFree2==0 );
3339cce7d176Sdrh       break;
3340cce7d176Sdrh     }
33416a2fe093Sdrh     case TK_IS:
33426a2fe093Sdrh     case TK_ISNOT: {
33436d4486aeSdrh       testcase( pExpr->op==TK_IS );
33446d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3345b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3346b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
33476a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
33486a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
33496a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
33506a2fe093Sdrh       testcase( regFree1==0 );
33516a2fe093Sdrh       testcase( regFree2==0 );
33526a2fe093Sdrh       break;
33536a2fe093Sdrh     }
3354cce7d176Sdrh     case TK_ISNULL:
3355cce7d176Sdrh     case TK_NOTNULL: {
3356c5499befSdrh       testcase( op==TK_ISNULL );
3357c5499befSdrh       testcase( op==TK_NOTNULL );
33582dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
33592dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3360c5499befSdrh       testcase( regFree1==0 );
3361cce7d176Sdrh       break;
3362cce7d176Sdrh     }
3363fef5208cSdrh     case TK_BETWEEN: {
33645c03f30aSdrh       testcase( jumpIfNull==0 );
336536c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3366fef5208cSdrh       break;
3367fef5208cSdrh     }
3368e3365e6cSdrh     case TK_IN: {
3369e3365e6cSdrh       if( jumpIfNull ){
3370e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3371e3365e6cSdrh       }else{
3372e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3373e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3374e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3375e3365e6cSdrh       }
3376e3365e6cSdrh       break;
3377e3365e6cSdrh     }
3378cce7d176Sdrh     default: {
33792dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
33802dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3381c5499befSdrh       testcase( regFree1==0 );
3382c5499befSdrh       testcase( jumpIfNull==0 );
3383cce7d176Sdrh       break;
3384cce7d176Sdrh     }
3385cce7d176Sdrh   }
33862dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
33872dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3388cce7d176Sdrh }
33892282792aSdrh 
33902282792aSdrh /*
33911d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
33921d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
33931d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
33941d9da70aSdrh ** other than the top-level COLLATE operator.
3395d40aab0eSdrh **
33961d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3397d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
33981d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
33991d9da70aSdrh ** returns 2, then you do not really know for certain if the two
34001d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3401d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
34021d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3403d40aab0eSdrh ** just might result in some slightly slower code.  But returning
34041d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
34052282792aSdrh */
34064adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
34074b202ae2Sdanielk1977   if( pA==0||pB==0 ){
34081d9da70aSdrh     return pB==pA ? 0 : 2;
34092282792aSdrh   }
341033e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
341133e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
34126ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
34131d9da70aSdrh     return 2;
34146ab3a2ecSdanielk1977   }
34151d9da70aSdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
34161d9da70aSdrh   if( pA->op!=pB->op ) return 2;
34171d9da70aSdrh   if( sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 2;
34181d9da70aSdrh   if( sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 2;
34198c6f666bSdrh   if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList) ) return 2;
34201d9da70aSdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 2;
342133e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
342233e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
34231d9da70aSdrh       return 2;
342433e619fcSdrh     }
342533e619fcSdrh   }else if( pA->op!=TK_COLUMN && pA->u.zToken ){
34261d9da70aSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 2;
342733e619fcSdrh     if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ){
34281d9da70aSdrh       return 2;
34291d9da70aSdrh     }
34301d9da70aSdrh   }
34311d9da70aSdrh   if( (pA->flags & EP_ExpCollate)!=(pB->flags & EP_ExpCollate) ) return 1;
34321d9da70aSdrh   if( (pA->flags & EP_ExpCollate)!=0 && pA->pColl!=pB->pColl ) return 2;
34332646da7eSdrh   return 0;
34342646da7eSdrh }
34352282792aSdrh 
34368c6f666bSdrh /*
34378c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
34388c6f666bSdrh ** non-zero if they differ in any way.
34398c6f666bSdrh **
34408c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
34418c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
34428c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
34438c6f666bSdrh ** a malfunction will result.
34448c6f666bSdrh **
34458c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
34468c6f666bSdrh ** always differs from a non-NULL pointer.
34478c6f666bSdrh */
34488c6f666bSdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB){
34498c6f666bSdrh   int i;
34508c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
34518c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
34528c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
34538c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
34548c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
34558c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
34568c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
34578c6f666bSdrh     if( sqlite3ExprCompare(pExprA, pExprB) ) return 1;
34588c6f666bSdrh   }
34598c6f666bSdrh   return 0;
34608c6f666bSdrh }
346113449892Sdrh 
34622282792aSdrh /*
346313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
346413449892Sdrh ** the new element.  Return a negative number if malloc fails.
34652282792aSdrh */
346617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
346713449892Sdrh   int i;
3468cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
346917435752Sdrh        db,
3470cf643729Sdrh        pInfo->aCol,
3471cf643729Sdrh        sizeof(pInfo->aCol[0]),
3472cf643729Sdrh        3,
3473cf643729Sdrh        &pInfo->nColumn,
3474cf643729Sdrh        &pInfo->nColumnAlloc,
3475cf643729Sdrh        &i
3476cf643729Sdrh   );
347713449892Sdrh   return i;
34782282792aSdrh }
347913449892Sdrh 
348013449892Sdrh /*
348113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
348213449892Sdrh ** the new element.  Return a negative number if malloc fails.
348313449892Sdrh */
348417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
348513449892Sdrh   int i;
3486cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
348717435752Sdrh        db,
3488cf643729Sdrh        pInfo->aFunc,
3489cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3490cf643729Sdrh        3,
3491cf643729Sdrh        &pInfo->nFunc,
3492cf643729Sdrh        &pInfo->nFuncAlloc,
3493cf643729Sdrh        &i
3494cf643729Sdrh   );
349513449892Sdrh   return i;
34962282792aSdrh }
34972282792aSdrh 
34982282792aSdrh /*
34997d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
35007d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3501626a879aSdrh ** for additional information.
35022282792aSdrh */
35037d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
35042282792aSdrh   int i;
35057d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3506a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3507a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
350813449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
350913449892Sdrh 
35102282792aSdrh   switch( pExpr->op ){
351189c69d00Sdrh     case TK_AGG_COLUMN:
3512967e8b73Sdrh     case TK_COLUMN: {
35138b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
35148b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
351513449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
351613449892Sdrh       ** clause of the aggregate query */
351720bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
351813449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
351913449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
352013449892Sdrh           struct AggInfo_col *pCol;
352133e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
352213449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
352313449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
352413449892Sdrh             ** that is in the FROM clause of the aggregate query.
352513449892Sdrh             **
352613449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
352713449892Sdrh             ** is not an entry there already.
352813449892Sdrh             */
35297f906d63Sdrh             int k;
353013449892Sdrh             pCol = pAggInfo->aCol;
35317f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
353213449892Sdrh               if( pCol->iTable==pExpr->iTable &&
353313449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
35342282792aSdrh                 break;
35352282792aSdrh               }
35362282792aSdrh             }
35371e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
35381e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
35391e536953Sdanielk1977             ){
35407f906d63Sdrh               pCol = &pAggInfo->aCol[k];
35410817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
354213449892Sdrh               pCol->iTable = pExpr->iTable;
354313449892Sdrh               pCol->iColumn = pExpr->iColumn;
35440a07c107Sdrh               pCol->iMem = ++pParse->nMem;
354513449892Sdrh               pCol->iSorterColumn = -1;
35465774b806Sdrh               pCol->pExpr = pExpr;
354713449892Sdrh               if( pAggInfo->pGroupBy ){
354813449892Sdrh                 int j, n;
354913449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
355013449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
355113449892Sdrh                 n = pGB->nExpr;
355213449892Sdrh                 for(j=0; j<n; j++, pTerm++){
355313449892Sdrh                   Expr *pE = pTerm->pExpr;
355413449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
355513449892Sdrh                       pE->iColumn==pExpr->iColumn ){
355613449892Sdrh                     pCol->iSorterColumn = j;
355713449892Sdrh                     break;
35582282792aSdrh                   }
355913449892Sdrh                 }
356013449892Sdrh               }
356113449892Sdrh               if( pCol->iSorterColumn<0 ){
356213449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
356313449892Sdrh               }
356413449892Sdrh             }
356513449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
356613449892Sdrh             ** because it was there before or because we just created it).
356713449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
356813449892Sdrh             ** pAggInfo->aCol[] entry.
356913449892Sdrh             */
357033e619fcSdrh             ExprSetIrreducible(pExpr);
357113449892Sdrh             pExpr->pAggInfo = pAggInfo;
357213449892Sdrh             pExpr->op = TK_AGG_COLUMN;
3573cf697396Sshane             pExpr->iAgg = (i16)k;
357413449892Sdrh             break;
357513449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
357613449892Sdrh         } /* end loop over pSrcList */
3577a58fdfb1Sdanielk1977       }
35787d10d5a6Sdrh       return WRC_Prune;
35792282792aSdrh     }
35802282792aSdrh     case TK_AGG_FUNCTION: {
358113449892Sdrh       /* The pNC->nDepth==0 test causes aggregate functions in subqueries
358213449892Sdrh       ** to be ignored */
3583a58fdfb1Sdanielk1977       if( pNC->nDepth==0 ){
358413449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
358513449892Sdrh         ** function that is already in the pAggInfo structure
358613449892Sdrh         */
358713449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
358813449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
35891d9da70aSdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr)==0 ){
35902282792aSdrh             break;
35912282792aSdrh           }
35922282792aSdrh         }
359313449892Sdrh         if( i>=pAggInfo->nFunc ){
359413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
359513449892Sdrh           */
359614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
35971e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
359813449892Sdrh           if( i>=0 ){
35996ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
360013449892Sdrh             pItem = &pAggInfo->aFunc[i];
360113449892Sdrh             pItem->pExpr = pExpr;
36020a07c107Sdrh             pItem->iMem = ++pParse->nMem;
360333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
360413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
360533e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
36066ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
3607fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
3608fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
3609fd357974Sdrh             }else{
3610fd357974Sdrh               pItem->iDistinct = -1;
3611fd357974Sdrh             }
36122282792aSdrh           }
361313449892Sdrh         }
361413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
361513449892Sdrh         */
361633e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
361733e619fcSdrh         ExprSetIrreducible(pExpr);
3618cf697396Sshane         pExpr->iAgg = (i16)i;
361913449892Sdrh         pExpr->pAggInfo = pAggInfo;
36207d10d5a6Sdrh         return WRC_Prune;
36212282792aSdrh       }
36222282792aSdrh     }
3623a58fdfb1Sdanielk1977   }
36247d10d5a6Sdrh   return WRC_Continue;
36257d10d5a6Sdrh }
36267d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
36277d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
36287d10d5a6Sdrh   if( pNC->nDepth==0 ){
3629a58fdfb1Sdanielk1977     pNC->nDepth++;
36307d10d5a6Sdrh     sqlite3WalkSelect(pWalker, pSelect);
3631a58fdfb1Sdanielk1977     pNC->nDepth--;
36327d10d5a6Sdrh     return WRC_Prune;
36337d10d5a6Sdrh   }else{
36347d10d5a6Sdrh     return WRC_Continue;
3635a58fdfb1Sdanielk1977   }
36362282792aSdrh }
3637626a879aSdrh 
3638626a879aSdrh /*
3639626a879aSdrh ** Analyze the given expression looking for aggregate functions and
3640626a879aSdrh ** for variables that need to be added to the pParse->aAgg[] array.
3641626a879aSdrh ** Make additional entries to the pParse->aAgg[] array as necessary.
3642626a879aSdrh **
3643626a879aSdrh ** This routine should only be called after the expression has been
36447d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
3645626a879aSdrh */
3646d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
36477d10d5a6Sdrh   Walker w;
36487d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
36497d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
36507d10d5a6Sdrh   w.u.pNC = pNC;
365120bc393cSdrh   assert( pNC->pSrcList!=0 );
36527d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
36532282792aSdrh }
36545d9a4af9Sdrh 
36555d9a4af9Sdrh /*
36565d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
36575d9a4af9Sdrh ** expression list.  Return the number of errors.
36585d9a4af9Sdrh **
36595d9a4af9Sdrh ** If an error is found, the analysis is cut short.
36605d9a4af9Sdrh */
3661d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
36625d9a4af9Sdrh   struct ExprList_item *pItem;
36635d9a4af9Sdrh   int i;
36645d9a4af9Sdrh   if( pList ){
3665d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
3666d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
36675d9a4af9Sdrh     }
36685d9a4af9Sdrh   }
36695d9a4af9Sdrh }
3670892d3179Sdrh 
3671892d3179Sdrh /*
3672ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
3673892d3179Sdrh */
3674892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
3675e55cbd72Sdrh   if( pParse->nTempReg==0 ){
3676892d3179Sdrh     return ++pParse->nMem;
3677892d3179Sdrh   }
36782f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
3679892d3179Sdrh }
3680ceea3321Sdrh 
3681ceea3321Sdrh /*
3682ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
3683ceea3321Sdrh ** purpose.
3684ceea3321Sdrh **
3685ceea3321Sdrh ** If a register is currently being used by the column cache, then
3686ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
3687ceea3321Sdrh ** the register becomes stale.
3688ceea3321Sdrh */
3689892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
36902dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
3691ceea3321Sdrh     int i;
3692ceea3321Sdrh     struct yColCache *p;
3693ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3694ceea3321Sdrh       if( p->iReg==iReg ){
3695ceea3321Sdrh         p->tempReg = 1;
3696ceea3321Sdrh         return;
3697ceea3321Sdrh       }
3698ceea3321Sdrh     }
3699892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
3700892d3179Sdrh   }
3701892d3179Sdrh }
3702892d3179Sdrh 
3703892d3179Sdrh /*
3704892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
3705892d3179Sdrh */
3706892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
3707e55cbd72Sdrh   int i, n;
3708892d3179Sdrh   i = pParse->iRangeReg;
3709e55cbd72Sdrh   n = pParse->nRangeReg;
3710f49f3523Sdrh   if( nReg<=n ){
3711f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
3712892d3179Sdrh     pParse->iRangeReg += nReg;
3713892d3179Sdrh     pParse->nRangeReg -= nReg;
3714892d3179Sdrh   }else{
3715892d3179Sdrh     i = pParse->nMem+1;
3716892d3179Sdrh     pParse->nMem += nReg;
3717892d3179Sdrh   }
3718892d3179Sdrh   return i;
3719892d3179Sdrh }
3720892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
3721f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
3722892d3179Sdrh   if( nReg>pParse->nRangeReg ){
3723892d3179Sdrh     pParse->nRangeReg = nReg;
3724892d3179Sdrh     pParse->iRangeReg = iReg;
3725892d3179Sdrh   }
3726892d3179Sdrh }
3727