xref: /sqlite-3.40.0/src/expr.c (revision e8abb4ca)
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;
9584e30ca0Sdrh   while( 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;
392d50ffc41Sdrh       assert( iValue>=0 );
39333e619fcSdrh     }
394a76b5dfcSdrh   }
395b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
396b7916a78Sdrh   if( pNew ){
3971bd10f8aSdrh     pNew->op = (u8)op;
398a58fdfb1Sdanielk1977     pNew->iAgg = -1;
399a76b5dfcSdrh     if( pToken ){
40033e619fcSdrh       if( nExtra==0 ){
40133e619fcSdrh         pNew->flags |= EP_IntValue;
40233e619fcSdrh         pNew->u.iValue = iValue;
40333e619fcSdrh       }else{
404d9da78a2Sdrh         int c;
40533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
406b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
407b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
40833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
409b7916a78Sdrh         if( dequote && nExtra>=3
410d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
41133e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
41224fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
413a34001c9Sdrh         }
414a34001c9Sdrh       }
41533e619fcSdrh     }
416b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
417b7916a78Sdrh     pNew->nHeight = 1;
418b7916a78Sdrh #endif
419a34001c9Sdrh   }
420a76b5dfcSdrh   return pNew;
421a76b5dfcSdrh }
422a76b5dfcSdrh 
423a76b5dfcSdrh /*
424b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
425b7916a78Sdrh ** already been dequoted.
426b7916a78Sdrh */
427b7916a78Sdrh Expr *sqlite3Expr(
428b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
429b7916a78Sdrh   int op,                 /* Expression opcode */
430b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
431b7916a78Sdrh ){
432b7916a78Sdrh   Token x;
433b7916a78Sdrh   x.z = zToken;
434b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
435b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
436b7916a78Sdrh }
437b7916a78Sdrh 
438b7916a78Sdrh /*
439b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
440b7916a78Sdrh **
441b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
442b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
443b7916a78Sdrh */
444b7916a78Sdrh void sqlite3ExprAttachSubtrees(
445b7916a78Sdrh   sqlite3 *db,
446b7916a78Sdrh   Expr *pRoot,
447b7916a78Sdrh   Expr *pLeft,
448b7916a78Sdrh   Expr *pRight
449b7916a78Sdrh ){
450b7916a78Sdrh   if( pRoot==0 ){
451b7916a78Sdrh     assert( db->mallocFailed );
452b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
453b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
454b7916a78Sdrh   }else{
455b7916a78Sdrh     if( pRight ){
456b7916a78Sdrh       pRoot->pRight = pRight;
457b7916a78Sdrh       if( pRight->flags & EP_ExpCollate ){
458b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
459b7916a78Sdrh         pRoot->pColl = pRight->pColl;
460b7916a78Sdrh       }
461b7916a78Sdrh     }
462b7916a78Sdrh     if( pLeft ){
463b7916a78Sdrh       pRoot->pLeft = pLeft;
464b7916a78Sdrh       if( pLeft->flags & EP_ExpCollate ){
465b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
466b7916a78Sdrh         pRoot->pColl = pLeft->pColl;
467b7916a78Sdrh       }
468b7916a78Sdrh     }
469b7916a78Sdrh     exprSetHeight(pRoot);
470b7916a78Sdrh   }
471b7916a78Sdrh }
472b7916a78Sdrh 
473b7916a78Sdrh /*
474bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
475b7916a78Sdrh **
476bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
477bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
478bf664469Sdrh ** free the subtrees and return NULL.
479206f3d96Sdrh */
48017435752Sdrh Expr *sqlite3PExpr(
48117435752Sdrh   Parse *pParse,          /* Parsing context */
48217435752Sdrh   int op,                 /* Expression opcode */
48317435752Sdrh   Expr *pLeft,            /* Left operand */
48417435752Sdrh   Expr *pRight,           /* Right operand */
48517435752Sdrh   const Token *pToken     /* Argument token */
48617435752Sdrh ){
4875fb52caaSdrh   Expr *p;
4885fb52caaSdrh   if( op==TK_AND && pLeft && pRight ){
4895fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
4905fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
4915fb52caaSdrh   }else{
4925fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
493b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
4945fb52caaSdrh   }
4952b359bdbSdan   if( p ) {
4962b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
4972b359bdbSdan   }
4984e0cff60Sdrh   return p;
4994e0cff60Sdrh }
5004e0cff60Sdrh 
5014e0cff60Sdrh /*
5025fb52caaSdrh ** Return 1 if an expression must be FALSE in all cases and 0 if the
5035fb52caaSdrh ** expression might be true.  This is an optimization.  If is OK to
5045fb52caaSdrh ** return 0 here even if the expression really is always false (a
5055fb52caaSdrh ** false negative).  But it is a bug to return 1 if the expression
5065fb52caaSdrh ** might be true in some rare circumstances (a false positive.)
5075fb52caaSdrh **
5085fb52caaSdrh ** Note that if the expression is part of conditional for a
5095fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5105fb52caaSdrh ** is it true or false, so always return 0.
5115fb52caaSdrh */
5125fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5135fb52caaSdrh   int v = 0;
5145fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5155fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5165fb52caaSdrh   return v==0;
5175fb52caaSdrh }
5185fb52caaSdrh 
5195fb52caaSdrh /*
52091bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
52191bb0eedSdrh ** NULL, then just return the other expression.
5225fb52caaSdrh **
5235fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5245fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5255fb52caaSdrh ** a value of false.
52691bb0eedSdrh */
5271e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
52891bb0eedSdrh   if( pLeft==0 ){
52991bb0eedSdrh     return pRight;
53091bb0eedSdrh   }else if( pRight==0 ){
53191bb0eedSdrh     return pLeft;
5325fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
5335fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
5345fb52caaSdrh     sqlite3ExprDelete(db, pRight);
5355fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
53691bb0eedSdrh   }else{
537b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
538b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
539b7916a78Sdrh     return pNew;
540a76b5dfcSdrh   }
541a76b5dfcSdrh }
542a76b5dfcSdrh 
543a76b5dfcSdrh /*
544a76b5dfcSdrh ** Construct a new expression node for a function with multiple
545a76b5dfcSdrh ** arguments.
546a76b5dfcSdrh */
54717435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
548a76b5dfcSdrh   Expr *pNew;
549633e6d57Sdrh   sqlite3 *db = pParse->db;
5504b202ae2Sdanielk1977   assert( pToken );
551b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
552a76b5dfcSdrh   if( pNew==0 ){
553d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
554a76b5dfcSdrh     return 0;
555a76b5dfcSdrh   }
5566ab3a2ecSdanielk1977   pNew->x.pList = pList;
5576ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5584b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
559a76b5dfcSdrh   return pNew;
560a76b5dfcSdrh }
561a76b5dfcSdrh 
562a76b5dfcSdrh /*
563fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
564fa6bc000Sdrh ** in the original SQL statement.
565fa6bc000Sdrh **
566fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
567fa6bc000Sdrh ** variable number.
568fa6bc000Sdrh **
569fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
570fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
571fa6bc000Sdrh ** the SQL statement comes from an external source.
572fa6bc000Sdrh **
57351f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
574fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
575fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
576fa6bc000Sdrh ** assigned.
577fa6bc000Sdrh */
578fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
57917435752Sdrh   sqlite3 *db = pParse->db;
580b7916a78Sdrh   const char *z;
58117435752Sdrh 
582fa6bc000Sdrh   if( pExpr==0 ) return;
58333e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
58433e619fcSdrh   z = pExpr->u.zToken;
585b7916a78Sdrh   assert( z!=0 );
586b7916a78Sdrh   assert( z[0]!=0 );
587b7916a78Sdrh   if( z[1]==0 ){
588fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
589b7916a78Sdrh     assert( z[0]=='?' );
5908677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
591124c0b49Sdrh   }else{
592124c0b49Sdrh     ynVar x = 0;
593124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
594124c0b49Sdrh     if( z[0]=='?' ){
595fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
596fa6bc000Sdrh       ** use it as the variable number */
597c8d735aeSdan       i64 i;
598124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
599124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
600c5499befSdrh       testcase( i==0 );
601c5499befSdrh       testcase( i==1 );
602c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
603c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
604c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
605fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
606bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
607124c0b49Sdrh         x = 0;
608fa6bc000Sdrh       }
609fa6bc000Sdrh       if( i>pParse->nVar ){
6101df2db7fSshaneh         pParse->nVar = (int)i;
611fa6bc000Sdrh       }
612fa6bc000Sdrh     }else{
61351f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
614fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
615fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
616fa6bc000Sdrh       */
617124c0b49Sdrh       ynVar i;
618124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
619124c0b49Sdrh         if( pParse->azVar[i] && memcmp(pParse->azVar[i],z,n+1)==0 ){
620124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
621fa6bc000Sdrh           break;
622fa6bc000Sdrh         }
623fa6bc000Sdrh       }
624124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
625fa6bc000Sdrh     }
626124c0b49Sdrh     if( x>0 ){
627124c0b49Sdrh       if( x>pParse->nzVar ){
628124c0b49Sdrh         char **a;
629124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
630124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
631124c0b49Sdrh         pParse->azVar = a;
632124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
633124c0b49Sdrh         pParse->nzVar = x;
634124c0b49Sdrh       }
635124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
636124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
637124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
638fa6bc000Sdrh       }
639fa6bc000Sdrh     }
640fa6bc000Sdrh   }
641bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
642832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
643832b2664Sdanielk1977   }
644fa6bc000Sdrh }
645fa6bc000Sdrh 
646fa6bc000Sdrh /*
647f6963f99Sdan ** Recursively delete an expression tree.
648a2e00042Sdrh */
649f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
650f6963f99Sdan   if( p==0 ) return;
651d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
652d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
653b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
654633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
655633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
65633e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
65733e619fcSdrh       sqlite3DbFree(db, p->u.zToken);
6586ab3a2ecSdanielk1977     }
6596ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6606ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6616ab3a2ecSdanielk1977     }else{
6626ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6636ab3a2ecSdanielk1977     }
6646ab3a2ecSdanielk1977   }
66533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
666633e6d57Sdrh     sqlite3DbFree(db, p);
667a2e00042Sdrh   }
66833e619fcSdrh }
669a2e00042Sdrh 
670d2687b77Sdrh /*
6716ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6726ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6736ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6746ab3a2ecSdanielk1977 */
6756ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6766ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6776ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6786ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6796ab3a2ecSdanielk1977 }
6806ab3a2ecSdanielk1977 
6816ab3a2ecSdanielk1977 /*
68233e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
68333e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
68433e619fcSdrh ** how much of the tree is measured.
68533e619fcSdrh **
68633e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
68733e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
68833e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
68933e619fcSdrh **
69033e619fcSdrh ***************************************************************************
69133e619fcSdrh **
69233e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
69333e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
69433e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
69533e619fcSdrh ** The return values is always one of:
69633e619fcSdrh **
69733e619fcSdrh **      EXPR_FULLSIZE
69833e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
69933e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
70033e619fcSdrh **
70133e619fcSdrh ** The size of the structure can be found by masking the return value
70233e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
70333e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
70433e619fcSdrh **
70533e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
70633e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
70733e619fcSdrh ** During expression analysis, extra information is computed and moved into
70833e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
70933e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
71033e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
71133e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
71233e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
71333e619fcSdrh ** to enforce this constraint.
7146ab3a2ecSdanielk1977 */
7156ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7166ab3a2ecSdanielk1977   int nSize;
71733e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
7186ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7196ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7206ab3a2ecSdanielk1977   }else{
72133e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
72233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
72333e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
72433e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
72533e619fcSdrh     if( p->pLeft || p->pRight || p->pColl || p->x.pList ){
72633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
72733e619fcSdrh     }else{
72833e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
72933e619fcSdrh     }
7306ab3a2ecSdanielk1977   }
7316ab3a2ecSdanielk1977   return nSize;
7326ab3a2ecSdanielk1977 }
7336ab3a2ecSdanielk1977 
7346ab3a2ecSdanielk1977 /*
73533e619fcSdrh ** This function returns the space in bytes required to store the copy
73633e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
73733e619fcSdrh ** string is defined.)
7386ab3a2ecSdanielk1977 */
7396ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
74033e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
74133e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
74233e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7436ab3a2ecSdanielk1977   }
744bc73971dSdanielk1977   return ROUND8(nByte);
7456ab3a2ecSdanielk1977 }
7466ab3a2ecSdanielk1977 
7476ab3a2ecSdanielk1977 /*
7486ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7496ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7506ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7516ab3a2ecSdanielk1977 **
7526ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
75333e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7546ab3a2ecSdanielk1977 **
7556ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7566ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7576ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7586ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7596ab3a2ecSdanielk1977 */
7606ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7616ab3a2ecSdanielk1977   int nByte = 0;
7626ab3a2ecSdanielk1977   if( p ){
7636ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7646ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
765b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7666ab3a2ecSdanielk1977     }
7676ab3a2ecSdanielk1977   }
7686ab3a2ecSdanielk1977   return nByte;
7696ab3a2ecSdanielk1977 }
7706ab3a2ecSdanielk1977 
7716ab3a2ecSdanielk1977 /*
7726ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7736ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
77433e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7756ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7766ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7776ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7786ab3a2ecSdanielk1977 */
7796ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7806ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7816ab3a2ecSdanielk1977   if( p ){
7826ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7836ab3a2ecSdanielk1977     u8 *zAlloc;
78433e619fcSdrh     u32 staticFlag = 0;
7856ab3a2ecSdanielk1977 
7866ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7876ab3a2ecSdanielk1977 
7886ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7896ab3a2ecSdanielk1977     if( pzBuffer ){
7906ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
79133e619fcSdrh       staticFlag = EP_Static;
7926ab3a2ecSdanielk1977     }else{
7936ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7946ab3a2ecSdanielk1977     }
7956ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7966ab3a2ecSdanielk1977 
7976ab3a2ecSdanielk1977     if( pNew ){
7986ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7996ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
8006ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
80133e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
8026ab3a2ecSdanielk1977       */
80333e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
80433e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
80533e619fcSdrh       int nToken;
80633e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
80733e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
80833e619fcSdrh       }else{
80933e619fcSdrh         nToken = 0;
81033e619fcSdrh       }
8116ab3a2ecSdanielk1977       if( isReduced ){
8126ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8136ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8146ab3a2ecSdanielk1977       }else{
8156ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8166ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8176ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8186ab3a2ecSdanielk1977       }
8196ab3a2ecSdanielk1977 
82033e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
82133e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
82233e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
82333e619fcSdrh       pNew->flags |= staticFlag;
8246ab3a2ecSdanielk1977 
82533e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8266ab3a2ecSdanielk1977       if( nToken ){
82733e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
82833e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8296ab3a2ecSdanielk1977       }
8306ab3a2ecSdanielk1977 
8316ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8326ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8336ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8346ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8356ab3a2ecSdanielk1977         }else{
8366ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8376ab3a2ecSdanielk1977         }
8386ab3a2ecSdanielk1977       }
8396ab3a2ecSdanielk1977 
8406ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
841b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8426ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8436ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8446ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8456ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8466ab3a2ecSdanielk1977         }
8476ab3a2ecSdanielk1977         if( pzBuffer ){
8486ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8496ab3a2ecSdanielk1977         }
850b7916a78Sdrh       }else{
851b7916a78Sdrh         pNew->flags2 = 0;
852b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8536ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8546ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8556ab3a2ecSdanielk1977         }
8566ab3a2ecSdanielk1977       }
857b7916a78Sdrh 
858b7916a78Sdrh     }
8596ab3a2ecSdanielk1977   }
8606ab3a2ecSdanielk1977   return pNew;
8616ab3a2ecSdanielk1977 }
8626ab3a2ecSdanielk1977 
8636ab3a2ecSdanielk1977 /*
864ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
865ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
866ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
867ff78bd2fSdrh ** without effecting the originals.
868ff78bd2fSdrh **
8694adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8704adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
871ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
872ff78bd2fSdrh **
873ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8746ab3a2ecSdanielk1977 **
875b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8766ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8776ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8786ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
879ff78bd2fSdrh */
8806ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8816ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
882ff78bd2fSdrh }
8836ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
884ff78bd2fSdrh   ExprList *pNew;
885145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
886ff78bd2fSdrh   int i;
887ff78bd2fSdrh   if( p==0 ) return 0;
88817435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
889ff78bd2fSdrh   if( pNew==0 ) return 0;
89031dad9daSdanielk1977   pNew->iECursor = 0;
891d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
892d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
893d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
894e0048400Sdanielk1977   if( pItem==0 ){
895633e6d57Sdrh     sqlite3DbFree(db, pNew);
896e0048400Sdanielk1977     return 0;
897e0048400Sdanielk1977   }
898145716b3Sdrh   pOldItem = p->a;
899145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
9006ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
901b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
90217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
903b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
904145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
9053e7bc9caSdrh     pItem->done = 0;
9064b3ac73cSdrh     pItem->iOrderByCol = pOldItem->iOrderByCol;
9078b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
908ff78bd2fSdrh   }
909ff78bd2fSdrh   return pNew;
910ff78bd2fSdrh }
91193758c8dSdanielk1977 
91293758c8dSdanielk1977 /*
91393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
91493758c8dSdanielk1977 ** the build, then none of the following routines, except for
91593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
91693758c8dSdanielk1977 ** called with a NULL argument.
91793758c8dSdanielk1977 */
9186a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9196a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9206ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
921ad3cab52Sdrh   SrcList *pNew;
922ad3cab52Sdrh   int i;
923113088ecSdrh   int nByte;
924ad3cab52Sdrh   if( p==0 ) return 0;
925113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
92617435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
927ad3cab52Sdrh   if( pNew==0 ) return 0;
9284305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
929ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9304efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9314efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
932ed8a3bb1Sdrh     Table *pTab;
93341fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
93417435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
93517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
93617435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9374efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9384efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9395b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
9405b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
941da79cf0cSdan     pNewItem->isCorrelated = pOldItem->isCorrelated;
94221172c4cSdrh     pNewItem->viaCoroutine = pOldItem->viaCoroutine;
94385574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
94485574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
94585574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
946ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
947ed8a3bb1Sdrh     if( pTab ){
948ed8a3bb1Sdrh       pTab->nRef++;
949a1cb183dSdanielk1977     }
9506ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9516ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
95217435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9536c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
954ad3cab52Sdrh   }
955ad3cab52Sdrh   return pNew;
956ad3cab52Sdrh }
95717435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
958ff78bd2fSdrh   IdList *pNew;
959ff78bd2fSdrh   int i;
960ff78bd2fSdrh   if( p==0 ) return 0;
96117435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
962ff78bd2fSdrh   if( pNew==0 ) return 0;
9636c535158Sdrh   pNew->nId = p->nId;
96417435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
965d5d56523Sdanielk1977   if( pNew->a==0 ){
966633e6d57Sdrh     sqlite3DbFree(db, pNew);
967d5d56523Sdanielk1977     return 0;
968d5d56523Sdanielk1977   }
9696c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
9706c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
9716c535158Sdrh   ** on the duplicate created by this function. */
972ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9734efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9744efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
97517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9764efc4754Sdrh     pNewItem->idx = pOldItem->idx;
977ff78bd2fSdrh   }
978ff78bd2fSdrh   return pNew;
979ff78bd2fSdrh }
9806ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
98123b1b372Sdrh   Select *pNew, *pPrior;
982ff78bd2fSdrh   if( p==0 ) return 0;
98317435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
984ff78bd2fSdrh   if( pNew==0 ) return 0;
985b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9866ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9876ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9886ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9896ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9906ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
991ff78bd2fSdrh   pNew->op = p->op;
99223b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
99323b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
99423b1b372Sdrh   pNew->pNext = 0;
9956ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9966ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
99792b01d53Sdrh   pNew->iLimit = 0;
99892b01d53Sdrh   pNew->iOffset = 0;
9997d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
10000342b1f5Sdrh   pNew->pRightmost = 0;
1001b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1002b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1003b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
1004ff78bd2fSdrh   return pNew;
1005ff78bd2fSdrh }
100693758c8dSdanielk1977 #else
10076ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
100893758c8dSdanielk1977   assert( p==0 );
100993758c8dSdanielk1977   return 0;
101093758c8dSdanielk1977 }
101193758c8dSdanielk1977 #endif
1012ff78bd2fSdrh 
1013ff78bd2fSdrh 
1014ff78bd2fSdrh /*
1015a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1016a76b5dfcSdrh ** initially NULL, then create a new expression list.
1017b7916a78Sdrh **
1018b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1019b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1020b7916a78Sdrh ** that the new entry was successfully appended.
1021a76b5dfcSdrh */
102217435752Sdrh ExprList *sqlite3ExprListAppend(
102317435752Sdrh   Parse *pParse,          /* Parsing context */
102417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1025b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
102617435752Sdrh ){
102717435752Sdrh   sqlite3 *db = pParse->db;
1028a76b5dfcSdrh   if( pList==0 ){
102917435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1030a76b5dfcSdrh     if( pList==0 ){
1031d5d56523Sdanielk1977       goto no_mem;
1032a76b5dfcSdrh     }
1033d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1034d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1035d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1036d5d56523Sdanielk1977     struct ExprList_item *a;
1037d872bb18Sdrh     assert( pList->nExpr>0 );
1038d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1039d5d56523Sdanielk1977     if( a==0 ){
1040d5d56523Sdanielk1977       goto no_mem;
1041a76b5dfcSdrh     }
1042d5d56523Sdanielk1977     pList->a = a;
1043a76b5dfcSdrh   }
10444efc4754Sdrh   assert( pList->a!=0 );
1045b7916a78Sdrh   if( 1 ){
10464efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10474efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1048e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1049a76b5dfcSdrh   }
1050a76b5dfcSdrh   return pList;
1051d5d56523Sdanielk1977 
1052d5d56523Sdanielk1977 no_mem:
1053d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1054633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1055633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1056d5d56523Sdanielk1977   return 0;
1057a76b5dfcSdrh }
1058a76b5dfcSdrh 
1059a76b5dfcSdrh /*
1060b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1061b7916a78Sdrh ** on the expression list.
1062b7916a78Sdrh **
1063b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1064b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1065b7916a78Sdrh ** is set.
1066b7916a78Sdrh */
1067b7916a78Sdrh void sqlite3ExprListSetName(
1068b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1069b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1070b7916a78Sdrh   Token *pName,           /* Name to be added */
1071b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1072b7916a78Sdrh ){
1073b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1074b7916a78Sdrh   if( pList ){
1075b7916a78Sdrh     struct ExprList_item *pItem;
1076b7916a78Sdrh     assert( pList->nExpr>0 );
1077b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1078b7916a78Sdrh     assert( pItem->zName==0 );
1079b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1080b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1081b7916a78Sdrh   }
1082b7916a78Sdrh }
1083b7916a78Sdrh 
1084b7916a78Sdrh /*
1085b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1086b7916a78Sdrh ** on the expression list.
1087b7916a78Sdrh **
1088b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1089b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1090b7916a78Sdrh ** is set.
1091b7916a78Sdrh */
1092b7916a78Sdrh void sqlite3ExprListSetSpan(
1093b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1094b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1095b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1096b7916a78Sdrh ){
1097b7916a78Sdrh   sqlite3 *db = pParse->db;
1098b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1099b7916a78Sdrh   if( pList ){
1100b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1101b7916a78Sdrh     assert( pList->nExpr>0 );
1102b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1103b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1104b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1105cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1106b7916a78Sdrh   }
1107b7916a78Sdrh }
1108b7916a78Sdrh 
1109b7916a78Sdrh /*
11107a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
11117a15a4beSdanielk1977 ** leave an error message in pParse.
11127a15a4beSdanielk1977 */
11137a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
11147a15a4beSdanielk1977   Parse *pParse,
11157a15a4beSdanielk1977   ExprList *pEList,
11167a15a4beSdanielk1977   const char *zObject
11177a15a4beSdanielk1977 ){
1118b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1119c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1120c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1121b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11227a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11237a15a4beSdanielk1977   }
11247a15a4beSdanielk1977 }
11257a15a4beSdanielk1977 
11267a15a4beSdanielk1977 /*
1127a76b5dfcSdrh ** Delete an entire expression list.
1128a76b5dfcSdrh */
1129633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1130a76b5dfcSdrh   int i;
1131be5c89acSdrh   struct ExprList_item *pItem;
1132a76b5dfcSdrh   if( pList==0 ) return;
1133d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1134be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1135633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1136633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1137b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1138a76b5dfcSdrh   }
1139633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1140633e6d57Sdrh   sqlite3DbFree(db, pList);
1141a76b5dfcSdrh }
1142a76b5dfcSdrh 
1143a76b5dfcSdrh /*
11447d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11457d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11467d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11477d10d5a6Sdrh ** not constant.
114873b211abSdrh **
11497d10d5a6Sdrh ** These callback routines are used to implement the following:
1150626a879aSdrh **
11517d10d5a6Sdrh **     sqlite3ExprIsConstant()
11527d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11537d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
115487abf5c0Sdrh **
1155626a879aSdrh */
11567d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1157626a879aSdrh 
11587d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11590a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11600a168377Sdrh   ** from being considered constant. */
11617d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11627d10d5a6Sdrh     pWalker->u.i = 0;
11637d10d5a6Sdrh     return WRC_Abort;
11640a168377Sdrh   }
11650a168377Sdrh 
1166626a879aSdrh   switch( pExpr->op ){
1167eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11687d10d5a6Sdrh     ** and pWalker->u.i==2 */
1169eb55bd2fSdrh     case TK_FUNCTION:
11707d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1171eb55bd2fSdrh       /* Fall through */
1172626a879aSdrh     case TK_ID:
1173626a879aSdrh     case TK_COLUMN:
1174626a879aSdrh     case TK_AGG_FUNCTION:
117513449892Sdrh     case TK_AGG_COLUMN:
1176c5499befSdrh       testcase( pExpr->op==TK_ID );
1177c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1178c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1179c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11807d10d5a6Sdrh       pWalker->u.i = 0;
11817d10d5a6Sdrh       return WRC_Abort;
1182626a879aSdrh     default:
1183b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1184b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
11857d10d5a6Sdrh       return WRC_Continue;
1186626a879aSdrh   }
1187626a879aSdrh }
118862c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
118962c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11907d10d5a6Sdrh   pWalker->u.i = 0;
11917d10d5a6Sdrh   return WRC_Abort;
11927d10d5a6Sdrh }
11937d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11947d10d5a6Sdrh   Walker w;
11957d10d5a6Sdrh   w.u.i = initFlag;
11967d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11977d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11987d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11997d10d5a6Sdrh   return w.u.i;
12007d10d5a6Sdrh }
1201626a879aSdrh 
1202626a879aSdrh /*
1203fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1204eb55bd2fSdrh ** and 0 if it involves variables or function calls.
12052398937bSdrh **
12062398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
12072398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
12082398937bSdrh ** a constant.
1209fef5208cSdrh */
12104adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
12117d10d5a6Sdrh   return exprIsConst(p, 1);
1212fef5208cSdrh }
1213fef5208cSdrh 
1214fef5208cSdrh /*
1215eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12160a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12170a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12180a168377Sdrh ** an ON or USING clause.
12190a168377Sdrh */
12200a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12217d10d5a6Sdrh   return exprIsConst(p, 3);
12220a168377Sdrh }
12230a168377Sdrh 
12240a168377Sdrh /*
12250a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1226eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1227eb55bd2fSdrh ** are any variables.
1228eb55bd2fSdrh **
1229eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1230eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1231eb55bd2fSdrh ** a constant.
1232eb55bd2fSdrh */
1233eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12347d10d5a6Sdrh   return exprIsConst(p, 2);
1235eb55bd2fSdrh }
1236eb55bd2fSdrh 
1237eb55bd2fSdrh /*
123873b211abSdrh ** If the expression p codes a constant integer that is small enough
1239202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1240202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1241202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1242e4de1febSdrh */
12434adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
124492b01d53Sdrh   int rc = 0;
1245cd92e84dSdrh 
1246cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1247cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1248cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1249cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1250cd92e84dSdrh 
125192b01d53Sdrh   if( p->flags & EP_IntValue ){
125233e619fcSdrh     *pValue = p->u.iValue;
1253e4de1febSdrh     return 1;
1254e4de1febSdrh   }
125592b01d53Sdrh   switch( p->op ){
12564b59ab5eSdrh     case TK_UPLUS: {
125792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1258f6e369a1Sdrh       break;
12594b59ab5eSdrh     }
1260e4de1febSdrh     case TK_UMINUS: {
1261e4de1febSdrh       int v;
12624adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1263e4de1febSdrh         *pValue = -v;
126492b01d53Sdrh         rc = 1;
1265e4de1febSdrh       }
1266e4de1febSdrh       break;
1267e4de1febSdrh     }
1268e4de1febSdrh     default: break;
1269e4de1febSdrh   }
127092b01d53Sdrh   return rc;
1271e4de1febSdrh }
1272e4de1febSdrh 
1273e4de1febSdrh /*
1274039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1275039fc32eSdrh **
1276039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1277039fc32eSdrh ** to tell return TRUE.
1278039fc32eSdrh **
1279039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1280039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1281039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1282039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1283039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1284039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1285039fc32eSdrh ** TRUE.
1286039fc32eSdrh */
1287039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1288039fc32eSdrh   u8 op;
1289cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1290039fc32eSdrh   op = p->op;
1291039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1292039fc32eSdrh   switch( op ){
1293039fc32eSdrh     case TK_INTEGER:
1294039fc32eSdrh     case TK_STRING:
1295039fc32eSdrh     case TK_FLOAT:
1296039fc32eSdrh     case TK_BLOB:
1297039fc32eSdrh       return 0;
1298039fc32eSdrh     default:
1299039fc32eSdrh       return 1;
1300039fc32eSdrh   }
1301039fc32eSdrh }
1302039fc32eSdrh 
1303039fc32eSdrh /*
13042f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
13052f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
13062f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
13072f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
13082f2855b6Sdrh ** can be omitted.
13092f2855b6Sdrh */
13102f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
13112f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
13122f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
13132f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
13142f2855b6Sdrh   int iDest           /* Jump here if the value is null */
13152f2855b6Sdrh ){
13162f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
13172f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
13182f2855b6Sdrh   }
13192f2855b6Sdrh }
13202f2855b6Sdrh 
13212f2855b6Sdrh /*
1322039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1323039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1324039fc32eSdrh ** argument.
1325039fc32eSdrh **
1326039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1327039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1328039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1329039fc32eSdrh ** answer.
1330039fc32eSdrh */
1331039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1332039fc32eSdrh   u8 op;
1333039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1334cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1335039fc32eSdrh   op = p->op;
1336039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1337039fc32eSdrh   switch( op ){
1338039fc32eSdrh     case TK_INTEGER: {
1339039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1340039fc32eSdrh     }
1341039fc32eSdrh     case TK_FLOAT: {
1342039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1343039fc32eSdrh     }
1344039fc32eSdrh     case TK_STRING: {
1345039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1346039fc32eSdrh     }
1347039fc32eSdrh     case TK_BLOB: {
1348039fc32eSdrh       return 1;
1349039fc32eSdrh     }
13502f2855b6Sdrh     case TK_COLUMN: {
135188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
135288376ca7Sdrh       return p->iColumn<0
13532f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
13542f2855b6Sdrh     }
1355039fc32eSdrh     default: {
1356039fc32eSdrh       return 0;
1357039fc32eSdrh     }
1358039fc32eSdrh   }
1359039fc32eSdrh }
1360039fc32eSdrh 
1361039fc32eSdrh /*
1362c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1363c4a3c779Sdrh */
13644adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
13654adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
13664adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
13674adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1368c4a3c779Sdrh   return 0;
1369c4a3c779Sdrh }
1370c4a3c779Sdrh 
13719a96b668Sdanielk1977 /*
1372b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1373b74b1017Sdrh ** query of the form
1374b287f4b6Sdrh **
1375b74b1017Sdrh **       x IN (SELECT ...)
1376b287f4b6Sdrh **
1377b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1378b74b1017Sdrh ** routine.
1379b74b1017Sdrh **
1380b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1381b74b1017Sdrh ** errors have been found.
1382b287f4b6Sdrh */
1383b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1384b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1385b287f4b6Sdrh   SrcList *pSrc;
1386b287f4b6Sdrh   ExprList *pEList;
1387b287f4b6Sdrh   Table *pTab;
1388b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1389b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
13907d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1391b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1392b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
13937d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
13947d10d5a6Sdrh   }
1395b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1396b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1397b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1398b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1399b287f4b6Sdrh   pSrc = p->pSrc;
1400d1fa7bcaSdrh   assert( pSrc!=0 );
1401d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1402b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1403b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1404b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1405b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1406b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1407b287f4b6Sdrh   pEList = p->pEList;
1408b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1409b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1410b287f4b6Sdrh   return 1;
1411b287f4b6Sdrh }
1412b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1413b287f4b6Sdrh 
1414b287f4b6Sdrh /*
14151d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
14161d8cb21fSdan ** address of the new instruction.
14171d8cb21fSdan */
14181d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
14191d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
14201d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
14211d8cb21fSdan }
14221d8cb21fSdan 
14231d8cb21fSdan /*
14249a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1425d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1426d4305ca6Sdrh ** might be either a list of expressions or a subquery.
14279a96b668Sdanielk1977 **
1428d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1429d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1430d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1431d4305ca6Sdrh **
1432d4305ca6Sdrh ** A cursor is opened on the b-tree object that the RHS of the IN operator
1433d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1434d4305ca6Sdrh **
1435b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
14369a96b668Sdanielk1977 **
14379a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
14382d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
14399a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
14409a96b668Sdanielk1977 **                    populated epheremal table.
14419a96b668Sdanielk1977 **
1442d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1443d4305ca6Sdrh ** subquery such as:
14449a96b668Sdanielk1977 **
14459a96b668Sdanielk1977 **     SELECT <column> FROM <table>
14469a96b668Sdanielk1977 **
1447d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1448d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
1449d4305ca6Sdrh ** pX->iTable made to point to the ephermeral table instead of an
1450d4305ca6Sdrh ** existing table.
1451d4305ca6Sdrh **
1452b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
14539a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
14549a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
14559a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1456b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
14570cdc022eSdanielk1977 **
1458b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
14590cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
14600cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
14610cdc022eSdanielk1977 ** be found with <column> as its left-most column.
14620cdc022eSdanielk1977 **
1463b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
14640cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
14650cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1466e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
14670cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1468e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
14690cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
14700cdc022eSdanielk1977 **
14710cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1472e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1473e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1474b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1475e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1476b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
14770cdc022eSdanielk1977 **
14780cdc022eSdanielk1977 **   if( register==NULL ){
14790cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
14800cdc022eSdanielk1977 **     register = 1
14810cdc022eSdanielk1977 **   }
14820cdc022eSdanielk1977 **
14830cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
14840cdc022eSdanielk1977 ** test more often than is necessary.
14859a96b668Sdanielk1977 */
1486284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
14870cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1488b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1489b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1490b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1491b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
1492b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
14939a96b668Sdanielk1977 
14941450bc6eSdrh   assert( pX->op==TK_IN );
14951450bc6eSdrh 
1496b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1497b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1498b74b1017Sdrh   ** ephemeral table.
14999a96b668Sdanielk1977   */
15006ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1501fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1502e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1503b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1504b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1505b07028f7Sdrh     int iCol;                              /* Index of column <column> */
1506e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1507e1fb65a0Sdanielk1977 
1508b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1509b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1510b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1511b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1512b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1513b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1514b07028f7Sdrh     iCol = pExpr->iColumn;
1515b07028f7Sdrh 
1516e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1517e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1518e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1519e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
15209a96b668Sdanielk1977 
15219a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
15229a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
15239a96b668Sdanielk1977     ** successful here.
15249a96b668Sdanielk1977     */
15259a96b668Sdanielk1977     assert(v);
15269a96b668Sdanielk1977     if( iCol<0 ){
15279a96b668Sdanielk1977       int iAddr;
15289a96b668Sdanielk1977 
15291d8cb21fSdan       iAddr = sqlite3CodeOnce(pParse);
15309a96b668Sdanielk1977 
15319a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
15329a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
15339a96b668Sdanielk1977 
15349a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
15359a96b668Sdanielk1977     }else{
1536e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1537e1fb65a0Sdanielk1977 
15389a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
15399a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1540e1fb65a0Sdanielk1977       ** to this collation sequence.  */
15419a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
15429a96b668Sdanielk1977 
15439a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
15449a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
15459a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
15469a96b668Sdanielk1977       */
1547dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
15489a96b668Sdanielk1977 
15499a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
15509a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1551b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
15529a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
15539a96b668Sdanielk1977         ){
15549a96b668Sdanielk1977           int iAddr;
15559a96b668Sdanielk1977           char *pKey;
15569a96b668Sdanielk1977 
15579a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
15581d8cb21fSdan           iAddr = sqlite3CodeOnce(pParse);
15599a96b668Sdanielk1977 
1560207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
156166a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1562207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
15639a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
15649a96b668Sdanielk1977 
15659a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
15660cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
15670cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
1568b8475df8Sdrh             sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
15690cdc022eSdanielk1977           }
15709a96b668Sdanielk1977         }
15719a96b668Sdanielk1977       }
15729a96b668Sdanielk1977     }
15739a96b668Sdanielk1977   }
15749a96b668Sdanielk1977 
15759a96b668Sdanielk1977   if( eType==0 ){
15761450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1577b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1578b74b1017Sdrh     */
1579cf4d38aaSdrh     double savedNQueryLoop = pParse->nQueryLoop;
15800cdc022eSdanielk1977     int rMayHaveNull = 0;
158141a05b7bSdanielk1977     eType = IN_INDEX_EPH;
15820cdc022eSdanielk1977     if( prNotFound ){
15830cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1584b8475df8Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
1585cf4d38aaSdrh     }else{
1586cf4d38aaSdrh       testcase( pParse->nQueryLoop>(double)1 );
1587cf4d38aaSdrh       pParse->nQueryLoop = (double)1;
1588cf4d38aaSdrh       if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
158941a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
15900cdc022eSdanielk1977       }
1591cf4d38aaSdrh     }
159241a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1593cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
15949a96b668Sdanielk1977   }else{
15959a96b668Sdanielk1977     pX->iTable = iTab;
15969a96b668Sdanielk1977   }
15979a96b668Sdanielk1977   return eType;
15989a96b668Sdanielk1977 }
1599284f4acaSdanielk1977 #endif
1600626a879aSdrh 
1601626a879aSdrh /*
1602d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1603d4187c71Sdrh ** or IN operators.  Examples:
1604626a879aSdrh **
16059cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
16069cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
16079cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
16089cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1609fef5208cSdrh **
16109cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
16119cbe6352Sdrh ** operator or subquery.
161241a05b7bSdanielk1977 **
161341a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
161441a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
161541a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
161641a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
161741a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1618fd773cf9Sdrh **
1619fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1620fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1621fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1622fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1623fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1624fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1625fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1626fd773cf9Sdrh **
1627fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1628fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1629fd773cf9Sdrh ** registers to indicate the presense or absence of NULLs on the RHS.
16301450bc6eSdrh **
16311450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
16321450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1633cce7d176Sdrh */
163451522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
16351450bc6eSdrh int sqlite3CodeSubselect(
1636fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1637fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1638fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1639fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
164041a05b7bSdanielk1977 ){
1641dfd2d9f6Sdrh   int testAddr = -1;                      /* One-time test address */
16421450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1643b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
16441450bc6eSdrh   if( NEVER(v==0) ) return 0;
1645ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1646fc976065Sdanielk1977 
164757dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
164857dbd7b3Sdrh   ** if any of the following is true:
164957dbd7b3Sdrh   **
165057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
165157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
165257dbd7b3Sdrh   **    *  We are inside a trigger
165357dbd7b3Sdrh   **
165457dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
165557dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1656b3bce662Sdanielk1977   */
16571d8cb21fSdan   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) ){
16581d8cb21fSdan     testAddr = sqlite3CodeOnce(pParse);
1659b3bce662Sdanielk1977   }
1660b3bce662Sdanielk1977 
16614a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
16624a07e3dbSdan   if( pParse->explain==2 ){
16634a07e3dbSdan     char *zMsg = sqlite3MPrintf(
1664dfd2d9f6Sdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", testAddr>=0?"":"CORRELATED ",
16654a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
16664a07e3dbSdan     );
16674a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
16684a07e3dbSdan   }
16694a07e3dbSdan #endif
16704a07e3dbSdan 
1671cce7d176Sdrh   switch( pExpr->op ){
1672fef5208cSdrh     case TK_IN: {
1673d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1674d4187c71Sdrh       KeyInfo keyInfo;            /* Keyinfo for the generated table */
1675e1a022e4Sdrh       static u8 sortOrder = 0;    /* Fake aSortOrder for keyInfo */
1676b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1677d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1678d3d39e93Sdrh 
16790cdc022eSdanielk1977       if( rMayHaveNull ){
16800cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
16810cdc022eSdanielk1977       }
16820cdc022eSdanielk1977 
168341a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1684e014a838Sdanielk1977 
1685e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
16868cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1687e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1688e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1689fef5208cSdrh       **
1690e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1691e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1692e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1693e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1694e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1695e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1696e014a838Sdanielk1977       ** is used.
1697fef5208cSdrh       */
1698832508b7Sdrh       pExpr->iTable = pParse->nTab++;
169941a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1700d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1701d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1702d3d39e93Sdrh       keyInfo.nField = 1;
1703e1a022e4Sdrh       keyInfo.aSortOrder = &sortOrder;
1704e014a838Sdanielk1977 
17056ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1706e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1707e014a838Sdanielk1977         **
1708e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1709e014a838Sdanielk1977         ** table allocated and opened above.
1710e014a838Sdanielk1977         */
17111013c932Sdrh         SelectDest dest;
1712be5c89acSdrh         ExprList *pEList;
17131013c932Sdrh 
171441a05b7bSdanielk1977         assert( !isRowid );
17151013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
17162b596da8Sdrh         dest.affSdst = (u8)affinity;
1717e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
171848b5b041Sdrh         pExpr->x.pSelect->iLimit = 0;
17196ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
17201450bc6eSdrh           return 0;
172194ccde58Sdrh         }
17226ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1723fd773cf9Sdrh         if( ALWAYS(pEList!=0 && pEList->nExpr>0) ){
1724bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1725be5c89acSdrh               pEList->a[0].pExpr);
17260202b29eSdanielk1977         }
1727a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1728fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1729fef5208cSdrh         **
1730e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1731e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1732e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1733e014a838Sdanielk1977         ** a column, use numeric affinity.
1734fef5208cSdrh         */
1735e014a838Sdanielk1977         int i;
17366ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
173757dbd7b3Sdrh         struct ExprList_item *pItem;
1738ecc31805Sdrh         int r1, r2, r3;
173957dbd7b3Sdrh 
1740e014a838Sdanielk1977         if( !affinity ){
17418159a35fSdrh           affinity = SQLITE_AFF_NONE;
1742e014a838Sdanielk1977         }
17437d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1744e1a022e4Sdrh         keyInfo.aSortOrder = &sortOrder;
1745e014a838Sdanielk1977 
1746e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
17472d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
17482d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
17494e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
175057dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
175157dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1752e05c929bSdrh           int iValToIns;
1753e014a838Sdanielk1977 
175457dbd7b3Sdrh           /* If the expression is not constant then we will need to
175557dbd7b3Sdrh           ** disable the test that was generated above that makes sure
175657dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
175757dbd7b3Sdrh           ** expression we need to rerun this code each time.
175857dbd7b3Sdrh           */
1759dfd2d9f6Sdrh           if( testAddr>=0 && !sqlite3ExprIsConstant(pE2) ){
176048f2d3b1Sdrh             sqlite3VdbeChangeToNoop(v, testAddr);
1761dfd2d9f6Sdrh             testAddr = -1;
17624794b980Sdrh           }
1763e014a838Sdanielk1977 
1764e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1765e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1766e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1767e05c929bSdrh           }else{
1768ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
176941a05b7bSdanielk1977             if( isRowid ){
1770e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1771e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
177241a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
177341a05b7bSdanielk1977             }else{
1774ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
17753c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
17762d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1777fef5208cSdrh             }
177841a05b7bSdanielk1977           }
1779e05c929bSdrh         }
17802d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
17812d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1782fef5208cSdrh       }
178341a05b7bSdanielk1977       if( !isRowid ){
178466a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
178541a05b7bSdanielk1977       }
1786b3bce662Sdanielk1977       break;
1787fef5208cSdrh     }
1788fef5208cSdrh 
178951522cd3Sdrh     case TK_EXISTS:
1790fd773cf9Sdrh     case TK_SELECT:
1791fd773cf9Sdrh     default: {
1792fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1793fef5208cSdrh       ** value of this select in a memory cell and record the number
1794fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1795fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1796fd773cf9Sdrh       ** and record that memory cell in iColumn.
1797fef5208cSdrh       */
1798fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1799fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
18001398ad36Sdrh 
1801cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1802cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1803cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1804cf697396Sshane 
18056ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
18066ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
18071013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
180851522cd3Sdrh       if( pExpr->op==TK_SELECT ){
18096c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
18102b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
1811d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
181251522cd3Sdrh       }else{
18136c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
18142b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
1815d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
181651522cd3Sdrh       }
1817633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1818094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1819094430ebSdrh                                   &sqlite3IntTokens[1]);
182048b5b041Sdrh       pSel->iLimit = 0;
18217d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
18221450bc6eSdrh         return 0;
182394ccde58Sdrh       }
18242b596da8Sdrh       rReg = dest.iSDParm;
182533e619fcSdrh       ExprSetIrreducible(pExpr);
1826b3bce662Sdanielk1977       break;
182719a775c2Sdrh     }
1828cce7d176Sdrh   }
1829b3bce662Sdanielk1977 
1830dfd2d9f6Sdrh   if( testAddr>=0 ){
183148f2d3b1Sdrh     sqlite3VdbeJumpHere(v, testAddr);
1832b3bce662Sdanielk1977   }
1833ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1834fc976065Sdanielk1977 
18351450bc6eSdrh   return rReg;
1836cce7d176Sdrh }
183751522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1838cce7d176Sdrh 
1839e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1840e3365e6cSdrh /*
1841e3365e6cSdrh ** Generate code for an IN expression.
1842e3365e6cSdrh **
1843e3365e6cSdrh **      x IN (SELECT ...)
1844e3365e6cSdrh **      x IN (value, value, ...)
1845e3365e6cSdrh **
1846e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1847e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1848e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1849e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1850e3365e6cSdrh ** RHS contains one or more NULL values.
1851e3365e6cSdrh **
1852e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1853e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1854e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1855e3365e6cSdrh ** within the RHS then fall through.
1856e3365e6cSdrh */
1857e3365e6cSdrh static void sqlite3ExprCodeIN(
1858e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1859e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1860e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1861e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1862e3365e6cSdrh ){
1863e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1864e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1865e3365e6cSdrh   int eType;            /* Type of the RHS */
1866e3365e6cSdrh   int r1;               /* Temporary use register */
1867e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1868e3365e6cSdrh 
1869e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1870e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1871e3365e6cSdrh   */
1872e3365e6cSdrh   v = pParse->pVdbe;
1873e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1874e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1875e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1876e3365e6cSdrh 
1877e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1878e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1879e3365e6cSdrh   ** P4 of OP_MakeRecord.
1880e3365e6cSdrh   */
1881e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1882e3365e6cSdrh 
1883e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1884e3365e6cSdrh   */
1885e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1886e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1887e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1888e3365e6cSdrh 
1889094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1890094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1891094430ebSdrh   */
1892094430ebSdrh   if( destIfNull==destIfFalse ){
1893094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1894094430ebSdrh     ** the same. */
1895094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1896094430ebSdrh   }else{
1897094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1898094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1899094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1900094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1901094430ebSdrh   }
1902e3365e6cSdrh 
1903e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1904e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1905e3365e6cSdrh     */
1906e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1907e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1908e3365e6cSdrh   }else{
1909e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1910e3365e6cSdrh     */
19118cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1912e3365e6cSdrh 
1913e3365e6cSdrh     /* If the set membership test fails, then the result of the
1914e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1915e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1916e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1917e3365e6cSdrh     ** expression is also NULL.
1918e3365e6cSdrh     */
1919e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1920e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1921e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1922e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1923e3365e6cSdrh       **
1924e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1925e3365e6cSdrh       ** for this particular IN operator.
1926e3365e6cSdrh       */
19278cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1928e3365e6cSdrh 
1929e3365e6cSdrh     }else{
1930e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1931e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1932e3365e6cSdrh       ** outcome.
1933e3365e6cSdrh       */
1934e3365e6cSdrh       int j1, j2, j3;
1935e3365e6cSdrh 
1936e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1937e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1938e3365e6cSdrh       ** over all of the code that follows.
1939e3365e6cSdrh       */
19408cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
1941e3365e6cSdrh 
1942e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1943e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1944e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1945e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1946e3365e6cSdrh       ** jump to destIfFalse.
1947e3365e6cSdrh       */
1948e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
19498cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
1950e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1951e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1952e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1953e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1954e3365e6cSdrh 
1955e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1956e3365e6cSdrh       ** the RHS contains a NULL
1957e3365e6cSdrh       */
1958e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1959e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1960e3365e6cSdrh 
1961e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1962e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1963e3365e6cSdrh       */
1964e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1965e3365e6cSdrh     }
1966e3365e6cSdrh   }
1967e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
1968e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
1969e3365e6cSdrh   VdbeComment((v, "end IN expr"));
1970e3365e6cSdrh }
1971e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
1972e3365e6cSdrh 
1973cce7d176Sdrh /*
1974598f1340Sdrh ** Duplicate an 8-byte value
1975598f1340Sdrh */
1976598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1977598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1978598f1340Sdrh   if( out ){
1979598f1340Sdrh     memcpy(out, in, 8);
1980598f1340Sdrh   }
1981598f1340Sdrh   return out;
1982598f1340Sdrh }
1983598f1340Sdrh 
198413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
1985598f1340Sdrh /*
1986598f1340Sdrh ** Generate an instruction that will put the floating point
19879cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
19880cf19ed8Sdrh **
19890cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
19900cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
19910cf19ed8Sdrh ** like the continuation of the number.
1992598f1340Sdrh */
1993b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1994fd773cf9Sdrh   if( ALWAYS(z!=0) ){
1995598f1340Sdrh     double value;
1996598f1340Sdrh     char *zV;
19979339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
1998d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
1999598f1340Sdrh     if( negateFlag ) value = -value;
2000598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
20019de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
2002598f1340Sdrh   }
2003598f1340Sdrh }
200413573c71Sdrh #endif
2005598f1340Sdrh 
2006598f1340Sdrh 
2007598f1340Sdrh /*
2008fec19aadSdrh ** Generate an instruction that will put the integer describe by
20099cbf3425Sdrh ** text z[0..n-1] into register iMem.
20100cf19ed8Sdrh **
20115f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2012fec19aadSdrh */
201313573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
201413573c71Sdrh   Vdbe *v = pParse->pVdbe;
201592b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
201633e619fcSdrh     int i = pExpr->u.iValue;
2017d50ffc41Sdrh     assert( i>=0 );
201892b01d53Sdrh     if( negFlag ) i = -i;
201992b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2020fd773cf9Sdrh   }else{
20215f1d6b61Sshaneh     int c;
20225f1d6b61Sshaneh     i64 value;
2023fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2024fd773cf9Sdrh     assert( z!=0 );
20255f1d6b61Sshaneh     c = sqlite3Atoi64(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
20265f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2027598f1340Sdrh       char *zV;
2028158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
2029598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
20309de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
2031fec19aadSdrh     }else{
203213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
203313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
203413573c71Sdrh #else
2035b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
203613573c71Sdrh #endif
2037fec19aadSdrh     }
2038fec19aadSdrh   }
2039c9cf901dSdanielk1977 }
2040fec19aadSdrh 
2041ceea3321Sdrh /*
2042ceea3321Sdrh ** Clear a cache entry.
2043ceea3321Sdrh */
2044ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2045ceea3321Sdrh   if( p->tempReg ){
2046ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2047ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2048ceea3321Sdrh     }
2049ceea3321Sdrh     p->tempReg = 0;
2050ceea3321Sdrh   }
2051ceea3321Sdrh }
2052ceea3321Sdrh 
2053ceea3321Sdrh 
2054ceea3321Sdrh /*
2055ceea3321Sdrh ** Record in the column cache that a particular column from a
2056ceea3321Sdrh ** particular table is stored in a particular register.
2057ceea3321Sdrh */
2058ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2059ceea3321Sdrh   int i;
2060ceea3321Sdrh   int minLru;
2061ceea3321Sdrh   int idxLru;
2062ceea3321Sdrh   struct yColCache *p;
2063ceea3321Sdrh 
206420411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
206520411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
206620411ea7Sdrh 
2067b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2068b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2069b6da74ebSdrh   ** with and without the column cache.
2070b6da74ebSdrh   */
20717e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2072b6da74ebSdrh 
207327ee406eSdrh   /* First replace any existing entry.
207427ee406eSdrh   **
207527ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
207627ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
207727ee406eSdrh   */
207827ee406eSdrh #ifndef NDEBUG
2079ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
208027ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2081ceea3321Sdrh   }
208227ee406eSdrh #endif
2083ceea3321Sdrh 
2084ceea3321Sdrh   /* Find an empty slot and replace it */
2085ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2086ceea3321Sdrh     if( p->iReg==0 ){
2087ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2088ceea3321Sdrh       p->iTable = iTab;
2089ceea3321Sdrh       p->iColumn = iCol;
2090ceea3321Sdrh       p->iReg = iReg;
2091ceea3321Sdrh       p->tempReg = 0;
2092ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2093ceea3321Sdrh       return;
2094ceea3321Sdrh     }
2095ceea3321Sdrh   }
2096ceea3321Sdrh 
2097ceea3321Sdrh   /* Replace the last recently used */
2098ceea3321Sdrh   minLru = 0x7fffffff;
2099ceea3321Sdrh   idxLru = -1;
2100ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2101ceea3321Sdrh     if( p->lru<minLru ){
2102ceea3321Sdrh       idxLru = i;
2103ceea3321Sdrh       minLru = p->lru;
2104ceea3321Sdrh     }
2105ceea3321Sdrh   }
210620411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2107ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2108ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2109ceea3321Sdrh     p->iTable = iTab;
2110ceea3321Sdrh     p->iColumn = iCol;
2111ceea3321Sdrh     p->iReg = iReg;
2112ceea3321Sdrh     p->tempReg = 0;
2113ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2114ceea3321Sdrh     return;
2115ceea3321Sdrh   }
2116ceea3321Sdrh }
2117ceea3321Sdrh 
2118ceea3321Sdrh /*
2119f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2120f49f3523Sdrh ** Purge the range of registers from the column cache.
2121ceea3321Sdrh */
2122f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2123ceea3321Sdrh   int i;
2124f49f3523Sdrh   int iLast = iReg + nReg - 1;
2125ceea3321Sdrh   struct yColCache *p;
2126ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2127f49f3523Sdrh     int r = p->iReg;
2128f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2129ceea3321Sdrh       cacheEntryClear(pParse, p);
2130ceea3321Sdrh       p->iReg = 0;
2131ceea3321Sdrh     }
2132ceea3321Sdrh   }
2133ceea3321Sdrh }
2134ceea3321Sdrh 
2135ceea3321Sdrh /*
2136ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2137ceea3321Sdrh ** added to the column cache after this call are removed when the
2138ceea3321Sdrh ** corresponding pop occurs.
2139ceea3321Sdrh */
2140ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2141ceea3321Sdrh   pParse->iCacheLevel++;
2142ceea3321Sdrh }
2143ceea3321Sdrh 
2144ceea3321Sdrh /*
2145ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2146ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2147ceea3321Sdrh ** to the state it was in N Pushes ago.
2148ceea3321Sdrh */
2149ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2150ceea3321Sdrh   int i;
2151ceea3321Sdrh   struct yColCache *p;
2152ceea3321Sdrh   assert( N>0 );
2153ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2154ceea3321Sdrh   pParse->iCacheLevel -= N;
2155ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2156ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2157ceea3321Sdrh       cacheEntryClear(pParse, p);
2158ceea3321Sdrh       p->iReg = 0;
2159ceea3321Sdrh     }
2160ceea3321Sdrh   }
2161ceea3321Sdrh }
2162945498f3Sdrh 
2163945498f3Sdrh /*
21645cd79239Sdrh ** When a cached column is reused, make sure that its register is
21655cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
21665cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
21675cd79239Sdrh ** get them all.
21685cd79239Sdrh */
21695cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
21705cd79239Sdrh   int i;
21715cd79239Sdrh   struct yColCache *p;
21725cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
21735cd79239Sdrh     if( p->iReg==iReg ){
21745cd79239Sdrh       p->tempReg = 0;
21755cd79239Sdrh     }
21765cd79239Sdrh   }
21775cd79239Sdrh }
21785cd79239Sdrh 
21795cd79239Sdrh /*
21805c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
21815c092e8aSdrh */
21825c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
21835c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
21845c092e8aSdrh   Table *pTab,    /* The table containing the value */
21855c092e8aSdrh   int iTabCur,    /* The cursor for this table */
21865c092e8aSdrh   int iCol,       /* Index of the column to extract */
21875c092e8aSdrh   int regOut      /* Extract the valud into this register */
21885c092e8aSdrh ){
21895c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
21905c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
21915c092e8aSdrh   }else{
21925c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
21935c092e8aSdrh     sqlite3VdbeAddOp3(v, op, iTabCur, iCol, regOut);
21945c092e8aSdrh   }
21955c092e8aSdrh   if( iCol>=0 ){
21965c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
21975c092e8aSdrh   }
21985c092e8aSdrh }
21995c092e8aSdrh 
22005c092e8aSdrh /*
2201945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2202e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2203e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2204e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2205e55cbd72Sdrh **
2206e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2207e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2208945498f3Sdrh */
2209e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2210e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
22112133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
22122133d822Sdrh   int iColumn,     /* Index of the table column */
22132133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2214a748fdccSdrh   int iReg,        /* Store results here */
2215a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
22162133d822Sdrh ){
2217e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2218e55cbd72Sdrh   int i;
2219da250ea5Sdrh   struct yColCache *p;
2220e55cbd72Sdrh 
2221ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2222b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2223ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
22245cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2225da250ea5Sdrh       return p->iReg;
2226e55cbd72Sdrh     }
2227e55cbd72Sdrh   }
2228e55cbd72Sdrh   assert( v!=0 );
22295c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2230a748fdccSdrh   if( p5 ){
2231a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2232a748fdccSdrh   }else{
2233ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2234a748fdccSdrh   }
2235e55cbd72Sdrh   return iReg;
2236e55cbd72Sdrh }
2237e55cbd72Sdrh 
2238e55cbd72Sdrh /*
2239ceea3321Sdrh ** Clear all column cache entries.
2240e55cbd72Sdrh */
2241ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2242e55cbd72Sdrh   int i;
2243ceea3321Sdrh   struct yColCache *p;
2244ceea3321Sdrh 
2245ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2246ceea3321Sdrh     if( p->iReg ){
2247ceea3321Sdrh       cacheEntryClear(pParse, p);
2248ceea3321Sdrh       p->iReg = 0;
2249e55cbd72Sdrh     }
2250da250ea5Sdrh   }
2251da250ea5Sdrh }
2252e55cbd72Sdrh 
2253e55cbd72Sdrh /*
2254da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2255da250ea5Sdrh ** registers starting with iStart.
2256e55cbd72Sdrh */
2257da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2258f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2259e55cbd72Sdrh }
2260e55cbd72Sdrh 
2261e55cbd72Sdrh /*
2262b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2263b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2264e55cbd72Sdrh */
2265b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2266e55cbd72Sdrh   int i;
2267ceea3321Sdrh   struct yColCache *p;
2268e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2269e8e4af76Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg-1);
2270ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2271ceea3321Sdrh     int x = p->iReg;
2272b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2273ceea3321Sdrh       p->iReg += iTo-iFrom;
2274e55cbd72Sdrh     }
2275e55cbd72Sdrh   }
2276945498f3Sdrh }
2277945498f3Sdrh 
2278f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
227992b01d53Sdrh /*
2280652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2281652fbf55Sdrh ** is used as part of the column cache.
2282f49f3523Sdrh **
2283f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2284f49f3523Sdrh ** and does not appear in a normal build.
2285652fbf55Sdrh */
2286652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2287652fbf55Sdrh   int i;
2288ceea3321Sdrh   struct yColCache *p;
2289ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2290ceea3321Sdrh     int r = p->iReg;
2291f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2292652fbf55Sdrh   }
2293652fbf55Sdrh   return 0;
2294652fbf55Sdrh }
2295f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2296652fbf55Sdrh 
2297652fbf55Sdrh /*
2298cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
22992dcef11bSdrh ** expression.  Attempt to store the results in register "target".
23002dcef11bSdrh ** Return the register where results are stored.
2301389a1adbSdrh **
23028b213899Sdrh ** With this routine, there is no guarantee that results will
23032dcef11bSdrh ** be stored in target.  The result might be stored in some other
23042dcef11bSdrh ** register if it is convenient to do so.  The calling function
23052dcef11bSdrh ** must check the return code and move the results to the desired
23062dcef11bSdrh ** register.
2307cce7d176Sdrh */
2308678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
23092dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
23102dcef11bSdrh   int op;                   /* The opcode being coded */
23112dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
23122dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
23132dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2314678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
231520411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2316ffe07b2dSdrh 
23179cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
231820411ea7Sdrh   if( v==0 ){
231920411ea7Sdrh     assert( pParse->db->mallocFailed );
232020411ea7Sdrh     return 0;
232120411ea7Sdrh   }
2322389a1adbSdrh 
2323389a1adbSdrh   if( pExpr==0 ){
2324389a1adbSdrh     op = TK_NULL;
2325389a1adbSdrh   }else{
2326f2bc013cSdrh     op = pExpr->op;
2327389a1adbSdrh   }
2328f2bc013cSdrh   switch( op ){
232913449892Sdrh     case TK_AGG_COLUMN: {
233013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
233113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
233213449892Sdrh       if( !pAggInfo->directMode ){
23339de221dfSdrh         assert( pCol->iMem>0 );
23349de221dfSdrh         inReg = pCol->iMem;
233513449892Sdrh         break;
233613449892Sdrh       }else if( pAggInfo->useSortingIdx ){
23375134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2338389a1adbSdrh                               pCol->iSorterColumn, target);
233913449892Sdrh         break;
234013449892Sdrh       }
234113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
234213449892Sdrh     }
2343967e8b73Sdrh     case TK_COLUMN: {
2344ffe07b2dSdrh       if( pExpr->iTable<0 ){
2345ffe07b2dSdrh         /* This only happens when coding check constraints */
2346aa9b8963Sdrh         assert( pParse->ckBase>0 );
2347aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2348c4a3c779Sdrh       }else{
2349e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2350a748fdccSdrh                                  pExpr->iColumn, pExpr->iTable, target,
2351a748fdccSdrh                                  pExpr->op2);
23522282792aSdrh       }
2353cce7d176Sdrh       break;
2354cce7d176Sdrh     }
2355cce7d176Sdrh     case TK_INTEGER: {
235613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2357fec19aadSdrh       break;
235851e9a445Sdrh     }
235913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2360598f1340Sdrh     case TK_FLOAT: {
236133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
236233e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2363598f1340Sdrh       break;
2364598f1340Sdrh     }
236513573c71Sdrh #endif
2366fec19aadSdrh     case TK_STRING: {
236733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
236833e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2369cce7d176Sdrh       break;
2370cce7d176Sdrh     }
2371f0863fe5Sdrh     case TK_NULL: {
23729de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2373f0863fe5Sdrh       break;
2374f0863fe5Sdrh     }
23755338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2376c572ef7fSdanielk1977     case TK_BLOB: {
23776c8c6cecSdrh       int n;
23786c8c6cecSdrh       const char *z;
2379ca48c90fSdrh       char *zBlob;
238033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
238133e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
238233e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
238333e619fcSdrh       z = &pExpr->u.zToken[2];
2384b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2385b7916a78Sdrh       assert( z[n]=='\'' );
2386ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2387ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2388c572ef7fSdanielk1977       break;
2389c572ef7fSdanielk1977     }
23905338a5f7Sdanielk1977 #endif
239150457896Sdrh     case TK_VARIABLE: {
239233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
239333e619fcSdrh       assert( pExpr->u.zToken!=0 );
239433e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2395eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
239633e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
239704e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
239804e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
239904e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2400895d7472Sdrh       }
240150457896Sdrh       break;
240250457896Sdrh     }
24034e0cff60Sdrh     case TK_REGISTER: {
24049de221dfSdrh       inReg = pExpr->iTable;
24054e0cff60Sdrh       break;
24064e0cff60Sdrh     }
24078b213899Sdrh     case TK_AS: {
24087445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
24098b213899Sdrh       break;
24108b213899Sdrh     }
2411487e262fSdrh #ifndef SQLITE_OMIT_CAST
2412487e262fSdrh     case TK_CAST: {
2413487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2414f0113000Sdanielk1977       int aff, to_op;
24152dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
241633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
241733e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2418f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2419f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2420f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2421f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2422f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2423f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2424c5499befSdrh       testcase( to_op==OP_ToText );
2425c5499befSdrh       testcase( to_op==OP_ToBlob );
2426c5499befSdrh       testcase( to_op==OP_ToNumeric );
2427c5499befSdrh       testcase( to_op==OP_ToInt );
2428c5499befSdrh       testcase( to_op==OP_ToReal );
24291735fa88Sdrh       if( inReg!=target ){
24301735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
24311735fa88Sdrh         inReg = target;
24321735fa88Sdrh       }
24332dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2434c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2435b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2436487e262fSdrh       break;
2437487e262fSdrh     }
2438487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2439c9b84a1fSdrh     case TK_LT:
2440c9b84a1fSdrh     case TK_LE:
2441c9b84a1fSdrh     case TK_GT:
2442c9b84a1fSdrh     case TK_GE:
2443c9b84a1fSdrh     case TK_NE:
2444c9b84a1fSdrh     case TK_EQ: {
2445f2bc013cSdrh       assert( TK_LT==OP_Lt );
2446f2bc013cSdrh       assert( TK_LE==OP_Le );
2447f2bc013cSdrh       assert( TK_GT==OP_Gt );
2448f2bc013cSdrh       assert( TK_GE==OP_Ge );
2449f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2450f2bc013cSdrh       assert( TK_NE==OP_Ne );
2451c5499befSdrh       testcase( op==TK_LT );
2452c5499befSdrh       testcase( op==TK_LE );
2453c5499befSdrh       testcase( op==TK_GT );
2454c5499befSdrh       testcase( op==TK_GE );
2455c5499befSdrh       testcase( op==TK_EQ );
2456c5499befSdrh       testcase( op==TK_NE );
2457b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2458b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
245935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
246035573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2461c5499befSdrh       testcase( regFree1==0 );
2462c5499befSdrh       testcase( regFree2==0 );
2463a37cdde0Sdanielk1977       break;
2464c9b84a1fSdrh     }
24656a2fe093Sdrh     case TK_IS:
24666a2fe093Sdrh     case TK_ISNOT: {
24676a2fe093Sdrh       testcase( op==TK_IS );
24686a2fe093Sdrh       testcase( op==TK_ISNOT );
2469b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2470b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24716a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
24726a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
24736a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
24746a2fe093Sdrh       testcase( regFree1==0 );
24756a2fe093Sdrh       testcase( regFree2==0 );
24766a2fe093Sdrh       break;
24776a2fe093Sdrh     }
2478cce7d176Sdrh     case TK_AND:
2479cce7d176Sdrh     case TK_OR:
2480cce7d176Sdrh     case TK_PLUS:
2481cce7d176Sdrh     case TK_STAR:
2482cce7d176Sdrh     case TK_MINUS:
2483bf4133cbSdrh     case TK_REM:
2484bf4133cbSdrh     case TK_BITAND:
2485bf4133cbSdrh     case TK_BITOR:
248617c40294Sdrh     case TK_SLASH:
2487bf4133cbSdrh     case TK_LSHIFT:
2488855eb1cfSdrh     case TK_RSHIFT:
24890040077dSdrh     case TK_CONCAT: {
2490f2bc013cSdrh       assert( TK_AND==OP_And );
2491f2bc013cSdrh       assert( TK_OR==OP_Or );
2492f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2493f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2494f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2495f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2496f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2497f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2498f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2499f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2500f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2501c5499befSdrh       testcase( op==TK_AND );
2502c5499befSdrh       testcase( op==TK_OR );
2503c5499befSdrh       testcase( op==TK_PLUS );
2504c5499befSdrh       testcase( op==TK_MINUS );
2505c5499befSdrh       testcase( op==TK_REM );
2506c5499befSdrh       testcase( op==TK_BITAND );
2507c5499befSdrh       testcase( op==TK_BITOR );
2508c5499befSdrh       testcase( op==TK_SLASH );
2509c5499befSdrh       testcase( op==TK_LSHIFT );
2510c5499befSdrh       testcase( op==TK_RSHIFT );
2511c5499befSdrh       testcase( op==TK_CONCAT );
25122dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
25132dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25145b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2515c5499befSdrh       testcase( regFree1==0 );
2516c5499befSdrh       testcase( regFree2==0 );
25170040077dSdrh       break;
25180040077dSdrh     }
2519cce7d176Sdrh     case TK_UMINUS: {
2520fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2521fec19aadSdrh       assert( pLeft );
252213573c71Sdrh       if( pLeft->op==TK_INTEGER ){
252313573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
252413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
252513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
252633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
252733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
252813573c71Sdrh #endif
25293c84ddffSdrh       }else{
25302dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
25313c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2532e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
25332dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2534c5499befSdrh         testcase( regFree2==0 );
25353c84ddffSdrh       }
25369de221dfSdrh       inReg = target;
25376e142f54Sdrh       break;
25386e142f54Sdrh     }
2539bf4133cbSdrh     case TK_BITNOT:
25406e142f54Sdrh     case TK_NOT: {
2541f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2542f2bc013cSdrh       assert( TK_NOT==OP_Not );
2543c5499befSdrh       testcase( op==TK_BITNOT );
2544c5499befSdrh       testcase( op==TK_NOT );
2545e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2546e99fa2afSdrh       testcase( regFree1==0 );
2547e99fa2afSdrh       inReg = target;
2548e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2549cce7d176Sdrh       break;
2550cce7d176Sdrh     }
2551cce7d176Sdrh     case TK_ISNULL:
2552cce7d176Sdrh     case TK_NOTNULL: {
25536a288a33Sdrh       int addr;
2554f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2555f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2556c5499befSdrh       testcase( op==TK_ISNULL );
2557c5499befSdrh       testcase( op==TK_NOTNULL );
25589de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
25592dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2560c5499befSdrh       testcase( regFree1==0 );
25612dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
25629de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
25636a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2564a37cdde0Sdanielk1977       break;
2565f2bc013cSdrh     }
25662282792aSdrh     case TK_AGG_FUNCTION: {
256713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
25687e56e711Sdrh       if( pInfo==0 ){
256933e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
257033e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
25717e56e711Sdrh       }else{
25729de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
25737e56e711Sdrh       }
25742282792aSdrh       break;
25752282792aSdrh     }
2576b71090fdSdrh     case TK_CONST_FUNC:
2577cce7d176Sdrh     case TK_FUNCTION: {
257812ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
257912ffee8cSdrh       int nFarg;             /* Number of function arguments */
258012ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
258112ffee8cSdrh       int nId;               /* Length of the function name in bytes */
258212ffee8cSdrh       const char *zId;       /* The function name */
258312ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
258412ffee8cSdrh       int i;                 /* Loop counter */
258512ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
258612ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
258717435752Sdrh 
25886ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2589c5499befSdrh       testcase( op==TK_CONST_FUNC );
2590c5499befSdrh       testcase( op==TK_FUNCTION );
2591b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
259212ffee8cSdrh         pFarg = 0;
259312ffee8cSdrh       }else{
259412ffee8cSdrh         pFarg = pExpr->x.pList;
259512ffee8cSdrh       }
259612ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
259733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
259833e619fcSdrh       zId = pExpr->u.zToken;
2599b7916a78Sdrh       nId = sqlite3Strlen30(zId);
260012ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2601feb306f5Sdrh       if( pDef==0 ){
2602feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2603feb306f5Sdrh         break;
2604feb306f5Sdrh       }
2605ae6bb957Sdrh 
2606ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2607ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2608ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2609ae6bb957Sdrh       */
2610ae6bb957Sdrh       if( pDef->flags & SQLITE_FUNC_COALESCE ){
2611ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2612ae6bb957Sdrh         assert( nFarg>=2 );
2613ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2614ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2615ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2616f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2617ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2618ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2619ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2620ae6bb957Sdrh         }
2621ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2622ae6bb957Sdrh         break;
2623ae6bb957Sdrh       }
2624ae6bb957Sdrh 
2625ae6bb957Sdrh 
262612ffee8cSdrh       if( pFarg ){
262712ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2628a748fdccSdrh 
2629a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2630a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2631a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2632a748fdccSdrh         ** loading.
2633a748fdccSdrh         */
2634a748fdccSdrh         if( (pDef->flags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
26354e245a4cSdrh           u8 exprOp;
2636a748fdccSdrh           assert( nFarg==1 );
2637a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
26384e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
26394e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2640a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2641a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2642a748fdccSdrh             testcase( pDef->flags==SQLITE_FUNC_LENGTH );
2643a748fdccSdrh             pFarg->a[0].pExpr->op2 = pDef->flags;
2644a748fdccSdrh           }
2645a748fdccSdrh         }
2646a748fdccSdrh 
2647d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
264812ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2649d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2650892d3179Sdrh       }else{
265112ffee8cSdrh         r1 = 0;
2652892d3179Sdrh       }
2653b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2654a43fa227Sdrh       /* Possibly overload the function if the first argument is
2655a43fa227Sdrh       ** a virtual table column.
2656a43fa227Sdrh       **
2657a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2658a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2659a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2660a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2661a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2662a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2663a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2664a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2665a43fa227Sdrh       */
266612ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
266712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
266812ffee8cSdrh       }else if( nFarg>0 ){
266912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2670b7f6f68fSdrh       }
2671b7f6f68fSdrh #endif
2672f7bca574Sdrh       for(i=0; i<nFarg; i++){
2673f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
267413449892Sdrh           constMask |= (1<<i);
2675d02eb1fdSdanielk1977         }
2676e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
267712ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2678dc1bdc4fSdanielk1977         }
2679dc1bdc4fSdanielk1977       }
2680e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
26818b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
268266a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2683682f68b0Sdanielk1977       }
26842dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
268566a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
268612ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
268712ffee8cSdrh       if( nFarg ){
268812ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
26892dcef11bSdrh       }
26906ec2733bSdrh       break;
26916ec2733bSdrh     }
2692fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2693fe2093d7Sdrh     case TK_EXISTS:
269419a775c2Sdrh     case TK_SELECT: {
2695c5499befSdrh       testcase( op==TK_EXISTS );
2696c5499befSdrh       testcase( op==TK_SELECT );
26971450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
269819a775c2Sdrh       break;
269919a775c2Sdrh     }
2700fef5208cSdrh     case TK_IN: {
2701e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2702e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2703e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2704e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
270566ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2706e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2707e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2708e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2709fef5208cSdrh       break;
2710fef5208cSdrh     }
2711e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2712e3365e6cSdrh 
2713e3365e6cSdrh 
27142dcef11bSdrh     /*
27152dcef11bSdrh     **    x BETWEEN y AND z
27162dcef11bSdrh     **
27172dcef11bSdrh     ** This is equivalent to
27182dcef11bSdrh     **
27192dcef11bSdrh     **    x>=y AND x<=z
27202dcef11bSdrh     **
27212dcef11bSdrh     ** X is stored in pExpr->pLeft.
27222dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
27232dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
27242dcef11bSdrh     */
2725fef5208cSdrh     case TK_BETWEEN: {
2726be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
27276ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2728be5c89acSdrh       Expr *pRight = pLItem->pExpr;
272935573356Sdrh 
2730b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2731b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2732c5499befSdrh       testcase( regFree1==0 );
2733c5499befSdrh       testcase( regFree2==0 );
27342dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2735678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
273635573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
273735573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2738be5c89acSdrh       pLItem++;
2739be5c89acSdrh       pRight = pLItem->pExpr;
27402dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
27412dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2742c5499befSdrh       testcase( regFree2==0 );
2743678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2744678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
27452dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2746678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2747fef5208cSdrh       break;
2748fef5208cSdrh     }
27494f07e5fbSdrh     case TK_UPLUS: {
27502dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2751a2e00042Sdrh       break;
2752a2e00042Sdrh     }
27532dcef11bSdrh 
2754165921a7Sdan     case TK_TRIGGER: {
275565a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
275665a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
275765a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
275865a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
275965a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
276065a7cd16Sdan       ** read the rowid field.
276165a7cd16Sdan       **
276265a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
276365a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
276465a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
276565a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
276665a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
276765a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
276865a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
276965a7cd16Sdan       ** example, if the table on which triggers are being fired is
277065a7cd16Sdan       ** declared as:
277165a7cd16Sdan       **
277265a7cd16Sdan       **   CREATE TABLE t1(a, b);
277365a7cd16Sdan       **
277465a7cd16Sdan       ** Then p1 is interpreted as follows:
277565a7cd16Sdan       **
277665a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
277765a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
277865a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
277965a7cd16Sdan       */
27802832ad42Sdan       Table *pTab = pExpr->pTab;
278165a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
278265a7cd16Sdan 
278365a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
278465a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
278565a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
278665a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
278765a7cd16Sdan 
278865a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
278976d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2790165921a7Sdan         (pExpr->iTable ? "new" : "old"),
279176d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
279276d462eeSdan         target
2793165921a7Sdan       ));
279465a7cd16Sdan 
279544dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
279665a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
279765a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
27982832ad42Sdan       if( pExpr->iColumn>=0
27992832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
28002832ad42Sdan       ){
28012832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
28022832ad42Sdan       }
280344dbca83Sdrh #endif
2804165921a7Sdan       break;
2805165921a7Sdan     }
2806165921a7Sdan 
2807165921a7Sdan 
28082dcef11bSdrh     /*
28092dcef11bSdrh     ** Form A:
28102dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28112dcef11bSdrh     **
28122dcef11bSdrh     ** Form B:
28132dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28142dcef11bSdrh     **
28152dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
28162dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
28172dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
28182dcef11bSdrh     **
28192dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
28202dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
28212dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
28222dcef11bSdrh     ** exprssion is NULL.
28232dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
28242dcef11bSdrh     **
28252dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
28262dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
28272dcef11bSdrh     ** no ELSE term, NULL.
28282dcef11bSdrh     */
282933cd4909Sdrh     default: assert( op==TK_CASE ); {
28302dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
28312dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
28322dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
28332dcef11bSdrh       int i;                            /* Loop counter */
28342dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
28352dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
28362dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
28372dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
28382dcef11bSdrh       Expr *pX;                         /* The X expression */
28391bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2840ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
284117a7f8ddSdrh 
28426ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
28436ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
28446ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
28456ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2846be5c89acSdrh       aListelem = pEList->a;
2847be5c89acSdrh       nExpr = pEList->nExpr;
28482dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
28492dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
28502dcef11bSdrh         cacheX = *pX;
285133cd4909Sdrh         testcase( pX->op==TK_COLUMN );
285233cd4909Sdrh         testcase( pX->op==TK_REGISTER );
28532dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2854c5499befSdrh         testcase( regFree1==0 );
28552dcef11bSdrh         cacheX.op = TK_REGISTER;
28562dcef11bSdrh         opCompare.op = TK_EQ;
28572dcef11bSdrh         opCompare.pLeft = &cacheX;
28582dcef11bSdrh         pTest = &opCompare;
28598b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
28608b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
28618b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
28628b1db07fSdrh         ** purposes and possibly overwritten.  */
28638b1db07fSdrh         regFree1 = 0;
2864cce7d176Sdrh       }
2865f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2866ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28672dcef11bSdrh         if( pX ){
28681bd10f8aSdrh           assert( pTest!=0 );
28692dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2870f5905aa7Sdrh         }else{
28712dcef11bSdrh           pTest = aListelem[i].pExpr;
287217a7f8ddSdrh         }
28732dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
287433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
28752dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2876c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2877c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
28789de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
28792dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2880ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
28812dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2882f570f011Sdrh       }
288317a7f8ddSdrh       if( pExpr->pRight ){
2884ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28859de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2886ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
288717a7f8ddSdrh       }else{
28889de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
288917a7f8ddSdrh       }
2890c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2891c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
28922dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
28936f34903eSdanielk1977       break;
28946f34903eSdanielk1977     }
28955338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
28966f34903eSdanielk1977     case TK_RAISE: {
2897165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2898165921a7Sdan            || pExpr->affinity==OE_Abort
2899165921a7Sdan            || pExpr->affinity==OE_Fail
2900165921a7Sdan            || pExpr->affinity==OE_Ignore
2901165921a7Sdan       );
2902e0af83acSdan       if( !pParse->pTriggerTab ){
2903e0af83acSdan         sqlite3ErrorMsg(pParse,
2904e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2905e0af83acSdan         return 0;
2906e0af83acSdan       }
2907e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2908e0af83acSdan         sqlite3MayAbort(pParse);
2909e0af83acSdan       }
291033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2911e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2912e0af83acSdan         sqlite3VdbeAddOp4(
2913e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2914e0af83acSdan       }else{
2915e0af83acSdan         sqlite3HaltConstraint(pParse, pExpr->affinity, pExpr->u.zToken, 0);
2916e0af83acSdan       }
2917e0af83acSdan 
2918ffe07b2dSdrh       break;
291917a7f8ddSdrh     }
29205338a5f7Sdanielk1977 #endif
2921ffe07b2dSdrh   }
29222dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
29232dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
29242dcef11bSdrh   return inReg;
29255b6afba9Sdrh }
29262dcef11bSdrh 
29272dcef11bSdrh /*
29282dcef11bSdrh ** Generate code to evaluate an expression and store the results
29292dcef11bSdrh ** into a register.  Return the register number where the results
29302dcef11bSdrh ** are stored.
29312dcef11bSdrh **
29322dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2933678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
29342dcef11bSdrh ** a temporary, then set *pReg to zero.
29352dcef11bSdrh */
29362dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
29372dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
29382dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
29392dcef11bSdrh   if( r2==r1 ){
29402dcef11bSdrh     *pReg = r1;
29412dcef11bSdrh   }else{
29422dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
29432dcef11bSdrh     *pReg = 0;
29442dcef11bSdrh   }
29452dcef11bSdrh   return r2;
29462dcef11bSdrh }
29472dcef11bSdrh 
29482dcef11bSdrh /*
29492dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
29502dcef11bSdrh ** results in register target.  The results are guaranteed to appear
29512dcef11bSdrh ** in register target.
29522dcef11bSdrh */
29532dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
29549cbf3425Sdrh   int inReg;
29559cbf3425Sdrh 
29569cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
2957ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
2958ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
2959ebc16717Sdrh   }else{
29609cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
29610e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
29620e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
29639cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
296417a7f8ddSdrh     }
2965ebc16717Sdrh   }
2966389a1adbSdrh   return target;
2967cce7d176Sdrh }
2968cce7d176Sdrh 
2969cce7d176Sdrh /*
29702dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2971de4fcfddSdrh ** in register target.
297225303780Sdrh **
29732dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
29742dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
29752dcef11bSdrh ** the result is a copy of the cache register.
29762dcef11bSdrh **
29772dcef11bSdrh ** This routine is used for expressions that are used multiple
29782dcef11bSdrh ** times.  They are evaluated once and the results of the expression
29792dcef11bSdrh ** are reused.
298025303780Sdrh */
29812dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
298225303780Sdrh   Vdbe *v = pParse->pVdbe;
29832dcef11bSdrh   int inReg;
29842dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2985de4fcfddSdrh   assert( target>0 );
298620bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
298720bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
298820bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
298920bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
299020bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
299120bc393cSdrh   ** modifications or enhancements. */
299220bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
299325303780Sdrh     int iMem;
29942dcef11bSdrh     iMem = ++pParse->nMem;
29952dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
29962dcef11bSdrh     pExpr->iTable = iMem;
2997937d0deaSdan     pExpr->op2 = pExpr->op;
299825303780Sdrh     pExpr->op = TK_REGISTER;
299925303780Sdrh   }
30002dcef11bSdrh   return inReg;
300125303780Sdrh }
30022dcef11bSdrh 
3003678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
30047e02e5e6Sdrh /*
30057e02e5e6Sdrh ** Generate a human-readable explanation of an expression tree.
30067e02e5e6Sdrh */
3007a84203a0Sdrh void sqlite3ExplainExpr(Vdbe *pOut, Expr *pExpr){
3008a84203a0Sdrh   int op;                   /* The opcode being coded */
3009a84203a0Sdrh   const char *zBinOp = 0;   /* Binary operator */
3010a84203a0Sdrh   const char *zUniOp = 0;   /* Unary operator */
3011a84203a0Sdrh   if( pExpr==0 ){
3012a84203a0Sdrh     op = TK_NULL;
30137e02e5e6Sdrh   }else{
3014a84203a0Sdrh     op = pExpr->op;
30157e02e5e6Sdrh   }
3016a84203a0Sdrh   switch( op ){
3017a84203a0Sdrh     case TK_AGG_COLUMN: {
301804b8342bSdrh       sqlite3ExplainPrintf(pOut, "AGG{%d:%d}",
301904b8342bSdrh             pExpr->iTable, pExpr->iColumn);
3020a84203a0Sdrh       break;
30217e02e5e6Sdrh     }
3022a84203a0Sdrh     case TK_COLUMN: {
3023a84203a0Sdrh       if( pExpr->iTable<0 ){
3024a84203a0Sdrh         /* This only happens when coding check constraints */
3025a84203a0Sdrh         sqlite3ExplainPrintf(pOut, "COLUMN(%d)", pExpr->iColumn);
3026a84203a0Sdrh       }else{
302704b8342bSdrh         sqlite3ExplainPrintf(pOut, "{%d:%d}",
302804b8342bSdrh                              pExpr->iTable, pExpr->iColumn);
3029a84203a0Sdrh       }
3030a84203a0Sdrh       break;
3031a84203a0Sdrh     }
3032a84203a0Sdrh     case TK_INTEGER: {
3033a84203a0Sdrh       if( pExpr->flags & EP_IntValue ){
303404b8342bSdrh         sqlite3ExplainPrintf(pOut, "%d", pExpr->u.iValue);
3035a84203a0Sdrh       }else{
303604b8342bSdrh         sqlite3ExplainPrintf(pOut, "%s", pExpr->u.zToken);
3037a84203a0Sdrh       }
3038a84203a0Sdrh       break;
3039a84203a0Sdrh     }
3040a84203a0Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3041a84203a0Sdrh     case TK_FLOAT: {
304204b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3043a84203a0Sdrh       break;
3044a84203a0Sdrh     }
3045a84203a0Sdrh #endif
3046a84203a0Sdrh     case TK_STRING: {
304704b8342bSdrh       sqlite3ExplainPrintf(pOut,"%Q", pExpr->u.zToken);
3048a84203a0Sdrh       break;
3049a84203a0Sdrh     }
3050a84203a0Sdrh     case TK_NULL: {
3051a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"NULL");
3052a84203a0Sdrh       break;
3053a84203a0Sdrh     }
3054a84203a0Sdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
3055a84203a0Sdrh     case TK_BLOB: {
305604b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3057a84203a0Sdrh       break;
3058a84203a0Sdrh     }
3059a84203a0Sdrh #endif
3060a84203a0Sdrh     case TK_VARIABLE: {
3061a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"VARIABLE(%s,%d)",
3062a84203a0Sdrh                            pExpr->u.zToken, pExpr->iColumn);
3063a84203a0Sdrh       break;
3064a84203a0Sdrh     }
3065a84203a0Sdrh     case TK_REGISTER: {
3066a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"REGISTER(%d)", pExpr->iTable);
3067a84203a0Sdrh       break;
3068a84203a0Sdrh     }
3069a84203a0Sdrh     case TK_AS: {
3070a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3071a84203a0Sdrh       break;
3072a84203a0Sdrh     }
3073a84203a0Sdrh #ifndef SQLITE_OMIT_CAST
3074a84203a0Sdrh     case TK_CAST: {
3075a84203a0Sdrh       /* Expressions of the form:   CAST(pLeft AS token) */
3076a84203a0Sdrh       const char *zAff = "unk";
3077a84203a0Sdrh       switch( sqlite3AffinityType(pExpr->u.zToken) ){
3078a84203a0Sdrh         case SQLITE_AFF_TEXT:    zAff = "TEXT";     break;
3079a84203a0Sdrh         case SQLITE_AFF_NONE:    zAff = "NONE";     break;
3080a84203a0Sdrh         case SQLITE_AFF_NUMERIC: zAff = "NUMERIC";  break;
3081a84203a0Sdrh         case SQLITE_AFF_INTEGER: zAff = "INTEGER";  break;
3082a84203a0Sdrh         case SQLITE_AFF_REAL:    zAff = "REAL";     break;
3083a84203a0Sdrh       }
3084a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CAST-%s(", zAff);
3085a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3086a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3087a84203a0Sdrh       break;
3088a84203a0Sdrh     }
3089a84203a0Sdrh #endif /* SQLITE_OMIT_CAST */
3090a84203a0Sdrh     case TK_LT:      zBinOp = "LT";     break;
3091a84203a0Sdrh     case TK_LE:      zBinOp = "LE";     break;
3092a84203a0Sdrh     case TK_GT:      zBinOp = "GT";     break;
3093a84203a0Sdrh     case TK_GE:      zBinOp = "GE";     break;
3094a84203a0Sdrh     case TK_NE:      zBinOp = "NE";     break;
3095a84203a0Sdrh     case TK_EQ:      zBinOp = "EQ";     break;
3096a84203a0Sdrh     case TK_IS:      zBinOp = "IS";     break;
3097a84203a0Sdrh     case TK_ISNOT:   zBinOp = "ISNOT";  break;
3098a84203a0Sdrh     case TK_AND:     zBinOp = "AND";    break;
3099a84203a0Sdrh     case TK_OR:      zBinOp = "OR";     break;
3100a84203a0Sdrh     case TK_PLUS:    zBinOp = "ADD";    break;
3101a84203a0Sdrh     case TK_STAR:    zBinOp = "MUL";    break;
3102a84203a0Sdrh     case TK_MINUS:   zBinOp = "SUB";    break;
3103a84203a0Sdrh     case TK_REM:     zBinOp = "REM";    break;
3104a84203a0Sdrh     case TK_BITAND:  zBinOp = "BITAND"; break;
3105a84203a0Sdrh     case TK_BITOR:   zBinOp = "BITOR";  break;
3106a84203a0Sdrh     case TK_SLASH:   zBinOp = "DIV";    break;
3107a84203a0Sdrh     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
3108a84203a0Sdrh     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
3109a84203a0Sdrh     case TK_CONCAT:  zBinOp = "CONCAT"; break;
3110a84203a0Sdrh 
3111a84203a0Sdrh     case TK_UMINUS:  zUniOp = "UMINUS"; break;
3112a84203a0Sdrh     case TK_UPLUS:   zUniOp = "UPLUS";  break;
3113a84203a0Sdrh     case TK_BITNOT:  zUniOp = "BITNOT"; break;
3114a84203a0Sdrh     case TK_NOT:     zUniOp = "NOT";    break;
3115a84203a0Sdrh     case TK_ISNULL:  zUniOp = "ISNULL"; break;
3116a84203a0Sdrh     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
3117a84203a0Sdrh 
3118a84203a0Sdrh     case TK_AGG_FUNCTION:
3119a84203a0Sdrh     case TK_CONST_FUNC:
3120a84203a0Sdrh     case TK_FUNCTION: {
3121a84203a0Sdrh       ExprList *pFarg;       /* List of function arguments */
3122a84203a0Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
3123a84203a0Sdrh         pFarg = 0;
3124a84203a0Sdrh       }else{
3125a84203a0Sdrh         pFarg = pExpr->x.pList;
3126a84203a0Sdrh       }
3127ed551b95Sdrh       if( op==TK_AGG_FUNCTION ){
3128ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "AGG_FUNCTION%d:%s(",
3129ed551b95Sdrh                              pExpr->op2, pExpr->u.zToken);
3130ed551b95Sdrh       }else{
3131ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "FUNCTION:%s(", pExpr->u.zToken);
3132ed551b95Sdrh       }
3133a84203a0Sdrh       if( pFarg ){
3134a84203a0Sdrh         sqlite3ExplainExprList(pOut, pFarg);
31357e02e5e6Sdrh       }
31367e02e5e6Sdrh       sqlite3ExplainPrintf(pOut, ")");
3137a84203a0Sdrh       break;
3138a84203a0Sdrh     }
3139a84203a0Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3140a84203a0Sdrh     case TK_EXISTS: {
3141a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "EXISTS(");
3142a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3143a84203a0Sdrh       sqlite3ExplainPrintf(pOut,")");
3144a84203a0Sdrh       break;
3145a84203a0Sdrh     }
3146a84203a0Sdrh     case TK_SELECT: {
3147a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "(");
3148a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3149a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3150a84203a0Sdrh       break;
3151a84203a0Sdrh     }
3152a84203a0Sdrh     case TK_IN: {
3153a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "IN(");
3154a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3155a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3156a84203a0Sdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3157a84203a0Sdrh         sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3158a84203a0Sdrh       }else{
3159a84203a0Sdrh         sqlite3ExplainExprList(pOut, pExpr->x.pList);
3160a84203a0Sdrh       }
3161a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3162a84203a0Sdrh       break;
3163a84203a0Sdrh     }
3164a84203a0Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3165a84203a0Sdrh 
3166a84203a0Sdrh     /*
3167a84203a0Sdrh     **    x BETWEEN y AND z
3168a84203a0Sdrh     **
3169a84203a0Sdrh     ** This is equivalent to
3170a84203a0Sdrh     **
3171a84203a0Sdrh     **    x>=y AND x<=z
3172a84203a0Sdrh     **
3173a84203a0Sdrh     ** X is stored in pExpr->pLeft.
3174a84203a0Sdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
3175a84203a0Sdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
3176a84203a0Sdrh     */
3177a84203a0Sdrh     case TK_BETWEEN: {
3178a84203a0Sdrh       Expr *pX = pExpr->pLeft;
3179a84203a0Sdrh       Expr *pY = pExpr->x.pList->a[0].pExpr;
3180a84203a0Sdrh       Expr *pZ = pExpr->x.pList->a[1].pExpr;
3181a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "BETWEEN(");
3182a84203a0Sdrh       sqlite3ExplainExpr(pOut, pX);
3183a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3184a84203a0Sdrh       sqlite3ExplainExpr(pOut, pY);
3185a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3186a84203a0Sdrh       sqlite3ExplainExpr(pOut, pZ);
3187a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3188a84203a0Sdrh       break;
3189a84203a0Sdrh     }
3190a84203a0Sdrh     case TK_TRIGGER: {
3191a84203a0Sdrh       /* If the opcode is TK_TRIGGER, then the expression is a reference
3192a84203a0Sdrh       ** to a column in the new.* or old.* pseudo-tables available to
3193a84203a0Sdrh       ** trigger programs. In this case Expr.iTable is set to 1 for the
3194a84203a0Sdrh       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3195a84203a0Sdrh       ** is set to the column of the pseudo-table to read, or to -1 to
3196a84203a0Sdrh       ** read the rowid field.
3197a84203a0Sdrh       */
3198a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "%s(%d)",
3199a84203a0Sdrh           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
3200a84203a0Sdrh       break;
3201a84203a0Sdrh     }
3202a84203a0Sdrh     case TK_CASE: {
3203a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CASE(");
3204a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3205a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3206a84203a0Sdrh       sqlite3ExplainExprList(pOut, pExpr->x.pList);
3207a84203a0Sdrh       break;
3208a84203a0Sdrh     }
3209a84203a0Sdrh #ifndef SQLITE_OMIT_TRIGGER
3210a84203a0Sdrh     case TK_RAISE: {
3211a84203a0Sdrh       const char *zType = "unk";
3212a84203a0Sdrh       switch( pExpr->affinity ){
3213a84203a0Sdrh         case OE_Rollback:   zType = "rollback";  break;
3214a84203a0Sdrh         case OE_Abort:      zType = "abort";     break;
3215a84203a0Sdrh         case OE_Fail:       zType = "fail";      break;
3216a84203a0Sdrh         case OE_Ignore:     zType = "ignore";    break;
3217a84203a0Sdrh       }
3218a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "RAISE-%s(%s)", zType, pExpr->u.zToken);
3219a84203a0Sdrh       break;
3220a84203a0Sdrh     }
3221a84203a0Sdrh #endif
3222a84203a0Sdrh   }
3223a84203a0Sdrh   if( zBinOp ){
3224a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zBinOp);
3225a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3226a84203a0Sdrh     sqlite3ExplainPrintf(pOut,",");
3227a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pRight);
3228a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3229a84203a0Sdrh   }else if( zUniOp ){
3230a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zUniOp);
3231a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3232a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3233a84203a0Sdrh   }
32347e02e5e6Sdrh }
3235678a9aa7Sdrh #endif /* defined(SQLITE_ENABLE_TREE_EXPLAIN) */
32367e02e5e6Sdrh 
3237678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
32387e02e5e6Sdrh /*
32397e02e5e6Sdrh ** Generate a human-readable explanation of an expression list.
32407e02e5e6Sdrh */
32417e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe *pOut, ExprList *pList){
32427e02e5e6Sdrh   int i;
3243a84203a0Sdrh   if( pList==0 || pList->nExpr==0 ){
32447e02e5e6Sdrh     sqlite3ExplainPrintf(pOut, "(empty-list)");
32457e02e5e6Sdrh     return;
3246a84203a0Sdrh   }else if( pList->nExpr==1 ){
3247a84203a0Sdrh     sqlite3ExplainExpr(pOut, pList->a[0].pExpr);
3248a84203a0Sdrh   }else{
32497e02e5e6Sdrh     sqlite3ExplainPush(pOut);
32507e02e5e6Sdrh     for(i=0; i<pList->nExpr; i++){
3251a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "item[%d] = ", i);
32527e02e5e6Sdrh       sqlite3ExplainPush(pOut);
32537e02e5e6Sdrh       sqlite3ExplainExpr(pOut, pList->a[i].pExpr);
32547e02e5e6Sdrh       sqlite3ExplainPop(pOut);
32557e02e5e6Sdrh       if( i<pList->nExpr-1 ){
32567e02e5e6Sdrh         sqlite3ExplainNL(pOut);
32577e02e5e6Sdrh       }
32587e02e5e6Sdrh     }
32597e02e5e6Sdrh     sqlite3ExplainPop(pOut);
32607e02e5e6Sdrh   }
3261a84203a0Sdrh }
32627e02e5e6Sdrh #endif /* SQLITE_DEBUG */
32637e02e5e6Sdrh 
3264678ccce8Sdrh /*
326547de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
326647de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
326747de955eSdrh **
326847de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
326947de955eSdrh **
327047de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
327147de955eSdrh **       or OP_Variable that does not need to be placed in a
327247de955eSdrh **       specific register.
327347de955eSdrh **
327447de955eSdrh ** There is no point in factoring out single-instruction constant
327547de955eSdrh ** expressions that need to be placed in a particular register.
327647de955eSdrh ** We could factor them out, but then we would end up adding an
327747de955eSdrh ** OP_SCopy instruction to move the value into the correct register
327847de955eSdrh ** later.  We might as well just use the original instruction and
327947de955eSdrh ** avoid the OP_SCopy.
328047de955eSdrh */
328147de955eSdrh static int isAppropriateForFactoring(Expr *p){
328247de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
328347de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
328447de955eSdrh   }
328547de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
328647de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
328747de955eSdrh   }
328847de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
328947de955eSdrh   switch( p->op ){
329047de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
329147de955eSdrh     case TK_BLOB:
329247de955eSdrh #endif
329347de955eSdrh     case TK_VARIABLE:
329447de955eSdrh     case TK_INTEGER:
329547de955eSdrh     case TK_FLOAT:
329647de955eSdrh     case TK_NULL:
329747de955eSdrh     case TK_STRING: {
329847de955eSdrh       testcase( p->op==TK_BLOB );
329947de955eSdrh       testcase( p->op==TK_VARIABLE );
330047de955eSdrh       testcase( p->op==TK_INTEGER );
330147de955eSdrh       testcase( p->op==TK_FLOAT );
330247de955eSdrh       testcase( p->op==TK_NULL );
330347de955eSdrh       testcase( p->op==TK_STRING );
330447de955eSdrh       /* Single-instruction constants with a fixed destination are
330547de955eSdrh       ** better done in-line.  If we factor them, they will just end
330647de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
330747de955eSdrh       ** register. */
330847de955eSdrh       return 0;
330947de955eSdrh     }
331047de955eSdrh     case TK_UMINUS: {
331147de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
331247de955eSdrh         return 0;
331347de955eSdrh       }
331447de955eSdrh       break;
331547de955eSdrh     }
331647de955eSdrh     default: {
331747de955eSdrh       break;
331847de955eSdrh     }
331947de955eSdrh   }
332047de955eSdrh   return 1;
332147de955eSdrh }
332247de955eSdrh 
332347de955eSdrh /*
332447de955eSdrh ** If pExpr is a constant expression that is appropriate for
332547de955eSdrh ** factoring out of a loop, then evaluate the expression
3326678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
3327678ccce8Sdrh ** expression.
3328678ccce8Sdrh */
33297d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
33307d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
333147de955eSdrh   switch( pExpr->op ){
3332e05c929bSdrh     case TK_IN:
333347de955eSdrh     case TK_REGISTER: {
333433cd4909Sdrh       return WRC_Prune;
3335678ccce8Sdrh     }
333647de955eSdrh     case TK_FUNCTION:
333747de955eSdrh     case TK_AGG_FUNCTION:
333847de955eSdrh     case TK_CONST_FUNC: {
333947de955eSdrh       /* The arguments to a function have a fixed destination.
334047de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
334147de955eSdrh       ** instructions.
334247de955eSdrh       */
33436ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
33446ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
334547de955eSdrh       if( pList ){
334647de955eSdrh         int i = pList->nExpr;
334747de955eSdrh         struct ExprList_item *pItem = pList->a;
334847de955eSdrh         for(; i>0; i--, pItem++){
334933cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
335047de955eSdrh         }
335147de955eSdrh       }
335247de955eSdrh       break;
335347de955eSdrh     }
335447de955eSdrh   }
335547de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
3356678ccce8Sdrh     int r1 = ++pParse->nMem;
3357678ccce8Sdrh     int r2;
3358678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
335933cd4909Sdrh     if( NEVER(r1!=r2) ) sqlite3ReleaseTempReg(pParse, r1);
3360fcd4a150Sdan     pExpr->op2 = pExpr->op;
3361678ccce8Sdrh     pExpr->op = TK_REGISTER;
3362678ccce8Sdrh     pExpr->iTable = r2;
33637d10d5a6Sdrh     return WRC_Prune;
3364678ccce8Sdrh   }
33657d10d5a6Sdrh   return WRC_Continue;
3366678ccce8Sdrh }
3367678ccce8Sdrh 
3368678ccce8Sdrh /*
3369678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3370678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3371678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3372f58ee7f1Sdrh **
3373f58ee7f1Sdrh ** This routine is a no-op if the jump to the cookie-check code has
3374f58ee7f1Sdrh ** already occur.  Since the cookie-check jump is generated prior to
3375f58ee7f1Sdrh ** any other serious processing, this check ensures that there is no
3376f58ee7f1Sdrh ** way to accidently bypass the constant initializations.
3377f58ee7f1Sdrh **
3378f58ee7f1Sdrh ** This routine is also a no-op if the SQLITE_FactorOutConst optimization
3379f58ee7f1Sdrh ** is disabled via the sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS)
3380f58ee7f1Sdrh ** interface.  This allows test logic to verify that the same answer is
3381f58ee7f1Sdrh ** obtained for queries regardless of whether or not constants are
3382f58ee7f1Sdrh ** precomputed into registers or if they are inserted in-line.
3383678ccce8Sdrh */
3384678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
33857d10d5a6Sdrh   Walker w;
338648b5b041Sdrh   if( pParse->cookieGoto ) return;
33877e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_FactorOutConst) ) return;
33887d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
3389ef4c0598Sdrh   w.xSelectCallback = 0;
33907d10d5a6Sdrh   w.pParse = pParse;
33917d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3392678ccce8Sdrh }
3393678ccce8Sdrh 
339425303780Sdrh 
339525303780Sdrh /*
3396268380caSdrh ** Generate code that pushes the value of every element of the given
33979cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3398268380caSdrh **
3399892d3179Sdrh ** Return the number of elements evaluated.
3400268380caSdrh */
34014adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3402268380caSdrh   Parse *pParse,     /* Parsing context */
3403389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3404191b54cbSdrh   int target,        /* Where to write results */
3405d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3406268380caSdrh ){
3407268380caSdrh   struct ExprList_item *pItem;
34089cbf3425Sdrh   int i, n;
34099d8b3072Sdrh   assert( pList!=0 );
34109cbf3425Sdrh   assert( target>0 );
3411d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3412268380caSdrh   n = pList->nExpr;
3413191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34147445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
34157445ffe2Sdrh     int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3416746fd9ccSdrh     if( inReg!=target+i ){
34177445ffe2Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, doHardCopy ? OP_Copy : OP_SCopy,
34187445ffe2Sdrh                         inReg, target+i);
3419d176611bSdrh     }
3420268380caSdrh   }
3421f9b596ebSdrh   return n;
3422268380caSdrh }
3423268380caSdrh 
3424268380caSdrh /*
342536c563a2Sdrh ** Generate code for a BETWEEN operator.
342636c563a2Sdrh **
342736c563a2Sdrh **    x BETWEEN y AND z
342836c563a2Sdrh **
342936c563a2Sdrh ** The above is equivalent to
343036c563a2Sdrh **
343136c563a2Sdrh **    x>=y AND x<=z
343236c563a2Sdrh **
343336c563a2Sdrh ** Code it as such, taking care to do the common subexpression
343436c563a2Sdrh ** elementation of x.
343536c563a2Sdrh */
343636c563a2Sdrh static void exprCodeBetween(
343736c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
343836c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
343936c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
344036c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
344136c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
344236c563a2Sdrh ){
344336c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
344436c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
344536c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
344636c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
344736c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
344836c563a2Sdrh 
344936c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
345036c563a2Sdrh   exprX = *pExpr->pLeft;
345136c563a2Sdrh   exprAnd.op = TK_AND;
345236c563a2Sdrh   exprAnd.pLeft = &compLeft;
345336c563a2Sdrh   exprAnd.pRight = &compRight;
345436c563a2Sdrh   compLeft.op = TK_GE;
345536c563a2Sdrh   compLeft.pLeft = &exprX;
345636c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
345736c563a2Sdrh   compRight.op = TK_LE;
345836c563a2Sdrh   compRight.pLeft = &exprX;
345936c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
346036c563a2Sdrh   exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
346136c563a2Sdrh   exprX.op = TK_REGISTER;
346236c563a2Sdrh   if( jumpIfTrue ){
346336c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
346436c563a2Sdrh   }else{
346536c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
346636c563a2Sdrh   }
346736c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
346836c563a2Sdrh 
346936c563a2Sdrh   /* Ensure adequate test coverage */
347036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
347136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
347236c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
347336c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
347436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
347536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
347636c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
347736c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
347836c563a2Sdrh }
347936c563a2Sdrh 
348036c563a2Sdrh /*
3481cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3482cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3483cce7d176Sdrh ** continues straight thru if the expression is false.
3484f5905aa7Sdrh **
3485f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
348635573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3487f2bc013cSdrh **
3488f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3489f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3490f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3491f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3492f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3493cce7d176Sdrh */
34944adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3495cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3496cce7d176Sdrh   int op = 0;
34972dcef11bSdrh   int regFree1 = 0;
34982dcef11bSdrh   int regFree2 = 0;
34992dcef11bSdrh   int r1, r2;
35002dcef11bSdrh 
350135573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
350233cd4909Sdrh   if( NEVER(v==0) )     return;  /* Existance of VDBE checked by caller */
350333cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3504f2bc013cSdrh   op = pExpr->op;
3505f2bc013cSdrh   switch( op ){
3506cce7d176Sdrh     case TK_AND: {
35074adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3508c5499befSdrh       testcase( jumpIfNull==0 );
3509ceea3321Sdrh       sqlite3ExprCachePush(pParse);
351035573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
35114adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35124adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3513ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3514cce7d176Sdrh       break;
3515cce7d176Sdrh     }
3516cce7d176Sdrh     case TK_OR: {
3517c5499befSdrh       testcase( jumpIfNull==0 );
35184adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
35194adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3520cce7d176Sdrh       break;
3521cce7d176Sdrh     }
3522cce7d176Sdrh     case TK_NOT: {
3523c5499befSdrh       testcase( jumpIfNull==0 );
35244adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3525cce7d176Sdrh       break;
3526cce7d176Sdrh     }
3527cce7d176Sdrh     case TK_LT:
3528cce7d176Sdrh     case TK_LE:
3529cce7d176Sdrh     case TK_GT:
3530cce7d176Sdrh     case TK_GE:
3531cce7d176Sdrh     case TK_NE:
35320ac65892Sdrh     case TK_EQ: {
3533f2bc013cSdrh       assert( TK_LT==OP_Lt );
3534f2bc013cSdrh       assert( TK_LE==OP_Le );
3535f2bc013cSdrh       assert( TK_GT==OP_Gt );
3536f2bc013cSdrh       assert( TK_GE==OP_Ge );
3537f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3538f2bc013cSdrh       assert( TK_NE==OP_Ne );
3539c5499befSdrh       testcase( op==TK_LT );
3540c5499befSdrh       testcase( op==TK_LE );
3541c5499befSdrh       testcase( op==TK_GT );
3542c5499befSdrh       testcase( op==TK_GE );
3543c5499befSdrh       testcase( op==TK_EQ );
3544c5499befSdrh       testcase( op==TK_NE );
3545c5499befSdrh       testcase( jumpIfNull==0 );
3546b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3547b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
354835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35492dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3550c5499befSdrh       testcase( regFree1==0 );
3551c5499befSdrh       testcase( regFree2==0 );
3552cce7d176Sdrh       break;
3553cce7d176Sdrh     }
35546a2fe093Sdrh     case TK_IS:
35556a2fe093Sdrh     case TK_ISNOT: {
35566a2fe093Sdrh       testcase( op==TK_IS );
35576a2fe093Sdrh       testcase( op==TK_ISNOT );
3558b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3559b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
35606a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
35616a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35626a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
35636a2fe093Sdrh       testcase( regFree1==0 );
35646a2fe093Sdrh       testcase( regFree2==0 );
35656a2fe093Sdrh       break;
35666a2fe093Sdrh     }
3567cce7d176Sdrh     case TK_ISNULL:
3568cce7d176Sdrh     case TK_NOTNULL: {
3569f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3570f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3571c5499befSdrh       testcase( op==TK_ISNULL );
3572c5499befSdrh       testcase( op==TK_NOTNULL );
35732dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35742dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3575c5499befSdrh       testcase( regFree1==0 );
3576cce7d176Sdrh       break;
3577cce7d176Sdrh     }
3578fef5208cSdrh     case TK_BETWEEN: {
35795c03f30aSdrh       testcase( jumpIfNull==0 );
358036c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3581fef5208cSdrh       break;
3582fef5208cSdrh     }
3583bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3584e3365e6cSdrh     case TK_IN: {
3585e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3586e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3587e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3588e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3589e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3590e3365e6cSdrh       break;
3591e3365e6cSdrh     }
3592bb201344Sshaneh #endif
3593cce7d176Sdrh     default: {
35942dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
35952dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3596c5499befSdrh       testcase( regFree1==0 );
3597c5499befSdrh       testcase( jumpIfNull==0 );
3598cce7d176Sdrh       break;
3599cce7d176Sdrh     }
3600cce7d176Sdrh   }
36012dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
36022dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3603cce7d176Sdrh }
3604cce7d176Sdrh 
3605cce7d176Sdrh /*
360666b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3607cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3608cce7d176Sdrh ** continues straight thru if the expression is true.
3609f5905aa7Sdrh **
3610f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
361135573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
361235573356Sdrh ** is 0.
3613cce7d176Sdrh */
36144adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3615cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3616cce7d176Sdrh   int op = 0;
36172dcef11bSdrh   int regFree1 = 0;
36182dcef11bSdrh   int regFree2 = 0;
36192dcef11bSdrh   int r1, r2;
36202dcef11bSdrh 
362135573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
362233cd4909Sdrh   if( NEVER(v==0) ) return; /* Existance of VDBE checked by caller */
362333cd4909Sdrh   if( pExpr==0 )    return;
3624f2bc013cSdrh 
3625f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3626f2bc013cSdrh   **
3627f2bc013cSdrh   **       pExpr->op            op
3628f2bc013cSdrh   **       ---------          ----------
3629f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3630f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3631f2bc013cSdrh   **       TK_NE              OP_Eq
3632f2bc013cSdrh   **       TK_EQ              OP_Ne
3633f2bc013cSdrh   **       TK_GT              OP_Le
3634f2bc013cSdrh   **       TK_LE              OP_Gt
3635f2bc013cSdrh   **       TK_GE              OP_Lt
3636f2bc013cSdrh   **       TK_LT              OP_Ge
3637f2bc013cSdrh   **
3638f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3639f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3640f2bc013cSdrh   ** can compute the mapping above using the following expression.
3641f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3642f2bc013cSdrh   */
3643f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3644f2bc013cSdrh 
3645f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3646f2bc013cSdrh   */
3647f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3648f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3649f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3650f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3651f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3652f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3653f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3654f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3655f2bc013cSdrh 
3656cce7d176Sdrh   switch( pExpr->op ){
3657cce7d176Sdrh     case TK_AND: {
3658c5499befSdrh       testcase( jumpIfNull==0 );
36594adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
36604adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3661cce7d176Sdrh       break;
3662cce7d176Sdrh     }
3663cce7d176Sdrh     case TK_OR: {
36644adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3665c5499befSdrh       testcase( jumpIfNull==0 );
3666ceea3321Sdrh       sqlite3ExprCachePush(pParse);
366735573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
36684adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
36694adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3670ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3671cce7d176Sdrh       break;
3672cce7d176Sdrh     }
3673cce7d176Sdrh     case TK_NOT: {
36745c03f30aSdrh       testcase( jumpIfNull==0 );
36754adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3676cce7d176Sdrh       break;
3677cce7d176Sdrh     }
3678cce7d176Sdrh     case TK_LT:
3679cce7d176Sdrh     case TK_LE:
3680cce7d176Sdrh     case TK_GT:
3681cce7d176Sdrh     case TK_GE:
3682cce7d176Sdrh     case TK_NE:
3683cce7d176Sdrh     case TK_EQ: {
3684c5499befSdrh       testcase( op==TK_LT );
3685c5499befSdrh       testcase( op==TK_LE );
3686c5499befSdrh       testcase( op==TK_GT );
3687c5499befSdrh       testcase( op==TK_GE );
3688c5499befSdrh       testcase( op==TK_EQ );
3689c5499befSdrh       testcase( op==TK_NE );
3690c5499befSdrh       testcase( jumpIfNull==0 );
3691b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3692b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
369335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36942dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3695c5499befSdrh       testcase( regFree1==0 );
3696c5499befSdrh       testcase( regFree2==0 );
3697cce7d176Sdrh       break;
3698cce7d176Sdrh     }
36996a2fe093Sdrh     case TK_IS:
37006a2fe093Sdrh     case TK_ISNOT: {
37016d4486aeSdrh       testcase( pExpr->op==TK_IS );
37026d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3703b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3704b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37056a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
37066a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37076a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
37086a2fe093Sdrh       testcase( regFree1==0 );
37096a2fe093Sdrh       testcase( regFree2==0 );
37106a2fe093Sdrh       break;
37116a2fe093Sdrh     }
3712cce7d176Sdrh     case TK_ISNULL:
3713cce7d176Sdrh     case TK_NOTNULL: {
3714c5499befSdrh       testcase( op==TK_ISNULL );
3715c5499befSdrh       testcase( op==TK_NOTNULL );
37162dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37172dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3718c5499befSdrh       testcase( regFree1==0 );
3719cce7d176Sdrh       break;
3720cce7d176Sdrh     }
3721fef5208cSdrh     case TK_BETWEEN: {
37225c03f30aSdrh       testcase( jumpIfNull==0 );
372336c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3724fef5208cSdrh       break;
3725fef5208cSdrh     }
3726bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3727e3365e6cSdrh     case TK_IN: {
3728e3365e6cSdrh       if( jumpIfNull ){
3729e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3730e3365e6cSdrh       }else{
3731e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3732e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3733e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3734e3365e6cSdrh       }
3735e3365e6cSdrh       break;
3736e3365e6cSdrh     }
3737bb201344Sshaneh #endif
3738cce7d176Sdrh     default: {
37392dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
37402dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3741c5499befSdrh       testcase( regFree1==0 );
3742c5499befSdrh       testcase( jumpIfNull==0 );
3743cce7d176Sdrh       break;
3744cce7d176Sdrh     }
3745cce7d176Sdrh   }
37462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
37472dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3748cce7d176Sdrh }
37492282792aSdrh 
37502282792aSdrh /*
37511d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
37521d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
37531d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
37541d9da70aSdrh ** other than the top-level COLLATE operator.
3755d40aab0eSdrh **
37561d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3757d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
37581d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
37591d9da70aSdrh ** returns 2, then you do not really know for certain if the two
37601d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3761d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
37621d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3763d40aab0eSdrh ** just might result in some slightly slower code.  But returning
37641d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
37652282792aSdrh */
37664adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
37674b202ae2Sdanielk1977   if( pA==0||pB==0 ){
37681d9da70aSdrh     return pB==pA ? 0 : 2;
37692282792aSdrh   }
377033e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
377133e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
37726ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
37731d9da70aSdrh     return 2;
37746ab3a2ecSdanielk1977   }
37751d9da70aSdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
37761d9da70aSdrh   if( pA->op!=pB->op ) return 2;
37771d9da70aSdrh   if( sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 2;
37781d9da70aSdrh   if( sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 2;
37798c6f666bSdrh   if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList) ) return 2;
37801d9da70aSdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 2;
378133e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
378233e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
37831d9da70aSdrh       return 2;
378433e619fcSdrh     }
3785bbabe197Sdrh   }else if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken){
37861d9da70aSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 2;
37876b93c9aeSdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
37881d9da70aSdrh       return 2;
37891d9da70aSdrh     }
37901d9da70aSdrh   }
37911d9da70aSdrh   if( (pA->flags & EP_ExpCollate)!=(pB->flags & EP_ExpCollate) ) return 1;
37921d9da70aSdrh   if( (pA->flags & EP_ExpCollate)!=0 && pA->pColl!=pB->pColl ) return 2;
37932646da7eSdrh   return 0;
37942646da7eSdrh }
37952282792aSdrh 
37968c6f666bSdrh /*
37978c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
37988c6f666bSdrh ** non-zero if they differ in any way.
37998c6f666bSdrh **
38008c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
38018c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
38028c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
38038c6f666bSdrh ** a malfunction will result.
38048c6f666bSdrh **
38058c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
38068c6f666bSdrh ** always differs from a non-NULL pointer.
38078c6f666bSdrh */
38088c6f666bSdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB){
38098c6f666bSdrh   int i;
38108c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38118c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38128c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
38138c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
38148c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
38158c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
38168c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
38178c6f666bSdrh     if( sqlite3ExprCompare(pExprA, pExprB) ) return 1;
38188c6f666bSdrh   }
38198c6f666bSdrh   return 0;
38208c6f666bSdrh }
382113449892Sdrh 
38222282792aSdrh /*
3823030796dfSdrh ** An instance of the following structure is used by the tree walker
3824030796dfSdrh ** to count references to table columns in the arguments of an
3825ed551b95Sdrh ** aggregate function, in order to implement the
3826ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3827374fdce4Sdrh */
3828030796dfSdrh struct SrcCount {
3829030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3830030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3831030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3832030796dfSdrh };
3833030796dfSdrh 
3834030796dfSdrh /*
3835030796dfSdrh ** Count the number of references to columns.
3836030796dfSdrh */
3837030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3838fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3839fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3840fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3841fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3842fb0a6081Sdrh   ** NEVER() will need to be removed. */
3843fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3844374fdce4Sdrh     int i;
3845030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3846030796dfSdrh     SrcList *pSrc = p->pSrc;
3847374fdce4Sdrh     for(i=0; i<pSrc->nSrc; i++){
3848030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3849374fdce4Sdrh     }
3850030796dfSdrh     if( i<pSrc->nSrc ){
3851030796dfSdrh       p->nThis++;
3852374fdce4Sdrh     }else{
3853030796dfSdrh       p->nOther++;
3854374fdce4Sdrh     }
3855374fdce4Sdrh   }
3856030796dfSdrh   return WRC_Continue;
3857030796dfSdrh }
3858374fdce4Sdrh 
3859374fdce4Sdrh /*
3860030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3861030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3862030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3863030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3864374fdce4Sdrh */
3865030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3866374fdce4Sdrh   Walker w;
3867030796dfSdrh   struct SrcCount cnt;
3868374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3869374fdce4Sdrh   memset(&w, 0, sizeof(w));
3870030796dfSdrh   w.xExprCallback = exprSrcCount;
3871030796dfSdrh   w.u.pSrcCount = &cnt;
3872030796dfSdrh   cnt.pSrc = pSrcList;
3873030796dfSdrh   cnt.nThis = 0;
3874030796dfSdrh   cnt.nOther = 0;
3875030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
3876030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
3877374fdce4Sdrh }
3878374fdce4Sdrh 
3879374fdce4Sdrh /*
388013449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
388113449892Sdrh ** the new element.  Return a negative number if malloc fails.
38822282792aSdrh */
388317435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
388413449892Sdrh   int i;
3885cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
388617435752Sdrh        db,
3887cf643729Sdrh        pInfo->aCol,
3888cf643729Sdrh        sizeof(pInfo->aCol[0]),
3889cf643729Sdrh        &pInfo->nColumn,
3890cf643729Sdrh        &i
3891cf643729Sdrh   );
389213449892Sdrh   return i;
38932282792aSdrh }
389413449892Sdrh 
389513449892Sdrh /*
389613449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
389713449892Sdrh ** the new element.  Return a negative number if malloc fails.
389813449892Sdrh */
389917435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
390013449892Sdrh   int i;
3901cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
390217435752Sdrh        db,
3903cf643729Sdrh        pInfo->aFunc,
3904cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3905cf643729Sdrh        &pInfo->nFunc,
3906cf643729Sdrh        &i
3907cf643729Sdrh   );
390813449892Sdrh   return i;
39092282792aSdrh }
39102282792aSdrh 
39112282792aSdrh /*
39127d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
39137d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3914626a879aSdrh ** for additional information.
39152282792aSdrh */
39167d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
39172282792aSdrh   int i;
39187d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3919a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3920a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
392113449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
392213449892Sdrh 
39232282792aSdrh   switch( pExpr->op ){
392489c69d00Sdrh     case TK_AGG_COLUMN:
3925967e8b73Sdrh     case TK_COLUMN: {
39268b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
39278b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
392813449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
392913449892Sdrh       ** clause of the aggregate query */
393020bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
393113449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
393213449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
393313449892Sdrh           struct AggInfo_col *pCol;
393433e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
393513449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
393613449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
393713449892Sdrh             ** that is in the FROM clause of the aggregate query.
393813449892Sdrh             **
393913449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
394013449892Sdrh             ** is not an entry there already.
394113449892Sdrh             */
39427f906d63Sdrh             int k;
394313449892Sdrh             pCol = pAggInfo->aCol;
39447f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
394513449892Sdrh               if( pCol->iTable==pExpr->iTable &&
394613449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
39472282792aSdrh                 break;
39482282792aSdrh               }
39492282792aSdrh             }
39501e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
39511e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
39521e536953Sdanielk1977             ){
39537f906d63Sdrh               pCol = &pAggInfo->aCol[k];
39540817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
395513449892Sdrh               pCol->iTable = pExpr->iTable;
395613449892Sdrh               pCol->iColumn = pExpr->iColumn;
39570a07c107Sdrh               pCol->iMem = ++pParse->nMem;
395813449892Sdrh               pCol->iSorterColumn = -1;
39595774b806Sdrh               pCol->pExpr = pExpr;
396013449892Sdrh               if( pAggInfo->pGroupBy ){
396113449892Sdrh                 int j, n;
396213449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
396313449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
396413449892Sdrh                 n = pGB->nExpr;
396513449892Sdrh                 for(j=0; j<n; j++, pTerm++){
396613449892Sdrh                   Expr *pE = pTerm->pExpr;
396713449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
396813449892Sdrh                       pE->iColumn==pExpr->iColumn ){
396913449892Sdrh                     pCol->iSorterColumn = j;
397013449892Sdrh                     break;
39712282792aSdrh                   }
397213449892Sdrh                 }
397313449892Sdrh               }
397413449892Sdrh               if( pCol->iSorterColumn<0 ){
397513449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
397613449892Sdrh               }
397713449892Sdrh             }
397813449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
397913449892Sdrh             ** because it was there before or because we just created it).
398013449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
398113449892Sdrh             ** pAggInfo->aCol[] entry.
398213449892Sdrh             */
398333e619fcSdrh             ExprSetIrreducible(pExpr);
398413449892Sdrh             pExpr->pAggInfo = pAggInfo;
398513449892Sdrh             pExpr->op = TK_AGG_COLUMN;
3986cf697396Sshane             pExpr->iAgg = (i16)k;
398713449892Sdrh             break;
398813449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
398913449892Sdrh         } /* end loop over pSrcList */
3990a58fdfb1Sdanielk1977       }
39917d10d5a6Sdrh       return WRC_Prune;
39922282792aSdrh     }
39932282792aSdrh     case TK_AGG_FUNCTION: {
39943a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
3995ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
39963a8c4be7Sdrh       ){
399713449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
399813449892Sdrh         ** function that is already in the pAggInfo structure
399913449892Sdrh         */
400013449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
400113449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
40021d9da70aSdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr)==0 ){
40032282792aSdrh             break;
40042282792aSdrh           }
40052282792aSdrh         }
400613449892Sdrh         if( i>=pAggInfo->nFunc ){
400713449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
400813449892Sdrh           */
400914db2665Sdanielk1977           u8 enc = ENC(pParse->db);
40101e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
401113449892Sdrh           if( i>=0 ){
40126ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
401313449892Sdrh             pItem = &pAggInfo->aFunc[i];
401413449892Sdrh             pItem->pExpr = pExpr;
40150a07c107Sdrh             pItem->iMem = ++pParse->nMem;
401633e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
401713449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
401833e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
40196ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4020fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4021fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4022fd357974Sdrh             }else{
4023fd357974Sdrh               pItem->iDistinct = -1;
4024fd357974Sdrh             }
40252282792aSdrh           }
402613449892Sdrh         }
402713449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
402813449892Sdrh         */
402933e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
403033e619fcSdrh         ExprSetIrreducible(pExpr);
4031cf697396Sshane         pExpr->iAgg = (i16)i;
403213449892Sdrh         pExpr->pAggInfo = pAggInfo;
40332282792aSdrh       }
40343a8c4be7Sdrh       return WRC_Prune;
40352282792aSdrh     }
4036a58fdfb1Sdanielk1977   }
40377d10d5a6Sdrh   return WRC_Continue;
40387d10d5a6Sdrh }
40397d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4040d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4041d5a336efSdrh   UNUSED_PARAMETER(pSelect);
40427d10d5a6Sdrh   return WRC_Continue;
4043a58fdfb1Sdanielk1977 }
4044626a879aSdrh 
4045626a879aSdrh /*
4046*e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4047*e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4048*e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4049*e8abb4caSdrh ** necessary.
4050626a879aSdrh **
4051626a879aSdrh ** This routine should only be called after the expression has been
40527d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4053626a879aSdrh */
4054d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
40557d10d5a6Sdrh   Walker w;
4056374fdce4Sdrh   memset(&w, 0, sizeof(w));
40577d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
40587d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
40597d10d5a6Sdrh   w.u.pNC = pNC;
406020bc393cSdrh   assert( pNC->pSrcList!=0 );
40617d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
40622282792aSdrh }
40635d9a4af9Sdrh 
40645d9a4af9Sdrh /*
40655d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
40665d9a4af9Sdrh ** expression list.  Return the number of errors.
40675d9a4af9Sdrh **
40685d9a4af9Sdrh ** If an error is found, the analysis is cut short.
40695d9a4af9Sdrh */
4070d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
40715d9a4af9Sdrh   struct ExprList_item *pItem;
40725d9a4af9Sdrh   int i;
40735d9a4af9Sdrh   if( pList ){
4074d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4075d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
40765d9a4af9Sdrh     }
40775d9a4af9Sdrh   }
40785d9a4af9Sdrh }
4079892d3179Sdrh 
4080892d3179Sdrh /*
4081ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4082892d3179Sdrh */
4083892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4084e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4085892d3179Sdrh     return ++pParse->nMem;
4086892d3179Sdrh   }
40872f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4088892d3179Sdrh }
4089ceea3321Sdrh 
4090ceea3321Sdrh /*
4091ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4092ceea3321Sdrh ** purpose.
4093ceea3321Sdrh **
4094ceea3321Sdrh ** If a register is currently being used by the column cache, then
4095ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
4096ceea3321Sdrh ** the register becomes stale.
4097ceea3321Sdrh */
4098892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
40992dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4100ceea3321Sdrh     int i;
4101ceea3321Sdrh     struct yColCache *p;
4102ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4103ceea3321Sdrh       if( p->iReg==iReg ){
4104ceea3321Sdrh         p->tempReg = 1;
4105ceea3321Sdrh         return;
4106ceea3321Sdrh       }
4107ceea3321Sdrh     }
4108892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4109892d3179Sdrh   }
4110892d3179Sdrh }
4111892d3179Sdrh 
4112892d3179Sdrh /*
4113892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4114892d3179Sdrh */
4115892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4116e55cbd72Sdrh   int i, n;
4117892d3179Sdrh   i = pParse->iRangeReg;
4118e55cbd72Sdrh   n = pParse->nRangeReg;
4119f49f3523Sdrh   if( nReg<=n ){
4120f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4121892d3179Sdrh     pParse->iRangeReg += nReg;
4122892d3179Sdrh     pParse->nRangeReg -= nReg;
4123892d3179Sdrh   }else{
4124892d3179Sdrh     i = pParse->nMem+1;
4125892d3179Sdrh     pParse->nMem += nReg;
4126892d3179Sdrh   }
4127892d3179Sdrh   return i;
4128892d3179Sdrh }
4129892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4130f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4131892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4132892d3179Sdrh     pParse->nRangeReg = nReg;
4133892d3179Sdrh     pParse->iRangeReg = iReg;
4134892d3179Sdrh   }
4135892d3179Sdrh }
4136cdc69557Sdrh 
4137cdc69557Sdrh /*
4138cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4139cdc69557Sdrh */
4140cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4141cdc69557Sdrh   pParse->nTempReg = 0;
4142cdc69557Sdrh   pParse->nRangeReg = 0;
4143cdc69557Sdrh }
4144