xref: /sqlite-3.40.0/src/expr.c (revision 4b17cf58)
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 /*
598b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
60ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
61ae80ddeaSdrh ** implements the COLLATE operator.
628b4c40d8Sdrh */
638342e49fSdrh Expr *sqlite3ExprSetCollByToken(Parse *pParse, Expr *pExpr, Token *pCollName){
64ae80ddeaSdrh   Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, 1);
65ae80ddeaSdrh   if( pNew ){
66ae80ddeaSdrh     pNew->pLeft = pExpr;
67ae80ddeaSdrh     pNew->flags |= EP_Collate;
68ae80ddeaSdrh   }
69ae80ddeaSdrh   return pNew;
708b4c40d8Sdrh }
718b4c40d8Sdrh 
728b4c40d8Sdrh /*
73ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
74ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
75ae80ddeaSdrh **
76ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
77ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
78ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
79ae80ddeaSdrh ** precedence over right operands.
800202b29eSdanielk1977 */
817cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
82ae80ddeaSdrh   sqlite3 *db = pParse->db;
837cedc8d4Sdanielk1977   CollSeq *pColl = 0;
847d10d5a6Sdrh   Expr *p = pExpr;
85ae80ddeaSdrh   while( p && pColl==0 ){
86ae80ddeaSdrh     int op = p->op;
87ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
88ae80ddeaSdrh       p = p->pLeft;
89ae80ddeaSdrh       continue;
90ae80ddeaSdrh     }
91ae80ddeaSdrh     if( op==TK_COLLATE ){
92ae80ddeaSdrh       pColl = sqlite3FindCollSeq(db, ENC(db), p->u.zToken, 0);
93ae80ddeaSdrh       break;
94ae80ddeaSdrh     }
95ae80ddeaSdrh     if( p->pTab!=0
96ae80ddeaSdrh      && (op==TK_AGG_COLUMN || op==TK_COLUMN
97ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
98ae80ddeaSdrh     ){
997d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1007d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1017d10d5a6Sdrh       int j = p->iColumn;
1027d10d5a6Sdrh       if( j>=0 ){
103ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
104c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1050202b29eSdanielk1977       }
1067d10d5a6Sdrh       break;
1077d10d5a6Sdrh     }
108ae80ddeaSdrh     if( p->flags & EP_Collate ){
109*4b17cf58Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1107d10d5a6Sdrh         p = p->pLeft;
111ae80ddeaSdrh       }else{
112ae80ddeaSdrh         p = p->pRight;
113ae80ddeaSdrh       }
114ae80ddeaSdrh     }else{
115ae80ddeaSdrh       break;
116ae80ddeaSdrh     }
1170202b29eSdanielk1977   }
1187cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1197cedc8d4Sdanielk1977     pColl = 0;
1207cedc8d4Sdanielk1977   }
1217cedc8d4Sdanielk1977   return pColl;
1220202b29eSdanielk1977 }
1230202b29eSdanielk1977 
1240202b29eSdanielk1977 /*
125626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
126626a879aSdrh ** type affinity of the other operand.  This routine returns the
12753db1458Sdrh ** type affinity that should be used for the comparison operator.
12853db1458Sdrh */
129e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
130bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
131e014a838Sdanielk1977   if( aff1 && aff2 ){
1328df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1338df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
134e014a838Sdanielk1977     */
1358a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
136e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
137e014a838Sdanielk1977     }else{
138e014a838Sdanielk1977       return SQLITE_AFF_NONE;
139e014a838Sdanielk1977     }
140e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1415f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1425f6a87b3Sdrh     ** results directly.
143e014a838Sdanielk1977     */
1445f6a87b3Sdrh     return SQLITE_AFF_NONE;
145e014a838Sdanielk1977   }else{
146e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
147fe05af87Sdrh     assert( aff1==0 || aff2==0 );
148e014a838Sdanielk1977     return (aff1 + aff2);
149e014a838Sdanielk1977   }
150e014a838Sdanielk1977 }
151e014a838Sdanielk1977 
15253db1458Sdrh /*
15353db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
15453db1458Sdrh ** be applied to both operands prior to doing the comparison.
15553db1458Sdrh */
156e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
157e014a838Sdanielk1977   char aff;
158e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
159e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
1606a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
161e014a838Sdanielk1977   assert( pExpr->pLeft );
162bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
163e014a838Sdanielk1977   if( pExpr->pRight ){
164e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1656ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1666ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
1676ab3a2ecSdanielk1977   }else if( !aff ){
168de087bd5Sdrh     aff = SQLITE_AFF_NONE;
169e014a838Sdanielk1977   }
170e014a838Sdanielk1977   return aff;
171e014a838Sdanielk1977 }
172e014a838Sdanielk1977 
173e014a838Sdanielk1977 /*
174e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
175e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
176e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
177e014a838Sdanielk1977 ** the comparison in pExpr.
178e014a838Sdanielk1977 */
179e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
180e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
1818a51256cSdrh   switch( aff ){
1828a51256cSdrh     case SQLITE_AFF_NONE:
1838a51256cSdrh       return 1;
1848a51256cSdrh     case SQLITE_AFF_TEXT:
1858a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
1868a51256cSdrh     default:
1878a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
1888a51256cSdrh   }
189e014a838Sdanielk1977 }
190e014a838Sdanielk1977 
191a37cdde0Sdanielk1977 /*
19235573356Sdrh ** Return the P5 value that should be used for a binary comparison
193a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
194a37cdde0Sdanielk1977 */
19535573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
19635573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
1971bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
19835573356Sdrh   return aff;
199a37cdde0Sdanielk1977 }
200a37cdde0Sdanielk1977 
201a2e00042Sdrh /*
2020202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2030202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2040202b29eSdanielk1977 **
2050202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2060202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2070202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2080202b29eSdanielk1977 ** type.
209bcbb04e5Sdanielk1977 **
210bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
211bcbb04e5Sdanielk1977 ** it is not considered.
2120202b29eSdanielk1977 */
213bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
214bcbb04e5Sdanielk1977   Parse *pParse,
215bcbb04e5Sdanielk1977   Expr *pLeft,
216bcbb04e5Sdanielk1977   Expr *pRight
217bcbb04e5Sdanielk1977 ){
218ec41ddacSdrh   CollSeq *pColl;
219ec41ddacSdrh   assert( pLeft );
220ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
221ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
222ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
223ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
224ec41ddacSdrh   }else{
225ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2260202b29eSdanielk1977     if( !pColl ){
2277cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2280202b29eSdanielk1977     }
229ec41ddacSdrh   }
2300202b29eSdanielk1977   return pColl;
2310202b29eSdanielk1977 }
2320202b29eSdanielk1977 
2330202b29eSdanielk1977 /*
234be5c89acSdrh ** Generate code for a comparison operator.
235be5c89acSdrh */
236be5c89acSdrh static int codeCompare(
237be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
238be5c89acSdrh   Expr *pLeft,      /* The left operand */
239be5c89acSdrh   Expr *pRight,     /* The right operand */
240be5c89acSdrh   int opcode,       /* The comparison opcode */
24135573356Sdrh   int in1, int in2, /* Register holding operands */
242be5c89acSdrh   int dest,         /* Jump here if true.  */
243be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
244be5c89acSdrh ){
24535573356Sdrh   int p5;
24635573356Sdrh   int addr;
24735573356Sdrh   CollSeq *p4;
24835573356Sdrh 
24935573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
25035573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
25135573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
25235573356Sdrh                            (void*)p4, P4_COLLSEQ);
2531bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
25435573356Sdrh   return addr;
255be5c89acSdrh }
256be5c89acSdrh 
2574b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2584b5255acSdanielk1977 /*
2594b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2604b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2614b5255acSdanielk1977 ** pParse.
2624b5255acSdanielk1977 */
2637d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2644b5255acSdanielk1977   int rc = SQLITE_OK;
2654b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
2664b5255acSdanielk1977   if( nHeight>mxHeight ){
2674b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
2684b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
2694b5255acSdanielk1977     );
2704b5255acSdanielk1977     rc = SQLITE_ERROR;
2714b5255acSdanielk1977   }
2724b5255acSdanielk1977   return rc;
2734b5255acSdanielk1977 }
2744b5255acSdanielk1977 
2754b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
2764b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
2774b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
2784b5255acSdanielk1977 ** first argument.
2794b5255acSdanielk1977 **
2804b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
2814b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
2824b5255acSdanielk1977 ** value.
2834b5255acSdanielk1977 */
2844b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
2854b5255acSdanielk1977   if( p ){
2864b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
2874b5255acSdanielk1977       *pnHeight = p->nHeight;
2884b5255acSdanielk1977     }
2894b5255acSdanielk1977   }
2904b5255acSdanielk1977 }
2914b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
2924b5255acSdanielk1977   if( p ){
2934b5255acSdanielk1977     int i;
2944b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
2954b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
2964b5255acSdanielk1977     }
2974b5255acSdanielk1977   }
2984b5255acSdanielk1977 }
2994b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3004b5255acSdanielk1977   if( p ){
3014b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3024b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3034b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3044b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3054b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3064b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3074b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3084b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3094b5255acSdanielk1977   }
3104b5255acSdanielk1977 }
3114b5255acSdanielk1977 
3124b5255acSdanielk1977 /*
3134b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3144b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3154b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3164b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3174b5255acSdanielk1977 ** referenced Expr plus one.
3184b5255acSdanielk1977 */
3194b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3204b5255acSdanielk1977   int nHeight = 0;
3214b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3224b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3236ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3246ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3256ab3a2ecSdanielk1977   }else{
3266ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3276ab3a2ecSdanielk1977   }
3284b5255acSdanielk1977   p->nHeight = nHeight + 1;
3294b5255acSdanielk1977 }
3304b5255acSdanielk1977 
3314b5255acSdanielk1977 /*
3324b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3334b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3344b5255acSdanielk1977 ** leave an error in pParse.
3354b5255acSdanielk1977 */
3364b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3374b5255acSdanielk1977   exprSetHeight(p);
3387d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3394b5255acSdanielk1977 }
3404b5255acSdanielk1977 
3414b5255acSdanielk1977 /*
3424b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3434b5255acSdanielk1977 ** by the select statement passed as an argument.
3444b5255acSdanielk1977 */
3454b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3464b5255acSdanielk1977   int nHeight = 0;
3474b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3484b5255acSdanielk1977   return nHeight;
3494b5255acSdanielk1977 }
3504b5255acSdanielk1977 #else
3514b5255acSdanielk1977   #define exprSetHeight(y)
3524b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3534b5255acSdanielk1977 
354be5c89acSdrh /*
355b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
356b7916a78Sdrh **
357a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
358b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
359b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
360a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
361b7916a78Sdrh **
362b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
363b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
364b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
365b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
366b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
36733e619fcSdrh **
36833e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
36933e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
37033e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
37133e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
37233e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
373a76b5dfcSdrh */
374b7916a78Sdrh Expr *sqlite3ExprAlloc(
375a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
37617435752Sdrh   int op,                 /* Expression opcode */
377b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
378b7916a78Sdrh   int dequote             /* True to dequote */
37917435752Sdrh ){
380a76b5dfcSdrh   Expr *pNew;
38133e619fcSdrh   int nExtra = 0;
382cf697396Sshane   int iValue = 0;
383b7916a78Sdrh 
384b7916a78Sdrh   if( pToken ){
38533e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
38633e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
387b7916a78Sdrh       nExtra = pToken->n+1;
388d50ffc41Sdrh       assert( iValue>=0 );
38933e619fcSdrh     }
390a76b5dfcSdrh   }
391b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
392b7916a78Sdrh   if( pNew ){
3931bd10f8aSdrh     pNew->op = (u8)op;
394a58fdfb1Sdanielk1977     pNew->iAgg = -1;
395a76b5dfcSdrh     if( pToken ){
39633e619fcSdrh       if( nExtra==0 ){
39733e619fcSdrh         pNew->flags |= EP_IntValue;
39833e619fcSdrh         pNew->u.iValue = iValue;
39933e619fcSdrh       }else{
400d9da78a2Sdrh         int c;
40133e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
402b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
403b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
40433e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
405b7916a78Sdrh         if( dequote && nExtra>=3
406d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
40733e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
40824fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
409a34001c9Sdrh         }
410a34001c9Sdrh       }
41133e619fcSdrh     }
412b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
413b7916a78Sdrh     pNew->nHeight = 1;
414b7916a78Sdrh #endif
415a34001c9Sdrh   }
416a76b5dfcSdrh   return pNew;
417a76b5dfcSdrh }
418a76b5dfcSdrh 
419a76b5dfcSdrh /*
420b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
421b7916a78Sdrh ** already been dequoted.
422b7916a78Sdrh */
423b7916a78Sdrh Expr *sqlite3Expr(
424b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
425b7916a78Sdrh   int op,                 /* Expression opcode */
426b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
427b7916a78Sdrh ){
428b7916a78Sdrh   Token x;
429b7916a78Sdrh   x.z = zToken;
430b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
431b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
432b7916a78Sdrh }
433b7916a78Sdrh 
434b7916a78Sdrh /*
435b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
436b7916a78Sdrh **
437b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
438b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
439b7916a78Sdrh */
440b7916a78Sdrh void sqlite3ExprAttachSubtrees(
441b7916a78Sdrh   sqlite3 *db,
442b7916a78Sdrh   Expr *pRoot,
443b7916a78Sdrh   Expr *pLeft,
444b7916a78Sdrh   Expr *pRight
445b7916a78Sdrh ){
446b7916a78Sdrh   if( pRoot==0 ){
447b7916a78Sdrh     assert( db->mallocFailed );
448b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
449b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
450b7916a78Sdrh   }else{
451b7916a78Sdrh     if( pRight ){
452b7916a78Sdrh       pRoot->pRight = pRight;
453ae80ddeaSdrh       pRoot->flags |= EP_Collate & pRight->flags;
454b7916a78Sdrh     }
455b7916a78Sdrh     if( pLeft ){
456b7916a78Sdrh       pRoot->pLeft = pLeft;
457ae80ddeaSdrh       pRoot->flags |= EP_Collate & pLeft->flags;
458b7916a78Sdrh     }
459b7916a78Sdrh     exprSetHeight(pRoot);
460b7916a78Sdrh   }
461b7916a78Sdrh }
462b7916a78Sdrh 
463b7916a78Sdrh /*
464bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
465b7916a78Sdrh **
466bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
467bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
468bf664469Sdrh ** free the subtrees and return NULL.
469206f3d96Sdrh */
47017435752Sdrh Expr *sqlite3PExpr(
47117435752Sdrh   Parse *pParse,          /* Parsing context */
47217435752Sdrh   int op,                 /* Expression opcode */
47317435752Sdrh   Expr *pLeft,            /* Left operand */
47417435752Sdrh   Expr *pRight,           /* Right operand */
47517435752Sdrh   const Token *pToken     /* Argument token */
47617435752Sdrh ){
4775fb52caaSdrh   Expr *p;
4785fb52caaSdrh   if( op==TK_AND && pLeft && pRight ){
4795fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
4805fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
4815fb52caaSdrh   }else{
4825fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
483b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
4845fb52caaSdrh   }
4852b359bdbSdan   if( p ) {
4862b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
4872b359bdbSdan   }
4884e0cff60Sdrh   return p;
4894e0cff60Sdrh }
4904e0cff60Sdrh 
4914e0cff60Sdrh /*
4925fb52caaSdrh ** Return 1 if an expression must be FALSE in all cases and 0 if the
4935fb52caaSdrh ** expression might be true.  This is an optimization.  If is OK to
4945fb52caaSdrh ** return 0 here even if the expression really is always false (a
4955fb52caaSdrh ** false negative).  But it is a bug to return 1 if the expression
4965fb52caaSdrh ** might be true in some rare circumstances (a false positive.)
4975fb52caaSdrh **
4985fb52caaSdrh ** Note that if the expression is part of conditional for a
4995fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5005fb52caaSdrh ** is it true or false, so always return 0.
5015fb52caaSdrh */
5025fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5035fb52caaSdrh   int v = 0;
5045fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5055fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5065fb52caaSdrh   return v==0;
5075fb52caaSdrh }
5085fb52caaSdrh 
5095fb52caaSdrh /*
51091bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
51191bb0eedSdrh ** NULL, then just return the other expression.
5125fb52caaSdrh **
5135fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5145fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5155fb52caaSdrh ** a value of false.
51691bb0eedSdrh */
5171e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
51891bb0eedSdrh   if( pLeft==0 ){
51991bb0eedSdrh     return pRight;
52091bb0eedSdrh   }else if( pRight==0 ){
52191bb0eedSdrh     return pLeft;
5225fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
5235fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
5245fb52caaSdrh     sqlite3ExprDelete(db, pRight);
5255fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
52691bb0eedSdrh   }else{
527b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
528b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
529b7916a78Sdrh     return pNew;
530a76b5dfcSdrh   }
531a76b5dfcSdrh }
532a76b5dfcSdrh 
533a76b5dfcSdrh /*
534a76b5dfcSdrh ** Construct a new expression node for a function with multiple
535a76b5dfcSdrh ** arguments.
536a76b5dfcSdrh */
53717435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
538a76b5dfcSdrh   Expr *pNew;
539633e6d57Sdrh   sqlite3 *db = pParse->db;
5404b202ae2Sdanielk1977   assert( pToken );
541b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
542a76b5dfcSdrh   if( pNew==0 ){
543d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
544a76b5dfcSdrh     return 0;
545a76b5dfcSdrh   }
5466ab3a2ecSdanielk1977   pNew->x.pList = pList;
5476ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5484b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
549a76b5dfcSdrh   return pNew;
550a76b5dfcSdrh }
551a76b5dfcSdrh 
552a76b5dfcSdrh /*
553fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
554fa6bc000Sdrh ** in the original SQL statement.
555fa6bc000Sdrh **
556fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
557fa6bc000Sdrh ** variable number.
558fa6bc000Sdrh **
559fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
560fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
561fa6bc000Sdrh ** the SQL statement comes from an external source.
562fa6bc000Sdrh **
56351f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
564fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
565fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
566fa6bc000Sdrh ** assigned.
567fa6bc000Sdrh */
568fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
56917435752Sdrh   sqlite3 *db = pParse->db;
570b7916a78Sdrh   const char *z;
57117435752Sdrh 
572fa6bc000Sdrh   if( pExpr==0 ) return;
57333e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
57433e619fcSdrh   z = pExpr->u.zToken;
575b7916a78Sdrh   assert( z!=0 );
576b7916a78Sdrh   assert( z[0]!=0 );
577b7916a78Sdrh   if( z[1]==0 ){
578fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
579b7916a78Sdrh     assert( z[0]=='?' );
5808677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
581124c0b49Sdrh   }else{
582124c0b49Sdrh     ynVar x = 0;
583124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
584124c0b49Sdrh     if( z[0]=='?' ){
585fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
586fa6bc000Sdrh       ** use it as the variable number */
587c8d735aeSdan       i64 i;
588124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
589124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
590c5499befSdrh       testcase( i==0 );
591c5499befSdrh       testcase( i==1 );
592c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
593c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
594c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
595fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
596bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
597124c0b49Sdrh         x = 0;
598fa6bc000Sdrh       }
599fa6bc000Sdrh       if( i>pParse->nVar ){
6001df2db7fSshaneh         pParse->nVar = (int)i;
601fa6bc000Sdrh       }
602fa6bc000Sdrh     }else{
60351f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
604fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
605fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
606fa6bc000Sdrh       */
607124c0b49Sdrh       ynVar i;
608124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
609124c0b49Sdrh         if( pParse->azVar[i] && memcmp(pParse->azVar[i],z,n+1)==0 ){
610124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
611fa6bc000Sdrh           break;
612fa6bc000Sdrh         }
613fa6bc000Sdrh       }
614124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
615fa6bc000Sdrh     }
616124c0b49Sdrh     if( x>0 ){
617124c0b49Sdrh       if( x>pParse->nzVar ){
618124c0b49Sdrh         char **a;
619124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
620124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
621124c0b49Sdrh         pParse->azVar = a;
622124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
623124c0b49Sdrh         pParse->nzVar = x;
624124c0b49Sdrh       }
625124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
626124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
627124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
628fa6bc000Sdrh       }
629fa6bc000Sdrh     }
630fa6bc000Sdrh   }
631bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
632832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
633832b2664Sdanielk1977   }
634fa6bc000Sdrh }
635fa6bc000Sdrh 
636fa6bc000Sdrh /*
637f6963f99Sdan ** Recursively delete an expression tree.
638a2e00042Sdrh */
639f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
640f6963f99Sdan   if( p==0 ) return;
641d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
642d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
643b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
644633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
645633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
64633e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
64733e619fcSdrh       sqlite3DbFree(db, p->u.zToken);
6486ab3a2ecSdanielk1977     }
6496ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6506ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6516ab3a2ecSdanielk1977     }else{
6526ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6536ab3a2ecSdanielk1977     }
6546ab3a2ecSdanielk1977   }
65533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
656633e6d57Sdrh     sqlite3DbFree(db, p);
657a2e00042Sdrh   }
65833e619fcSdrh }
659a2e00042Sdrh 
660d2687b77Sdrh /*
6616ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6626ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6636ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6646ab3a2ecSdanielk1977 */
6656ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6666ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6676ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6686ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6696ab3a2ecSdanielk1977 }
6706ab3a2ecSdanielk1977 
6716ab3a2ecSdanielk1977 /*
67233e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
67333e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
67433e619fcSdrh ** how much of the tree is measured.
67533e619fcSdrh **
67633e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
67733e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
67833e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
67933e619fcSdrh **
68033e619fcSdrh ***************************************************************************
68133e619fcSdrh **
68233e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
68333e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
68433e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
68533e619fcSdrh ** The return values is always one of:
68633e619fcSdrh **
68733e619fcSdrh **      EXPR_FULLSIZE
68833e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
68933e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
69033e619fcSdrh **
69133e619fcSdrh ** The size of the structure can be found by masking the return value
69233e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
69333e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
69433e619fcSdrh **
69533e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
69633e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
69733e619fcSdrh ** During expression analysis, extra information is computed and moved into
69833e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
69933e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
70033e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
70133e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
70233e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
70333e619fcSdrh ** to enforce this constraint.
7046ab3a2ecSdanielk1977 */
7056ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7066ab3a2ecSdanielk1977   int nSize;
70733e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
7086ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7096ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7106ab3a2ecSdanielk1977   }else{
71133e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
71233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
71333e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
71433e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
715ae80ddeaSdrh     if( p->pLeft || p->pRight || p->x.pList ){
71633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
71733e619fcSdrh     }else{
71833e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
71933e619fcSdrh     }
7206ab3a2ecSdanielk1977   }
7216ab3a2ecSdanielk1977   return nSize;
7226ab3a2ecSdanielk1977 }
7236ab3a2ecSdanielk1977 
7246ab3a2ecSdanielk1977 /*
72533e619fcSdrh ** This function returns the space in bytes required to store the copy
72633e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
72733e619fcSdrh ** string is defined.)
7286ab3a2ecSdanielk1977 */
7296ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
73033e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
73133e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
73233e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7336ab3a2ecSdanielk1977   }
734bc73971dSdanielk1977   return ROUND8(nByte);
7356ab3a2ecSdanielk1977 }
7366ab3a2ecSdanielk1977 
7376ab3a2ecSdanielk1977 /*
7386ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7396ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7406ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7416ab3a2ecSdanielk1977 **
7426ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
74333e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7446ab3a2ecSdanielk1977 **
7456ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7466ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7476ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7486ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7496ab3a2ecSdanielk1977 */
7506ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7516ab3a2ecSdanielk1977   int nByte = 0;
7526ab3a2ecSdanielk1977   if( p ){
7536ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7546ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
755b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7566ab3a2ecSdanielk1977     }
7576ab3a2ecSdanielk1977   }
7586ab3a2ecSdanielk1977   return nByte;
7596ab3a2ecSdanielk1977 }
7606ab3a2ecSdanielk1977 
7616ab3a2ecSdanielk1977 /*
7626ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7636ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
76433e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7656ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7666ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7676ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7686ab3a2ecSdanielk1977 */
7696ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7706ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7716ab3a2ecSdanielk1977   if( p ){
7726ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7736ab3a2ecSdanielk1977     u8 *zAlloc;
77433e619fcSdrh     u32 staticFlag = 0;
7756ab3a2ecSdanielk1977 
7766ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7776ab3a2ecSdanielk1977 
7786ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7796ab3a2ecSdanielk1977     if( pzBuffer ){
7806ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
78133e619fcSdrh       staticFlag = EP_Static;
7826ab3a2ecSdanielk1977     }else{
7836ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7846ab3a2ecSdanielk1977     }
7856ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7866ab3a2ecSdanielk1977 
7876ab3a2ecSdanielk1977     if( pNew ){
7886ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7896ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
7906ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
79133e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
7926ab3a2ecSdanielk1977       */
79333e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
79433e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
79533e619fcSdrh       int nToken;
79633e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
79733e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
79833e619fcSdrh       }else{
79933e619fcSdrh         nToken = 0;
80033e619fcSdrh       }
8016ab3a2ecSdanielk1977       if( isReduced ){
8026ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8036ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8046ab3a2ecSdanielk1977       }else{
8056ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8066ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8076ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8086ab3a2ecSdanielk1977       }
8096ab3a2ecSdanielk1977 
81033e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
81133e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
81233e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
81333e619fcSdrh       pNew->flags |= staticFlag;
8146ab3a2ecSdanielk1977 
81533e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8166ab3a2ecSdanielk1977       if( nToken ){
81733e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
81833e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8196ab3a2ecSdanielk1977       }
8206ab3a2ecSdanielk1977 
8216ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8226ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8236ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8246ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8256ab3a2ecSdanielk1977         }else{
8266ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8276ab3a2ecSdanielk1977         }
8286ab3a2ecSdanielk1977       }
8296ab3a2ecSdanielk1977 
8306ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
831b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8326ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8336ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8346ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8356ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8366ab3a2ecSdanielk1977         }
8376ab3a2ecSdanielk1977         if( pzBuffer ){
8386ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8396ab3a2ecSdanielk1977         }
840b7916a78Sdrh       }else{
841b7916a78Sdrh         pNew->flags2 = 0;
842b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8436ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8446ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8456ab3a2ecSdanielk1977         }
8466ab3a2ecSdanielk1977       }
847b7916a78Sdrh 
848b7916a78Sdrh     }
8496ab3a2ecSdanielk1977   }
8506ab3a2ecSdanielk1977   return pNew;
8516ab3a2ecSdanielk1977 }
8526ab3a2ecSdanielk1977 
8536ab3a2ecSdanielk1977 /*
854ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
855ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
856ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
857ff78bd2fSdrh ** without effecting the originals.
858ff78bd2fSdrh **
8594adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8604adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
861ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
862ff78bd2fSdrh **
863ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8646ab3a2ecSdanielk1977 **
865b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8666ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8676ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8686ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
869ff78bd2fSdrh */
8706ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8716ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
872ff78bd2fSdrh }
8736ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
874ff78bd2fSdrh   ExprList *pNew;
875145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
876ff78bd2fSdrh   int i;
877ff78bd2fSdrh   if( p==0 ) return 0;
87817435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
879ff78bd2fSdrh   if( pNew==0 ) return 0;
88031dad9daSdanielk1977   pNew->iECursor = 0;
881d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
882d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
883d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
884e0048400Sdanielk1977   if( pItem==0 ){
885633e6d57Sdrh     sqlite3DbFree(db, pNew);
886e0048400Sdanielk1977     return 0;
887e0048400Sdanielk1977   }
888145716b3Sdrh   pOldItem = p->a;
889145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
8906ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
891b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
89217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
893b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
894145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
8953e7bc9caSdrh     pItem->done = 0;
8964b3ac73cSdrh     pItem->iOrderByCol = pOldItem->iOrderByCol;
8978b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
898ff78bd2fSdrh   }
899ff78bd2fSdrh   return pNew;
900ff78bd2fSdrh }
90193758c8dSdanielk1977 
90293758c8dSdanielk1977 /*
90393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
90493758c8dSdanielk1977 ** the build, then none of the following routines, except for
90593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
90693758c8dSdanielk1977 ** called with a NULL argument.
90793758c8dSdanielk1977 */
9086a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9096a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9106ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
911ad3cab52Sdrh   SrcList *pNew;
912ad3cab52Sdrh   int i;
913113088ecSdrh   int nByte;
914ad3cab52Sdrh   if( p==0 ) return 0;
915113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
91617435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
917ad3cab52Sdrh   if( pNew==0 ) return 0;
9184305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
919ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9204efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9214efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
922ed8a3bb1Sdrh     Table *pTab;
92341fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
92417435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
92517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
92617435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9274efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9284efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9295b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
9305b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
931da79cf0cSdan     pNewItem->isCorrelated = pOldItem->isCorrelated;
93221172c4cSdrh     pNewItem->viaCoroutine = pOldItem->viaCoroutine;
93385574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
93485574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
93585574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
936ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
937ed8a3bb1Sdrh     if( pTab ){
938ed8a3bb1Sdrh       pTab->nRef++;
939a1cb183dSdanielk1977     }
9406ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9416ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
94217435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9436c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
944ad3cab52Sdrh   }
945ad3cab52Sdrh   return pNew;
946ad3cab52Sdrh }
94717435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
948ff78bd2fSdrh   IdList *pNew;
949ff78bd2fSdrh   int i;
950ff78bd2fSdrh   if( p==0 ) return 0;
95117435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
952ff78bd2fSdrh   if( pNew==0 ) return 0;
9536c535158Sdrh   pNew->nId = p->nId;
95417435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
955d5d56523Sdanielk1977   if( pNew->a==0 ){
956633e6d57Sdrh     sqlite3DbFree(db, pNew);
957d5d56523Sdanielk1977     return 0;
958d5d56523Sdanielk1977   }
9596c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
9606c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
9616c535158Sdrh   ** on the duplicate created by this function. */
962ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9634efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9644efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
96517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9664efc4754Sdrh     pNewItem->idx = pOldItem->idx;
967ff78bd2fSdrh   }
968ff78bd2fSdrh   return pNew;
969ff78bd2fSdrh }
9706ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
97123b1b372Sdrh   Select *pNew, *pPrior;
972ff78bd2fSdrh   if( p==0 ) return 0;
97317435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
974ff78bd2fSdrh   if( pNew==0 ) return 0;
975b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9766ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9776ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9786ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9796ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9806ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
981ff78bd2fSdrh   pNew->op = p->op;
98223b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
98323b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
98423b1b372Sdrh   pNew->pNext = 0;
9856ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9866ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
98792b01d53Sdrh   pNew->iLimit = 0;
98892b01d53Sdrh   pNew->iOffset = 0;
9897d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
9900342b1f5Sdrh   pNew->pRightmost = 0;
991b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
992b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
993b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
994ff78bd2fSdrh   return pNew;
995ff78bd2fSdrh }
99693758c8dSdanielk1977 #else
9976ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
99893758c8dSdanielk1977   assert( p==0 );
99993758c8dSdanielk1977   return 0;
100093758c8dSdanielk1977 }
100193758c8dSdanielk1977 #endif
1002ff78bd2fSdrh 
1003ff78bd2fSdrh 
1004ff78bd2fSdrh /*
1005a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1006a76b5dfcSdrh ** initially NULL, then create a new expression list.
1007b7916a78Sdrh **
1008b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1009b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1010b7916a78Sdrh ** that the new entry was successfully appended.
1011a76b5dfcSdrh */
101217435752Sdrh ExprList *sqlite3ExprListAppend(
101317435752Sdrh   Parse *pParse,          /* Parsing context */
101417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1015b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
101617435752Sdrh ){
101717435752Sdrh   sqlite3 *db = pParse->db;
1018a76b5dfcSdrh   if( pList==0 ){
101917435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1020a76b5dfcSdrh     if( pList==0 ){
1021d5d56523Sdanielk1977       goto no_mem;
1022a76b5dfcSdrh     }
1023d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1024d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1025d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1026d5d56523Sdanielk1977     struct ExprList_item *a;
1027d872bb18Sdrh     assert( pList->nExpr>0 );
1028d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1029d5d56523Sdanielk1977     if( a==0 ){
1030d5d56523Sdanielk1977       goto no_mem;
1031a76b5dfcSdrh     }
1032d5d56523Sdanielk1977     pList->a = a;
1033a76b5dfcSdrh   }
10344efc4754Sdrh   assert( pList->a!=0 );
1035b7916a78Sdrh   if( 1 ){
10364efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10374efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1038e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1039a76b5dfcSdrh   }
1040a76b5dfcSdrh   return pList;
1041d5d56523Sdanielk1977 
1042d5d56523Sdanielk1977 no_mem:
1043d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1044633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1045633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1046d5d56523Sdanielk1977   return 0;
1047a76b5dfcSdrh }
1048a76b5dfcSdrh 
1049a76b5dfcSdrh /*
1050b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1051b7916a78Sdrh ** on the expression list.
1052b7916a78Sdrh **
1053b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1054b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1055b7916a78Sdrh ** is set.
1056b7916a78Sdrh */
1057b7916a78Sdrh void sqlite3ExprListSetName(
1058b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1059b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1060b7916a78Sdrh   Token *pName,           /* Name to be added */
1061b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1062b7916a78Sdrh ){
1063b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1064b7916a78Sdrh   if( pList ){
1065b7916a78Sdrh     struct ExprList_item *pItem;
1066b7916a78Sdrh     assert( pList->nExpr>0 );
1067b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1068b7916a78Sdrh     assert( pItem->zName==0 );
1069b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1070b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1071b7916a78Sdrh   }
1072b7916a78Sdrh }
1073b7916a78Sdrh 
1074b7916a78Sdrh /*
1075b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1076b7916a78Sdrh ** on the expression list.
1077b7916a78Sdrh **
1078b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1079b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1080b7916a78Sdrh ** is set.
1081b7916a78Sdrh */
1082b7916a78Sdrh void sqlite3ExprListSetSpan(
1083b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1084b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1085b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1086b7916a78Sdrh ){
1087b7916a78Sdrh   sqlite3 *db = pParse->db;
1088b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1089b7916a78Sdrh   if( pList ){
1090b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1091b7916a78Sdrh     assert( pList->nExpr>0 );
1092b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1093b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1094b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1095cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1096b7916a78Sdrh   }
1097b7916a78Sdrh }
1098b7916a78Sdrh 
1099b7916a78Sdrh /*
11007a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
11017a15a4beSdanielk1977 ** leave an error message in pParse.
11027a15a4beSdanielk1977 */
11037a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
11047a15a4beSdanielk1977   Parse *pParse,
11057a15a4beSdanielk1977   ExprList *pEList,
11067a15a4beSdanielk1977   const char *zObject
11077a15a4beSdanielk1977 ){
1108b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1109c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1110c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1111b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11127a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11137a15a4beSdanielk1977   }
11147a15a4beSdanielk1977 }
11157a15a4beSdanielk1977 
11167a15a4beSdanielk1977 /*
1117a76b5dfcSdrh ** Delete an entire expression list.
1118a76b5dfcSdrh */
1119633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1120a76b5dfcSdrh   int i;
1121be5c89acSdrh   struct ExprList_item *pItem;
1122a76b5dfcSdrh   if( pList==0 ) return;
1123d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1124be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1125633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1126633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1127b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1128a76b5dfcSdrh   }
1129633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1130633e6d57Sdrh   sqlite3DbFree(db, pList);
1131a76b5dfcSdrh }
1132a76b5dfcSdrh 
1133a76b5dfcSdrh /*
11347d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11357d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11367d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11377d10d5a6Sdrh ** not constant.
113873b211abSdrh **
11397d10d5a6Sdrh ** These callback routines are used to implement the following:
1140626a879aSdrh **
11417d10d5a6Sdrh **     sqlite3ExprIsConstant()
11427d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11437d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
114487abf5c0Sdrh **
1145626a879aSdrh */
11467d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1147626a879aSdrh 
11487d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11490a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11500a168377Sdrh   ** from being considered constant. */
11517d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11527d10d5a6Sdrh     pWalker->u.i = 0;
11537d10d5a6Sdrh     return WRC_Abort;
11540a168377Sdrh   }
11550a168377Sdrh 
1156626a879aSdrh   switch( pExpr->op ){
1157eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11587d10d5a6Sdrh     ** and pWalker->u.i==2 */
1159eb55bd2fSdrh     case TK_FUNCTION:
11607d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1161eb55bd2fSdrh       /* Fall through */
1162626a879aSdrh     case TK_ID:
1163626a879aSdrh     case TK_COLUMN:
1164626a879aSdrh     case TK_AGG_FUNCTION:
116513449892Sdrh     case TK_AGG_COLUMN:
1166c5499befSdrh       testcase( pExpr->op==TK_ID );
1167c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1168c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1169c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11707d10d5a6Sdrh       pWalker->u.i = 0;
11717d10d5a6Sdrh       return WRC_Abort;
1172626a879aSdrh     default:
1173b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1174b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
11757d10d5a6Sdrh       return WRC_Continue;
1176626a879aSdrh   }
1177626a879aSdrh }
117862c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
117962c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11807d10d5a6Sdrh   pWalker->u.i = 0;
11817d10d5a6Sdrh   return WRC_Abort;
11827d10d5a6Sdrh }
11837d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11847d10d5a6Sdrh   Walker w;
11857d10d5a6Sdrh   w.u.i = initFlag;
11867d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11877d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11887d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11897d10d5a6Sdrh   return w.u.i;
11907d10d5a6Sdrh }
1191626a879aSdrh 
1192626a879aSdrh /*
1193fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1194eb55bd2fSdrh ** and 0 if it involves variables or function calls.
11952398937bSdrh **
11962398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
11972398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
11982398937bSdrh ** a constant.
1199fef5208cSdrh */
12004adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
12017d10d5a6Sdrh   return exprIsConst(p, 1);
1202fef5208cSdrh }
1203fef5208cSdrh 
1204fef5208cSdrh /*
1205eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12060a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12070a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12080a168377Sdrh ** an ON or USING clause.
12090a168377Sdrh */
12100a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12117d10d5a6Sdrh   return exprIsConst(p, 3);
12120a168377Sdrh }
12130a168377Sdrh 
12140a168377Sdrh /*
12150a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1216eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1217eb55bd2fSdrh ** are any variables.
1218eb55bd2fSdrh **
1219eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1220eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1221eb55bd2fSdrh ** a constant.
1222eb55bd2fSdrh */
1223eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12247d10d5a6Sdrh   return exprIsConst(p, 2);
1225eb55bd2fSdrh }
1226eb55bd2fSdrh 
1227eb55bd2fSdrh /*
122873b211abSdrh ** If the expression p codes a constant integer that is small enough
1229202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1230202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1231202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1232e4de1febSdrh */
12334adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
123492b01d53Sdrh   int rc = 0;
1235cd92e84dSdrh 
1236cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1237cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1238cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1239cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1240cd92e84dSdrh 
124192b01d53Sdrh   if( p->flags & EP_IntValue ){
124233e619fcSdrh     *pValue = p->u.iValue;
1243e4de1febSdrh     return 1;
1244e4de1febSdrh   }
124592b01d53Sdrh   switch( p->op ){
12464b59ab5eSdrh     case TK_UPLUS: {
124792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1248f6e369a1Sdrh       break;
12494b59ab5eSdrh     }
1250e4de1febSdrh     case TK_UMINUS: {
1251e4de1febSdrh       int v;
12524adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1253e4de1febSdrh         *pValue = -v;
125492b01d53Sdrh         rc = 1;
1255e4de1febSdrh       }
1256e4de1febSdrh       break;
1257e4de1febSdrh     }
1258e4de1febSdrh     default: break;
1259e4de1febSdrh   }
126092b01d53Sdrh   return rc;
1261e4de1febSdrh }
1262e4de1febSdrh 
1263e4de1febSdrh /*
1264039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1265039fc32eSdrh **
1266039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1267039fc32eSdrh ** to tell return TRUE.
1268039fc32eSdrh **
1269039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1270039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1271039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1272039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1273039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1274039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1275039fc32eSdrh ** TRUE.
1276039fc32eSdrh */
1277039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1278039fc32eSdrh   u8 op;
1279cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1280039fc32eSdrh   op = p->op;
1281039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1282039fc32eSdrh   switch( op ){
1283039fc32eSdrh     case TK_INTEGER:
1284039fc32eSdrh     case TK_STRING:
1285039fc32eSdrh     case TK_FLOAT:
1286039fc32eSdrh     case TK_BLOB:
1287039fc32eSdrh       return 0;
1288039fc32eSdrh     default:
1289039fc32eSdrh       return 1;
1290039fc32eSdrh   }
1291039fc32eSdrh }
1292039fc32eSdrh 
1293039fc32eSdrh /*
12942f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
12952f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
12962f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
12972f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
12982f2855b6Sdrh ** can be omitted.
12992f2855b6Sdrh */
13002f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
13012f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
13022f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
13032f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
13042f2855b6Sdrh   int iDest           /* Jump here if the value is null */
13052f2855b6Sdrh ){
13062f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
13072f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
13082f2855b6Sdrh   }
13092f2855b6Sdrh }
13102f2855b6Sdrh 
13112f2855b6Sdrh /*
1312039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1313039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1314039fc32eSdrh ** argument.
1315039fc32eSdrh **
1316039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1317039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1318039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1319039fc32eSdrh ** answer.
1320039fc32eSdrh */
1321039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1322039fc32eSdrh   u8 op;
1323039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1324cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1325039fc32eSdrh   op = p->op;
1326039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1327039fc32eSdrh   switch( op ){
1328039fc32eSdrh     case TK_INTEGER: {
1329039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1330039fc32eSdrh     }
1331039fc32eSdrh     case TK_FLOAT: {
1332039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1333039fc32eSdrh     }
1334039fc32eSdrh     case TK_STRING: {
1335039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1336039fc32eSdrh     }
1337039fc32eSdrh     case TK_BLOB: {
1338039fc32eSdrh       return 1;
1339039fc32eSdrh     }
13402f2855b6Sdrh     case TK_COLUMN: {
134188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
134288376ca7Sdrh       return p->iColumn<0
13432f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
13442f2855b6Sdrh     }
1345039fc32eSdrh     default: {
1346039fc32eSdrh       return 0;
1347039fc32eSdrh     }
1348039fc32eSdrh   }
1349039fc32eSdrh }
1350039fc32eSdrh 
1351039fc32eSdrh /*
1352c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1353c4a3c779Sdrh */
13544adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
13554adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
13564adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
13574adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1358c4a3c779Sdrh   return 0;
1359c4a3c779Sdrh }
1360c4a3c779Sdrh 
13619a96b668Sdanielk1977 /*
1362b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1363b74b1017Sdrh ** query of the form
1364b287f4b6Sdrh **
1365b74b1017Sdrh **       x IN (SELECT ...)
1366b287f4b6Sdrh **
1367b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1368b74b1017Sdrh ** routine.
1369b74b1017Sdrh **
1370b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1371b74b1017Sdrh ** errors have been found.
1372b287f4b6Sdrh */
1373b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1374b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1375b287f4b6Sdrh   SrcList *pSrc;
1376b287f4b6Sdrh   ExprList *pEList;
1377b287f4b6Sdrh   Table *pTab;
1378b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1379b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
13807d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1381b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1382b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
13837d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
13847d10d5a6Sdrh   }
1385b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1386b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1387b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1388b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1389b287f4b6Sdrh   pSrc = p->pSrc;
1390d1fa7bcaSdrh   assert( pSrc!=0 );
1391d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1392b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1393b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1394b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1395b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1396b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1397b287f4b6Sdrh   pEList = p->pEList;
1398b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1399b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1400b287f4b6Sdrh   return 1;
1401b287f4b6Sdrh }
1402b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1403b287f4b6Sdrh 
1404b287f4b6Sdrh /*
14051d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
14061d8cb21fSdan ** address of the new instruction.
14071d8cb21fSdan */
14081d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
14091d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
14101d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
14111d8cb21fSdan }
14121d8cb21fSdan 
14131d8cb21fSdan /*
14149a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1415d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1416d4305ca6Sdrh ** might be either a list of expressions or a subquery.
14179a96b668Sdanielk1977 **
1418d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1419d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1420d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1421d4305ca6Sdrh **
1422d4305ca6Sdrh ** A cursor is opened on the b-tree object that the RHS of the IN operator
1423d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1424d4305ca6Sdrh **
1425b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
14269a96b668Sdanielk1977 **
14279a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
14282d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
14299a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
14309a96b668Sdanielk1977 **                    populated epheremal table.
14319a96b668Sdanielk1977 **
1432d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1433d4305ca6Sdrh ** subquery such as:
14349a96b668Sdanielk1977 **
14359a96b668Sdanielk1977 **     SELECT <column> FROM <table>
14369a96b668Sdanielk1977 **
1437d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1438d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
1439d4305ca6Sdrh ** pX->iTable made to point to the ephermeral table instead of an
1440d4305ca6Sdrh ** existing table.
1441d4305ca6Sdrh **
1442b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
14439a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
14449a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
14459a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1446b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
14470cdc022eSdanielk1977 **
1448b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
14490cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
14500cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
14510cdc022eSdanielk1977 ** be found with <column> as its left-most column.
14520cdc022eSdanielk1977 **
1453b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
14540cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
14550cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1456e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
14570cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1458e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
14590cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
14600cdc022eSdanielk1977 **
14610cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1462e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1463e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1464b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1465e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1466b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
14670cdc022eSdanielk1977 **
14680cdc022eSdanielk1977 **   if( register==NULL ){
14690cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
14700cdc022eSdanielk1977 **     register = 1
14710cdc022eSdanielk1977 **   }
14720cdc022eSdanielk1977 **
14730cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
14740cdc022eSdanielk1977 ** test more often than is necessary.
14759a96b668Sdanielk1977 */
1476284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
14770cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1478b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1479b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1480b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1481b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
1482b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
14839a96b668Sdanielk1977 
14841450bc6eSdrh   assert( pX->op==TK_IN );
14851450bc6eSdrh 
1486b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1487b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1488b74b1017Sdrh   ** ephemeral table.
14899a96b668Sdanielk1977   */
14906ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1491fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1492e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1493b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1494b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1495b07028f7Sdrh     int iCol;                              /* Index of column <column> */
1496e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1497e1fb65a0Sdanielk1977 
1498b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1499b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1500b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1501b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1502b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1503b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1504b07028f7Sdrh     iCol = pExpr->iColumn;
1505b07028f7Sdrh 
1506e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1507e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1508e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1509e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
15109a96b668Sdanielk1977 
15119a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
15129a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
15139a96b668Sdanielk1977     ** successful here.
15149a96b668Sdanielk1977     */
15159a96b668Sdanielk1977     assert(v);
15169a96b668Sdanielk1977     if( iCol<0 ){
15179a96b668Sdanielk1977       int iAddr;
15189a96b668Sdanielk1977 
15191d8cb21fSdan       iAddr = sqlite3CodeOnce(pParse);
15209a96b668Sdanielk1977 
15219a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
15229a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
15239a96b668Sdanielk1977 
15249a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
15259a96b668Sdanielk1977     }else{
1526e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1527e1fb65a0Sdanielk1977 
15289a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
15299a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1530e1fb65a0Sdanielk1977       ** to this collation sequence.  */
15319a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
15329a96b668Sdanielk1977 
15339a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
15349a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
15359a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
15369a96b668Sdanielk1977       */
1537dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
15389a96b668Sdanielk1977 
15399a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
15409a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1541b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
15429a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
15439a96b668Sdanielk1977         ){
15449a96b668Sdanielk1977           int iAddr;
15459a96b668Sdanielk1977           char *pKey;
15469a96b668Sdanielk1977 
15479a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
15481d8cb21fSdan           iAddr = sqlite3CodeOnce(pParse);
15499a96b668Sdanielk1977 
1550207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
155166a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1552207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
15539a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
15549a96b668Sdanielk1977 
15559a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
15560cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
15570cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
1558b8475df8Sdrh             sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
15590cdc022eSdanielk1977           }
15609a96b668Sdanielk1977         }
15619a96b668Sdanielk1977       }
15629a96b668Sdanielk1977     }
15639a96b668Sdanielk1977   }
15649a96b668Sdanielk1977 
15659a96b668Sdanielk1977   if( eType==0 ){
15661450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1567b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1568b74b1017Sdrh     */
1569cf4d38aaSdrh     double savedNQueryLoop = pParse->nQueryLoop;
15700cdc022eSdanielk1977     int rMayHaveNull = 0;
157141a05b7bSdanielk1977     eType = IN_INDEX_EPH;
15720cdc022eSdanielk1977     if( prNotFound ){
15730cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1574b8475df8Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
1575cf4d38aaSdrh     }else{
1576cf4d38aaSdrh       testcase( pParse->nQueryLoop>(double)1 );
1577cf4d38aaSdrh       pParse->nQueryLoop = (double)1;
1578cf4d38aaSdrh       if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
157941a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
15800cdc022eSdanielk1977       }
1581cf4d38aaSdrh     }
158241a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1583cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
15849a96b668Sdanielk1977   }else{
15859a96b668Sdanielk1977     pX->iTable = iTab;
15869a96b668Sdanielk1977   }
15879a96b668Sdanielk1977   return eType;
15889a96b668Sdanielk1977 }
1589284f4acaSdanielk1977 #endif
1590626a879aSdrh 
1591626a879aSdrh /*
1592d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1593d4187c71Sdrh ** or IN operators.  Examples:
1594626a879aSdrh **
15959cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
15969cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
15979cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
15989cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1599fef5208cSdrh **
16009cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
16019cbe6352Sdrh ** operator or subquery.
160241a05b7bSdanielk1977 **
160341a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
160441a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
160541a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
160641a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
160741a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1608fd773cf9Sdrh **
1609fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1610fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1611fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1612fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1613fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1614fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1615fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1616fd773cf9Sdrh **
1617fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1618fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1619fd773cf9Sdrh ** registers to indicate the presense or absence of NULLs on the RHS.
16201450bc6eSdrh **
16211450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
16221450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1623cce7d176Sdrh */
162451522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
16251450bc6eSdrh int sqlite3CodeSubselect(
1626fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1627fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1628fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1629fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
163041a05b7bSdanielk1977 ){
1631dfd2d9f6Sdrh   int testAddr = -1;                      /* One-time test address */
16321450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1633b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
16341450bc6eSdrh   if( NEVER(v==0) ) return 0;
1635ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1636fc976065Sdanielk1977 
163757dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
163857dbd7b3Sdrh   ** if any of the following is true:
163957dbd7b3Sdrh   **
164057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
164157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
164257dbd7b3Sdrh   **    *  We are inside a trigger
164357dbd7b3Sdrh   **
164457dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
164557dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1646b3bce662Sdanielk1977   */
16471d8cb21fSdan   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) ){
16481d8cb21fSdan     testAddr = sqlite3CodeOnce(pParse);
1649b3bce662Sdanielk1977   }
1650b3bce662Sdanielk1977 
16514a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
16524a07e3dbSdan   if( pParse->explain==2 ){
16534a07e3dbSdan     char *zMsg = sqlite3MPrintf(
1654dfd2d9f6Sdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", testAddr>=0?"":"CORRELATED ",
16554a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
16564a07e3dbSdan     );
16574a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
16584a07e3dbSdan   }
16594a07e3dbSdan #endif
16604a07e3dbSdan 
1661cce7d176Sdrh   switch( pExpr->op ){
1662fef5208cSdrh     case TK_IN: {
1663d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1664d4187c71Sdrh       KeyInfo keyInfo;            /* Keyinfo for the generated table */
1665e1a022e4Sdrh       static u8 sortOrder = 0;    /* Fake aSortOrder for keyInfo */
1666b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1667d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1668d3d39e93Sdrh 
16690cdc022eSdanielk1977       if( rMayHaveNull ){
16700cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
16710cdc022eSdanielk1977       }
16720cdc022eSdanielk1977 
167341a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1674e014a838Sdanielk1977 
1675e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
16768cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1677e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1678e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1679fef5208cSdrh       **
1680e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1681e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1682e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1683e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1684e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1685e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1686e014a838Sdanielk1977       ** is used.
1687fef5208cSdrh       */
1688832508b7Sdrh       pExpr->iTable = pParse->nTab++;
168941a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1690d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1691d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1692d3d39e93Sdrh       keyInfo.nField = 1;
1693e1a022e4Sdrh       keyInfo.aSortOrder = &sortOrder;
1694e014a838Sdanielk1977 
16956ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1696e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1697e014a838Sdanielk1977         **
1698e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1699e014a838Sdanielk1977         ** table allocated and opened above.
1700e014a838Sdanielk1977         */
17011013c932Sdrh         SelectDest dest;
1702be5c89acSdrh         ExprList *pEList;
17031013c932Sdrh 
170441a05b7bSdanielk1977         assert( !isRowid );
17051013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
17062b596da8Sdrh         dest.affSdst = (u8)affinity;
1707e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
170848b5b041Sdrh         pExpr->x.pSelect->iLimit = 0;
17096ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
17101450bc6eSdrh           return 0;
171194ccde58Sdrh         }
17126ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1713fd773cf9Sdrh         if( ALWAYS(pEList!=0 && pEList->nExpr>0) ){
1714bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1715be5c89acSdrh               pEList->a[0].pExpr);
17160202b29eSdanielk1977         }
1717a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1718fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1719fef5208cSdrh         **
1720e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1721e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1722e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1723e014a838Sdanielk1977         ** a column, use numeric affinity.
1724fef5208cSdrh         */
1725e014a838Sdanielk1977         int i;
17266ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
172757dbd7b3Sdrh         struct ExprList_item *pItem;
1728ecc31805Sdrh         int r1, r2, r3;
172957dbd7b3Sdrh 
1730e014a838Sdanielk1977         if( !affinity ){
17318159a35fSdrh           affinity = SQLITE_AFF_NONE;
1732e014a838Sdanielk1977         }
17337d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1734e1a022e4Sdrh         keyInfo.aSortOrder = &sortOrder;
1735e014a838Sdanielk1977 
1736e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
17372d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
17382d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
17394e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
174057dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
174157dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1742e05c929bSdrh           int iValToIns;
1743e014a838Sdanielk1977 
174457dbd7b3Sdrh           /* If the expression is not constant then we will need to
174557dbd7b3Sdrh           ** disable the test that was generated above that makes sure
174657dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
174757dbd7b3Sdrh           ** expression we need to rerun this code each time.
174857dbd7b3Sdrh           */
1749dfd2d9f6Sdrh           if( testAddr>=0 && !sqlite3ExprIsConstant(pE2) ){
175048f2d3b1Sdrh             sqlite3VdbeChangeToNoop(v, testAddr);
1751dfd2d9f6Sdrh             testAddr = -1;
17524794b980Sdrh           }
1753e014a838Sdanielk1977 
1754e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1755e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1756e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1757e05c929bSdrh           }else{
1758ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
175941a05b7bSdanielk1977             if( isRowid ){
1760e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1761e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
176241a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
176341a05b7bSdanielk1977             }else{
1764ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
17653c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
17662d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1767fef5208cSdrh             }
176841a05b7bSdanielk1977           }
1769e05c929bSdrh         }
17702d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
17712d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1772fef5208cSdrh       }
177341a05b7bSdanielk1977       if( !isRowid ){
177466a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
177541a05b7bSdanielk1977       }
1776b3bce662Sdanielk1977       break;
1777fef5208cSdrh     }
1778fef5208cSdrh 
177951522cd3Sdrh     case TK_EXISTS:
1780fd773cf9Sdrh     case TK_SELECT:
1781fd773cf9Sdrh     default: {
1782fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1783fef5208cSdrh       ** value of this select in a memory cell and record the number
1784fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1785fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1786fd773cf9Sdrh       ** and record that memory cell in iColumn.
1787fef5208cSdrh       */
1788fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1789fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
17901398ad36Sdrh 
1791cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1792cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1793cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1794cf697396Sshane 
17956ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
17966ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
17971013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
179851522cd3Sdrh       if( pExpr->op==TK_SELECT ){
17996c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
18002b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
1801d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
180251522cd3Sdrh       }else{
18036c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
18042b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
1805d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
180651522cd3Sdrh       }
1807633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1808094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1809094430ebSdrh                                   &sqlite3IntTokens[1]);
181048b5b041Sdrh       pSel->iLimit = 0;
18117d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
18121450bc6eSdrh         return 0;
181394ccde58Sdrh       }
18142b596da8Sdrh       rReg = dest.iSDParm;
181533e619fcSdrh       ExprSetIrreducible(pExpr);
1816b3bce662Sdanielk1977       break;
181719a775c2Sdrh     }
1818cce7d176Sdrh   }
1819b3bce662Sdanielk1977 
1820dfd2d9f6Sdrh   if( testAddr>=0 ){
182148f2d3b1Sdrh     sqlite3VdbeJumpHere(v, testAddr);
1822b3bce662Sdanielk1977   }
1823ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1824fc976065Sdanielk1977 
18251450bc6eSdrh   return rReg;
1826cce7d176Sdrh }
182751522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1828cce7d176Sdrh 
1829e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1830e3365e6cSdrh /*
1831e3365e6cSdrh ** Generate code for an IN expression.
1832e3365e6cSdrh **
1833e3365e6cSdrh **      x IN (SELECT ...)
1834e3365e6cSdrh **      x IN (value, value, ...)
1835e3365e6cSdrh **
1836e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1837e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1838e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1839e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1840e3365e6cSdrh ** RHS contains one or more NULL values.
1841e3365e6cSdrh **
1842e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1843e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1844e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1845e3365e6cSdrh ** within the RHS then fall through.
1846e3365e6cSdrh */
1847e3365e6cSdrh static void sqlite3ExprCodeIN(
1848e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1849e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1850e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1851e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1852e3365e6cSdrh ){
1853e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1854e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1855e3365e6cSdrh   int eType;            /* Type of the RHS */
1856e3365e6cSdrh   int r1;               /* Temporary use register */
1857e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1858e3365e6cSdrh 
1859e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1860e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1861e3365e6cSdrh   */
1862e3365e6cSdrh   v = pParse->pVdbe;
1863e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1864e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1865e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1866e3365e6cSdrh 
1867e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1868e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1869e3365e6cSdrh   ** P4 of OP_MakeRecord.
1870e3365e6cSdrh   */
1871e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1872e3365e6cSdrh 
1873e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1874e3365e6cSdrh   */
1875e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1876e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1877e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1878e3365e6cSdrh 
1879094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1880094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1881094430ebSdrh   */
1882094430ebSdrh   if( destIfNull==destIfFalse ){
1883094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1884094430ebSdrh     ** the same. */
1885094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1886094430ebSdrh   }else{
1887094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1888094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1889094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1890094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1891094430ebSdrh   }
1892e3365e6cSdrh 
1893e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1894e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1895e3365e6cSdrh     */
1896e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1897e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1898e3365e6cSdrh   }else{
1899e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1900e3365e6cSdrh     */
19018cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1902e3365e6cSdrh 
1903e3365e6cSdrh     /* If the set membership test fails, then the result of the
1904e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1905e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1906e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1907e3365e6cSdrh     ** expression is also NULL.
1908e3365e6cSdrh     */
1909e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1910e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1911e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1912e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1913e3365e6cSdrh       **
1914e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1915e3365e6cSdrh       ** for this particular IN operator.
1916e3365e6cSdrh       */
19178cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1918e3365e6cSdrh 
1919e3365e6cSdrh     }else{
1920e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1921e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1922e3365e6cSdrh       ** outcome.
1923e3365e6cSdrh       */
1924e3365e6cSdrh       int j1, j2, j3;
1925e3365e6cSdrh 
1926e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1927e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1928e3365e6cSdrh       ** over all of the code that follows.
1929e3365e6cSdrh       */
19308cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
1931e3365e6cSdrh 
1932e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1933e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1934e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1935e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1936e3365e6cSdrh       ** jump to destIfFalse.
1937e3365e6cSdrh       */
1938e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
19398cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
1940e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1941e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1942e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1943e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1944e3365e6cSdrh 
1945e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1946e3365e6cSdrh       ** the RHS contains a NULL
1947e3365e6cSdrh       */
1948e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1949e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1950e3365e6cSdrh 
1951e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1952e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1953e3365e6cSdrh       */
1954e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1955e3365e6cSdrh     }
1956e3365e6cSdrh   }
1957e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
1958e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
1959e3365e6cSdrh   VdbeComment((v, "end IN expr"));
1960e3365e6cSdrh }
1961e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
1962e3365e6cSdrh 
1963cce7d176Sdrh /*
1964598f1340Sdrh ** Duplicate an 8-byte value
1965598f1340Sdrh */
1966598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1967598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1968598f1340Sdrh   if( out ){
1969598f1340Sdrh     memcpy(out, in, 8);
1970598f1340Sdrh   }
1971598f1340Sdrh   return out;
1972598f1340Sdrh }
1973598f1340Sdrh 
197413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
1975598f1340Sdrh /*
1976598f1340Sdrh ** Generate an instruction that will put the floating point
19779cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
19780cf19ed8Sdrh **
19790cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
19800cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
19810cf19ed8Sdrh ** like the continuation of the number.
1982598f1340Sdrh */
1983b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1984fd773cf9Sdrh   if( ALWAYS(z!=0) ){
1985598f1340Sdrh     double value;
1986598f1340Sdrh     char *zV;
19879339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
1988d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
1989598f1340Sdrh     if( negateFlag ) value = -value;
1990598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
19919de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
1992598f1340Sdrh   }
1993598f1340Sdrh }
199413573c71Sdrh #endif
1995598f1340Sdrh 
1996598f1340Sdrh 
1997598f1340Sdrh /*
1998fec19aadSdrh ** Generate an instruction that will put the integer describe by
19999cbf3425Sdrh ** text z[0..n-1] into register iMem.
20000cf19ed8Sdrh **
20015f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2002fec19aadSdrh */
200313573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
200413573c71Sdrh   Vdbe *v = pParse->pVdbe;
200592b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
200633e619fcSdrh     int i = pExpr->u.iValue;
2007d50ffc41Sdrh     assert( i>=0 );
200892b01d53Sdrh     if( negFlag ) i = -i;
200992b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2010fd773cf9Sdrh   }else{
20115f1d6b61Sshaneh     int c;
20125f1d6b61Sshaneh     i64 value;
2013fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2014fd773cf9Sdrh     assert( z!=0 );
20155f1d6b61Sshaneh     c = sqlite3Atoi64(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
20165f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2017598f1340Sdrh       char *zV;
2018158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
2019598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
20209de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
2021fec19aadSdrh     }else{
202213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
202313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
202413573c71Sdrh #else
2025b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
202613573c71Sdrh #endif
2027fec19aadSdrh     }
2028fec19aadSdrh   }
2029c9cf901dSdanielk1977 }
2030fec19aadSdrh 
2031ceea3321Sdrh /*
2032ceea3321Sdrh ** Clear a cache entry.
2033ceea3321Sdrh */
2034ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2035ceea3321Sdrh   if( p->tempReg ){
2036ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2037ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2038ceea3321Sdrh     }
2039ceea3321Sdrh     p->tempReg = 0;
2040ceea3321Sdrh   }
2041ceea3321Sdrh }
2042ceea3321Sdrh 
2043ceea3321Sdrh 
2044ceea3321Sdrh /*
2045ceea3321Sdrh ** Record in the column cache that a particular column from a
2046ceea3321Sdrh ** particular table is stored in a particular register.
2047ceea3321Sdrh */
2048ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2049ceea3321Sdrh   int i;
2050ceea3321Sdrh   int minLru;
2051ceea3321Sdrh   int idxLru;
2052ceea3321Sdrh   struct yColCache *p;
2053ceea3321Sdrh 
205420411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
205520411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
205620411ea7Sdrh 
2057b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2058b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2059b6da74ebSdrh   ** with and without the column cache.
2060b6da74ebSdrh   */
20617e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2062b6da74ebSdrh 
206327ee406eSdrh   /* First replace any existing entry.
206427ee406eSdrh   **
206527ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
206627ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
206727ee406eSdrh   */
206827ee406eSdrh #ifndef NDEBUG
2069ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
207027ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2071ceea3321Sdrh   }
207227ee406eSdrh #endif
2073ceea3321Sdrh 
2074ceea3321Sdrh   /* Find an empty slot and replace it */
2075ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2076ceea3321Sdrh     if( p->iReg==0 ){
2077ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2078ceea3321Sdrh       p->iTable = iTab;
2079ceea3321Sdrh       p->iColumn = iCol;
2080ceea3321Sdrh       p->iReg = iReg;
2081ceea3321Sdrh       p->tempReg = 0;
2082ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2083ceea3321Sdrh       return;
2084ceea3321Sdrh     }
2085ceea3321Sdrh   }
2086ceea3321Sdrh 
2087ceea3321Sdrh   /* Replace the last recently used */
2088ceea3321Sdrh   minLru = 0x7fffffff;
2089ceea3321Sdrh   idxLru = -1;
2090ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2091ceea3321Sdrh     if( p->lru<minLru ){
2092ceea3321Sdrh       idxLru = i;
2093ceea3321Sdrh       minLru = p->lru;
2094ceea3321Sdrh     }
2095ceea3321Sdrh   }
209620411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2097ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2098ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2099ceea3321Sdrh     p->iTable = iTab;
2100ceea3321Sdrh     p->iColumn = iCol;
2101ceea3321Sdrh     p->iReg = iReg;
2102ceea3321Sdrh     p->tempReg = 0;
2103ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2104ceea3321Sdrh     return;
2105ceea3321Sdrh   }
2106ceea3321Sdrh }
2107ceea3321Sdrh 
2108ceea3321Sdrh /*
2109f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2110f49f3523Sdrh ** Purge the range of registers from the column cache.
2111ceea3321Sdrh */
2112f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2113ceea3321Sdrh   int i;
2114f49f3523Sdrh   int iLast = iReg + nReg - 1;
2115ceea3321Sdrh   struct yColCache *p;
2116ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2117f49f3523Sdrh     int r = p->iReg;
2118f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2119ceea3321Sdrh       cacheEntryClear(pParse, p);
2120ceea3321Sdrh       p->iReg = 0;
2121ceea3321Sdrh     }
2122ceea3321Sdrh   }
2123ceea3321Sdrh }
2124ceea3321Sdrh 
2125ceea3321Sdrh /*
2126ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2127ceea3321Sdrh ** added to the column cache after this call are removed when the
2128ceea3321Sdrh ** corresponding pop occurs.
2129ceea3321Sdrh */
2130ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2131ceea3321Sdrh   pParse->iCacheLevel++;
2132ceea3321Sdrh }
2133ceea3321Sdrh 
2134ceea3321Sdrh /*
2135ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2136ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2137ceea3321Sdrh ** to the state it was in N Pushes ago.
2138ceea3321Sdrh */
2139ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2140ceea3321Sdrh   int i;
2141ceea3321Sdrh   struct yColCache *p;
2142ceea3321Sdrh   assert( N>0 );
2143ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2144ceea3321Sdrh   pParse->iCacheLevel -= N;
2145ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2146ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2147ceea3321Sdrh       cacheEntryClear(pParse, p);
2148ceea3321Sdrh       p->iReg = 0;
2149ceea3321Sdrh     }
2150ceea3321Sdrh   }
2151ceea3321Sdrh }
2152945498f3Sdrh 
2153945498f3Sdrh /*
21545cd79239Sdrh ** When a cached column is reused, make sure that its register is
21555cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
21565cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
21575cd79239Sdrh ** get them all.
21585cd79239Sdrh */
21595cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
21605cd79239Sdrh   int i;
21615cd79239Sdrh   struct yColCache *p;
21625cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
21635cd79239Sdrh     if( p->iReg==iReg ){
21645cd79239Sdrh       p->tempReg = 0;
21655cd79239Sdrh     }
21665cd79239Sdrh   }
21675cd79239Sdrh }
21685cd79239Sdrh 
21695cd79239Sdrh /*
21705c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
21715c092e8aSdrh */
21725c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
21735c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
21745c092e8aSdrh   Table *pTab,    /* The table containing the value */
21755c092e8aSdrh   int iTabCur,    /* The cursor for this table */
21765c092e8aSdrh   int iCol,       /* Index of the column to extract */
21775c092e8aSdrh   int regOut      /* Extract the valud into this register */
21785c092e8aSdrh ){
21795c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
21805c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
21815c092e8aSdrh   }else{
21825c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
21835c092e8aSdrh     sqlite3VdbeAddOp3(v, op, iTabCur, iCol, regOut);
21845c092e8aSdrh   }
21855c092e8aSdrh   if( iCol>=0 ){
21865c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
21875c092e8aSdrh   }
21885c092e8aSdrh }
21895c092e8aSdrh 
21905c092e8aSdrh /*
2191945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2192e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2193e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2194e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2195e55cbd72Sdrh **
2196e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2197e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2198945498f3Sdrh */
2199e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2200e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
22012133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
22022133d822Sdrh   int iColumn,     /* Index of the table column */
22032133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2204a748fdccSdrh   int iReg,        /* Store results here */
2205a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
22062133d822Sdrh ){
2207e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2208e55cbd72Sdrh   int i;
2209da250ea5Sdrh   struct yColCache *p;
2210e55cbd72Sdrh 
2211ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2212b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2213ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
22145cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2215da250ea5Sdrh       return p->iReg;
2216e55cbd72Sdrh     }
2217e55cbd72Sdrh   }
2218e55cbd72Sdrh   assert( v!=0 );
22195c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2220a748fdccSdrh   if( p5 ){
2221a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2222a748fdccSdrh   }else{
2223ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2224a748fdccSdrh   }
2225e55cbd72Sdrh   return iReg;
2226e55cbd72Sdrh }
2227e55cbd72Sdrh 
2228e55cbd72Sdrh /*
2229ceea3321Sdrh ** Clear all column cache entries.
2230e55cbd72Sdrh */
2231ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2232e55cbd72Sdrh   int i;
2233ceea3321Sdrh   struct yColCache *p;
2234ceea3321Sdrh 
2235ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2236ceea3321Sdrh     if( p->iReg ){
2237ceea3321Sdrh       cacheEntryClear(pParse, p);
2238ceea3321Sdrh       p->iReg = 0;
2239e55cbd72Sdrh     }
2240da250ea5Sdrh   }
2241da250ea5Sdrh }
2242e55cbd72Sdrh 
2243e55cbd72Sdrh /*
2244da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2245da250ea5Sdrh ** registers starting with iStart.
2246e55cbd72Sdrh */
2247da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2248f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2249e55cbd72Sdrh }
2250e55cbd72Sdrh 
2251e55cbd72Sdrh /*
2252b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2253b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2254e55cbd72Sdrh */
2255b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2256e55cbd72Sdrh   int i;
2257ceea3321Sdrh   struct yColCache *p;
2258e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2259e8e4af76Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg-1);
2260ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2261ceea3321Sdrh     int x = p->iReg;
2262b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2263ceea3321Sdrh       p->iReg += iTo-iFrom;
2264e55cbd72Sdrh     }
2265e55cbd72Sdrh   }
2266945498f3Sdrh }
2267945498f3Sdrh 
2268f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
226992b01d53Sdrh /*
2270652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2271652fbf55Sdrh ** is used as part of the column cache.
2272f49f3523Sdrh **
2273f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2274f49f3523Sdrh ** and does not appear in a normal build.
2275652fbf55Sdrh */
2276652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2277652fbf55Sdrh   int i;
2278ceea3321Sdrh   struct yColCache *p;
2279ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2280ceea3321Sdrh     int r = p->iReg;
2281f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2282652fbf55Sdrh   }
2283652fbf55Sdrh   return 0;
2284652fbf55Sdrh }
2285f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2286652fbf55Sdrh 
2287652fbf55Sdrh /*
2288cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
22892dcef11bSdrh ** expression.  Attempt to store the results in register "target".
22902dcef11bSdrh ** Return the register where results are stored.
2291389a1adbSdrh **
22928b213899Sdrh ** With this routine, there is no guarantee that results will
22932dcef11bSdrh ** be stored in target.  The result might be stored in some other
22942dcef11bSdrh ** register if it is convenient to do so.  The calling function
22952dcef11bSdrh ** must check the return code and move the results to the desired
22962dcef11bSdrh ** register.
2297cce7d176Sdrh */
2298678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
22992dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
23002dcef11bSdrh   int op;                   /* The opcode being coded */
23012dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
23022dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
23032dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2304678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
230520411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2306ffe07b2dSdrh 
23079cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
230820411ea7Sdrh   if( v==0 ){
230920411ea7Sdrh     assert( pParse->db->mallocFailed );
231020411ea7Sdrh     return 0;
231120411ea7Sdrh   }
2312389a1adbSdrh 
2313389a1adbSdrh   if( pExpr==0 ){
2314389a1adbSdrh     op = TK_NULL;
2315389a1adbSdrh   }else{
2316f2bc013cSdrh     op = pExpr->op;
2317389a1adbSdrh   }
2318f2bc013cSdrh   switch( op ){
231913449892Sdrh     case TK_AGG_COLUMN: {
232013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
232113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
232213449892Sdrh       if( !pAggInfo->directMode ){
23239de221dfSdrh         assert( pCol->iMem>0 );
23249de221dfSdrh         inReg = pCol->iMem;
232513449892Sdrh         break;
232613449892Sdrh       }else if( pAggInfo->useSortingIdx ){
23275134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2328389a1adbSdrh                               pCol->iSorterColumn, target);
232913449892Sdrh         break;
233013449892Sdrh       }
233113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
233213449892Sdrh     }
2333967e8b73Sdrh     case TK_COLUMN: {
2334ffe07b2dSdrh       if( pExpr->iTable<0 ){
2335ffe07b2dSdrh         /* This only happens when coding check constraints */
2336aa9b8963Sdrh         assert( pParse->ckBase>0 );
2337aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2338c4a3c779Sdrh       }else{
2339e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2340a748fdccSdrh                                  pExpr->iColumn, pExpr->iTable, target,
2341a748fdccSdrh                                  pExpr->op2);
23422282792aSdrh       }
2343cce7d176Sdrh       break;
2344cce7d176Sdrh     }
2345cce7d176Sdrh     case TK_INTEGER: {
234613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2347fec19aadSdrh       break;
234851e9a445Sdrh     }
234913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2350598f1340Sdrh     case TK_FLOAT: {
235133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
235233e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2353598f1340Sdrh       break;
2354598f1340Sdrh     }
235513573c71Sdrh #endif
2356fec19aadSdrh     case TK_STRING: {
235733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
235833e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2359cce7d176Sdrh       break;
2360cce7d176Sdrh     }
2361f0863fe5Sdrh     case TK_NULL: {
23629de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2363f0863fe5Sdrh       break;
2364f0863fe5Sdrh     }
23655338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2366c572ef7fSdanielk1977     case TK_BLOB: {
23676c8c6cecSdrh       int n;
23686c8c6cecSdrh       const char *z;
2369ca48c90fSdrh       char *zBlob;
237033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
237133e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
237233e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
237333e619fcSdrh       z = &pExpr->u.zToken[2];
2374b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2375b7916a78Sdrh       assert( z[n]=='\'' );
2376ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2377ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2378c572ef7fSdanielk1977       break;
2379c572ef7fSdanielk1977     }
23805338a5f7Sdanielk1977 #endif
238150457896Sdrh     case TK_VARIABLE: {
238233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
238333e619fcSdrh       assert( pExpr->u.zToken!=0 );
238433e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2385eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
238633e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
238704e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
238804e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
238904e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2390895d7472Sdrh       }
239150457896Sdrh       break;
239250457896Sdrh     }
23934e0cff60Sdrh     case TK_REGISTER: {
23949de221dfSdrh       inReg = pExpr->iTable;
23954e0cff60Sdrh       break;
23964e0cff60Sdrh     }
23978b213899Sdrh     case TK_AS: {
23987445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
23998b213899Sdrh       break;
24008b213899Sdrh     }
2401487e262fSdrh #ifndef SQLITE_OMIT_CAST
2402487e262fSdrh     case TK_CAST: {
2403487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2404f0113000Sdanielk1977       int aff, to_op;
24052dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
240633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
240733e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2408f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2409f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2410f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2411f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2412f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2413f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2414c5499befSdrh       testcase( to_op==OP_ToText );
2415c5499befSdrh       testcase( to_op==OP_ToBlob );
2416c5499befSdrh       testcase( to_op==OP_ToNumeric );
2417c5499befSdrh       testcase( to_op==OP_ToInt );
2418c5499befSdrh       testcase( to_op==OP_ToReal );
24191735fa88Sdrh       if( inReg!=target ){
24201735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
24211735fa88Sdrh         inReg = target;
24221735fa88Sdrh       }
24232dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2424c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2425b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2426487e262fSdrh       break;
2427487e262fSdrh     }
2428487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2429c9b84a1fSdrh     case TK_LT:
2430c9b84a1fSdrh     case TK_LE:
2431c9b84a1fSdrh     case TK_GT:
2432c9b84a1fSdrh     case TK_GE:
2433c9b84a1fSdrh     case TK_NE:
2434c9b84a1fSdrh     case TK_EQ: {
2435f2bc013cSdrh       assert( TK_LT==OP_Lt );
2436f2bc013cSdrh       assert( TK_LE==OP_Le );
2437f2bc013cSdrh       assert( TK_GT==OP_Gt );
2438f2bc013cSdrh       assert( TK_GE==OP_Ge );
2439f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2440f2bc013cSdrh       assert( TK_NE==OP_Ne );
2441c5499befSdrh       testcase( op==TK_LT );
2442c5499befSdrh       testcase( op==TK_LE );
2443c5499befSdrh       testcase( op==TK_GT );
2444c5499befSdrh       testcase( op==TK_GE );
2445c5499befSdrh       testcase( op==TK_EQ );
2446c5499befSdrh       testcase( op==TK_NE );
2447b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2448b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
244935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
245035573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2451c5499befSdrh       testcase( regFree1==0 );
2452c5499befSdrh       testcase( regFree2==0 );
2453a37cdde0Sdanielk1977       break;
2454c9b84a1fSdrh     }
24556a2fe093Sdrh     case TK_IS:
24566a2fe093Sdrh     case TK_ISNOT: {
24576a2fe093Sdrh       testcase( op==TK_IS );
24586a2fe093Sdrh       testcase( op==TK_ISNOT );
2459b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2460b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24616a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
24626a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
24636a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
24646a2fe093Sdrh       testcase( regFree1==0 );
24656a2fe093Sdrh       testcase( regFree2==0 );
24666a2fe093Sdrh       break;
24676a2fe093Sdrh     }
2468cce7d176Sdrh     case TK_AND:
2469cce7d176Sdrh     case TK_OR:
2470cce7d176Sdrh     case TK_PLUS:
2471cce7d176Sdrh     case TK_STAR:
2472cce7d176Sdrh     case TK_MINUS:
2473bf4133cbSdrh     case TK_REM:
2474bf4133cbSdrh     case TK_BITAND:
2475bf4133cbSdrh     case TK_BITOR:
247617c40294Sdrh     case TK_SLASH:
2477bf4133cbSdrh     case TK_LSHIFT:
2478855eb1cfSdrh     case TK_RSHIFT:
24790040077dSdrh     case TK_CONCAT: {
2480f2bc013cSdrh       assert( TK_AND==OP_And );
2481f2bc013cSdrh       assert( TK_OR==OP_Or );
2482f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2483f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2484f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2485f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2486f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2487f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2488f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2489f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2490f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2491c5499befSdrh       testcase( op==TK_AND );
2492c5499befSdrh       testcase( op==TK_OR );
2493c5499befSdrh       testcase( op==TK_PLUS );
2494c5499befSdrh       testcase( op==TK_MINUS );
2495c5499befSdrh       testcase( op==TK_REM );
2496c5499befSdrh       testcase( op==TK_BITAND );
2497c5499befSdrh       testcase( op==TK_BITOR );
2498c5499befSdrh       testcase( op==TK_SLASH );
2499c5499befSdrh       testcase( op==TK_LSHIFT );
2500c5499befSdrh       testcase( op==TK_RSHIFT );
2501c5499befSdrh       testcase( op==TK_CONCAT );
25022dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
25032dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25045b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2505c5499befSdrh       testcase( regFree1==0 );
2506c5499befSdrh       testcase( regFree2==0 );
25070040077dSdrh       break;
25080040077dSdrh     }
2509cce7d176Sdrh     case TK_UMINUS: {
2510fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2511fec19aadSdrh       assert( pLeft );
251213573c71Sdrh       if( pLeft->op==TK_INTEGER ){
251313573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
251413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
251513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
251633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
251733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
251813573c71Sdrh #endif
25193c84ddffSdrh       }else{
25202dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
25213c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2522e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
25232dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2524c5499befSdrh         testcase( regFree2==0 );
25253c84ddffSdrh       }
25269de221dfSdrh       inReg = target;
25276e142f54Sdrh       break;
25286e142f54Sdrh     }
2529bf4133cbSdrh     case TK_BITNOT:
25306e142f54Sdrh     case TK_NOT: {
2531f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2532f2bc013cSdrh       assert( TK_NOT==OP_Not );
2533c5499befSdrh       testcase( op==TK_BITNOT );
2534c5499befSdrh       testcase( op==TK_NOT );
2535e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2536e99fa2afSdrh       testcase( regFree1==0 );
2537e99fa2afSdrh       inReg = target;
2538e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2539cce7d176Sdrh       break;
2540cce7d176Sdrh     }
2541cce7d176Sdrh     case TK_ISNULL:
2542cce7d176Sdrh     case TK_NOTNULL: {
25436a288a33Sdrh       int addr;
2544f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2545f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2546c5499befSdrh       testcase( op==TK_ISNULL );
2547c5499befSdrh       testcase( op==TK_NOTNULL );
25489de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
25492dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2550c5499befSdrh       testcase( regFree1==0 );
25512dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
25529de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
25536a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2554a37cdde0Sdanielk1977       break;
2555f2bc013cSdrh     }
25562282792aSdrh     case TK_AGG_FUNCTION: {
255713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
25587e56e711Sdrh       if( pInfo==0 ){
255933e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
256033e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
25617e56e711Sdrh       }else{
25629de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
25637e56e711Sdrh       }
25642282792aSdrh       break;
25652282792aSdrh     }
2566b71090fdSdrh     case TK_CONST_FUNC:
2567cce7d176Sdrh     case TK_FUNCTION: {
256812ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
256912ffee8cSdrh       int nFarg;             /* Number of function arguments */
257012ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
257112ffee8cSdrh       int nId;               /* Length of the function name in bytes */
257212ffee8cSdrh       const char *zId;       /* The function name */
257312ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
257412ffee8cSdrh       int i;                 /* Loop counter */
257512ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
257612ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
257717435752Sdrh 
25786ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2579c5499befSdrh       testcase( op==TK_CONST_FUNC );
2580c5499befSdrh       testcase( op==TK_FUNCTION );
2581b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
258212ffee8cSdrh         pFarg = 0;
258312ffee8cSdrh       }else{
258412ffee8cSdrh         pFarg = pExpr->x.pList;
258512ffee8cSdrh       }
258612ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
258733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
258833e619fcSdrh       zId = pExpr->u.zToken;
2589b7916a78Sdrh       nId = sqlite3Strlen30(zId);
259012ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2591feb306f5Sdrh       if( pDef==0 ){
2592feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2593feb306f5Sdrh         break;
2594feb306f5Sdrh       }
2595ae6bb957Sdrh 
2596ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2597ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2598ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2599ae6bb957Sdrh       */
2600ae6bb957Sdrh       if( pDef->flags & SQLITE_FUNC_COALESCE ){
2601ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2602ae6bb957Sdrh         assert( nFarg>=2 );
2603ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2604ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2605ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2606f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2607ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2608ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2609ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2610ae6bb957Sdrh         }
2611ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2612ae6bb957Sdrh         break;
2613ae6bb957Sdrh       }
2614ae6bb957Sdrh 
2615ae6bb957Sdrh 
261612ffee8cSdrh       if( pFarg ){
261712ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2618a748fdccSdrh 
2619a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2620a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2621a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2622a748fdccSdrh         ** loading.
2623a748fdccSdrh         */
2624a748fdccSdrh         if( (pDef->flags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
26254e245a4cSdrh           u8 exprOp;
2626a748fdccSdrh           assert( nFarg==1 );
2627a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
26284e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
26294e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2630a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2631a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2632a748fdccSdrh             testcase( pDef->flags==SQLITE_FUNC_LENGTH );
2633a748fdccSdrh             pFarg->a[0].pExpr->op2 = pDef->flags;
2634a748fdccSdrh           }
2635a748fdccSdrh         }
2636a748fdccSdrh 
2637d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
263812ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2639d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2640892d3179Sdrh       }else{
264112ffee8cSdrh         r1 = 0;
2642892d3179Sdrh       }
2643b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2644a43fa227Sdrh       /* Possibly overload the function if the first argument is
2645a43fa227Sdrh       ** a virtual table column.
2646a43fa227Sdrh       **
2647a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2648a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2649a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2650a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2651a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2652a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2653a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2654a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2655a43fa227Sdrh       */
265612ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
265712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
265812ffee8cSdrh       }else if( nFarg>0 ){
265912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2660b7f6f68fSdrh       }
2661b7f6f68fSdrh #endif
2662f7bca574Sdrh       for(i=0; i<nFarg; i++){
2663f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
266413449892Sdrh           constMask |= (1<<i);
2665d02eb1fdSdanielk1977         }
2666e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
266712ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2668dc1bdc4fSdanielk1977         }
2669dc1bdc4fSdanielk1977       }
2670e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
26718b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
267266a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2673682f68b0Sdanielk1977       }
26742dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
267566a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
267612ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
267712ffee8cSdrh       if( nFarg ){
267812ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
26792dcef11bSdrh       }
26806ec2733bSdrh       break;
26816ec2733bSdrh     }
2682fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2683fe2093d7Sdrh     case TK_EXISTS:
268419a775c2Sdrh     case TK_SELECT: {
2685c5499befSdrh       testcase( op==TK_EXISTS );
2686c5499befSdrh       testcase( op==TK_SELECT );
26871450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
268819a775c2Sdrh       break;
268919a775c2Sdrh     }
2690fef5208cSdrh     case TK_IN: {
2691e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2692e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2693e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2694e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
269566ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2696e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2697e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2698e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2699fef5208cSdrh       break;
2700fef5208cSdrh     }
2701e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2702e3365e6cSdrh 
2703e3365e6cSdrh 
27042dcef11bSdrh     /*
27052dcef11bSdrh     **    x BETWEEN y AND z
27062dcef11bSdrh     **
27072dcef11bSdrh     ** This is equivalent to
27082dcef11bSdrh     **
27092dcef11bSdrh     **    x>=y AND x<=z
27102dcef11bSdrh     **
27112dcef11bSdrh     ** X is stored in pExpr->pLeft.
27122dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
27132dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
27142dcef11bSdrh     */
2715fef5208cSdrh     case TK_BETWEEN: {
2716be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
27176ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2718be5c89acSdrh       Expr *pRight = pLItem->pExpr;
271935573356Sdrh 
2720b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2721b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2722c5499befSdrh       testcase( regFree1==0 );
2723c5499befSdrh       testcase( regFree2==0 );
27242dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2725678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
272635573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
272735573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2728be5c89acSdrh       pLItem++;
2729be5c89acSdrh       pRight = pLItem->pExpr;
27302dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
27312dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2732c5499befSdrh       testcase( regFree2==0 );
2733678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2734678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
27352dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2736678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2737fef5208cSdrh       break;
2738fef5208cSdrh     }
2739ae80ddeaSdrh     case TK_COLLATE:
27404f07e5fbSdrh     case TK_UPLUS: {
27412dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2742a2e00042Sdrh       break;
2743a2e00042Sdrh     }
27442dcef11bSdrh 
2745165921a7Sdan     case TK_TRIGGER: {
274665a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
274765a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
274865a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
274965a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
275065a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
275165a7cd16Sdan       ** read the rowid field.
275265a7cd16Sdan       **
275365a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
275465a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
275565a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
275665a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
275765a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
275865a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
275965a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
276065a7cd16Sdan       ** example, if the table on which triggers are being fired is
276165a7cd16Sdan       ** declared as:
276265a7cd16Sdan       **
276365a7cd16Sdan       **   CREATE TABLE t1(a, b);
276465a7cd16Sdan       **
276565a7cd16Sdan       ** Then p1 is interpreted as follows:
276665a7cd16Sdan       **
276765a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
276865a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
276965a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
277065a7cd16Sdan       */
27712832ad42Sdan       Table *pTab = pExpr->pTab;
277265a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
277365a7cd16Sdan 
277465a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
277565a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
277665a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
277765a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
277865a7cd16Sdan 
277965a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
278076d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2781165921a7Sdan         (pExpr->iTable ? "new" : "old"),
278276d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
278376d462eeSdan         target
2784165921a7Sdan       ));
278565a7cd16Sdan 
278644dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
278765a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
278865a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
27892832ad42Sdan       if( pExpr->iColumn>=0
27902832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
27912832ad42Sdan       ){
27922832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
27932832ad42Sdan       }
279444dbca83Sdrh #endif
2795165921a7Sdan       break;
2796165921a7Sdan     }
2797165921a7Sdan 
2798165921a7Sdan 
27992dcef11bSdrh     /*
28002dcef11bSdrh     ** Form A:
28012dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28022dcef11bSdrh     **
28032dcef11bSdrh     ** Form B:
28042dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28052dcef11bSdrh     **
28062dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
28072dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
28082dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
28092dcef11bSdrh     **
28102dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
28112dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
28122dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
28132dcef11bSdrh     ** exprssion is NULL.
28142dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
28152dcef11bSdrh     **
28162dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
28172dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
28182dcef11bSdrh     ** no ELSE term, NULL.
28192dcef11bSdrh     */
282033cd4909Sdrh     default: assert( op==TK_CASE ); {
28212dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
28222dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
28232dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
28242dcef11bSdrh       int i;                            /* Loop counter */
28252dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
28262dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
28272dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
28282dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
28292dcef11bSdrh       Expr *pX;                         /* The X expression */
28301bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2831ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
283217a7f8ddSdrh 
28336ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
28346ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
28356ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
28366ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2837be5c89acSdrh       aListelem = pEList->a;
2838be5c89acSdrh       nExpr = pEList->nExpr;
28392dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
28402dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
28412dcef11bSdrh         cacheX = *pX;
284233cd4909Sdrh         testcase( pX->op==TK_COLUMN );
284333cd4909Sdrh         testcase( pX->op==TK_REGISTER );
28442dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2845c5499befSdrh         testcase( regFree1==0 );
28462dcef11bSdrh         cacheX.op = TK_REGISTER;
28472dcef11bSdrh         opCompare.op = TK_EQ;
28482dcef11bSdrh         opCompare.pLeft = &cacheX;
28492dcef11bSdrh         pTest = &opCompare;
28508b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
28518b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
28528b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
28538b1db07fSdrh         ** purposes and possibly overwritten.  */
28548b1db07fSdrh         regFree1 = 0;
2855cce7d176Sdrh       }
2856f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2857ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28582dcef11bSdrh         if( pX ){
28591bd10f8aSdrh           assert( pTest!=0 );
28602dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2861f5905aa7Sdrh         }else{
28622dcef11bSdrh           pTest = aListelem[i].pExpr;
286317a7f8ddSdrh         }
28642dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
286533cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
28662dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2867c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2868c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
28699de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
28702dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2871ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
28722dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2873f570f011Sdrh       }
287417a7f8ddSdrh       if( pExpr->pRight ){
2875ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28769de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2877ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
287817a7f8ddSdrh       }else{
28799de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
288017a7f8ddSdrh       }
2881c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2882c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
28832dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
28846f34903eSdanielk1977       break;
28856f34903eSdanielk1977     }
28865338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
28876f34903eSdanielk1977     case TK_RAISE: {
2888165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2889165921a7Sdan            || pExpr->affinity==OE_Abort
2890165921a7Sdan            || pExpr->affinity==OE_Fail
2891165921a7Sdan            || pExpr->affinity==OE_Ignore
2892165921a7Sdan       );
2893e0af83acSdan       if( !pParse->pTriggerTab ){
2894e0af83acSdan         sqlite3ErrorMsg(pParse,
2895e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2896e0af83acSdan         return 0;
2897e0af83acSdan       }
2898e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2899e0af83acSdan         sqlite3MayAbort(pParse);
2900e0af83acSdan       }
290133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2902e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2903e0af83acSdan         sqlite3VdbeAddOp4(
2904e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2905e0af83acSdan       }else{
2906e0af83acSdan         sqlite3HaltConstraint(pParse, pExpr->affinity, pExpr->u.zToken, 0);
2907e0af83acSdan       }
2908e0af83acSdan 
2909ffe07b2dSdrh       break;
291017a7f8ddSdrh     }
29115338a5f7Sdanielk1977 #endif
2912ffe07b2dSdrh   }
29132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
29142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
29152dcef11bSdrh   return inReg;
29165b6afba9Sdrh }
29172dcef11bSdrh 
29182dcef11bSdrh /*
29192dcef11bSdrh ** Generate code to evaluate an expression and store the results
29202dcef11bSdrh ** into a register.  Return the register number where the results
29212dcef11bSdrh ** are stored.
29222dcef11bSdrh **
29232dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2924678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
29252dcef11bSdrh ** a temporary, then set *pReg to zero.
29262dcef11bSdrh */
29272dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
29282dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
29292dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
29302dcef11bSdrh   if( r2==r1 ){
29312dcef11bSdrh     *pReg = r1;
29322dcef11bSdrh   }else{
29332dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
29342dcef11bSdrh     *pReg = 0;
29352dcef11bSdrh   }
29362dcef11bSdrh   return r2;
29372dcef11bSdrh }
29382dcef11bSdrh 
29392dcef11bSdrh /*
29402dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
29412dcef11bSdrh ** results in register target.  The results are guaranteed to appear
29422dcef11bSdrh ** in register target.
29432dcef11bSdrh */
29442dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
29459cbf3425Sdrh   int inReg;
29469cbf3425Sdrh 
29479cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
2948ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
2949ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
2950ebc16717Sdrh   }else{
29519cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
29520e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
29530e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
29549cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
295517a7f8ddSdrh     }
2956ebc16717Sdrh   }
2957389a1adbSdrh   return target;
2958cce7d176Sdrh }
2959cce7d176Sdrh 
2960cce7d176Sdrh /*
29612dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2962de4fcfddSdrh ** in register target.
296325303780Sdrh **
29642dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
29652dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
29662dcef11bSdrh ** the result is a copy of the cache register.
29672dcef11bSdrh **
29682dcef11bSdrh ** This routine is used for expressions that are used multiple
29692dcef11bSdrh ** times.  They are evaluated once and the results of the expression
29702dcef11bSdrh ** are reused.
297125303780Sdrh */
29722dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
297325303780Sdrh   Vdbe *v = pParse->pVdbe;
29742dcef11bSdrh   int inReg;
29752dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2976de4fcfddSdrh   assert( target>0 );
297720bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
297820bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
297920bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
298020bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
298120bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
298220bc393cSdrh   ** modifications or enhancements. */
298320bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
298425303780Sdrh     int iMem;
29852dcef11bSdrh     iMem = ++pParse->nMem;
29862dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
29872dcef11bSdrh     pExpr->iTable = iMem;
2988937d0deaSdan     pExpr->op2 = pExpr->op;
298925303780Sdrh     pExpr->op = TK_REGISTER;
299025303780Sdrh   }
29912dcef11bSdrh   return inReg;
299225303780Sdrh }
29932dcef11bSdrh 
2994678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
29957e02e5e6Sdrh /*
29967e02e5e6Sdrh ** Generate a human-readable explanation of an expression tree.
29977e02e5e6Sdrh */
2998a84203a0Sdrh void sqlite3ExplainExpr(Vdbe *pOut, Expr *pExpr){
2999a84203a0Sdrh   int op;                   /* The opcode being coded */
3000a84203a0Sdrh   const char *zBinOp = 0;   /* Binary operator */
3001a84203a0Sdrh   const char *zUniOp = 0;   /* Unary operator */
3002a84203a0Sdrh   if( pExpr==0 ){
3003a84203a0Sdrh     op = TK_NULL;
30047e02e5e6Sdrh   }else{
3005a84203a0Sdrh     op = pExpr->op;
30067e02e5e6Sdrh   }
3007a84203a0Sdrh   switch( op ){
3008a84203a0Sdrh     case TK_AGG_COLUMN: {
300904b8342bSdrh       sqlite3ExplainPrintf(pOut, "AGG{%d:%d}",
301004b8342bSdrh             pExpr->iTable, pExpr->iColumn);
3011a84203a0Sdrh       break;
30127e02e5e6Sdrh     }
3013a84203a0Sdrh     case TK_COLUMN: {
3014a84203a0Sdrh       if( pExpr->iTable<0 ){
3015a84203a0Sdrh         /* This only happens when coding check constraints */
3016a84203a0Sdrh         sqlite3ExplainPrintf(pOut, "COLUMN(%d)", pExpr->iColumn);
3017a84203a0Sdrh       }else{
301804b8342bSdrh         sqlite3ExplainPrintf(pOut, "{%d:%d}",
301904b8342bSdrh                              pExpr->iTable, pExpr->iColumn);
3020a84203a0Sdrh       }
3021a84203a0Sdrh       break;
3022a84203a0Sdrh     }
3023a84203a0Sdrh     case TK_INTEGER: {
3024a84203a0Sdrh       if( pExpr->flags & EP_IntValue ){
302504b8342bSdrh         sqlite3ExplainPrintf(pOut, "%d", pExpr->u.iValue);
3026a84203a0Sdrh       }else{
302704b8342bSdrh         sqlite3ExplainPrintf(pOut, "%s", pExpr->u.zToken);
3028a84203a0Sdrh       }
3029a84203a0Sdrh       break;
3030a84203a0Sdrh     }
3031a84203a0Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3032a84203a0Sdrh     case TK_FLOAT: {
303304b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3034a84203a0Sdrh       break;
3035a84203a0Sdrh     }
3036a84203a0Sdrh #endif
3037a84203a0Sdrh     case TK_STRING: {
303804b8342bSdrh       sqlite3ExplainPrintf(pOut,"%Q", pExpr->u.zToken);
3039a84203a0Sdrh       break;
3040a84203a0Sdrh     }
3041a84203a0Sdrh     case TK_NULL: {
3042a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"NULL");
3043a84203a0Sdrh       break;
3044a84203a0Sdrh     }
3045a84203a0Sdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
3046a84203a0Sdrh     case TK_BLOB: {
304704b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3048a84203a0Sdrh       break;
3049a84203a0Sdrh     }
3050a84203a0Sdrh #endif
3051a84203a0Sdrh     case TK_VARIABLE: {
3052a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"VARIABLE(%s,%d)",
3053a84203a0Sdrh                            pExpr->u.zToken, pExpr->iColumn);
3054a84203a0Sdrh       break;
3055a84203a0Sdrh     }
3056a84203a0Sdrh     case TK_REGISTER: {
3057a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"REGISTER(%d)", pExpr->iTable);
3058a84203a0Sdrh       break;
3059a84203a0Sdrh     }
3060a84203a0Sdrh     case TK_AS: {
3061a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3062a84203a0Sdrh       break;
3063a84203a0Sdrh     }
3064a84203a0Sdrh #ifndef SQLITE_OMIT_CAST
3065a84203a0Sdrh     case TK_CAST: {
3066a84203a0Sdrh       /* Expressions of the form:   CAST(pLeft AS token) */
3067a84203a0Sdrh       const char *zAff = "unk";
3068a84203a0Sdrh       switch( sqlite3AffinityType(pExpr->u.zToken) ){
3069a84203a0Sdrh         case SQLITE_AFF_TEXT:    zAff = "TEXT";     break;
3070a84203a0Sdrh         case SQLITE_AFF_NONE:    zAff = "NONE";     break;
3071a84203a0Sdrh         case SQLITE_AFF_NUMERIC: zAff = "NUMERIC";  break;
3072a84203a0Sdrh         case SQLITE_AFF_INTEGER: zAff = "INTEGER";  break;
3073a84203a0Sdrh         case SQLITE_AFF_REAL:    zAff = "REAL";     break;
3074a84203a0Sdrh       }
3075a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CAST-%s(", zAff);
3076a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3077a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3078a84203a0Sdrh       break;
3079a84203a0Sdrh     }
3080a84203a0Sdrh #endif /* SQLITE_OMIT_CAST */
3081a84203a0Sdrh     case TK_LT:      zBinOp = "LT";     break;
3082a84203a0Sdrh     case TK_LE:      zBinOp = "LE";     break;
3083a84203a0Sdrh     case TK_GT:      zBinOp = "GT";     break;
3084a84203a0Sdrh     case TK_GE:      zBinOp = "GE";     break;
3085a84203a0Sdrh     case TK_NE:      zBinOp = "NE";     break;
3086a84203a0Sdrh     case TK_EQ:      zBinOp = "EQ";     break;
3087a84203a0Sdrh     case TK_IS:      zBinOp = "IS";     break;
3088a84203a0Sdrh     case TK_ISNOT:   zBinOp = "ISNOT";  break;
3089a84203a0Sdrh     case TK_AND:     zBinOp = "AND";    break;
3090a84203a0Sdrh     case TK_OR:      zBinOp = "OR";     break;
3091a84203a0Sdrh     case TK_PLUS:    zBinOp = "ADD";    break;
3092a84203a0Sdrh     case TK_STAR:    zBinOp = "MUL";    break;
3093a84203a0Sdrh     case TK_MINUS:   zBinOp = "SUB";    break;
3094a84203a0Sdrh     case TK_REM:     zBinOp = "REM";    break;
3095a84203a0Sdrh     case TK_BITAND:  zBinOp = "BITAND"; break;
3096a84203a0Sdrh     case TK_BITOR:   zBinOp = "BITOR";  break;
3097a84203a0Sdrh     case TK_SLASH:   zBinOp = "DIV";    break;
3098a84203a0Sdrh     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
3099a84203a0Sdrh     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
3100a84203a0Sdrh     case TK_CONCAT:  zBinOp = "CONCAT"; break;
3101a84203a0Sdrh 
3102a84203a0Sdrh     case TK_UMINUS:  zUniOp = "UMINUS"; break;
3103a84203a0Sdrh     case TK_UPLUS:   zUniOp = "UPLUS";  break;
3104a84203a0Sdrh     case TK_BITNOT:  zUniOp = "BITNOT"; break;
3105a84203a0Sdrh     case TK_NOT:     zUniOp = "NOT";    break;
3106a84203a0Sdrh     case TK_ISNULL:  zUniOp = "ISNULL"; break;
3107a84203a0Sdrh     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
3108a84203a0Sdrh 
3109a84203a0Sdrh     case TK_AGG_FUNCTION:
3110a84203a0Sdrh     case TK_CONST_FUNC:
3111a84203a0Sdrh     case TK_FUNCTION: {
3112a84203a0Sdrh       ExprList *pFarg;       /* List of function arguments */
3113a84203a0Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
3114a84203a0Sdrh         pFarg = 0;
3115a84203a0Sdrh       }else{
3116a84203a0Sdrh         pFarg = pExpr->x.pList;
3117a84203a0Sdrh       }
3118ed551b95Sdrh       if( op==TK_AGG_FUNCTION ){
3119ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "AGG_FUNCTION%d:%s(",
3120ed551b95Sdrh                              pExpr->op2, pExpr->u.zToken);
3121ed551b95Sdrh       }else{
3122ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "FUNCTION:%s(", pExpr->u.zToken);
3123ed551b95Sdrh       }
3124a84203a0Sdrh       if( pFarg ){
3125a84203a0Sdrh         sqlite3ExplainExprList(pOut, pFarg);
31267e02e5e6Sdrh       }
31277e02e5e6Sdrh       sqlite3ExplainPrintf(pOut, ")");
3128a84203a0Sdrh       break;
3129a84203a0Sdrh     }
3130a84203a0Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3131a84203a0Sdrh     case TK_EXISTS: {
3132a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "EXISTS(");
3133a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3134a84203a0Sdrh       sqlite3ExplainPrintf(pOut,")");
3135a84203a0Sdrh       break;
3136a84203a0Sdrh     }
3137a84203a0Sdrh     case TK_SELECT: {
3138a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "(");
3139a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3140a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3141a84203a0Sdrh       break;
3142a84203a0Sdrh     }
3143a84203a0Sdrh     case TK_IN: {
3144a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "IN(");
3145a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3146a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3147a84203a0Sdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3148a84203a0Sdrh         sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3149a84203a0Sdrh       }else{
3150a84203a0Sdrh         sqlite3ExplainExprList(pOut, pExpr->x.pList);
3151a84203a0Sdrh       }
3152a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3153a84203a0Sdrh       break;
3154a84203a0Sdrh     }
3155a84203a0Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3156a84203a0Sdrh 
3157a84203a0Sdrh     /*
3158a84203a0Sdrh     **    x BETWEEN y AND z
3159a84203a0Sdrh     **
3160a84203a0Sdrh     ** This is equivalent to
3161a84203a0Sdrh     **
3162a84203a0Sdrh     **    x>=y AND x<=z
3163a84203a0Sdrh     **
3164a84203a0Sdrh     ** X is stored in pExpr->pLeft.
3165a84203a0Sdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
3166a84203a0Sdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
3167a84203a0Sdrh     */
3168a84203a0Sdrh     case TK_BETWEEN: {
3169a84203a0Sdrh       Expr *pX = pExpr->pLeft;
3170a84203a0Sdrh       Expr *pY = pExpr->x.pList->a[0].pExpr;
3171a84203a0Sdrh       Expr *pZ = pExpr->x.pList->a[1].pExpr;
3172a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "BETWEEN(");
3173a84203a0Sdrh       sqlite3ExplainExpr(pOut, pX);
3174a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3175a84203a0Sdrh       sqlite3ExplainExpr(pOut, pY);
3176a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3177a84203a0Sdrh       sqlite3ExplainExpr(pOut, pZ);
3178a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3179a84203a0Sdrh       break;
3180a84203a0Sdrh     }
3181a84203a0Sdrh     case TK_TRIGGER: {
3182a84203a0Sdrh       /* If the opcode is TK_TRIGGER, then the expression is a reference
3183a84203a0Sdrh       ** to a column in the new.* or old.* pseudo-tables available to
3184a84203a0Sdrh       ** trigger programs. In this case Expr.iTable is set to 1 for the
3185a84203a0Sdrh       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3186a84203a0Sdrh       ** is set to the column of the pseudo-table to read, or to -1 to
3187a84203a0Sdrh       ** read the rowid field.
3188a84203a0Sdrh       */
3189a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "%s(%d)",
3190a84203a0Sdrh           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
3191a84203a0Sdrh       break;
3192a84203a0Sdrh     }
3193a84203a0Sdrh     case TK_CASE: {
3194a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CASE(");
3195a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3196a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3197a84203a0Sdrh       sqlite3ExplainExprList(pOut, pExpr->x.pList);
3198a84203a0Sdrh       break;
3199a84203a0Sdrh     }
3200a84203a0Sdrh #ifndef SQLITE_OMIT_TRIGGER
3201a84203a0Sdrh     case TK_RAISE: {
3202a84203a0Sdrh       const char *zType = "unk";
3203a84203a0Sdrh       switch( pExpr->affinity ){
3204a84203a0Sdrh         case OE_Rollback:   zType = "rollback";  break;
3205a84203a0Sdrh         case OE_Abort:      zType = "abort";     break;
3206a84203a0Sdrh         case OE_Fail:       zType = "fail";      break;
3207a84203a0Sdrh         case OE_Ignore:     zType = "ignore";    break;
3208a84203a0Sdrh       }
3209a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "RAISE-%s(%s)", zType, pExpr->u.zToken);
3210a84203a0Sdrh       break;
3211a84203a0Sdrh     }
3212a84203a0Sdrh #endif
3213a84203a0Sdrh   }
3214a84203a0Sdrh   if( zBinOp ){
3215a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zBinOp);
3216a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3217a84203a0Sdrh     sqlite3ExplainPrintf(pOut,",");
3218a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pRight);
3219a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3220a84203a0Sdrh   }else if( zUniOp ){
3221a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zUniOp);
3222a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3223a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3224a84203a0Sdrh   }
32257e02e5e6Sdrh }
3226678a9aa7Sdrh #endif /* defined(SQLITE_ENABLE_TREE_EXPLAIN) */
32277e02e5e6Sdrh 
3228678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
32297e02e5e6Sdrh /*
32307e02e5e6Sdrh ** Generate a human-readable explanation of an expression list.
32317e02e5e6Sdrh */
32327e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe *pOut, ExprList *pList){
32337e02e5e6Sdrh   int i;
3234a84203a0Sdrh   if( pList==0 || pList->nExpr==0 ){
32357e02e5e6Sdrh     sqlite3ExplainPrintf(pOut, "(empty-list)");
32367e02e5e6Sdrh     return;
3237a84203a0Sdrh   }else if( pList->nExpr==1 ){
3238a84203a0Sdrh     sqlite3ExplainExpr(pOut, pList->a[0].pExpr);
3239a84203a0Sdrh   }else{
32407e02e5e6Sdrh     sqlite3ExplainPush(pOut);
32417e02e5e6Sdrh     for(i=0; i<pList->nExpr; i++){
3242a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "item[%d] = ", i);
32437e02e5e6Sdrh       sqlite3ExplainPush(pOut);
32447e02e5e6Sdrh       sqlite3ExplainExpr(pOut, pList->a[i].pExpr);
32457e02e5e6Sdrh       sqlite3ExplainPop(pOut);
32467e02e5e6Sdrh       if( i<pList->nExpr-1 ){
32477e02e5e6Sdrh         sqlite3ExplainNL(pOut);
32487e02e5e6Sdrh       }
32497e02e5e6Sdrh     }
32507e02e5e6Sdrh     sqlite3ExplainPop(pOut);
32517e02e5e6Sdrh   }
3252a84203a0Sdrh }
32537e02e5e6Sdrh #endif /* SQLITE_DEBUG */
32547e02e5e6Sdrh 
3255678ccce8Sdrh /*
325647de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
325747de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
325847de955eSdrh **
325947de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
326047de955eSdrh **
326147de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
326247de955eSdrh **       or OP_Variable that does not need to be placed in a
326347de955eSdrh **       specific register.
326447de955eSdrh **
326547de955eSdrh ** There is no point in factoring out single-instruction constant
326647de955eSdrh ** expressions that need to be placed in a particular register.
326747de955eSdrh ** We could factor them out, but then we would end up adding an
326847de955eSdrh ** OP_SCopy instruction to move the value into the correct register
326947de955eSdrh ** later.  We might as well just use the original instruction and
327047de955eSdrh ** avoid the OP_SCopy.
327147de955eSdrh */
327247de955eSdrh static int isAppropriateForFactoring(Expr *p){
327347de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
327447de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
327547de955eSdrh   }
327647de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
327747de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
327847de955eSdrh   }
327947de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
328047de955eSdrh   switch( p->op ){
328147de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
328247de955eSdrh     case TK_BLOB:
328347de955eSdrh #endif
328447de955eSdrh     case TK_VARIABLE:
328547de955eSdrh     case TK_INTEGER:
328647de955eSdrh     case TK_FLOAT:
328747de955eSdrh     case TK_NULL:
328847de955eSdrh     case TK_STRING: {
328947de955eSdrh       testcase( p->op==TK_BLOB );
329047de955eSdrh       testcase( p->op==TK_VARIABLE );
329147de955eSdrh       testcase( p->op==TK_INTEGER );
329247de955eSdrh       testcase( p->op==TK_FLOAT );
329347de955eSdrh       testcase( p->op==TK_NULL );
329447de955eSdrh       testcase( p->op==TK_STRING );
329547de955eSdrh       /* Single-instruction constants with a fixed destination are
329647de955eSdrh       ** better done in-line.  If we factor them, they will just end
329747de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
329847de955eSdrh       ** register. */
329947de955eSdrh       return 0;
330047de955eSdrh     }
330147de955eSdrh     case TK_UMINUS: {
330247de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
330347de955eSdrh         return 0;
330447de955eSdrh       }
330547de955eSdrh       break;
330647de955eSdrh     }
330747de955eSdrh     default: {
330847de955eSdrh       break;
330947de955eSdrh     }
331047de955eSdrh   }
331147de955eSdrh   return 1;
331247de955eSdrh }
331347de955eSdrh 
331447de955eSdrh /*
331547de955eSdrh ** If pExpr is a constant expression that is appropriate for
331647de955eSdrh ** factoring out of a loop, then evaluate the expression
3317678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
3318678ccce8Sdrh ** expression.
3319678ccce8Sdrh */
33207d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
33217d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
332247de955eSdrh   switch( pExpr->op ){
3323e05c929bSdrh     case TK_IN:
332447de955eSdrh     case TK_REGISTER: {
332533cd4909Sdrh       return WRC_Prune;
3326678ccce8Sdrh     }
332747de955eSdrh     case TK_FUNCTION:
332847de955eSdrh     case TK_AGG_FUNCTION:
332947de955eSdrh     case TK_CONST_FUNC: {
333047de955eSdrh       /* The arguments to a function have a fixed destination.
333147de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
333247de955eSdrh       ** instructions.
333347de955eSdrh       */
33346ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
33356ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
333647de955eSdrh       if( pList ){
333747de955eSdrh         int i = pList->nExpr;
333847de955eSdrh         struct ExprList_item *pItem = pList->a;
333947de955eSdrh         for(; i>0; i--, pItem++){
334033cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
334147de955eSdrh         }
334247de955eSdrh       }
334347de955eSdrh       break;
334447de955eSdrh     }
334547de955eSdrh   }
334647de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
3347678ccce8Sdrh     int r1 = ++pParse->nMem;
3348678ccce8Sdrh     int r2;
3349678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
3350*4b17cf58Sdrh     if( r1!=r2 ) sqlite3ReleaseTempReg(pParse, r1);
3351fcd4a150Sdan     pExpr->op2 = pExpr->op;
3352678ccce8Sdrh     pExpr->op = TK_REGISTER;
3353678ccce8Sdrh     pExpr->iTable = r2;
33547d10d5a6Sdrh     return WRC_Prune;
3355678ccce8Sdrh   }
33567d10d5a6Sdrh   return WRC_Continue;
3357678ccce8Sdrh }
3358678ccce8Sdrh 
3359678ccce8Sdrh /*
3360678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3361678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3362678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3363f58ee7f1Sdrh **
3364f58ee7f1Sdrh ** This routine is a no-op if the jump to the cookie-check code has
3365f58ee7f1Sdrh ** already occur.  Since the cookie-check jump is generated prior to
3366f58ee7f1Sdrh ** any other serious processing, this check ensures that there is no
3367f58ee7f1Sdrh ** way to accidently bypass the constant initializations.
3368f58ee7f1Sdrh **
3369f58ee7f1Sdrh ** This routine is also a no-op if the SQLITE_FactorOutConst optimization
3370f58ee7f1Sdrh ** is disabled via the sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS)
3371f58ee7f1Sdrh ** interface.  This allows test logic to verify that the same answer is
3372f58ee7f1Sdrh ** obtained for queries regardless of whether or not constants are
3373f58ee7f1Sdrh ** precomputed into registers or if they are inserted in-line.
3374678ccce8Sdrh */
3375678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
33767d10d5a6Sdrh   Walker w;
337748b5b041Sdrh   if( pParse->cookieGoto ) return;
33787e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_FactorOutConst) ) return;
33797d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
3380ef4c0598Sdrh   w.xSelectCallback = 0;
33817d10d5a6Sdrh   w.pParse = pParse;
33827d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3383678ccce8Sdrh }
3384678ccce8Sdrh 
338525303780Sdrh 
338625303780Sdrh /*
3387268380caSdrh ** Generate code that pushes the value of every element of the given
33889cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3389268380caSdrh **
3390892d3179Sdrh ** Return the number of elements evaluated.
3391268380caSdrh */
33924adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3393268380caSdrh   Parse *pParse,     /* Parsing context */
3394389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3395191b54cbSdrh   int target,        /* Where to write results */
3396d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3397268380caSdrh ){
3398268380caSdrh   struct ExprList_item *pItem;
33999cbf3425Sdrh   int i, n;
34009d8b3072Sdrh   assert( pList!=0 );
34019cbf3425Sdrh   assert( target>0 );
3402d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3403268380caSdrh   n = pList->nExpr;
3404191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34057445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
34067445ffe2Sdrh     int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3407746fd9ccSdrh     if( inReg!=target+i ){
34087445ffe2Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, doHardCopy ? OP_Copy : OP_SCopy,
34097445ffe2Sdrh                         inReg, target+i);
3410d176611bSdrh     }
3411268380caSdrh   }
3412f9b596ebSdrh   return n;
3413268380caSdrh }
3414268380caSdrh 
3415268380caSdrh /*
341636c563a2Sdrh ** Generate code for a BETWEEN operator.
341736c563a2Sdrh **
341836c563a2Sdrh **    x BETWEEN y AND z
341936c563a2Sdrh **
342036c563a2Sdrh ** The above is equivalent to
342136c563a2Sdrh **
342236c563a2Sdrh **    x>=y AND x<=z
342336c563a2Sdrh **
342436c563a2Sdrh ** Code it as such, taking care to do the common subexpression
342536c563a2Sdrh ** elementation of x.
342636c563a2Sdrh */
342736c563a2Sdrh static void exprCodeBetween(
342836c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
342936c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
343036c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
343136c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
343236c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
343336c563a2Sdrh ){
343436c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
343536c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
343636c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
343736c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
343836c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
343936c563a2Sdrh 
344036c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
344136c563a2Sdrh   exprX = *pExpr->pLeft;
344236c563a2Sdrh   exprAnd.op = TK_AND;
344336c563a2Sdrh   exprAnd.pLeft = &compLeft;
344436c563a2Sdrh   exprAnd.pRight = &compRight;
344536c563a2Sdrh   compLeft.op = TK_GE;
344636c563a2Sdrh   compLeft.pLeft = &exprX;
344736c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
344836c563a2Sdrh   compRight.op = TK_LE;
344936c563a2Sdrh   compRight.pLeft = &exprX;
345036c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
345136c563a2Sdrh   exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
345236c563a2Sdrh   exprX.op = TK_REGISTER;
345336c563a2Sdrh   if( jumpIfTrue ){
345436c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
345536c563a2Sdrh   }else{
345636c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
345736c563a2Sdrh   }
345836c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
345936c563a2Sdrh 
346036c563a2Sdrh   /* Ensure adequate test coverage */
346136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
346236c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
346336c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
346436c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
346536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
346636c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
346736c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
346836c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
346936c563a2Sdrh }
347036c563a2Sdrh 
347136c563a2Sdrh /*
3472cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3473cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3474cce7d176Sdrh ** continues straight thru if the expression is false.
3475f5905aa7Sdrh **
3476f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
347735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3478f2bc013cSdrh **
3479f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3480f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3481f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3482f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3483f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3484cce7d176Sdrh */
34854adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3486cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3487cce7d176Sdrh   int op = 0;
34882dcef11bSdrh   int regFree1 = 0;
34892dcef11bSdrh   int regFree2 = 0;
34902dcef11bSdrh   int r1, r2;
34912dcef11bSdrh 
349235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
349333cd4909Sdrh   if( NEVER(v==0) )     return;  /* Existance of VDBE checked by caller */
349433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3495f2bc013cSdrh   op = pExpr->op;
3496f2bc013cSdrh   switch( op ){
3497cce7d176Sdrh     case TK_AND: {
34984adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3499c5499befSdrh       testcase( jumpIfNull==0 );
3500ceea3321Sdrh       sqlite3ExprCachePush(pParse);
350135573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
35024adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35034adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3504ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3505cce7d176Sdrh       break;
3506cce7d176Sdrh     }
3507cce7d176Sdrh     case TK_OR: {
3508c5499befSdrh       testcase( jumpIfNull==0 );
35094adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
35104adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3511cce7d176Sdrh       break;
3512cce7d176Sdrh     }
3513cce7d176Sdrh     case TK_NOT: {
3514c5499befSdrh       testcase( jumpIfNull==0 );
35154adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3516cce7d176Sdrh       break;
3517cce7d176Sdrh     }
3518cce7d176Sdrh     case TK_LT:
3519cce7d176Sdrh     case TK_LE:
3520cce7d176Sdrh     case TK_GT:
3521cce7d176Sdrh     case TK_GE:
3522cce7d176Sdrh     case TK_NE:
35230ac65892Sdrh     case TK_EQ: {
3524f2bc013cSdrh       assert( TK_LT==OP_Lt );
3525f2bc013cSdrh       assert( TK_LE==OP_Le );
3526f2bc013cSdrh       assert( TK_GT==OP_Gt );
3527f2bc013cSdrh       assert( TK_GE==OP_Ge );
3528f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3529f2bc013cSdrh       assert( TK_NE==OP_Ne );
3530c5499befSdrh       testcase( op==TK_LT );
3531c5499befSdrh       testcase( op==TK_LE );
3532c5499befSdrh       testcase( op==TK_GT );
3533c5499befSdrh       testcase( op==TK_GE );
3534c5499befSdrh       testcase( op==TK_EQ );
3535c5499befSdrh       testcase( op==TK_NE );
3536c5499befSdrh       testcase( jumpIfNull==0 );
3537b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3538b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
353935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35402dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3541c5499befSdrh       testcase( regFree1==0 );
3542c5499befSdrh       testcase( regFree2==0 );
3543cce7d176Sdrh       break;
3544cce7d176Sdrh     }
35456a2fe093Sdrh     case TK_IS:
35466a2fe093Sdrh     case TK_ISNOT: {
35476a2fe093Sdrh       testcase( op==TK_IS );
35486a2fe093Sdrh       testcase( op==TK_ISNOT );
3549b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3550b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
35516a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
35526a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35536a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
35546a2fe093Sdrh       testcase( regFree1==0 );
35556a2fe093Sdrh       testcase( regFree2==0 );
35566a2fe093Sdrh       break;
35576a2fe093Sdrh     }
3558cce7d176Sdrh     case TK_ISNULL:
3559cce7d176Sdrh     case TK_NOTNULL: {
3560f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3561f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3562c5499befSdrh       testcase( op==TK_ISNULL );
3563c5499befSdrh       testcase( op==TK_NOTNULL );
35642dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35652dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3566c5499befSdrh       testcase( regFree1==0 );
3567cce7d176Sdrh       break;
3568cce7d176Sdrh     }
3569fef5208cSdrh     case TK_BETWEEN: {
35705c03f30aSdrh       testcase( jumpIfNull==0 );
357136c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3572fef5208cSdrh       break;
3573fef5208cSdrh     }
3574bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3575e3365e6cSdrh     case TK_IN: {
3576e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3577e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3578e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3579e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3580e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3581e3365e6cSdrh       break;
3582e3365e6cSdrh     }
3583bb201344Sshaneh #endif
3584cce7d176Sdrh     default: {
35852dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
35862dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3587c5499befSdrh       testcase( regFree1==0 );
3588c5499befSdrh       testcase( jumpIfNull==0 );
3589cce7d176Sdrh       break;
3590cce7d176Sdrh     }
3591cce7d176Sdrh   }
35922dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
35932dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3594cce7d176Sdrh }
3595cce7d176Sdrh 
3596cce7d176Sdrh /*
359766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3598cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3599cce7d176Sdrh ** continues straight thru if the expression is true.
3600f5905aa7Sdrh **
3601f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
360235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
360335573356Sdrh ** is 0.
3604cce7d176Sdrh */
36054adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3606cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3607cce7d176Sdrh   int op = 0;
36082dcef11bSdrh   int regFree1 = 0;
36092dcef11bSdrh   int regFree2 = 0;
36102dcef11bSdrh   int r1, r2;
36112dcef11bSdrh 
361235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
361333cd4909Sdrh   if( NEVER(v==0) ) return; /* Existance of VDBE checked by caller */
361433cd4909Sdrh   if( pExpr==0 )    return;
3615f2bc013cSdrh 
3616f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3617f2bc013cSdrh   **
3618f2bc013cSdrh   **       pExpr->op            op
3619f2bc013cSdrh   **       ---------          ----------
3620f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3621f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3622f2bc013cSdrh   **       TK_NE              OP_Eq
3623f2bc013cSdrh   **       TK_EQ              OP_Ne
3624f2bc013cSdrh   **       TK_GT              OP_Le
3625f2bc013cSdrh   **       TK_LE              OP_Gt
3626f2bc013cSdrh   **       TK_GE              OP_Lt
3627f2bc013cSdrh   **       TK_LT              OP_Ge
3628f2bc013cSdrh   **
3629f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3630f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3631f2bc013cSdrh   ** can compute the mapping above using the following expression.
3632f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3633f2bc013cSdrh   */
3634f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3635f2bc013cSdrh 
3636f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3637f2bc013cSdrh   */
3638f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3639f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3640f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3641f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3642f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3643f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3644f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3645f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3646f2bc013cSdrh 
3647cce7d176Sdrh   switch( pExpr->op ){
3648cce7d176Sdrh     case TK_AND: {
3649c5499befSdrh       testcase( jumpIfNull==0 );
36504adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
36514adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3652cce7d176Sdrh       break;
3653cce7d176Sdrh     }
3654cce7d176Sdrh     case TK_OR: {
36554adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3656c5499befSdrh       testcase( jumpIfNull==0 );
3657ceea3321Sdrh       sqlite3ExprCachePush(pParse);
365835573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
36594adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
36604adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3661ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3662cce7d176Sdrh       break;
3663cce7d176Sdrh     }
3664cce7d176Sdrh     case TK_NOT: {
36655c03f30aSdrh       testcase( jumpIfNull==0 );
36664adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3667cce7d176Sdrh       break;
3668cce7d176Sdrh     }
3669cce7d176Sdrh     case TK_LT:
3670cce7d176Sdrh     case TK_LE:
3671cce7d176Sdrh     case TK_GT:
3672cce7d176Sdrh     case TK_GE:
3673cce7d176Sdrh     case TK_NE:
3674cce7d176Sdrh     case TK_EQ: {
3675c5499befSdrh       testcase( op==TK_LT );
3676c5499befSdrh       testcase( op==TK_LE );
3677c5499befSdrh       testcase( op==TK_GT );
3678c5499befSdrh       testcase( op==TK_GE );
3679c5499befSdrh       testcase( op==TK_EQ );
3680c5499befSdrh       testcase( op==TK_NE );
3681c5499befSdrh       testcase( jumpIfNull==0 );
3682b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3683b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
368435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36852dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3686c5499befSdrh       testcase( regFree1==0 );
3687c5499befSdrh       testcase( regFree2==0 );
3688cce7d176Sdrh       break;
3689cce7d176Sdrh     }
36906a2fe093Sdrh     case TK_IS:
36916a2fe093Sdrh     case TK_ISNOT: {
36926d4486aeSdrh       testcase( pExpr->op==TK_IS );
36936d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3694b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3695b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36966a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
36976a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36986a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
36996a2fe093Sdrh       testcase( regFree1==0 );
37006a2fe093Sdrh       testcase( regFree2==0 );
37016a2fe093Sdrh       break;
37026a2fe093Sdrh     }
3703cce7d176Sdrh     case TK_ISNULL:
3704cce7d176Sdrh     case TK_NOTNULL: {
3705c5499befSdrh       testcase( op==TK_ISNULL );
3706c5499befSdrh       testcase( op==TK_NOTNULL );
37072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37082dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3709c5499befSdrh       testcase( regFree1==0 );
3710cce7d176Sdrh       break;
3711cce7d176Sdrh     }
3712fef5208cSdrh     case TK_BETWEEN: {
37135c03f30aSdrh       testcase( jumpIfNull==0 );
371436c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3715fef5208cSdrh       break;
3716fef5208cSdrh     }
3717bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3718e3365e6cSdrh     case TK_IN: {
3719e3365e6cSdrh       if( jumpIfNull ){
3720e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3721e3365e6cSdrh       }else{
3722e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3723e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3724e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3725e3365e6cSdrh       }
3726e3365e6cSdrh       break;
3727e3365e6cSdrh     }
3728bb201344Sshaneh #endif
3729cce7d176Sdrh     default: {
37302dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
37312dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3732c5499befSdrh       testcase( regFree1==0 );
3733c5499befSdrh       testcase( jumpIfNull==0 );
3734cce7d176Sdrh       break;
3735cce7d176Sdrh     }
3736cce7d176Sdrh   }
37372dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
37382dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3739cce7d176Sdrh }
37402282792aSdrh 
37412282792aSdrh /*
37421d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
37431d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
37441d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
37451d9da70aSdrh ** other than the top-level COLLATE operator.
3746d40aab0eSdrh **
37471d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3748d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
37491d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
37501d9da70aSdrh ** returns 2, then you do not really know for certain if the two
37511d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3752d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
37531d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3754d40aab0eSdrh ** just might result in some slightly slower code.  But returning
37551d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
37562282792aSdrh */
37574adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
37584b202ae2Sdanielk1977   if( pA==0||pB==0 ){
37591d9da70aSdrh     return pB==pA ? 0 : 2;
37602282792aSdrh   }
376133e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
376233e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
37636ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
37641d9da70aSdrh     return 2;
37656ab3a2ecSdanielk1977   }
37661d9da70aSdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
3767ae80ddeaSdrh   if( pA->op!=pB->op ){
3768ae80ddeaSdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB)<2 ){
3769ae80ddeaSdrh       return 1;
3770ae80ddeaSdrh     }
3771ae80ddeaSdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft)<2 ){
3772ae80ddeaSdrh       return 1;
3773ae80ddeaSdrh     }
3774ae80ddeaSdrh     return 2;
3775ae80ddeaSdrh   }
37761d9da70aSdrh   if( sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 2;
37771d9da70aSdrh   if( sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 2;
37788c6f666bSdrh   if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList) ) return 2;
37791d9da70aSdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 2;
378033e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
378133e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
37821d9da70aSdrh       return 2;
378333e619fcSdrh     }
3784bbabe197Sdrh   }else if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken){
37851d9da70aSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 2;
37866b93c9aeSdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
3787ae80ddeaSdrh       return pA->op==TK_COLLATE ? 1 : 2;
37881d9da70aSdrh     }
37891d9da70aSdrh   }
3790*4b17cf58Sdrh   if( (pA->flags&EP_Collate)!=(pB->flags&EP_Collate) ) return 1;
37912646da7eSdrh   return 0;
37922646da7eSdrh }
37932282792aSdrh 
37948c6f666bSdrh /*
37958c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
37968c6f666bSdrh ** non-zero if they differ in any way.
37978c6f666bSdrh **
37988c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
37998c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
38008c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
38018c6f666bSdrh ** a malfunction will result.
38028c6f666bSdrh **
38038c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
38048c6f666bSdrh ** always differs from a non-NULL pointer.
38058c6f666bSdrh */
38068c6f666bSdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB){
38078c6f666bSdrh   int i;
38088c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38098c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38108c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
38118c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
38128c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
38138c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
38148c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
38158c6f666bSdrh     if( sqlite3ExprCompare(pExprA, pExprB) ) return 1;
38168c6f666bSdrh   }
38178c6f666bSdrh   return 0;
38188c6f666bSdrh }
381913449892Sdrh 
38202282792aSdrh /*
3821030796dfSdrh ** An instance of the following structure is used by the tree walker
3822030796dfSdrh ** to count references to table columns in the arguments of an
3823ed551b95Sdrh ** aggregate function, in order to implement the
3824ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3825374fdce4Sdrh */
3826030796dfSdrh struct SrcCount {
3827030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3828030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3829030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3830030796dfSdrh };
3831030796dfSdrh 
3832030796dfSdrh /*
3833030796dfSdrh ** Count the number of references to columns.
3834030796dfSdrh */
3835030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3836fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3837fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3838fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3839fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3840fb0a6081Sdrh   ** NEVER() will need to be removed. */
3841fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3842374fdce4Sdrh     int i;
3843030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3844030796dfSdrh     SrcList *pSrc = p->pSrc;
3845374fdce4Sdrh     for(i=0; i<pSrc->nSrc; i++){
3846030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3847374fdce4Sdrh     }
3848030796dfSdrh     if( i<pSrc->nSrc ){
3849030796dfSdrh       p->nThis++;
3850374fdce4Sdrh     }else{
3851030796dfSdrh       p->nOther++;
3852374fdce4Sdrh     }
3853374fdce4Sdrh   }
3854030796dfSdrh   return WRC_Continue;
3855030796dfSdrh }
3856374fdce4Sdrh 
3857374fdce4Sdrh /*
3858030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3859030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3860030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3861030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3862374fdce4Sdrh */
3863030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3864374fdce4Sdrh   Walker w;
3865030796dfSdrh   struct SrcCount cnt;
3866374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3867374fdce4Sdrh   memset(&w, 0, sizeof(w));
3868030796dfSdrh   w.xExprCallback = exprSrcCount;
3869030796dfSdrh   w.u.pSrcCount = &cnt;
3870030796dfSdrh   cnt.pSrc = pSrcList;
3871030796dfSdrh   cnt.nThis = 0;
3872030796dfSdrh   cnt.nOther = 0;
3873030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
3874030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
3875374fdce4Sdrh }
3876374fdce4Sdrh 
3877374fdce4Sdrh /*
387813449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
387913449892Sdrh ** the new element.  Return a negative number if malloc fails.
38802282792aSdrh */
388117435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
388213449892Sdrh   int i;
3883cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
388417435752Sdrh        db,
3885cf643729Sdrh        pInfo->aCol,
3886cf643729Sdrh        sizeof(pInfo->aCol[0]),
3887cf643729Sdrh        &pInfo->nColumn,
3888cf643729Sdrh        &i
3889cf643729Sdrh   );
389013449892Sdrh   return i;
38912282792aSdrh }
389213449892Sdrh 
389313449892Sdrh /*
389413449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
389513449892Sdrh ** the new element.  Return a negative number if malloc fails.
389613449892Sdrh */
389717435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
389813449892Sdrh   int i;
3899cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
390017435752Sdrh        db,
3901cf643729Sdrh        pInfo->aFunc,
3902cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3903cf643729Sdrh        &pInfo->nFunc,
3904cf643729Sdrh        &i
3905cf643729Sdrh   );
390613449892Sdrh   return i;
39072282792aSdrh }
39082282792aSdrh 
39092282792aSdrh /*
39107d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
39117d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3912626a879aSdrh ** for additional information.
39132282792aSdrh */
39147d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
39152282792aSdrh   int i;
39167d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3917a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3918a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
391913449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
392013449892Sdrh 
39212282792aSdrh   switch( pExpr->op ){
392289c69d00Sdrh     case TK_AGG_COLUMN:
3923967e8b73Sdrh     case TK_COLUMN: {
39248b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
39258b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
392613449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
392713449892Sdrh       ** clause of the aggregate query */
392820bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
392913449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
393013449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
393113449892Sdrh           struct AggInfo_col *pCol;
393233e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
393313449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
393413449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
393513449892Sdrh             ** that is in the FROM clause of the aggregate query.
393613449892Sdrh             **
393713449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
393813449892Sdrh             ** is not an entry there already.
393913449892Sdrh             */
39407f906d63Sdrh             int k;
394113449892Sdrh             pCol = pAggInfo->aCol;
39427f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
394313449892Sdrh               if( pCol->iTable==pExpr->iTable &&
394413449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
39452282792aSdrh                 break;
39462282792aSdrh               }
39472282792aSdrh             }
39481e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
39491e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
39501e536953Sdanielk1977             ){
39517f906d63Sdrh               pCol = &pAggInfo->aCol[k];
39520817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
395313449892Sdrh               pCol->iTable = pExpr->iTable;
395413449892Sdrh               pCol->iColumn = pExpr->iColumn;
39550a07c107Sdrh               pCol->iMem = ++pParse->nMem;
395613449892Sdrh               pCol->iSorterColumn = -1;
39575774b806Sdrh               pCol->pExpr = pExpr;
395813449892Sdrh               if( pAggInfo->pGroupBy ){
395913449892Sdrh                 int j, n;
396013449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
396113449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
396213449892Sdrh                 n = pGB->nExpr;
396313449892Sdrh                 for(j=0; j<n; j++, pTerm++){
396413449892Sdrh                   Expr *pE = pTerm->pExpr;
396513449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
396613449892Sdrh                       pE->iColumn==pExpr->iColumn ){
396713449892Sdrh                     pCol->iSorterColumn = j;
396813449892Sdrh                     break;
39692282792aSdrh                   }
397013449892Sdrh                 }
397113449892Sdrh               }
397213449892Sdrh               if( pCol->iSorterColumn<0 ){
397313449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
397413449892Sdrh               }
397513449892Sdrh             }
397613449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
397713449892Sdrh             ** because it was there before or because we just created it).
397813449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
397913449892Sdrh             ** pAggInfo->aCol[] entry.
398013449892Sdrh             */
398133e619fcSdrh             ExprSetIrreducible(pExpr);
398213449892Sdrh             pExpr->pAggInfo = pAggInfo;
398313449892Sdrh             pExpr->op = TK_AGG_COLUMN;
3984cf697396Sshane             pExpr->iAgg = (i16)k;
398513449892Sdrh             break;
398613449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
398713449892Sdrh         } /* end loop over pSrcList */
3988a58fdfb1Sdanielk1977       }
39897d10d5a6Sdrh       return WRC_Prune;
39902282792aSdrh     }
39912282792aSdrh     case TK_AGG_FUNCTION: {
39923a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
3993ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
39943a8c4be7Sdrh       ){
399513449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
399613449892Sdrh         ** function that is already in the pAggInfo structure
399713449892Sdrh         */
399813449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
399913449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
40001d9da70aSdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr)==0 ){
40012282792aSdrh             break;
40022282792aSdrh           }
40032282792aSdrh         }
400413449892Sdrh         if( i>=pAggInfo->nFunc ){
400513449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
400613449892Sdrh           */
400714db2665Sdanielk1977           u8 enc = ENC(pParse->db);
40081e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
400913449892Sdrh           if( i>=0 ){
40106ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
401113449892Sdrh             pItem = &pAggInfo->aFunc[i];
401213449892Sdrh             pItem->pExpr = pExpr;
40130a07c107Sdrh             pItem->iMem = ++pParse->nMem;
401433e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
401513449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
401633e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
40176ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4018fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4019fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4020fd357974Sdrh             }else{
4021fd357974Sdrh               pItem->iDistinct = -1;
4022fd357974Sdrh             }
40232282792aSdrh           }
402413449892Sdrh         }
402513449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
402613449892Sdrh         */
402733e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
402833e619fcSdrh         ExprSetIrreducible(pExpr);
4029cf697396Sshane         pExpr->iAgg = (i16)i;
403013449892Sdrh         pExpr->pAggInfo = pAggInfo;
40313a8c4be7Sdrh         return WRC_Prune;
40326e83a57fSdrh       }else{
40336e83a57fSdrh         return WRC_Continue;
40346e83a57fSdrh       }
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 /*
4046e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4047e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4048e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4049e8abb4caSdrh ** 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